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