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