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