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