git.oblomov.eu Git - wine/blob - tools/make_requests

   1 #! /usr/bin/perl -w
   2 #
   3 # Build the server/trace.c and server/request.h files
   4 # from the contents of include/wine/server.h.
   5 #
   6 # Copyright (C) 1998 Alexandre Julliard
   7 #
   8 # This library is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU Lesser General Public
  10 # License as published by the Free Software Foundation; either
  11 # version 2.1 of the License, or (at your option) any later version.
  12 #
  13 # This library is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # Lesser General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Lesser General Public
  19 # License along with this library; if not, write to the Free Software
  20 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21 #
  22 use strict;
  23
  24 my %formats =
  25 (                     # size align format
  26     "int"           => [  4,   4,  "%d" ],
  27     "short int"     => [  2,   2,  "%d" ],
  28     "char"          => [  1,   1,  "%c" ],
  29     "unsigned char" => [  1,   1,  "%02x" ],
  30     "unsigned short"=> [  2,   2,  "%04x" ],
  31     "unsigned int"  => [  4,   4,  "%08x" ],
  32     "void*"         => [  4,   4,  "%p" ],
  33     "data_size_t"   => [  4,   4,  "%u" ],
  34     "obj_handle_t"  => [  4,   4,  "%04x" ],
  35     "atom_t"        => [  2,   2,  "%04x" ],
  36     "user_handle_t" => [  4,   4,  "%08x" ],
  37     "process_id_t"  => [  4,   4,  "%04x" ],
  38     "thread_id_t"   => [  4,   4,  "%04x" ],
  39     "mod_handle_t"  => [  4,   4,  "%p" ],
  40     "lparam_t"      => [  8,   8,  "&dump_uint64" ],
  41     "apc_param_t"   => [  8,   8,  "&dump_uint64" ],
  42     "file_pos_t"    => [  8,   8,  "&dump_uint64" ],
  43     "mem_size_t"    => [  8,   8,  "&dump_uint64" ],
  44     "timeout_t"     => [  8,   8,  "&dump_timeout" ],
  45     "rectangle_t"   => [  16,  4,  "&dump_rectangle" ],
  46     "char_info_t"   => [  4,   2,  "&dump_char_info" ],
  47     "apc_call_t"    => [  40,  8,  "&dump_apc_call" ],
  48     "apc_result_t"  => [  40,  8,  "&dump_apc_result" ],
  49     "async_data_t"  => [  32,  8,  "&dump_async_data" ],
  50     "luid_t"        => [  8,   4,  "&dump_luid" ],
  51     "ioctl_code_t"  => [  4,   4,  "&dump_ioctl_code" ],
  52 );
  53
  54 my @requests = ();
  55 my %replies = ();
  56
  57 my @trace_lines = ();
  58
  59 my $max_req_size = 64;
  60
  61 my $warnings = scalar(@ARGV) && $ARGV[0] eq "-w";
  62
  63 ### Generate a dumping function
  64
  65 sub DO_DUMP_FUNC($$@)
  66 {
  67     my $name = shift;
  68     my $req = shift;
  69     push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
  70     while ($#_ >= 0)
  71     {
  72         my $type = shift;
  73         my $var = shift;
  74         if (defined($formats{$type}))
  75         {
  76             my $fmt = ${$formats{$type}}[2];
  77             if ($fmt =~ /^&(.*)/)
  78             {
  79                 my $func = $1;
  80                 push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
  81                 push @trace_lines, "    $func( &req->$var );\n";
  82                 push @trace_lines, "    fprintf( stderr, \",\" );\n" if ($#_ > 0);
  83             }
  84             elsif ($fmt =~ /^(%.*)\s+\((.*)\)/)
  85             {
  86                 my ($format, $cast) = ($1, $2);
  87                 push @trace_lines, "    fprintf( stderr, \" $var=$format";
  88                 push @trace_lines, "," if ($#_ > 0);
  89                 push @trace_lines, "\", ($cast)req->$var );\n";
  90             }
  91             else
  92             {
  93                 push @trace_lines, "    fprintf( stderr, \" $var=$fmt";
  94                 push @trace_lines, "," if ($#_ > 0);
  95                 push @trace_lines, "\", req->$var );\n";
  96             }
  97         }
  98         else  # must be some varargs format
  99         {
 100             my $func = $type;
 101             push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
 102             push @trace_lines, "    $func;\n";
 103             push @trace_lines, "    fputc( ',', stderr );\n" if ($#_ > 0);
 104         }
 105     }
 106     push @trace_lines, "}\n\n";
 107 }
 108
 109 ### Parse the request definitions
 110
 111 sub PARSE_REQUESTS()
 112 {
 113     # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
 114     my $state = 0;
 115     my $offset = 0;
 116     my $name = "";
 117     my @in_struct = ();
 118     my @out_struct = ();
 119
 120     open(PROTOCOL,"server/protocol.def") or die "Can't open server/protocol.def";
 121
 122     while (<PROTOCOL>)
 123     {
 124         my ($type, $var);
 125         # strip comments
 126         s!/\*.*\*/!!g;
 127         # strip white space at end of line
 128         s/\s+$//;
 129
 130         if (/^\@HEADER/)
 131         {
 132             die "Misplaced \@HEADER" unless $state == 0;
 133             $state++;
 134             next;
 135         }
 136
 137         # ignore everything while in state 0
 138         next if $state == 0;
 139
 140         if (/^\@REQ\(\s*(\w+)\s*\)/)
 141         {
 142             $name = $1;
 143             die "Misplaced \@REQ" unless $state == 1;
 144             # start a new request
 145             @in_struct = ();
 146             @out_struct = ();
 147             $offset = 12;
 148             print SERVER_PROT "struct ${name}_request\n{\n";
 149             print SERVER_PROT "    struct request_header __header;\n";
 150             $state++;
 151             next;
 152         }
 153
 154         if (/^\@REPLY/)
 155         {
 156             die "Misplaced \@REPLY" unless $state == 2;
 157             print SERVER_PROT "};\n";
 158             print SERVER_PROT "struct ${name}_reply\n{\n";
 159             print SERVER_PROT "    struct reply_header __header;\n";
 160             die "request $name too large ($offset)" if ($offset > $max_req_size);
 161             $offset = 8;
 162             $state++;
 163             next;
 164         }
 165
 166         if (/^\@END/)
 167         {
 168             die "Misplaced \@END" unless ($state == 2 || $state == 3);
 169             print SERVER_PROT "};\n";
 170
 171             if ($state == 2)  # build dummy reply struct
 172             {
 173                 die "request $name too large ($offset)" if ($offset > $max_req_size);
 174                 print SERVER_PROT "struct ${name}_reply\n{\n";
 175                 print SERVER_PROT "    struct reply_header __header;\n";
 176                 print SERVER_PROT "};\n";
 177             }
 178             else
 179             {
 180                 die "reply $name too large ($offset)" if ($offset > $max_req_size);
 181             }
 182             # got a complete request
 183             push @requests, $name;
 184             DO_DUMP_FUNC( $name, "request", @in_struct);
 185             if ($#out_struct >= 0)
 186             {
 187                 $replies{$name} = 1;
 188                 DO_DUMP_FUNC( $name, "reply", @out_struct);
 189             }
 190             $state = 1;
 191             next;
 192         }
 193
 194         if ($state != 1)
 195         {
 196             # skip empty lines (but keep them in output file)
 197             if (/^$/)
 198             {
 199                 print SERVER_PROT "\n";
 200                 next;
 201             }
 202
 203             if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
 204             {
 205                 $var = $1;
 206                 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
 207                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 208             }
 209             elsif (/^\s*VARARG\((\w+),(\w+)\)/)
 210             {
 211                 $var = $1;
 212                 $type = "dump_varargs_" . $2 . "( cur_size )";
 213                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 214             }
 215             elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
 216             {
 217                 $type = $1;
 218                 $var = $3;
 219                 die "Unrecognized type $type" unless defined($formats{$type});
 220                 my @fmt = @{$formats{$type}};
 221                 if ($offset & ($fmt[1] - 1))
 222                 {
 223                     print "protocol.def:$.: warning: $name $offset $type $var needs padding\n" if $warnings;
 224                 }
 225                 $offset = ($offset + $fmt[1] - 1) & ~($fmt[1] - 1);
 226                 $offset += $fmt[0];
 227             }
 228             else
 229             {
 230                 die "Unrecognized syntax $_";
 231             }
 232             if ($state == 2) { push @in_struct, $type, $var; }
 233             if ($state == 3) { push @out_struct, $type, $var; }
 234         }
 235
 236         # Pass it through into the output file
 237         print SERVER_PROT $_ . "\n";
 238     }
 239     close PROTOCOL;
 240 }
 241
 242 ### Retrieve the server protocol version from the existing server_protocol.h file
 243
 244 sub GET_PROTOCOL_VERSION()
 245 {
 246     my $protocol = 0;
 247     open SERVER_PROT, "include/wine/server_protocol.h" or return 0;
 248     while (<SERVER_PROT>)
 249     {
 250         if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
 251     }
 252     close SERVER_PROT;
 253     return $protocol;
 254 }
 255
 256 ### Retrieve the list of status and errors used in the server
 257
 258 sub GET_ERROR_NAMES()
 259 {
 260     my %errors = ();
 261     foreach my $f (glob "server/*.c")
 262     {
 263         next if $f eq "server/trace.c";
 264         open FILE, $f or die "Can't open $f";
 265         while (<FILE>)
 266         {
 267             if (/STATUS_(\w+)/)
 268             {
 269                 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
 270             }
 271             elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
 272             {
 273                 $errors{$1} = "0xc0010000 | $1";
 274             }
 275         }
 276         close FILE;
 277     }
 278     return %errors;
 279 }
 280
 281 # update a file if changed
 282 sub update_file($)
 283 {
 284     my $file = shift;
 285     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
 286     if (!$ret)
 287     {
 288         unlink "$file.new";
 289     }
 290     else
 291     {
 292         rename "$file.new", "$file";
 293         print "$file updated\n";
 294     }
 295     return $ret;
 296 }
 297
 298 # replace some lines in a file between two markers
 299 sub replace_in_file($$$@)
 300 {
 301     my $file = shift;
 302     my $start = shift;
 303     my $end = shift;
 304
 305     open NEW_FILE, ">$file.new" or die "cannot create $file.new";
 306
 307     if (defined($start))
 308     {
 309         open OLD_FILE, "$file" or die "cannot open $file";
 310         while (<OLD_FILE>)
 311         {
 312             print NEW_FILE $_;
 313             last if /$start/;
 314         }
 315     }
 316
 317     print NEW_FILE "\n", @_, "\n";
 318
 319     if (defined($end))
 320     {
 321         my $skip=1;
 322         while (<OLD_FILE>)
 323         {
 324             $skip = 0 if /$end/;
 325             print NEW_FILE $_ unless $skip;
 326         }
 327     }
 328
 329     close OLD_FILE if defined($start);
 330     close NEW_FILE;
 331     return update_file($file);
 332 }
 333
 334 ### Main
 335
 336 # Get the server protocol version
 337 my $protocol = GET_PROTOCOL_VERSION();
 338
 339 my %errors = GET_ERROR_NAMES();
 340
 341 ### Create server_protocol.h and print header
 342
 343 open SERVER_PROT, ">include/wine/server_protocol.h.new" or die "Cannot create include/wine/server_protocol.h.new";
 344 print SERVER_PROT "/*\n * Wine server protocol definitions\n *\n";
 345 print SERVER_PROT " * This file is automatically generated; DO NO EDIT!\n";
 346 print SERVER_PROT " * Edit server/protocol.def instead and re-run tools/make_requests\n";
 347 print SERVER_PROT " */\n\n";
 348 print SERVER_PROT "#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
 349 print SERVER_PROT "#define __WINE_WINE_SERVER_PROTOCOL_H\n";
 350
 351 ### Parse requests to find request/reply structure definitions
 352
 353 PARSE_REQUESTS();
 354
 355 ### Build the request list and structures
 356
 357 print SERVER_PROT "\n\nenum request\n{\n";
 358 foreach my $req (@requests) { print SERVER_PROT "    REQ_$req,\n"; }
 359 print SERVER_PROT "    REQ_NB_REQUESTS\n};\n\n";
 360
 361 print SERVER_PROT "union generic_request\n{\n";
 362 print SERVER_PROT "    struct request_max_size max_size;\n";
 363 print SERVER_PROT "    struct request_header request_header;\n";
 364 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_request ${req}_request;\n"; }
 365 print SERVER_PROT "};\n";
 366
 367 print SERVER_PROT "union generic_reply\n{\n";
 368 print SERVER_PROT "    struct request_max_size max_size;\n";
 369 print SERVER_PROT "    struct reply_header reply_header;\n";
 370 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_reply ${req}_reply;\n"; }
 371 print SERVER_PROT "};\n\n";
 372
 373 printf SERVER_PROT "#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
 374 print SERVER_PROT "#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
 375 close SERVER_PROT;
 376 update_file( "include/wine/server_protocol.h" );
 377
 378 ### Output the dumping function tables
 379
 380 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
 381 foreach my $req (@requests)
 382 {
 383     push @trace_lines, "    (dump_func)dump_${req}_request,\n";
 384 }
 385 push @trace_lines, "};\n\n";
 386
 387 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
 388 foreach my $req (@requests)
 389 {
 390     push @trace_lines, "    ", $replies{$req} ? "(dump_func)dump_${req}_reply,\n" : "NULL,\n";
 391 }
 392 push @trace_lines, "};\n\n";
 393
 394 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
 395 foreach my $req (@requests)
 396 {
 397     push @trace_lines, "    \"$req\",\n";
 398 }
 399 push @trace_lines, "};\n\n";
 400
 401 push @trace_lines, "static const struct\n{\n";
 402 push @trace_lines, "    const char  *name;\n";
 403 push @trace_lines, "    unsigned int value;\n";
 404 push @trace_lines, "} status_names[] =\n{\n";
 405
 406 foreach my $err (sort keys %errors)
 407 {
 408     push @trace_lines, sprintf("    { %-30s %s },\n", "\"$err\",", $errors{$err});
 409 }
 410 push @trace_lines, "    { NULL, 0 }\n";
 411 push @trace_lines, "};\n";
 412
 413 replace_in_file( "server/trace.c",
 414                  "### make_requests begin ###",
 415                  "### make_requests end ###",
 416                  @trace_lines );
 417
 418 ### Output the request handlers list
 419
 420 my @request_lines = ();
 421
 422 foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
 423 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
 424 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
 425 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
 426 foreach my $req (@requests)
 427 {
 428     push @request_lines, "    (req_handler)req_$req,\n";
 429 }
 430 push @request_lines, "};\n#endif  /* WANT_REQUEST_HANDLERS */\n";
 431
 432 replace_in_file( "server/request.h",
 433                  "### make_requests begin ###",
 434                  "### make_requests end ###",
 435                  @request_lines );