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   "d3dx9_36",
  77   "d3dx9_43",
  78   "d3dx9_42",
  79   "d3dx9_41",
  80   "d3dx9_40",
  81   "d3dx9_39",
  82   "d3dx9_38",
  83   "d3dx9_37",
  84   "d3dx9_35",
  85   "d3dx9_34",
  86   "d3dx9_33",
  87   "d3dx9_32",
  88   "d3dx9_31",
  89   "d3dx9_30",
  90   "d3dx9_29",
  91   "d3dx9_28",
  92   "d3dx9_27",
  93   "d3dx9_26",
  94   "d3dx9_25",
  95   "d3dx9_24",
  96  ],
  97  [
  98   "d3dx10_43",
  99   "d3dx10_42",
 100   "d3dx10_41",
 101   "d3dx10_40",
 102   "d3dx10_39",
 103   "d3dx10_38",
 104   "d3dx10_37",
 105   "d3dx10_36",
 106   "d3dx10_35",
 107   "d3dx10_34",
 108   "d3dx10_33",
 109  ],
 110  [
 111   "d3dx11_43",
 112   "d3dx11_42",
 113  ],
 114  [
 115   "d3dcompiler_43",
 116   "d3dcompiler_47",
 117   "d3dcompiler_46",
 118   "d3dcompiler_42",
 119   "d3dcompiler_41",
 120   "d3dcompiler_40",
 121   "d3dcompiler_39",
 122   "d3dcompiler_38",
 123   "d3dcompiler_37",
 124   "d3dcompiler_36",
 125   "d3dcompiler_35",
 126   "d3dcompiler_34",
 127   "d3dcompiler_33",
 128  ],
 129  [
 130   "xinput1_3",
 131   "xinput1_4",
 132   "xinput1_2",
 133   "xinput1_1",
 134   "xinput9_1_0",
 135  ],
 136  [
 137   "setupapi",
 138   "cfgmgr32",
 139  ],
 140  [
 141   "vcomp",
 142   "vcomp120",
 143   "vcomp110",
 144   "vcomp100",
 145   "vcomp90",
 146  ],
 147  [
 148   "advapi32",
 149   "api-ms-win-core-localregistry-l1-1-0",
 150   "api-ms-win-downlevel-advapi32-l1-1-0",
 151   "api-ms-win-downlevel-advapi32-l2-1-0",
 152   "api-ms-win-security-base-l1-1-0",
 153   "api-ms-win-core-registry-l1-1-0",
 154   "api-ms-win-eventing-classicprovider-l1-1-0",
 155   "api-ms-win-eventing-provider-l1-1-0",
 156   "api-ms-win-security-base-l1-2-0",
 157   "api-ms-win-security-lsalookup-l1-1-0",
 158   "api-ms-win-security-sddl-l1-1-0",
 159   "api-ms-win-service-core-l1-1-1",
 160   "api-ms-win-service-management-l1-1-0",
 161   "api-ms-win-service-winsvc-l1-2-0",
 162  ],
 163  [
 164   "kernel32",
 165   "api-ms-win-downlevel-normaliz-l1-1-0",
 166   "api-ms-win-core-processthreads-l1-1-0",
 167   "api-ms-win-core-debug-l1-1-0",
 168   "api-ms-win-core-debug-l1-1-1",
 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-string-l1-1-0",
 177   "api-ms-win-core-sysinfo-l1-1-0",
 178   "api-ms-win-core-sysinfo-l1-2-0",
 179   "api-ms-win-core-util-l1-1-0",
 180   "api-ms-win-core-synch-l1-1-0",
 181   "api-ms-win-core-synch-l1-2-0",
 182   "api-ms-win-core-console-l1-1-0",
 183   "api-ms-win-core-file-l1-1-0",
 184   "api-ms-win-core-file-l1-2-1",
 185   "api-ms-win-core-file-l1-2-0",
 186   "api-ms-win-core-file-l2-1-0",
 187   "api-ms-win-core-file-l2-1-1",
 188   "api-ms-win-core-handle-l1-1-0",
 189   "api-ms-win-core-heap-l1-1-0",
 190   "api-ms-win-core-heap-l1-2-0",
 191   "api-ms-win-core-heap-obsolete-l1-1-0",
 192   "api-ms-win-core-io-l1-1-1",
 193   "api-ms-win-core-kernel32-legacy-l1-1-0",
 194   "api-ms-win-core-kernel32-legacy-l1-1-1",
 195   "api-ms-win-core-localization-l1-1-0",
 196   "api-ms-win-core-localization-l1-2-0",
 197   "api-ms-win-core-localization-obsolete-l1-1-0",
 198   "api-ms-win-core-memory-l1-1-0",
 199   "api-ms-win-core-memory-l1-1-1",
 200   "api-ms-win-core-memory-l1-1-2",
 201   "api-ms-win-core-processenvironment-l1-1-0",
 202   "api-ms-win-core-processenvironment-l1-2-0",
 203   "api-ms-win-core-psapi-l1-1-0",
 204   "api-ms-win-core-threadpool-l1-2-0",
 205   "api-ms-win-core-threadpool-legacy-l1-1-0",
 206   "api-ms-win-core-timezone-l1-1-0",
 207   "api-ms-win-core-sysinfo-l1-2-1",
 208   "api-ms-win-core-processthreads-l1-1-2",
 209   "api-ms-win-core-fibers-l1-1-0",
 210   "api-ms-win-core-fibers-l1-1-1",
 211   "api-ms-win-core-localization-l1-2-1",
 212   "api-ms-win-core-datetime-l1-1-0",
 213   "api-ms-win-core-datetime-l1-1-1",
 214   "api-ms-win-core-wow64-l1-1-0",
 215   "api-ms-win-core-xstate-l2-1-0",
 216   "api-ms-win-core-errorhandling-l1-1-2",
 217   "kernelbase",
 218  ],
 219  [
 220   "kernel32",
 221   "user32",
 222   "api-ms-win-core-libraryloader-l1-1-0",
 223   "api-ms-win-core-libraryloader-l1-1-1",
 224   "api-ms-win-core-libraryloader-l1-2-0",
 225  ],
 226  [
 227   "kernel32",
 228   "advapi32",
 229   "api-ms-win-core-namedpipe-l1-1-0",
 230   "api-ms-win-core-namedpipe-l1-2-0",
 231   "api-ms-win-core-processthreads-l1-1-1",
 232  ],
 233  [
 234   "ole32",
 235   "api-ms-win-downlevel-ole32-l1-1-0",
 236   "api-ms-win-core-com-l1-1-0",
 237   "api-ms-win-core-com-l1-1-1",
 238   "combase",
 239  ],
 240  [
 241   "shell32",
 242   "api-ms-win-downlevel-shell32-l1-1-0",
 243  ],
 244  [
 245   "shlwapi",
 246   "api-ms-win-downlevel-shlwapi-l1-1-0",
 247   "api-ms-win-downlevel-shlwapi-l2-1-0",
 248   "api-ms-win-core-shlwapi-legacy-l1-1-0",
 249   "api-ms-win-core-url-l1-1-0",
 250  ],
 251  [
 252   "user32",
 253   "api-ms-win-core-string-l2-1-0",
 254   "api-ms-win-downlevel-user32-l1-1-0",
 255   "api-ms-win-ntuser-dc-access-l1-1-0",
 256  ],
 257  [
 258   "version",
 259   "api-ms-win-core-version-l1-1-0",
 260   "api-ms-win-downlevel-version-l1-1-0",
 261  ],
 262  [
 263   "msvcrt",
 264   "ntdll",
 265   "ntoskrnl.exe",
 266   "api-ms-win-core-rtlsupport-l1-1-0",
 267   "api-ms-win-core-rtlsupport-l1-2-0",
 268  ],
 269  [
 270   "gdi32",
 271   "ext-ms-win-gdi-devcaps-l1-1-0",
 272  ],
 273  [
 274   "combase",
 275   "api-ms-win-core-winrt-l1-1-0",
 276   "api-ms-win-core-winrt-registration-l1-1-0",
 277   "api-ms-win-core-winrt-string-l1-1-0",
 278  ],
 279  [
 280   "bthprops.cpl",
 281   "irprops.cpl",
 282  ],
 283 );
 284
 285 my $update_flags = 0;
 286 my $show_duplicates = 0;
 287
 288 foreach my $arg (@ARGV)
 289 {
 290     if ($arg eq "-f") { $update_flags = 1; }
 291     elsif ($arg eq "-d") { $show_duplicates = 1; }
 292 }
 293
 294 sub update_file($)
 295 {
 296     my $file = shift;
 297     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
 298     if (!$ret)
 299     {
 300         unlink "$file.new";
 301     }
 302     else
 303     {
 304         #system "diff -u $file $file.new";
 305         rename "$file.new", "$file";
 306         print "$file updated\n";
 307     }
 308     return $ret;
 309 }
 310
 311 # parse a spec file line
 312 sub parse_line($$$)
 313 {
 314     my ($name, $line, $str) = @_;
 315
 316     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*\#.*)?/)
 317     {
 318         return ( "ordinal" => $1, "callconv" => $2, "flags" => $3, "name" => $4, "args" => $5 || "",
 319                  "target" => $6 || $4, "comment" => $7, "spec" => $name );
 320     }
 321     return () if $str =~ /^\s*$/;
 322     return () if $str =~ /^\s*\#/;
 323     printf STDERR "$name.spec:$line: error: Unrecognized line $_\n";
 324 }
 325
 326 sub read_spec_file($)
 327 {
 328     my $name = shift;
 329     my $file = "dlls/$name/$name.spec";
 330     my %stubs;
 331     open SPEC, "<$file" or die "cannot open $file";
 332     while (<SPEC>)
 333     {
 334         chomp;
 335         my %descr = parse_line( $name, $., $_ );
 336         next unless %descr;
 337
 338         my $func = $descr{name};
 339         next if defined $funcs{$func};
 340         $funcs{$func} = \%descr;
 341     }
 342     close SPEC;
 343 }
 344
 345 sub update_spec_file($)
 346 {
 347     my $name = shift;
 348     my $file = "dlls/$name/$name.spec";
 349     my %stubs;
 350
 351     open SPEC, "<$file" or die "cannot open $file";
 352     open NEW, ">$file.new" or die "cannot create $file.new";
 353     while (<SPEC>)
 354     {
 355         chomp;
 356
 357         my $commented_out = 0;
 358         my %descr = parse_line( $name, $., $_ );
 359         if (!%descr)
 360         {
 361             # check for commented out exports
 362             if (/^\s*\#\s*((?:\@|\d+)\s+)?((?:extern|stub|stdcall|cdecl|varargs|thiscall)\s+.*)/)
 363             {
 364                 $commented_out = 1;
 365                 %descr = parse_line( $name, $., ($1 || "\@ ") . $2 );
 366             }
 367         }
 368         goto done unless %descr;
 369
 370         my $func = $descr{name};
 371         if (!defined $funcs{$func})
 372         {
 373             $funcs{$func} = \%descr unless $commented_out;
 374             goto done;
 375         }
 376
 377         my %parent = %{$funcs{$func}};
 378         goto done if $parent{spec} eq $descr{spec};  # the definition is in this spec file
 379         goto done if $descr{comment} && $descr{comment} =~ /don't forward/;
 380         if ($descr{callconv} ne "stub" && $descr{target} !~ /\./ && !$commented_out)
 381         {
 382             printf "%s:%u: note: %s already defined in %s\n", $file, $., $func, $parent{spec} if $show_duplicates;
 383             goto done;
 384         }
 385
 386         my $flags = $descr{flags};
 387         if ($parent{callconv} ne "stub" || $update_flags)
 388         {
 389             $flags = $parent{flags};
 390             $flags =~ s/-ordinal\s*// if $descr{ordinal} eq "@";
 391             $flags =~ s/-noname\s*// if $descr{ordinal} eq "@";
 392             if ($descr{flags} =~ /-private/)  # preserve -private flag
 393             {
 394                 $flags = "-private " . $flags unless $flags =~ /-private/;
 395             }
 396         }
 397
 398         if ($parent{callconv} ne "stub" || $parent{args})
 399         {
 400             my $callconv = $parent{callconv} ne "stub" ? $parent{callconv} :
 401                            $parent{spec} =~ /(msvc|ucrtbase)/ ? "cdecl" : "stdcall";  # hack
 402             $_ = sprintf "$descr{ordinal} %s %s%s", $callconv, $flags, $func;
 403
 404             if ($parent{target} =~ /$group_head\./)  # use the same forward as parent if possible
 405             {
 406                 $_ .= sprintf "%s %s", $parent{args}, $parent{target};
 407             }
 408             else
 409             {
 410                 $_ .= sprintf "%s %s.%s", $parent{args}, $parent{spec}, $func;
 411             }
 412         }
 413         else
 414         {
 415             $_ = sprintf "$descr{ordinal} stub %s%s", $flags, $func;
 416         }
 417         $_ .= $descr{comment} || "";
 418
 419       done:
 420         print NEW "$_\n";
 421     }
 422     close SPEC;
 423     close NEW;
 424     update_file( $file );
 425 }
 426
 427 sub sync_spec_files(@)
 428 {
 429     %funcs = ();
 430     $group_head = shift;
 431     read_spec_file( $group_head );
 432     foreach my $spec (@_) { update_spec_file($spec); }
 433 }
 434
 435 foreach my $group (@dll_groups)
 436 {
 437     sync_spec_files( @{$group} );
 438 }