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