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