tools/winapi_check/winapi_local.pm

   1 #
   2 # Copyright 1999, 2000, 2001 Patrik Stridvall
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17 #
  18
  19 package winapi_local;
  20
  21 use strict;
  22
  23 use nativeapi qw($nativeapi);
  24 use options qw($options);
  25 use output qw($output);
  26 use winapi qw($win16api $win32api @winapis);
  27
  28 sub check_function {
  29     my $function = shift;
  30
  31     my $return_type = $function->return_type;
  32     my $calling_convention = $function->calling_convention;
  33     my $calling_convention16 = $function->calling_convention16;
  34     my $calling_convention32 = $function->calling_convention32;
  35     my $internal_name = $function->internal_name;
  36     my $external_name16 = $function->external_name16;
  37     my $external_name32 = $function->external_name32;
  38     my $module16 = $function->module16;
  39     my $module32 = $function->module32;
  40     my $refargument_types = $function->argument_types;
  41
  42     if(!defined($refargument_types)) {
  43         return;
  44     }
  45
  46     if($options->win16 && $options->report_module($module16)) {
  47         _check_function($return_type,
  48                         $calling_convention, $external_name16,
  49                         $internal_name, $refargument_types,
  50                         $win16api);
  51     }
  52
  53     if($options->win32 && $options->report_module($module32)) {
  54         _check_function($return_type,
  55                         $calling_convention, $external_name32,
  56                         $internal_name, $refargument_types,
  57                         $win32api);
  58     }
  59 }
  60
  61 sub _check_function {
  62     my $return_type = shift;
  63     my $calling_convention = shift;
  64     my $external_name = shift;
  65     my $internal_name = shift;
  66     my $refargument_types = shift;
  67     my @argument_types = @$refargument_types;
  68     my $winapi = shift;
  69
  70     my $module = $winapi->function_internal_module($internal_name);
  71
  72     if($winapi->name eq "win16") {
  73         if($winapi->is_function_stub_in_module($module, $internal_name)) {
  74             if($options->implemented) {
  75                 $output->write("function implemented but declared as stub in .spec file\n");
  76             }
  77             return;
  78         } elsif($winapi->is_function_stub_in_module($module, $internal_name)) {
  79             if($options->implemented_win32) {
  80                 $output->write("32-bit variant of function implemented but declared as stub in .spec file\n");
  81             }
  82             return;
  83         }
  84     } elsif($winapi->is_function_stub_in_module($module, $internal_name)) {
  85         if($options->implemented) {
  86             $output->write("function implemented but declared as stub in .spec file\n");
  87         }
  88         return;
  89     }
  90
  91     my $forbidden_return_type = 0;
  92     my $implemented_return_kind;
  93     $winapi->type_used_in_module($return_type,$module);
  94     if(!defined($implemented_return_kind = $winapi->translate_argument($return_type))) {
  95         $winapi->declare_argument($return_type, "unknown");
  96         if($return_type ne "") {
  97             $output->write("no translation defined: " . $return_type . "\n");
  98         }
  99     } elsif(!$winapi->is_allowed_kind($implemented_return_kind) ||
 100             !$winapi->is_allowed_type_in_module($return_type, $module))
 101     {
 102         $forbidden_return_type = 1;
 103         $winapi->allow_kind($implemented_return_kind);
 104         $winapi->allow_type_in_module($return_type, $module);
 105         if($options->report_argument_forbidden($return_type)) {
 106             $output->write("return type is forbidden: $return_type ($implemented_return_kind)\n");
 107         }
 108     }
 109
 110     my $segmented = 0;
 111     if(defined($implemented_return_kind) && $implemented_return_kind =~ /^segptr|segstr$/) {
 112         $segmented = 1;
 113     }
 114
 115     my $implemented_calling_convention;
 116     if($winapi->name eq "win16") {
 117         if($calling_convention =~ /^__cdecl$/) {
 118             $implemented_calling_convention = "cdecl";
 119         } elsif($calling_convention =~ /^VFWAPIV|WINAPIV$/) {
 120             $implemented_calling_convention = "varargs";
 121         } elsif($calling_convention =~ /^__stdcall|VFWAPI|WINAPI|CALLBACK$/) {
 122             if($implemented_return_kind =~ /^s_word|word|void$/) {
 123                 $implemented_calling_convention = "pascal16";
 124             } else {
 125                 $implemented_calling_convention = "pascal";
 126             }
 127         } elsif($calling_convention =~ /^__asm$/) {
 128             $implemented_calling_convention = "asm";
 129         } else {
 130             $implemented_calling_convention = "cdecl";
 131         }
 132     } elsif($winapi->name eq "win32") {
 133         if($calling_convention =~ /^__cdecl$/) {
 134             $implemented_calling_convention = "cdecl";
 135         } elsif($calling_convention =~ /^VFWAPIV|WINAPIV$/) {
 136             $implemented_calling_convention = "varargs";
 137         } elsif($calling_convention =~ /^__stdcall|VFWAPI|WINAPI|CALLBACK$/) {
 138             if(defined($implemented_return_kind) && $implemented_return_kind =~ /^longlong$/) {
 139                 $implemented_calling_convention = "stdcall"; # FIXME: Check entry flags
 140             } else {
 141                 $implemented_calling_convention = "stdcall";
 142             }
 143         } elsif($calling_convention =~ /^__asm$/) {
 144             $implemented_calling_convention = "asm";
 145         } else {
 146             $implemented_calling_convention = "cdecl";
 147         }
 148     }
 149
 150     my $declared_calling_convention = $winapi->function_internal_calling_convention($internal_name);
 151     my @declared_argument_kinds = split(/\s+/, $winapi->function_internal_arguments($internal_name));
 152
 153     my $declared_register = 0;
 154     if ($declared_calling_convention =~ /^(\w+) -register$/) {
 155         $declared_register = 1;
 156         $declared_calling_convention = $1;
 157     }
 158
 159     if($implemented_calling_convention ne $declared_calling_convention &&
 160        $implemented_calling_convention ne "asm" &&
 161        !($declared_calling_convention =~ /^pascal/ && $forbidden_return_type) &&
 162        !($implemented_calling_convention =~ /^cdecl|varargs$/ && $declared_calling_convention =~ /^cdecl|varargs$/))
 163     {
 164         if($options->calling_convention && (
 165             ($options->calling_convention_win16 && $winapi->name eq "win16") ||
 166             ($options->calling_convention_win32 && $winapi->name eq "win32")) &&
 167             !$nativeapi->is_function($internal_name))
 168         {
 169             $output->write("calling convention mismatch: $implemented_calling_convention != $declared_calling_convention\n");
 170         }
 171     }
 172
 173     if($declared_calling_convention eq "varargs") {
 174         if($#argument_types != -1 && $argument_types[$#argument_types] eq "...") {
 175             pop @argument_types;
 176         } else {
 177             $output->write("function not implemented as vararg\n");
 178         }
 179     } elsif($#argument_types != -1 && $argument_types[$#argument_types] eq "...") {
 180         if($#argument_types == 0 || $winapi->name eq "win16") {
 181             pop @argument_types;
 182         } else {
 183             $output->write("function not declared as vararg\n");
 184         }
 185     }
 186
 187     if($#argument_types != -1 && $argument_types[$#argument_types] eq "CONTEXT *" &&
 188        $internal_name =~ /^(?:RtlRaiseException|RtlUnwind|NtRaiseException)$/) # FIXME: Kludge
 189     {
 190         $#argument_types--;
 191     }
 192
 193     if($internal_name =~ /^NTDLL__ftol|NTDLL__CIpow$/) { # FIXME: Kludge
 194         # ignore
 195     } else {
 196         my $n = 0;
 197         my @argument_kinds = map {
 198             my $type = $_;
 199             my $kind = "unknown";
 200             $winapi->type_used_in_module($type,$module);
 201             if($type eq "CONTEXT86 *") {
 202                 $kind = "context86";
 203             } elsif(!defined($kind = $winapi->translate_argument($type))) {
 204                 $winapi->declare_argument($type, "unknown");
 205                 $output->write("no translation defined: " . $type . "\n");
 206             } elsif(!$winapi->is_allowed_kind($kind) ||
 207                     !$winapi->is_allowed_type_in_module($type, $module))
 208             {
 209                 $winapi->allow_kind($kind);
 210                 $winapi->allow_type_in_module($type, $module);
 211                 if($options->report_argument_forbidden($type)) {
 212                     $output->write("argument " . ($n + 1) . " type is forbidden: " . $type . " (" . $kind . ")\n");
 213                 }
 214             }
 215
 216             # FIXME: Kludge
 217             if(defined($kind) && $kind eq "struct16") {
 218                 $n+=4;
 219                 ("long", "long", "long", "long");
 220             } elsif(defined($kind) && $kind eq "longlong") {
 221                 $n+=2;
 222                 ("long", "long");
 223             } else {
 224                 $n++;
 225                 $kind;
 226             }
 227         } @argument_types;
 228
 229         if ($declared_register && $argument_kinds[$#argument_kinds] ne "context86") {
 230             $output->write("function declared as register, but CONTEXT86 * is not last argument\n");
 231         }
 232
 233         for my $n (0..$#argument_kinds) {
 234             if(!defined($argument_kinds[$n]) || !defined($declared_argument_kinds[$n])) { next; }
 235
 236             if($argument_kinds[$n] =~ /^segptr|segstr$/ ||
 237                $declared_argument_kinds[$n] =~ /^segptr|segstr$/)
 238             {
 239                 $segmented = 1;
 240             }
 241
 242             # FIXME: Kludge
 243             if(!defined($argument_types[$n])) {
 244                 $argument_types[$n] = "";
 245             }
 246
 247             if($argument_kinds[$n] eq "context86") {
 248                 # Nothing
 249             } elsif(!$winapi->is_allowed_kind($argument_kinds[$n]) ||
 250                !$winapi->is_allowed_type_in_module($argument_types[$n], $module))
 251             {
 252                 $winapi->allow_kind($argument_kinds[$n]);
 253                 $winapi->allow_type_in_module($argument_types[$n],, $module);
 254                 if($options->report_argument_forbidden($argument_types[$n])) {
 255                     $output->write("argument " . ($n + 1) . " type is forbidden: " .
 256                                    "$argument_types[$n] ($argument_kinds[$n])\n");
 257                 }
 258             } elsif($argument_kinds[$n] ne $declared_argument_kinds[$n]) {
 259                 if($options->report_argument_kind($argument_kinds[$n]) ||
 260                    $options->report_argument_kind($declared_argument_kinds[$n]))
 261                 {
 262                     $output->write("argument " . ($n + 1) . " type mismatch: " .
 263                              $argument_types[$n] . " ($argument_kinds[$n]) != " .
 264                              $declared_argument_kinds[$n] . "\n");
 265                 }
 266             }
 267         }
 268
 269         if($#argument_kinds != $#declared_argument_kinds &&
 270            $implemented_calling_convention ne "asm")
 271         {
 272             if($options->argument_count) {
 273                 $output->write("argument count differs: " .
 274                     ($#argument_types + 1) . " != " .
 275                     ($#declared_argument_kinds + 1) . "\n");
 276             }
 277         }
 278
 279     }
 280
 281     if($segmented && $options->shared_segmented && $winapi->is_shared_internal_function($internal_name)) {
 282         $output->write("function using segmented pointers shared between Win16 och Win32\n");
 283     }
 284 }
 285
 286 sub check_statements {
 287     my $functions = shift;
 288     my $function = shift;
 289
 290     my $module16 = $function->module16;
 291     my $module32 = $function->module32;
 292
 293     if($options->win16 && $options->report_module($module16)) {
 294         _check_statements($win16api, $functions, $function);
 295     }
 296
 297     if($options->win32 && $options->report_module($module32)) {
 298         _check_statements($win16api, $functions, $function);
 299     }
 300 }
 301
 302 sub _check_statements {
 303     my $winapi = shift;
 304     my $functions = shift;
 305     my $function = shift;
 306
 307     my $module = $function->module;
 308     my $internal_name = $function->internal_name;
 309
 310     my $first_debug_message = 1;
 311     local $_ = $function->statements;
 312     while(defined($_)) {
 313         if(s/(\w+)\s*(?:\(\s*(\w+)\s*\))?\s*\(\s*((?:\"[^\"]*\"|\([^\)]*\)|[^\)])*?)\s*\)//) {
 314             my $called_name = $1;
 315             my $channel = $2;
 316             my $called_arguments = $3;
 317             if($called_name =~ /^if|for|while|switch|sizeof$/) {
 318                 # Nothing
 319             } elsif($called_name =~ /^ERR|FIXME|MSG|TRACE|WARN$/) {
 320                 if($first_debug_message && $called_name =~ /^FIXME|TRACE$/) {
 321                     $first_debug_message = 0;
 322                     if($called_arguments =~ /^\"\((.*?)\)(.*?)\"\s*,\s*(.*?)$/) {
 323                         my $formating = $1;
 324                         my $extra = $2;
 325                         my $arguments = $3;
 326
 327                         my $format;
 328                         my $argument;
 329                         my $n = 0;
 330                         while($formating && ($formating =~ s/^([^,]*),?//, $format = $1, $format =~ s/^\s*(.*?)\s*$/$1/) &&
 331                               $arguments && ($arguments =~ s/^([^,]*),?//, $argument = $1, $argument =~ s/^\s*(.*?)\s*$/$1/))
 332                         {
 333                             my $type = @{$function->argument_types}[$n];
 334                             my $name = @{$function->argument_names}[$n];
 335
 336                             $n++;
 337
 338                             if(!defined($type)) { last; }
 339
 340                             $format =~ s/^\w+\s*[:=]?\s*//;
 341                             $format =~ s/\s*\{[^\{\}]*\}$//;
 342                             $format =~ s/\s*\[[^\[\]]*\]$//;
 343                             $format =~ s/^\'(.*?)\'$/$1/;
 344                             $format =~ s/^\\\"(.*?)\\\"$/$1/;
 345
 346                             if($options->debug_messages) {
 347                                 if($argument !~ /$name/) {
 348                                     $output->write("$called_name: argument $n is wrong ($name != '$argument')\n");
 349                                 } elsif(!$winapi->is_allowed_type_format($module, $type, $format)) {
 350                                     $output->write("$called_name: argument $n ($type $name) has illegal format ($format)\n");
 351                                 }
 352                             }
 353                         }
 354
 355                         if($options->debug_messages) {
 356                             my $count = $#{$function->argument_types} + 1;
 357                             if($n != $count) {
 358                                 $output->write("$called_name: argument count mismatch ($n != $count)\n");
 359                             }
 360                         }
 361                     }
 362                 }
 363             } elsif($options->cross_call) {
 364                 # $output->write("$internal_name: called $called_name\n");
 365                 $$functions{$internal_name}->function_called($called_name);
 366                 if(!defined($$functions{$called_name})) {
 367                     my $called_function = 'winapi_function'->new;
 368
 369                     $called_function->internal_name($called_name);
 370
 371                     $$functions{$called_name} = $called_function;
 372                 }
 373                 $$functions{$called_name}->function_called_by($internal_name);
 374             }
 375         } else {
 376             undef $_;
 377         }
 378     }
 379 }
 380
 381 sub check_file {
 382     my $file = shift;
 383     my $functions = shift;
 384
 385     if($options->cross_call) {
 386         my @names = sort(keys(%$functions));
 387         for my $name (@names) {
 388             my $function = $$functions{$name};
 389
 390             my @called_names = $function->called_function_names;
 391             my @called_by_names = $function->called_by_function_names;
 392             my $module = $function->module;
 393
 394             if($options->cross_call_win32_win16) {
 395                 my $module16 = $function->module16;
 396                 my $module32 = $function->module32;
 397
 398                 if($#called_names >= 0 && (defined($module16) || defined($module32)) ) {
 399                     for my $called_name (@called_names) {
 400                         my $called_function = $$functions{$called_name};
 401
 402                         my $called_module16 = $called_function->module16;
 403                         my $called_module32 = $called_function->module32;
 404                         if(defined($module32) &&
 405                            defined($called_module16) && !defined($called_module32) &&
 406                            $name ne $called_name)
 407                         {
 408                             $output->write("$file: $module: $name: illegal call to $called_name (Win32 -> Win16)\n");
 409                         }
 410                     }
 411                 }
 412             }
 413
 414             if($options->cross_call_unicode_ascii) {
 415                 if($name =~ /(?<!A)W$/) {
 416                     for my $called_name (@called_names) {
 417                         if($called_name =~ /A$/) {
 418                             $output->write("$file: $module: $name: illegal call to $called_name (Unicode -> ASCII)\n");
 419                         }
 420                     }
 421                 }
 422             }
 423         }
 424     }
 425 }
 426
 427 1;