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-lsalookup-l1-1-1",
 126   "api-ms-win-security-lsalookup-l2-1-1",
 127   "api-ms-win-security-lsapolicy-l1-1-0",
 128   "api-ms-win-security-sddl-l1-1-0",
 129   "api-ms-win-service-core-l1-1-0",
 130   "api-ms-win-service-core-l1-1-1",
 131   "api-ms-win-service-management-l1-1-0",
 132   "api-ms-win-service-management-l2-1-0",
 133   "api-ms-win-service-private-l1-1-1",
 134   "api-ms-win-service-winsvc-l1-1-0",
 135   "api-ms-win-service-winsvc-l1-2-0",
 136  ],
 137  [
 138   "ntdll",
 139   "api-ms-win-core-xstate-l1-1-0",
 140  ],
 141  [
 142   "kernel32",
 143   "api-ms-win-appmodel-runtime-l1-1-1",
 144   "api-ms-win-downlevel-normaliz-l1-1-0",
 145   "api-ms-win-core-processthreads-l1-1-0",
 146   "api-ms-win-core-appcompat-l1-1-1",
 147   "api-ms-win-core-atoms-l1-1-0",
 148   "api-ms-win-core-debug-l1-1-0",
 149   "api-ms-win-core-debug-l1-1-1",
 150   "api-ms-win-core-delayload-l1-1-0",
 151   "api-ms-win-core-delayload-l1-1-1",
 152   "api-ms-win-core-errorhandling-l1-1-0",
 153   "api-ms-win-core-errorhandling-l1-1-1",
 154   "api-ms-win-core-interlocked-l1-1-0",
 155   "api-ms-win-core-interlocked-l1-2-0",
 156   "api-ms-win-core-misc-l1-1-0",
 157   "api-ms-win-core-profile-l1-1-0",
 158   "api-ms-win-core-realtime-l1-1-0",
 159   "api-ms-win-core-sidebyside-l1-1-0",
 160   "api-ms-win-core-string-l1-1-0",
 161   "api-ms-win-core-string-obsolete-l1-1-0",
 162   "api-ms-win-core-sysinfo-l1-1-0",
 163   "api-ms-win-core-sysinfo-l1-2-0",
 164   "api-ms-win-core-util-l1-1-0",
 165   "api-ms-win-core-synch-l1-1-0",
 166   "api-ms-win-core-synch-l1-2-0",
 167   "api-ms-win-core-console-l1-1-0",
 168   "api-ms-win-core-console-l2-1-0",
 169   "api-ms-win-core-file-l1-1-0",
 170   "api-ms-win-core-file-l1-2-1",
 171   "api-ms-win-core-file-l1-2-0",
 172   "api-ms-win-core-file-l2-1-0",
 173   "api-ms-win-core-file-l2-1-1",
 174   "api-ms-win-core-handle-l1-1-0",
 175   "api-ms-win-core-heap-l1-1-0",
 176   "api-ms-win-core-heap-l1-2-0",
 177   "api-ms-win-core-heap-obsolete-l1-1-0",
 178   "api-ms-win-core-io-l1-1-0",
 179   "api-ms-win-core-io-l1-1-1",
 180   "api-ms-win-core-job-l1-1-0",
 181   "api-ms-win-core-job-l2-1-0",
 182   "api-ms-win-core-kernel32-legacy-l1-1-0",
 183   "api-ms-win-core-kernel32-legacy-l1-1-1",
 184   "api-ms-win-core-kernel32-private-l1-1-1",
 185   "api-ms-win-core-libraryloader-l1-2-2",
 186   "api-ms-win-core-localization-l1-1-0",
 187   "api-ms-win-core-localization-l1-2-0",
 188   "api-ms-win-core-localization-l2-1-0",
 189   "api-ms-win-core-localization-obsolete-l1-1-0",
 190   "api-ms-win-core-localization-obsolete-l1-2-0",
 191   "api-ms-win-core-localization-private-l1-1-0",
 192   "api-ms-win-core-memory-l1-1-0",
 193   "api-ms-win-core-memory-l1-1-1",
 194   "api-ms-win-core-memory-l1-1-2",
 195   "api-ms-win-core-namespace-l1-1-0",
 196   "api-ms-win-core-normalization-l1-1-0",
 197   "api-ms-win-core-privateprofile-l1-1-1",
 198   "api-ms-win-core-processenvironment-l1-1-0",
 199   "api-ms-win-core-processenvironment-l1-2-0",
 200   "api-ms-win-core-psapi-l1-1-0",
 201   "api-ms-win-core-psapi-obsolete-l1-1-0",
 202   "api-ms-win-core-threadpool-l1-1-0",
 203   "api-ms-win-core-threadpool-l1-2-0",
 204   "api-ms-win-core-threadpool-legacy-l1-1-0",
 205   "api-ms-win-core-timezone-l1-1-0",
 206   "api-ms-win-core-toolhelp-l1-1-0",
 207   "api-ms-win-core-sysinfo-l1-2-1",
 208   "api-ms-win-core-processthreads-l1-1-2",
 209   "api-ms-win-core-fibers-l1-1-0",
 210   "api-ms-win-core-fibers-l1-1-1",
 211   "api-ms-win-core-localization-l1-2-1",
 212   "api-ms-win-core-datetime-l1-1-0",
 213   "api-ms-win-core-datetime-l1-1-1",
 214   "api-ms-win-core-windowserrorreporting-l1-1-0",
 215   "api-ms-win-core-wow64-l1-1-0",
 216   "api-ms-win-core-xstate-l2-1-0",
 217   "api-ms-win-core-errorhandling-l1-1-2",
 218   "api-ms-win-core-util-l1-1-0",
 219   "ext-ms-win-kernel32-package-current-l1-1-0",
 220  ],
 221  [
 222   "kernel32",
 223   "user32",
 224   "api-ms-win-core-appinit-l1-1-0",
 225   "api-ms-win-core-libraryloader-l1-1-0",
 226   "api-ms-win-core-libraryloader-l1-1-1",
 227   "api-ms-win-core-libraryloader-l1-2-0",
 228  ],
 229  [
 230   "kernel32",
 231   "advapi32",
 232   "api-ms-win-core-namedpipe-l1-1-0",
 233   "api-ms-win-core-namedpipe-l1-2-0",
 234   "api-ms-win-core-processthreads-l1-1-1",
 235  ],
 236  [
 237   "kernel32",
 238   "advapi32",
 239   "user32",
 240   "kernelbase",
 241   "api-ms-win-core-bem-l1-1-0",
 242  ],
 243  [
 244   "ole32",
 245   "api-ms-win-downlevel-ole32-l1-1-0",
 246   "api-ms-win-core-com-l1-1-0",
 247   "api-ms-win-core-com-l1-1-1",
 248   "api-ms-win-core-com-private-l1-1-0",
 249   "combase",
 250   "iprop",
 251  ],
 252  [
 253   "shell32",
 254   "api-ms-win-downlevel-shell32-l1-1-0",
 255   "api-ms-win-shell-shellcom-l1-1-0",
 256   "api-ms-win-shell-shellfolders-l1-1-0",
 257  ],
 258  [
 259   "shlwapi",
 260   "api-ms-win-downlevel-shlwapi-l1-1-0",
 261   "api-ms-win-downlevel-shlwapi-l2-1-0",
 262   "api-ms-win-core-registryuserspecific-l1-1-0",
 263   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 264   "api-ms-win-core-shlwapi-obsolete-l1-1-0",
 265   "api-ms-win-core-url-l1-1-0",
 266  ],
 267  [
 268   "user32",
 269   "api-ms-win-core-stringansi-l1-1-0",
 270   "api-ms-win-core-string-l2-1-0",
 271   "api-ms-win-downlevel-user32-l1-1-0",
 272   "api-ms-win-ntuser-dc-access-l1-1-0",
 273   "api-ms-win-rtcore-ntuser-private-l1-1-0",
 274   "ext-ms-win-ntuser-message-l1-1-1",
 275   "ext-ms-win-ntuser-private-l1-1-1",
 276   "ext-ms-win-ntuser-rectangle-ext-l1-1-0",
 277   "ext-ms-win-ntuser-uicontext-ext-l1-1-0",
 278   "ext-ms-win-ntuser-window-l1-1-1",
 279   "ext-ms-win-rtcore-ntuser-dc-access-l1-1-0",
 280   "ext-ms-win-rtcore-ntuser-dpi-l1-1-0",
 281   "ext-ms-win-rtcore-ntuser-sysparams-l1-1-0",
 282  ],
 283  [
 284   "version",
 285   "api-ms-win-core-versionansi-l1-1-0",
 286   "api-ms-win-core-version-l1-1-0",
 287   "api-ms-win-core-version-private-l1-1-0",
 288   "api-ms-win-downlevel-version-l1-1-0",
 289  ],
 290  [
 291   "msvcrt",
 292   "ntdll",
 293   "ntoskrnl.exe",
 294   "api-ms-win-core-apiquery-l1-1-0",
 295   "api-ms-win-core-rtlsupport-l1-1-0",
 296   "api-ms-win-core-rtlsupport-l1-2-0",
 297  ],
 298  [
 299   "gdi32",
 300   "api-ms-win-dx-d3dkmt-l1-1-0",
 301   "ext-ms-win-gdi-dc-create-l1-1-1",
 302   "ext-ms-win-gdi-dc-l1-2-0",
 303   "ext-ms-win-gdi-devcaps-l1-1-0",
 304   "ext-ms-win-gdi-draw-l1-1-1",
 305   "ext-ms-win-gdi-render-l1-1-0",
 306   "ext-ms-win-rtcore-gdi-object-l1-1-0",
 307   "ext-ms-win-rtcore-gdi-rgn-l1-1-0",
 308  ],
 309  [
 310   "combase",
 311   "api-ms-win-core-winrt-errorprivate-l1-1-1",
 312   "api-ms-win-core-winrt-l1-1-0",
 313   "api-ms-win-core-winrt-registration-l1-1-0",
 314   "api-ms-win-core-winrt-string-l1-1-0",
 315  ],
 316  [
 317   "bthprops.cpl",
 318   "irprops.cpl",
 319  ],
 320  [
 321   "sfc_os",
 322   "sfc",
 323  ],
 324  [
 325   "bcrypt",
 326   "ncrypt",
 327  ],
 328 );
 329
 330 my $update_flags = 0;
 331 my $show_duplicates = 0;
 332
 333 foreach my $arg (@ARGV)
 334 {
 335     if ($arg eq "-f") { $update_flags = 1; }
 336     elsif ($arg eq "-d") { $show_duplicates = 1; }
 337 }
 338
 339 # update a file if changed
 340 sub update_file($$)
 341 {
 342     my $file = shift;
 343     my $new = shift;
 344
 345     open FILE, ">$file.new" or die "cannot create $file.new";
 346     print FILE $new;
 347     close FILE;
 348     rename "$file.new", "$file";
 349     print "$file updated\n";
 350 }
 351
 352 # parse a spec file line
 353 sub parse_line($$$)
 354 {
 355     my ($name, $line, $str) = @_;
 356
 357     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*\#.*)?/)
 358     {
 359         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 360                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 361     }
 362     return () if $str =~ /^\s*$/;
 363     return () if $str =~ /^\s*\#/;
 364     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 365 }
 366
 367 sub read_spec_file($)
 368 {
 369     my $name = shift;
 370     my $file = "dlls/$name/$name.spec";
 371     my %stubs;
 372     open SPEC, "<$file" or die "cannot open $file";
 373     while (<SPEC>)
 374     {
 375         chomp;
 376         my %descr = parse_line( $name, $., $_ );
 377         next unless %descr;
 378
 379         my $func = $descr{name};
 380         next if defined $funcs{$func};
 381         $funcs{$func} = \%descr;
 382     }
 383     close SPEC;
 384 }
 385
 386 sub update_spec_file($)
 387 {
 388     my $name = shift;
 389     my $file = "dlls/$name/$name.spec";
 390     my %stubs;
 391     my ($old, $new);
 392
 393     open SPEC, "<$file" or die "cannot open $file";
 394     while (<SPEC>)
 395     {
 396         $old .= $_;
 397         chomp;
 398
 399         my $commented_out = 0;
 400         my %descr = parse_line( $name, $., $_ );
 401         if (!%descr)
 402         {
 403             # check for commented out exports
 404             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 405             {
 406                 $commented_out = 1;
 407                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 408             }
 409         }
 410         goto done unless %descr;
 411
 412         my $func = $descr{name};
 413         if (!defined $funcs{$func})
 414         {
 415             $funcs{$func} = \%descr unless $commented_out;
 416             goto done;
 417         }
 418
 419         my %parent = %{$funcs{$func}};
 420         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 421         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 422         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 423         {
 424             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 425             goto done;
 426         }
 427
 428         my $flags = $descr{flags};
 429         if ($parent{callconv} ne "stub" || $update_flags)
 430         {
 431             $flags = $parent{flags};
 432             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 433             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 434             if ($descr{flags} =~ /-private/)  # preserve -private flag
 435             {
 436                 $flags = "-private " . $flags unless $flags =~ /-private/;
 437             }
 438         }
 439
 440         if ($parent{callconv} ne "stub" || $parent{args})
 441         {
 442             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 443                            $parent{spec} =~ /(msvc|ucrtbase)/ ? "cdecl" : "stdcall";  # hack
 444             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 445
 446             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 447             {
 448                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 449             }
 450             else
 451             {
 452                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 453             }
 454         }
 455         else
 456         {
 457             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 458         }
 459         $_ .= $descr{comment} || "";
 460
 461       done:
 462         $new .= "$_\n";
 463     }
 464     close SPEC;
 465     update_file( $file, $new ) if $old ne $new;
 466 }
 467
 468 sub sync_spec_files(@)
 469 {
 470     %funcs = ();
 471     $group_head = shift;
 472     read_spec_file( $group_head );
 473     foreach my $spec (@_) { update_spec_file($spec); }
 474 }
 475
 476 foreach my $group (@dll_groups)
 477 {
 478     sync_spec_files( @{$group} );
 479 }