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