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     "data_size_t"   => [  4,   4,  "%u" ],
  33     "obj_handle_t"  => [  4,   4,  "%04x" ],
  34     "atom_t"        => [  4,   4,  "%04x" ],
  35     "user_handle_t" => [  4,   4,  "%08x" ],
  36     "process_id_t"  => [  4,   4,  "%04x" ],
  37     "thread_id_t"   => [  4,   4,  "%04x" ],
  38     "client_ptr_t"  => [  8,   8,  "&dump_uint64" ],
  39     "mod_handle_t"  => [  8,   8,  "&dump_uint64" ],
  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"  => [  40,  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         next if $var =~ /^__pad/;
  75         if (defined($formats{$type}))
  76         {
  77             my $fmt = ${$formats{$type}}[2];
  78             if ($fmt =~ /^&(.*)/)
  79             {
  80                 my $func = $1;
  81                 push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
  82                 push @trace_lines, "    $func( &req->$var );\n";
  83                 push @trace_lines, "    fprintf( stderr, \",\" );\n" if ($#_ > 0);
  84             }
  85             elsif ($fmt =~ /^(%.*)\s+\((.*)\)/)
  86             {
  87                 my ($format, $cast) = ($1, $2);
  88                 push @trace_lines, "    fprintf( stderr, \" $var=$format";
  89                 push @trace_lines, "," if ($#_ > 0);
  90                 push @trace_lines, "\", ($cast)req->$var );\n";
  91             }
  92             else
  93             {
  94                 push @trace_lines, "    fprintf( stderr, \" $var=$fmt";
  95                 push @trace_lines, "," if ($#_ > 0);
  96                 push @trace_lines, "\", req->$var );\n";
  97             }
  98         }
  99         else  # must be some varargs format
 100         {
 101             my $func = $type;
 102             push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
 103             push @trace_lines, "    $func;\n";
 104             push @trace_lines, "    fputc( ',', stderr );\n" if ($#_ > 0);
 105         }
 106     }
 107     push @trace_lines, "}\n\n";
 108 }
 109
 110 ### Parse the request definitions
 111
 112 sub PARSE_REQUESTS()
 113 {
 114     # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
 115     my $state = 0;
 116     my $offset = 0;
 117     my $name = "";
 118     my @in_struct = ();
 119     my @out_struct = ();
 120
 121     open(PROTOCOL,"server/protocol.def") or die "Can't open server/protocol.def";
 122
 123     while (<PROTOCOL>)
 124     {
 125         my ($type, $var);
 126         # strip comments
 127         s!/\*.*\*/!!g;
 128         # strip white space at end of line
 129         s/\s+$//;
 130
 131         if (/^\@HEADER/)
 132         {
 133             die "Misplaced \@HEADER" unless $state == 0;
 134             $state++;
 135             next;
 136         }
 137
 138         # ignore everything while in state 0
 139         next if $state == 0;
 140
 141         if (/^\@REQ\(\s*(\w+)\s*\)/)
 142         {
 143             $name = $1;
 144             die "Misplaced \@REQ" unless $state == 1;
 145             # start a new request
 146             @in_struct = ();
 147             @out_struct = ();
 148             $offset = 12;
 149             print SERVER_PROT "struct ${name}_request\n{\n";
 150             print SERVER_PROT "    struct request_header __header;\n";
 151             $state++;
 152             next;
 153         }
 154
 155         if (/^\@REPLY/)
 156         {
 157             die "Misplaced \@REPLY" unless $state == 2;
 158             print SERVER_PROT "};\n";
 159             print SERVER_PROT "struct ${name}_reply\n{\n";
 160             print SERVER_PROT "    struct reply_header __header;\n";
 161             die "request $name too large ($offset)" if ($offset > $max_req_size);
 162             $offset = 8;
 163             $state++;
 164             next;
 165         }
 166
 167         if (/^\@END/)
 168         {
 169             die "Misplaced \@END" unless ($state == 2 || $state == 3);
 170             print SERVER_PROT "};\n";
 171
 172             if ($state == 2)  # build dummy reply struct
 173             {
 174                 die "request $name too large ($offset)" if ($offset > $max_req_size);
 175                 print SERVER_PROT "struct ${name}_reply\n{\n";
 176                 print SERVER_PROT "    struct reply_header __header;\n";
 177                 print SERVER_PROT "};\n";
 178             }
 179             else
 180             {
 181                 die "reply $name too large ($offset)" if ($offset > $max_req_size);
 182             }
 183             # got a complete request
 184             push @requests, $name;
 185             DO_DUMP_FUNC( $name, "request", @in_struct);
 186             if ($#out_struct >= 0)
 187             {
 188                 $replies{$name} = 1;
 189                 DO_DUMP_FUNC( $name, "reply", @out_struct);
 190             }
 191             $state = 1;
 192             next;
 193         }
 194
 195         if ($state != 1)
 196         {
 197             # skip empty lines (but keep them in output file)
 198             if (/^$/)
 199             {
 200                 print SERVER_PROT "\n";
 201                 next;
 202             }
 203
 204             if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
 205             {
 206                 $var = $1;
 207                 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
 208                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 209             }
 210             elsif (/^\s*VARARG\((\w+),(\w+)\)/)
 211             {
 212                 $var = $1;
 213                 $type = "dump_varargs_" . $2 . "( cur_size )";
 214                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 215             }
 216             elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
 217             {
 218                 $type = $1;
 219                 $var = $3;
 220                 die "Unrecognized type $type" unless defined($formats{$type});
 221                 my @fmt = @{$formats{$type}};
 222                 if ($offset & ($fmt[1] - 1))
 223                 {
 224                     print "protocol.def:$.: warning: $name $offset $type $var needs padding\n" if $warnings;
 225                 }
 226                 $offset = ($offset + $fmt[1] - 1) & ~($fmt[1] - 1);
 227                 $offset += $fmt[0];
 228             }
 229             else
 230             {
 231                 die "Unrecognized syntax $_";
 232             }
 233             if ($state == 2) { push @in_struct, $type, $var; }
 234             if ($state == 3) { push @out_struct, $type, $var; }
 235         }
 236
 237         # Pass it through into the output file
 238         print SERVER_PROT $_ . "\n";
 239     }
 240     close PROTOCOL;
 241 }
 242
 243 ### Retrieve the server protocol version from the existing server_protocol.h file
 244
 245 sub GET_PROTOCOL_VERSION()
 246 {
 247     my $protocol = 0;
 248     open SERVER_PROT, "include/wine/server_protocol.h" or return 0;
 249     while (<SERVER_PROT>)
 250     {
 251         if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
 252     }
 253     close SERVER_PROT;
 254     return $protocol;
 255 }
 256
 257 ### Retrieve the list of status and errors used in the server
 258
 259 sub GET_ERROR_NAMES()
 260 {
 261     my %errors = ();
 262     foreach my $f (glob "server/*.c")
 263     {
 264         next if $f eq "server/trace.c";
 265         open FILE, $f or die "Can't open $f";
 266         while (<FILE>)
 267         {
 268             if (/STATUS_(\w+)/)
 269             {
 270                 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
 271             }
 272             elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
 273             {
 274                 $errors{$1} = "0xc0010000 | $1";
 275             }
 276         }
 277         close FILE;
 278     }
 279     return %errors;
 280 }
 281
 282 # update a file if changed
 283 sub update_file($)
 284 {
 285     my $file = shift;
 286     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
 287     if (!$ret)
 288     {
 289         unlink "$file.new";
 290     }
 291     else
 292     {
 293         rename "$file.new", "$file";
 294         print "$file updated\n";
 295     }
 296     return $ret;
 297 }
 298
 299 # replace some lines in a file between two markers
 300 sub replace_in_file($$$@)
 301 {
 302     my $file = shift;
 303     my $start = shift;
 304     my $end = shift;
 305
 306     open NEW_FILE, ">$file.new" or die "cannot create $file.new";
 307
 308     if (defined($start))
 309     {
 310         open OLD_FILE, "$file" or die "cannot open $file";
 311         while (<OLD_FILE>)
 312         {
 313             print NEW_FILE $_;
 314             last if /$start/;
 315         }
 316     }
 317
 318     print NEW_FILE "\n", @_, "\n";
 319
 320     if (defined($end))
 321     {
 322         my $skip=1;
 323         while (<OLD_FILE>)
 324         {
 325             $skip = 0 if /$end/;
 326             print NEW_FILE $_ unless $skip;
 327         }
 328     }
 329
 330     close OLD_FILE if defined($start);
 331     close NEW_FILE;
 332     return update_file($file);
 333 }
 334
 335 ### Main
 336
 337 # Get the server protocol version
 338 my $protocol = GET_PROTOCOL_VERSION();
 339
 340 my %errors = GET_ERROR_NAMES();
 341
 342 ### Create server_protocol.h and print header
 343
 344 open SERVER_PROT, ">include/wine/server_protocol.h.new" or die "Cannot create include/wine/server_protocol.h.new";
 345 print SERVER_PROT "/*\n * Wine server protocol definitions\n *\n";
 346 print SERVER_PROT " * This file is automatically generated; DO NO EDIT!\n";
 347 print SERVER_PROT " * Edit server/protocol.def instead and re-run tools/make_requests\n";
 348 print SERVER_PROT " */\n\n";
 349 print SERVER_PROT "#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
 350 print SERVER_PROT "#define __WINE_WINE_SERVER_PROTOCOL_H\n";
 351
 352 ### Parse requests to find request/reply structure definitions
 353
 354 PARSE_REQUESTS();
 355
 356 ### Build the request list and structures
 357
 358 print SERVER_PROT "\n\nenum request\n{\n";
 359 foreach my $req (@requests) { print SERVER_PROT "    REQ_$req,\n"; }
 360 print SERVER_PROT "    REQ_NB_REQUESTS\n};\n\n";
 361
 362 print SERVER_PROT "union generic_request\n{\n";
 363 print SERVER_PROT "    struct request_max_size max_size;\n";
 364 print SERVER_PROT "    struct request_header request_header;\n";
 365 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_request ${req}_request;\n"; }
 366 print SERVER_PROT "};\n";
 367
 368 print SERVER_PROT "union generic_reply\n{\n";
 369 print SERVER_PROT "    struct request_max_size max_size;\n";
 370 print SERVER_PROT "    struct reply_header reply_header;\n";
 371 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_reply ${req}_reply;\n"; }
 372 print SERVER_PROT "};\n\n";
 373
 374 printf SERVER_PROT "#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
 375 print SERVER_PROT "#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
 376 close SERVER_PROT;
 377 update_file( "include/wine/server_protocol.h" );
 378
 379 ### Output the dumping function tables
 380
 381 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
 382 foreach my $req (@requests)
 383 {
 384     push @trace_lines, "    (dump_func)dump_${req}_request,\n";
 385 }
 386 push @trace_lines, "};\n\n";
 387
 388 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
 389 foreach my $req (@requests)
 390 {
 391     push @trace_lines, "    ", $replies{$req} ? "(dump_func)dump_${req}_reply,\n" : "NULL,\n";
 392 }
 393 push @trace_lines, "};\n\n";
 394
 395 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
 396 foreach my $req (@requests)
 397 {
 398     push @trace_lines, "    \"$req\",\n";
 399 }
 400 push @trace_lines, "};\n\n";
 401
 402 push @trace_lines, "static const struct\n{\n";
 403 push @trace_lines, "    const char  *name;\n";
 404 push @trace_lines, "    unsigned int value;\n";
 405 push @trace_lines, "} status_names[] =\n{\n";
 406
 407 foreach my $err (sort keys %errors)
 408 {
 409     push @trace_lines, sprintf("    { %-30s %s },\n", "\"$err\",", $errors{$err});
 410 }
 411 push @trace_lines, "    { NULL, 0 }\n";
 412 push @trace_lines, "};\n";
 413
 414 replace_in_file( "server/trace.c",
 415                  "### make_requests begin ###",
 416                  "### make_requests end ###",
 417                  @trace_lines );
 418
 419 ### Output the request handlers list
 420
 421 my @request_lines = ();
 422
 423 foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
 424 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
 425 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
 426 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
 427 foreach my $req (@requests)
 428 {
 429     push @request_lines, "    (req_handler)req_$req,\n";
 430 }
 431 push @request_lines, "};\n#endif  /* WANT_REQUEST_HANDLERS */\n";
 432
 433 replace_in_file( "server/request.h",
 434                  "### make_requests begin ###",
 435                  "### make_requests end ###",
 436                  @request_lines );