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   "msvcp71",
  44   "msvcp80",
  45   "msvcp70",
  46   "msvcp60",
  47  ],
  48  [
  49   "msvcr120",
  50   "msvcr120_app",
  51  ],
  52  [
  53   "ucrtbase",
  54   "api-ms-win-crt-conio-l1-1-0",
  55   "api-ms-win-crt-convert-l1-1-0",
  56   "api-ms-win-crt-environment-l1-1-0",
  57   "api-ms-win-crt-filesystem-l1-1-0",
  58   "api-ms-win-crt-heap-l1-1-0",
  59   "api-ms-win-crt-locale-l1-1-0",
  60   "api-ms-win-crt-math-l1-1-0",
  61   "api-ms-win-crt-multibyte-l1-1-0",
  62   "api-ms-win-crt-private-l1-1-0",
  63   "api-ms-win-crt-process-l1-1-0",
  64   "api-ms-win-crt-runtime-l1-1-0",
  65   "api-ms-win-crt-stdio-l1-1-0",
  66   "api-ms-win-crt-string-l1-1-0",
  67   "api-ms-win-crt-time-l1-1-0",
  68   "api-ms-win-crt-utility-l1-1-0",
  69   "vcruntime140",
  70  ],
  71  [
  72   "msvcp120",
  73   "msvcp120_app",
  74  ],
  75  [
  76   "d3dx10_43",
  77   "d3dx10_42",
  78   "d3dx10_41",
  79   "d3dx10_40",
  80   "d3dx10_39",
  81   "d3dx10_38",
  82   "d3dx10_37",
  83   "d3dx10_36",
  84   "d3dx10_35",
  85   "d3dx10_34",
  86   "d3dx10_33",
  87  ],
  88  [
  89   "xinput1_3",
  90   "xinput1_4",
  91   "xinput1_2",
  92   "xinput1_1",
  93   "xinput9_1_0",
  94  ],
  95  [
  96   "setupapi",
  97   "cfgmgr32",
  98  ],
  99  [
 100   "vcomp",
 101   "vcomp120",
 102   "vcomp110",
 103   "vcomp100",
 104   "vcomp90",
 105  ],
 106  [
 107   "advapi32",
 108   "api-ms-win-core-localregistry-l1-1-0",
 109   "api-ms-win-downlevel-advapi32-l1-1-0",
 110   "api-ms-win-downlevel-advapi32-l2-1-0",
 111   "api-ms-win-security-base-l1-1-0",
 112   "api-ms-win-core-registry-l1-1-0",
 113   "api-ms-win-eventing-classicprovider-l1-1-0",
 114   "api-ms-win-eventing-provider-l1-1-0",
 115   "api-ms-win-security-base-l1-2-0",
 116   "api-ms-win-security-lsalookup-l1-1-0",
 117   "api-ms-win-security-sddl-l1-1-0",
 118   "api-ms-win-service-core-l1-1-1",
 119   "api-ms-win-service-management-l1-1-0",
 120   "api-ms-win-service-winsvc-l1-2-0",
 121  ],
 122  [
 123   "kernel32",
 124   "api-ms-win-downlevel-normaliz-l1-1-0",
 125   "api-ms-win-core-processthreads-l1-1-0",
 126   "api-ms-win-core-debug-l1-1-0",
 127   "api-ms-win-core-debug-l1-1-1",
 128   "api-ms-win-core-delayload-l1-1-1",
 129   "api-ms-win-core-errorhandling-l1-1-0",
 130   "api-ms-win-core-errorhandling-l1-1-1",
 131   "api-ms-win-core-interlocked-l1-1-0",
 132   "api-ms-win-core-interlocked-l1-2-0",
 133   "api-ms-win-core-misc-l1-1-0",
 134   "api-ms-win-core-profile-l1-1-0",
 135   "api-ms-win-core-string-l1-1-0",
 136   "api-ms-win-core-sysinfo-l1-1-0",
 137   "api-ms-win-core-sysinfo-l1-2-0",
 138   "api-ms-win-core-util-l1-1-0",
 139   "api-ms-win-core-synch-l1-1-0",
 140   "api-ms-win-core-synch-l1-2-0",
 141   "api-ms-win-core-console-l1-1-0",
 142   "api-ms-win-core-file-l1-1-0",
 143   "api-ms-win-core-file-l1-2-1",
 144   "api-ms-win-core-file-l1-2-0",
 145   "api-ms-win-core-file-l2-1-0",
 146   "api-ms-win-core-file-l2-1-1",
 147   "api-ms-win-core-handle-l1-1-0",
 148   "api-ms-win-core-heap-l1-1-0",
 149   "api-ms-win-core-heap-l1-2-0",
 150   "api-ms-win-core-heap-obsolete-l1-1-0",
 151   "api-ms-win-core-io-l1-1-1",
 152   "api-ms-win-core-kernel32-legacy-l1-1-0",
 153   "api-ms-win-core-kernel32-legacy-l1-1-1",
 154   "api-ms-win-core-localization-l1-1-0",
 155   "api-ms-win-core-localization-l1-2-0",
 156   "api-ms-win-core-localization-obsolete-l1-1-0",
 157   "api-ms-win-core-memory-l1-1-0",
 158   "api-ms-win-core-memory-l1-1-1",
 159   "api-ms-win-core-memory-l1-1-2",
 160   "api-ms-win-core-processenvironment-l1-1-0",
 161   "api-ms-win-core-processenvironment-l1-2-0",
 162   "api-ms-win-core-psapi-l1-1-0",
 163   "api-ms-win-core-threadpool-l1-2-0",
 164   "api-ms-win-core-threadpool-legacy-l1-1-0",
 165   "api-ms-win-core-timezone-l1-1-0",
 166   "api-ms-win-core-sysinfo-l1-2-1",
 167   "api-ms-win-core-processthreads-l1-1-2",
 168   "api-ms-win-core-fibers-l1-1-0",
 169   "api-ms-win-core-fibers-l1-1-1",
 170   "api-ms-win-core-localization-l1-2-1",
 171   "api-ms-win-core-datetime-l1-1-0",
 172   "api-ms-win-core-datetime-l1-1-1",
 173   "api-ms-win-core-wow64-l1-1-0",
 174   "api-ms-win-core-xstate-l2-1-0",
 175   "api-ms-win-core-errorhandling-l1-1-2",
 176  ],
 177  [
 178   "kernel32",
 179   "user32",
 180   "api-ms-win-core-libraryloader-l1-1-0",
 181   "api-ms-win-core-libraryloader-l1-1-1",
 182   "api-ms-win-core-libraryloader-l1-2-0",
 183  ],
 184  [
 185   "kernel32",
 186   "advapi32",
 187   "api-ms-win-core-namedpipe-l1-1-0",
 188   "api-ms-win-core-namedpipe-l1-2-0",
 189   "api-ms-win-core-processthreads-l1-1-1",
 190  ],
 191  [
 192   "kernel32",
 193   "advapi32",
 194   "user32",
 195   "kernelbase",
 196  ],
 197  [
 198   "ole32",
 199   "api-ms-win-downlevel-ole32-l1-1-0",
 200   "api-ms-win-core-com-l1-1-0",
 201   "api-ms-win-core-com-l1-1-1",
 202   "combase",
 203  ],
 204  [
 205   "shell32",
 206   "api-ms-win-downlevel-shell32-l1-1-0",
 207  ],
 208  [
 209   "shlwapi",
 210   "api-ms-win-downlevel-shlwapi-l1-1-0",
 211   "api-ms-win-downlevel-shlwapi-l2-1-0",
 212   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 213   "api-ms-win-core-url-l1-1-0",
 214  ],
 215  [
 216   "user32",
 217   "api-ms-win-core-string-l2-1-0",
 218   "api-ms-win-downlevel-user32-l1-1-0",
 219   "api-ms-win-ntuser-dc-access-l1-1-0",
 220  ],
 221  [
 222   "version",
 223   "api-ms-win-core-version-l1-1-0",
 224   "api-ms-win-downlevel-version-l1-1-0",
 225  ],
 226  [
 227   "msvcrt",
 228   "ntdll",
 229   "ntoskrnl.exe",
 230   "api-ms-win-core-rtlsupport-l1-1-0",
 231   "api-ms-win-core-rtlsupport-l1-2-0",
 232  ],
 233  [
 234   "gdi32",
 235   "ext-ms-win-gdi-devcaps-l1-1-0",
 236  ],
 237  [
 238   "combase",
 239   "api-ms-win-core-winrt-l1-1-0",
 240   "api-ms-win-core-winrt-registration-l1-1-0",
 241   "api-ms-win-core-winrt-string-l1-1-0",
 242  ],
 243  [
 244   "bthprops.cpl",
 245   "irprops.cpl",
 246  ],
 247  [
 248   "sfc_os",
 249   "sfc",
 250  ],
 251  [
 252   "bcrypt",
 253   "ncrypt",
 254  ],
 255 );
 256
 257 my $update_flags = 0;
 258 my $show_duplicates = 0;
 259
 260 foreach my $arg (@ARGV)
 261 {
 262     if ($arg eq "-f") { $update_flags = 1; }
 263     elsif ($arg eq "-d") { $show_duplicates = 1; }
 264 }
 265
 266 # update a file if changed
 267 sub update_file($$)
 268 {
 269     my $file = shift;
 270     my $new = shift;
 271
 272     open FILE, ">$file.new" or die "cannot create $file.new";
 273     print FILE $new;
 274     close FILE;
 275     rename "$file.new", "$file";
 276     print "$file updated\n";
 277 }
 278
 279 # parse a spec file line
 280 sub parse_line($$$)
 281 {
 282     my ($name, $line, $str) = @_;
 283
 284     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*\#.*)?/)
 285     {
 286         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 287                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 288     }
 289     return () if $str =~ /^\s*$/;
 290     return () if $str =~ /^\s*\#/;
 291     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 292 }
 293
 294 sub read_spec_file($)
 295 {
 296     my $name = shift;
 297     my $file = "dlls/$name/$name.spec";
 298     my %stubs;
 299     open SPEC, "<$file" or die "cannot open $file";
 300     while (<SPEC>)
 301     {
 302         chomp;
 303         my %descr = parse_line( $name, $., $_ );
 304         next unless %descr;
 305
 306         my $func = $descr{name};
 307         next if defined $funcs{$func};
 308         $funcs{$func} = \%descr;
 309     }
 310     close SPEC;
 311 }
 312
 313 sub update_spec_file($)
 314 {
 315     my $name = shift;
 316     my $file = "dlls/$name/$name.spec";
 317     my %stubs;
 318     my ($old, $new);
 319
 320     open SPEC, "<$file" or die "cannot open $file";
 321     while (<SPEC>)
 322     {
 323         $old .= $_;
 324         chomp;
 325
 326         my $commented_out = 0;
 327         my %descr = parse_line( $name, $., $_ );
 328         if (!%descr)
 329         {
 330             # check for commented out exports
 331             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 332             {
 333                 $commented_out = 1;
 334                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 335             }
 336         }
 337         goto done unless %descr;
 338
 339         my $func = $descr{name};
 340         if (!defined $funcs{$func})
 341         {
 342             $funcs{$func} = \%descr unless $commented_out;
 343             goto done;
 344         }
 345
 346         my %parent = %{$funcs{$func}};
 347         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 348         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 349         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 350         {
 351             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 352             goto done;
 353         }
 354
 355         my $flags = $descr{flags};
 356         if ($parent{callconv} ne "stub" || $update_flags)
 357         {
 358             $flags = $parent{flags};
 359             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 360             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 361             if ($descr{flags} =~ /-private/)  # preserve -private flag
 362             {
 363                 $flags = "-private " . $flags unless $flags =~ /-private/;
 364             }
 365         }
 366
 367         if ($parent{callconv} ne "stub" || $parent{args})
 368         {
 369             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 370                            $parent{spec} =~ /(msvc|ucrtbase)/ ? "cdecl" : "stdcall";  # hack
 371             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 372
 373             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 374             {
 375                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 376             }
 377             else
 378             {
 379                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 380             }
 381         }
 382         else
 383         {
 384             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 385         }
 386         $_ .= $descr{comment} || "";
 387
 388       done:
 389         $new .= "$_\n";
 390     }
 391     close SPEC;
 392     update_file( $file, $new ) if $old ne $new;
 393 }
 394
 395 sub sync_spec_files(@)
 396 {
 397     %funcs = ();
 398     $group_head = shift;
 399     read_spec_file( $group_head );
 400     foreach my $spec (@_) { update_spec_file($spec); }
 401 }
 402
 403 foreach my $group (@dll_groups)
 404 {
 405     sync_spec_files( @{$group} );
 406 }