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