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 (
  26     "int"           => "%d",
  27     "short int"     => "%d",
  28     "char"          => "%c",
  29     "unsigned char" => "%02x",
  30     "unsigned short"=> "%04x",
  31     "unsigned int"  => "%08x",
  32     "unsigned long" => "%lx",
  33     "void*"         => "%p",
  34     "time_t"        => "%ld (long)",
  35     "size_t"        => "%lu (unsigned long)",
  36     "data_size_t"   => "%u",
  37     "obj_handle_t"  => "%p",
  38     "atom_t"        => "%04x",
  39     "user_handle_t" => "%p",
  40     "process_id_t"  => "%04x",
  41     "thread_id_t"   => "%04x",
  42     "abs_time_t"    => "&dump_abs_time",
  43     "rectangle_t"   => "&dump_rectangle",
  44     "char_info_t"   => "&dump_char_info",
  45     "apc_call_t"    => "&dump_apc_call",
  46     "apc_result_t"  => "&dump_apc_result",
  47 );
  48
  49 my @requests = ();
  50 my %replies = ();
  51
  52 my @trace_lines = ();
  53
  54
  55
  56 ### Generate a dumping function
  57
  58 sub DO_DUMP_FUNC($$@)
  59 {
  60     my $name = shift;
  61     my $req = shift;
  62     push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
  63     while ($#_ >= 0)
  64     {
  65         my $type = shift;
  66         my $var = shift;
  67         if (defined($formats{$type}))
  68         {
  69             if ($formats{$type} =~ /^&(.*)/)
  70             {
  71                 my $func = $1;
  72                 push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
  73                 push @trace_lines, "    $func( &req->$var );\n";
  74                 push @trace_lines, "    fprintf( stderr, \",\" );\n" if ($#_ > 0);
  75             }
  76             elsif ($formats{$type} =~ /^(%.*)\s+\((.*)\)/)
  77             {
  78                 my ($format, $cast) = ($1, $2);
  79                 push @trace_lines, "    fprintf( stderr, \" $var=$format";
  80                 push @trace_lines, "," if ($#_ > 0);
  81                 push @trace_lines, "\", ($cast)req->$var );\n";
  82             }
  83             else
  84             {
  85                 push @trace_lines, "    fprintf( stderr, \" $var=$formats{$type}";
  86                 push @trace_lines, "," if ($#_ > 0);
  87                 push @trace_lines, "\", req->$var );\n";
  88             }
  89         }
  90         else  # must be some varargs format
  91         {
  92             my $func = $type;
  93             push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
  94             push @trace_lines, "    $func;\n";
  95             push @trace_lines, "    fputc( ',', stderr );\n" if ($#_ > 0);
  96         }
  97     }
  98     push @trace_lines, "}\n\n";
  99 }
 100
 101 ### Parse the request definitions
 102
 103 sub PARSE_REQUESTS()
 104 {
 105     # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
 106     my $state = 0;
 107     my $name = "";
 108     my @in_struct = ();
 109     my @out_struct = ();
 110
 111     open(PROTOCOL,"server/protocol.def") or die "Can't open server/protocol.def";
 112
 113     while (<PROTOCOL>)
 114     {
 115         my ($type, $var);
 116         # strip comments
 117         s!/\*.*\*/!!g;
 118         # strip white space at end of line
 119         s/\s+$//;
 120
 121         if (/^\@HEADER/)
 122         {
 123             die "Misplaced \@HEADER" unless $state == 0;
 124             $state++;
 125             next;
 126         }
 127
 128         # ignore everything while in state 0
 129         next if $state == 0;
 130
 131         if (/^\@REQ\(\s*(\w+)\s*\)/)
 132         {
 133             $name = $1;
 134             die "Misplaced \@REQ" unless $state == 1;
 135             # start a new request
 136             @in_struct = ();
 137             @out_struct = ();
 138             print SERVER_PROT "struct ${name}_request\n{\n";
 139             print SERVER_PROT "    struct request_header __header;\n";
 140             $state++;
 141             next;
 142         }
 143
 144         if (/^\@REPLY/)
 145         {
 146             die "Misplaced \@REPLY" unless $state == 2;
 147             print SERVER_PROT "};\n";
 148             print SERVER_PROT "struct ${name}_reply\n{\n";
 149             print SERVER_PROT "    struct reply_header __header;\n";
 150             $state++;
 151             next;
 152         }
 153
 154         if (/^\@END/)
 155         {
 156             die "Misplaced \@END" unless ($state == 2 || $state == 3);
 157             print SERVER_PROT "};\n";
 158
 159             if ($state == 2)  # build dummy reply struct
 160             {
 161                 print SERVER_PROT "struct ${name}_reply\n{\n";
 162                 print SERVER_PROT "    struct reply_header __header;\n";
 163                 print SERVER_PROT "};\n";
 164             }
 165
 166             # got a complete request
 167             push @requests, $name;
 168             DO_DUMP_FUNC( $name, "request", @in_struct);
 169             if ($#out_struct >= 0)
 170             {
 171                 $replies{$name} = 1;
 172                 DO_DUMP_FUNC( $name, "reply", @out_struct);
 173             }
 174             $state = 1;
 175             next;
 176         }
 177
 178         if ($state != 1)
 179         {
 180             # skip empty lines (but keep them in output file)
 181             if (/^$/)
 182             {
 183                 print SERVER_PROT "\n";
 184                 next;
 185             }
 186
 187             if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
 188             {
 189                 $var = $1;
 190                 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
 191                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 192             }
 193             elsif (/^\s*VARARG\((\w+),(\w+)\)/)
 194             {
 195                 $var = $1;
 196                 $type = "dump_varargs_" . $2 . "( cur_size )";
 197                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 198             }
 199             elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
 200             {
 201                 $type = $1;
 202                 $var = $3;
 203                 die "Unrecognized type $type" unless defined($formats{$type});
 204             }
 205             else
 206             {
 207                 die "Unrecognized syntax $_";
 208             }
 209             if ($state == 2) { push @in_struct, $type, $var; }
 210             if ($state == 3) { push @out_struct, $type, $var; }
 211         }
 212
 213         # Pass it through into the output file
 214         print SERVER_PROT $_ . "\n";
 215     }
 216     close PROTOCOL;
 217 }
 218
 219 ### Retrieve the server protocol version from the existing server_protocol.h file
 220
 221 sub GET_PROTOCOL_VERSION()
 222 {
 223     my $protocol = 0;
 224     open SERVER_PROT, "include/wine/server_protocol.h" or return 0;
 225     while (<SERVER_PROT>)
 226     {
 227         if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
 228     }
 229     close SERVER_PROT;
 230     return $protocol;
 231 }
 232
 233 ### Retrieve the list of status and errors used in the server
 234
 235 sub GET_ERROR_NAMES()
 236 {
 237     my %errors = ();
 238     foreach my $f (glob "server/*.c")
 239     {
 240         open FILE, $f or die "Can't open $f";
 241         while (<FILE>)
 242         {
 243             if (/set_error\s*\(\s*STATUS_(\w+)\s*\)/)
 244             {
 245                 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
 246             }
 247             elsif (/async_terminate_\w+\s*\(.*,\s*STATUS_(\w+)\s*\)/)
 248             {
 249                 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
 250             }
 251             elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
 252             {
 253                 $errors{$1} = "0xc0010000 | $1";
 254             }
 255         }
 256         close FILE;
 257     }
 258     return %errors;
 259 }
 260
 261 ### Replace the contents of a file between ### make_requests ### marks
 262
 263 sub REPLACE_IN_FILE($@)
 264 {
 265     my $name = shift;
 266     my @data = @_;
 267     my @lines = ();
 268     open(FILE,$name) or die "Can't open $name";
 269     while (<FILE>)
 270     {
 271         push @lines, $_;
 272         last if /\#\#\# make_requests begin \#\#\#/;
 273     }
 274     push @lines, "\n", @data;
 275     while (<FILE>)
 276     {
 277         if (/\#\#\# make_requests end \#\#\#/) { push @lines, "\n", $_; last; }
 278     }
 279     push @lines, <FILE>;
 280     open(FILE,">$name") or die "Can't modify $name";
 281     print FILE @lines;
 282     close(FILE);
 283 }
 284
 285 ### Main
 286
 287 # Get the server protocol version
 288 my $protocol = GET_PROTOCOL_VERSION();
 289
 290 my %errors = GET_ERROR_NAMES();
 291
 292 ### Create server_protocol.h and print header
 293
 294 open SERVER_PROT, ">include/wine/server_protocol.h" or die "Cannot create include/wine/server_protocol.h";
 295 print SERVER_PROT "/*\n * Wine server protocol definitions\n *\n";
 296 print SERVER_PROT " * This file is automatically generated; DO NO EDIT!\n";
 297 print SERVER_PROT " * Edit server/protocol.def instead and re-run tools/make_requests\n";
 298 print SERVER_PROT " */\n\n";
 299 print SERVER_PROT "#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
 300 print SERVER_PROT "#define __WINE_WINE_SERVER_PROTOCOL_H\n";
 301
 302 ### Parse requests to find request/reply structure definitions
 303
 304 PARSE_REQUESTS();
 305
 306 ### Build the request list and structures
 307
 308 print SERVER_PROT "\n\nenum request\n{\n";
 309 foreach my $req (@requests) { print SERVER_PROT "    REQ_$req,\n"; }
 310 print SERVER_PROT "    REQ_NB_REQUESTS\n};\n\n";
 311
 312 print SERVER_PROT "union generic_request\n{\n";
 313 print SERVER_PROT "    struct request_max_size max_size;\n";
 314 print SERVER_PROT "    struct request_header request_header;\n";
 315 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_request ${req}_request;\n"; }
 316 print SERVER_PROT "};\n";
 317
 318 print SERVER_PROT "union generic_reply\n{\n";
 319 print SERVER_PROT "    struct request_max_size max_size;\n";
 320 print SERVER_PROT "    struct reply_header reply_header;\n";
 321 foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_reply ${req}_reply;\n"; }
 322 print SERVER_PROT "};\n\n";
 323
 324 printf SERVER_PROT "#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
 325 print SERVER_PROT "#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
 326 close SERVER_PROT;
 327
 328 ### Output the dumping function tables
 329
 330 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
 331 foreach my $req (@requests)
 332 {
 333     push @trace_lines, "    (dump_func)dump_${req}_request,\n";
 334 }
 335 push @trace_lines, "};\n\n";
 336
 337 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
 338 foreach my $req (@requests)
 339 {
 340     push @trace_lines, "    (dump_func)", $replies{$req} ? "dump_${req}_reply,\n" : "0,\n";
 341 }
 342 push @trace_lines, "};\n\n";
 343
 344 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
 345 foreach my $req (@requests)
 346 {
 347     push @trace_lines, "    \"$req\",\n";
 348 }
 349 push @trace_lines, "};\n\n";
 350
 351 push @trace_lines, "static const struct\n{\n";
 352 push @trace_lines, "    const char  *name;\n";
 353 push @trace_lines, "    unsigned int value;\n";
 354 push @trace_lines, "} status_names[] =\n{\n";
 355
 356 foreach my $err (sort keys %errors)
 357 {
 358     push @trace_lines, sprintf("    { %-30s %s },\n", "\"$err\",", $errors{$err});
 359 }
 360 push @trace_lines, "    { NULL, 0 }\n";
 361 push @trace_lines, "};\n";
 362
 363 REPLACE_IN_FILE( "server/trace.c", @trace_lines );
 364
 365 ### Output the request handlers list
 366
 367 my @request_lines = ();
 368
 369 foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
 370 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
 371 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
 372 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
 373 foreach my $req (@requests)
 374 {
 375     push @request_lines, "    (req_handler)req_$req,\n";
 376 }
 377 push @request_lines, "};\n#endif  /* WANT_REQUEST_HANDLERS */\n";
 378
 379 REPLACE_IN_FILE( "server/request.h", @request_lines );