tools/make_specfiles

   1 #!/usr/bin/perl -w
   2 #
   3 # Update spec files across dlls that share an implementation
   4 #
   5 # Copyright 2011 Alexandre Julliard
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20 #
  21
  22 use strict;
  23
  24 my %funcs;
  25 my $group_head;
  26
  27 my @dll_groups =
  28 (
  29  [
  30   "msvcrt",
  31   "msvcirt",
  32   "msvcrt40",
  33   "msvcrt20",
  34   "msvcrtd",
  35   "crtdll",
  36  ],
  37  [
  38   "msvcrt",
  39   "msvcp90",
  40   "msvcp100",
  41   "msvcp110",
  42   "msvcp120",
  43   "msvcp140",
  44   "msvcp71",
  45   "msvcp80",
  46   "msvcp70",
  47   "msvcp60",
  48  ],
  49  [
  50   "msvcr120",
  51   "msvcr120_app",
  52   "concrt140",
  53  ],
  54  [
  55   "ucrtbase",
  56   "api-ms-win-crt-conio-l1-1-0",
  57   "api-ms-win-crt-convert-l1-1-0",
  58   "api-ms-win-crt-environment-l1-1-0",
  59   "api-ms-win-crt-filesystem-l1-1-0",
  60   "api-ms-win-crt-heap-l1-1-0",
  61   "api-ms-win-crt-locale-l1-1-0",
  62   "api-ms-win-crt-math-l1-1-0",
  63   "api-ms-win-crt-multibyte-l1-1-0",
  64   "api-ms-win-crt-private-l1-1-0",
  65   "api-ms-win-crt-process-l1-1-0",
  66   "api-ms-win-crt-runtime-l1-1-0",
  67   "api-ms-win-crt-stdio-l1-1-0",
  68   "api-ms-win-crt-string-l1-1-0",
  69   "api-ms-win-crt-time-l1-1-0",
  70   "api-ms-win-crt-utility-l1-1-0",
  71   "vcruntime140",
  72  ],
  73  [
  74   "msvcp120",
  75   "msvcp120_app",
  76  ],
  77  [
  78   "d3dx10_43",
  79   "d3dx10_42",
  80   "d3dx10_41",
  81   "d3dx10_40",
  82   "d3dx10_39",
  83   "d3dx10_38",
  84   "d3dx10_37",
  85   "d3dx10_36",
  86   "d3dx10_35",
  87   "d3dx10_34",
  88   "d3dx10_33",
  89  ],
  90  [
  91   "xinput1_3",
  92   "xinput1_4",
  93   "xinput1_2",
  94   "xinput1_1",
  95   "xinput9_1_0",
  96  ],
  97  [
  98   "setupapi",
  99   "cfgmgr32",
 100  ],
 101  [
 102   "vcomp",
 103   "vcomp140",
 104   "vcomp120",
 105   "vcomp110",
 106   "vcomp100",
 107   "vcomp90",
 108  ],
 109  [
 110   "advapi32",
 111   "api-ms-win-core-localregistry-l1-1-0",
 112   "api-ms-win-downlevel-advapi32-l1-1-0",
 113   "api-ms-win-downlevel-advapi32-l2-1-0",
 114   "api-ms-win-security-base-l1-1-0",
 115   "api-ms-win-core-registry-l1-1-0",
 116   "api-ms-win-eventing-classicprovider-l1-1-0",
 117   "api-ms-win-eventing-consumer-l1-1-0",
 118   "api-ms-win-eventing-controller-l1-1-0",
 119   "api-ms-win-eventing-provider-l1-1-0",
 120   "api-ms-win-eventlog-legacy-l1-1-0",
 121   "api-ms-win-security-audit-l1-1-1",
 122   "api-ms-win-security-base-l1-2-0",
 123   "api-ms-win-security-base-private-l1-1-1",
 124   "api-ms-win-security-lsalookup-l1-1-0",
 125   "api-ms-win-security-sddl-l1-1-0",
 126   "api-ms-win-service-core-l1-1-0",
 127   "api-ms-win-service-core-l1-1-1",
 128   "api-ms-win-service-management-l1-1-0",
 129   "api-ms-win-service-management-l2-1-0",
 130   "api-ms-win-service-private-l1-1-1",
 131   "api-ms-win-service-winsvc-l1-1-0",
 132   "api-ms-win-service-winsvc-l1-2-0",
 133  ],
 134  [
 135   "ntdll",
 136   "api-ms-win-core-xstate-l1-1-0",
 137  ],
 138  [
 139   "kernel32",
 140   "api-ms-win-downlevel-normaliz-l1-1-0",
 141   "api-ms-win-core-processthreads-l1-1-0",
 142   "api-ms-win-core-appcompat-l1-1-1",
 143   "api-ms-win-core-atoms-l1-1-0",
 144   "api-ms-win-core-debug-l1-1-0",
 145   "api-ms-win-core-debug-l1-1-1",
 146   "api-ms-win-core-delayload-l1-1-0",
 147   "api-ms-win-core-delayload-l1-1-1",
 148   "api-ms-win-core-errorhandling-l1-1-0",
 149   "api-ms-win-core-errorhandling-l1-1-1",
 150   "api-ms-win-core-interlocked-l1-1-0",
 151   "api-ms-win-core-interlocked-l1-2-0",
 152   "api-ms-win-core-misc-l1-1-0",
 153   "api-ms-win-core-profile-l1-1-0",
 154   "api-ms-win-core-realtime-l1-1-0",
 155   "api-ms-win-core-sidebyside-l1-1-0",
 156   "api-ms-win-core-string-l1-1-0",
 157   "api-ms-win-core-string-obsolete-l1-1-0",
 158   "api-ms-win-core-sysinfo-l1-1-0",
 159   "api-ms-win-core-sysinfo-l1-2-0",
 160   "api-ms-win-core-util-l1-1-0",
 161   "api-ms-win-core-synch-l1-1-0",
 162   "api-ms-win-core-synch-l1-2-0",
 163   "api-ms-win-core-console-l1-1-0",
 164   "api-ms-win-core-console-l2-1-0",
 165   "api-ms-win-core-file-l1-1-0",
 166   "api-ms-win-core-file-l1-2-1",
 167   "api-ms-win-core-file-l1-2-0",
 168   "api-ms-win-core-file-l2-1-0",
 169   "api-ms-win-core-file-l2-1-1",
 170   "api-ms-win-core-handle-l1-1-0",
 171   "api-ms-win-core-heap-l1-1-0",
 172   "api-ms-win-core-heap-l1-2-0",
 173   "api-ms-win-core-heap-obsolete-l1-1-0",
 174   "api-ms-win-core-io-l1-1-0",
 175   "api-ms-win-core-io-l1-1-1",
 176   "api-ms-win-core-job-l1-1-0",
 177   "api-ms-win-core-job-l2-1-0",
 178   "api-ms-win-core-kernel32-legacy-l1-1-0",
 179   "api-ms-win-core-kernel32-legacy-l1-1-1",
 180   "api-ms-win-core-kernel32-private-l1-1-1",
 181   "api-ms-win-core-libraryloader-l1-2-2",
 182   "api-ms-win-core-localization-l1-1-0",
 183   "api-ms-win-core-localization-l1-2-0",
 184   "api-ms-win-core-localization-l2-1-0",
 185   "api-ms-win-core-localization-obsolete-l1-1-0",
 186   "api-ms-win-core-localization-obsolete-l1-2-0",
 187   "api-ms-win-core-localization-private-l1-1-0",
 188   "api-ms-win-core-memory-l1-1-0",
 189   "api-ms-win-core-memory-l1-1-1",
 190   "api-ms-win-core-memory-l1-1-2",
 191   "api-ms-win-core-namespace-l1-1-0",
 192   "api-ms-win-core-normalization-l1-1-0",
 193   "api-ms-win-core-privateprofile-l1-1-1",
 194   "api-ms-win-core-processenvironment-l1-1-0",
 195   "api-ms-win-core-processenvironment-l1-2-0",
 196   "api-ms-win-core-psapi-l1-1-0",
 197   "api-ms-win-core-threadpool-l1-1-0",
 198   "api-ms-win-core-threadpool-l1-2-0",
 199   "api-ms-win-core-threadpool-legacy-l1-1-0",
 200   "api-ms-win-core-timezone-l1-1-0",
 201   "api-ms-win-core-toolhelp-l1-1-0",
 202   "api-ms-win-core-sysinfo-l1-2-1",
 203   "api-ms-win-core-processthreads-l1-1-2",
 204   "api-ms-win-core-fibers-l1-1-0",
 205   "api-ms-win-core-fibers-l1-1-1",
 206   "api-ms-win-core-localization-l1-2-1",
 207   "api-ms-win-core-datetime-l1-1-0",
 208   "api-ms-win-core-datetime-l1-1-1",
 209   "api-ms-win-core-windowserrorreporting-l1-1-0",
 210   "api-ms-win-core-wow64-l1-1-0",
 211   "api-ms-win-core-xstate-l2-1-0",
 212   "api-ms-win-core-errorhandling-l1-1-2",
 213   "api-ms-win-core-util-l1-1-0",
 214  ],
 215  [
 216   "kernel32",
 217   "user32",
 218   "api-ms-win-core-appinit-l1-1-0",
 219   "api-ms-win-core-libraryloader-l1-1-0",
 220   "api-ms-win-core-libraryloader-l1-1-1",
 221   "api-ms-win-core-libraryloader-l1-2-0",
 222  ],
 223  [
 224   "kernel32",
 225   "advapi32",
 226   "api-ms-win-core-namedpipe-l1-1-0",
 227   "api-ms-win-core-namedpipe-l1-2-0",
 228   "api-ms-win-core-processthreads-l1-1-1",
 229  ],
 230  [
 231   "kernel32",
 232   "advapi32",
 233   "user32",
 234   "kernelbase",
 235   "api-ms-win-core-bem-l1-1-0",
 236  ],
 237  [
 238   "ole32",
 239   "api-ms-win-downlevel-ole32-l1-1-0",
 240   "api-ms-win-core-com-l1-1-0",
 241   "api-ms-win-core-com-l1-1-1",
 242   "combase",
 243   "iprop",
 244  ],
 245  [
 246   "shell32",
 247   "api-ms-win-downlevel-shell32-l1-1-0",
 248   "api-ms-win-shell-shellcom-l1-1-0",
 249   "api-ms-win-shell-shellfolders-l1-1-0",
 250  ],
 251  [
 252   "shlwapi",
 253   "api-ms-win-downlevel-shlwapi-l1-1-0",
 254   "api-ms-win-downlevel-shlwapi-l2-1-0",
 255   "api-ms-win-core-registryuserspecific-l1-1-0",
 256   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 257   "api-ms-win-core-shlwapi-obsolete-l1-1-0",
 258   "api-ms-win-core-url-l1-1-0",
 259  ],
 260  [
 261   "user32",
 262   "api-ms-win-core-stringansi-l1-1-0",
 263   "api-ms-win-core-string-l2-1-0",
 264   "api-ms-win-downlevel-user32-l1-1-0",
 265   "api-ms-win-ntuser-dc-access-l1-1-0",
 266  ],
 267  [
 268   "version",
 269   "api-ms-win-core-versionansi-l1-1-0",
 270   "api-ms-win-core-version-l1-1-0",
 271   "api-ms-win-core-version-private-l1-1-0",
 272   "api-ms-win-downlevel-version-l1-1-0",
 273  ],
 274  [
 275   "msvcrt",
 276   "ntdll",
 277   "ntoskrnl.exe",
 278   "api-ms-win-core-apiquery-l1-1-0",
 279   "api-ms-win-core-rtlsupport-l1-1-0",
 280   "api-ms-win-core-rtlsupport-l1-2-0",
 281  ],
 282  [
 283   "gdi32",
 284   "ext-ms-win-gdi-devcaps-l1-1-0",
 285  ],
 286  [
 287   "combase",
 288   "api-ms-win-core-winrt-errorprivate-l1-1-1",
 289   "api-ms-win-core-winrt-l1-1-0",
 290   "api-ms-win-core-winrt-registration-l1-1-0",
 291   "api-ms-win-core-winrt-string-l1-1-0",
 292  ],
 293  [
 294   "bthprops.cpl",
 295   "irprops.cpl",
 296  ],
 297  [
 298   "sfc_os",
 299   "sfc",
 300  ],
 301  [
 302   "bcrypt",
 303   "ncrypt",
 304  ],
 305 );
 306
 307 my $update_flags = 0;
 308 my $show_duplicates = 0;
 309
 310 foreach my $arg (@ARGV)
 311 {
 312     if ($arg eq "-f") { $update_flags = 1; }
 313     elsif ($arg eq "-d") { $show_duplicates = 1; }
 314 }
 315
 316 # update a file if changed
 317 sub update_file($$)
 318 {
 319     my $file = shift;
 320     my $new = shift;
 321
 322     open FILE, ">$file.new" or die "cannot create $file.new";
 323     print FILE $new;
 324     close FILE;
 325     rename "$file.new", "$file";
 326     print "$file updated\n";
 327 }
 328
 329 # parse a spec file line
 330 sub parse_line($$$)
 331 {
 332     my ($name, $line, $str) = @_;
 333
 334     if ($str =~ /^\s*(\@|\d+)\s+(stdcall|cdecl|varargs|thiscall|stub|extern)\s+((?:-\S+\s+)*)([A-Za-z0-9_\@\$?]+)(?:\s*(\([^)]*\)))?(?:\s+([A-Za-z0-9_\@\$?.]+))?(\s*\#.*)?/)
 335     {
 336         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 337                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 338     }
 339     return () if $str =~ /^\s*$/;
 340     return () if $str =~ /^\s*\#/;
 341     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 342 }
 343
 344 sub read_spec_file($)
 345 {
 346     my $name = shift;
 347     my $file = "dlls/$name/$name.spec";
 348     my %stubs;
 349     open SPEC, "<$file" or die "cannot open $file";
 350     while (<SPEC>)
 351     {
 352         chomp;
 353         my %descr = parse_line( $name, $., $_ );
 354         next unless %descr;
 355
 356         my $func = $descr{name};
 357         next if defined $funcs{$func};
 358         $funcs{$func} = \%descr;
 359     }
 360     close SPEC;
 361 }
 362
 363 sub update_spec_file($)
 364 {
 365     my $name = shift;
 366     my $file = "dlls/$name/$name.spec";
 367     my %stubs;
 368     my ($old, $new);
 369
 370     open SPEC, "<$file" or die "cannot open $file";
 371     while (<SPEC>)
 372     {
 373         $old .= $_;
 374         chomp;
 375
 376         my $commented_out = 0;
 377         my %descr = parse_line( $name, $., $_ );
 378         if (!%descr)
 379         {
 380             # check for commented out exports
 381             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 382             {
 383                 $commented_out = 1;
 384                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 385             }
 386         }
 387         goto done unless %descr;
 388
 389         my $func = $descr{name};
 390         if (!defined $funcs{$func})
 391         {
 392             $funcs{$func} = \%descr unless $commented_out;
 393             goto done;
 394         }
 395
 396         my %parent = %{$funcs{$func}};
 397         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 398         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 399         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 400         {
 401             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 402             goto done;
 403         }
 404
 405         my $flags = $descr{flags};
 406         if ($parent{callconv} ne "stub" || $update_flags)
 407         {
 408             $flags = $parent{flags};
 409             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 410             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 411             if ($descr{flags} =~ /-private/)  # preserve -private flag
 412             {
 413                 $flags = "-private " . $flags unless $flags =~ /-private/;
 414             }
 415         }
 416
 417         if ($parent{callconv} ne "stub" || $parent{args})
 418         {
 419             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 420                            $parent{spec} =~ /(msvc|ucrtbase)/ ? "cdecl" : "stdcall";  # hack
 421             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 422
 423             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 424             {
 425                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 426             }
 427             else
 428             {
 429                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 430             }
 431         }
 432         else
 433         {
 434             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 435         }
 436         $_ .= $descr{comment} || "";
 437
 438       done:
 439         $new .= "$_\n";
 440     }
 441     close SPEC;
 442     update_file( $file, $new ) if $old ne $new;
 443 }
 444
 445 sub sync_spec_files(@)
 446 {
 447     %funcs = ();
 448     $group_head = shift;
 449     read_spec_file( $group_head );
 450     foreach my $spec (@_) { update_spec_file($spec); }
 451 }
 452
 453 foreach my $group (@dll_groups)
 454 {
 455     sync_spec_files( @{$group} );
 456 }