3 # Build the server/trace.c and server/request.h files
4 # from the contents of include/wine/server.h.
6 # Copyright (C) 1998 Alexandre Julliard
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.
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.
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
29 "unsigned char" => "%02x",
30 "unsigned short"=> "%04x",
31 "unsigned int" => "%08x",
32 "unsigned long" => "%lx",
34 "time_t" => "%ld (long)",
35 "size_t" => "%lu (unsigned long)",
36 "data_size_t" => "%u",
37 "obj_handle_t" => "%p",
39 "user_handle_t" => "%p",
40 "process_id_t" => "%04x",
41 "thread_id_t" => "%04x",
42 "timeout_t" => "&dump_timeout",
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 "async_data_t" => "&dump_async_data",
48 "luid_t" => "&dump_luid",
49 "ioctl_code_t" => "&dump_ioctl_code",
50 "file_pos_t" => "&dump_file_pos",
60 ### Generate a dumping function
66 push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
71 if (defined($formats{$type}))
73 if ($formats{$type} =~ /^&(.*)/)
76 push @trace_lines, " fprintf( stderr, \" $var=\" );\n";
77 push @trace_lines, " $func( &req->$var );\n";
78 push @trace_lines, " fprintf( stderr, \",\" );\n" if ($#_ > 0);
80 elsif ($formats{$type} =~ /^(%.*)\s+\((.*)\)/)
82 my ($format, $cast) = ($1, $2);
83 push @trace_lines, " fprintf( stderr, \" $var=$format";
84 push @trace_lines, "," if ($#_ > 0);
85 push @trace_lines, "\", ($cast)req->$var );\n";
89 push @trace_lines, " fprintf( stderr, \" $var=$formats{$type}";
90 push @trace_lines, "," if ($#_ > 0);
91 push @trace_lines, "\", req->$var );\n";
94 else # must be some varargs format
97 push @trace_lines, " fprintf( stderr, \" $var=\" );\n";
98 push @trace_lines, " $func;\n";
99 push @trace_lines, " fputc( ',', stderr );\n" if ($#_ > 0);
102 push @trace_lines, "}\n\n";
105 ### Parse the request definitions
109 # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
115 open(PROTOCOL
,"server/protocol.def") or die "Can't open server/protocol.def";
122 # strip white space at end of line
127 die "Misplaced \@HEADER" unless $state == 0;
132 # ignore everything while in state 0
135 if (/^\@REQ\(\s*(\w+)\s*\)/)
138 die "Misplaced \@REQ" unless $state == 1;
139 # start a new request
142 print SERVER_PROT
"struct ${name}_request\n{\n";
143 print SERVER_PROT
" struct request_header __header;\n";
150 die "Misplaced \@REPLY" unless $state == 2;
151 print SERVER_PROT
"};\n";
152 print SERVER_PROT
"struct ${name}_reply\n{\n";
153 print SERVER_PROT
" struct reply_header __header;\n";
160 die "Misplaced \@END" unless ($state == 2 || $state == 3);
161 print SERVER_PROT
"};\n";
163 if ($state == 2) # build dummy reply struct
165 print SERVER_PROT
"struct ${name}_reply\n{\n";
166 print SERVER_PROT
" struct reply_header __header;\n";
167 print SERVER_PROT
"};\n";
170 # got a complete request
171 push @requests, $name;
172 DO_DUMP_FUNC
( $name, "request", @in_struct);
173 if ($#out_struct >= 0)
176 DO_DUMP_FUNC
( $name, "reply", @out_struct);
184 # skip empty lines (but keep them in output file)
187 print SERVER_PROT
"\n";
191 if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
194 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
195 s!(VARARG\(.*\)\s*;)!/* $1 */!;
197 elsif (/^\s*VARARG\((\w+),(\w+)\)/)
200 $type = "dump_varargs_" . $2 . "( cur_size )";
201 s!(VARARG\(.*\)\s*;)!/* $1 */!;
203 elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
207 die "Unrecognized type $type" unless defined($formats{$type});
211 die "Unrecognized syntax $_";
213 if ($state == 2) { push @in_struct, $type, $var; }
214 if ($state == 3) { push @out_struct, $type, $var; }
217 # Pass it through into the output file
218 print SERVER_PROT
$_ . "\n";
223 ### Retrieve the server protocol version from the existing server_protocol.h file
225 sub GET_PROTOCOL_VERSION
()
228 open SERVER_PROT
, "include/wine/server_protocol.h" or return 0;
229 while (<SERVER_PROT
>)
231 if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
237 ### Retrieve the list of status and errors used in the server
239 sub GET_ERROR_NAMES
()
242 foreach my $f (glob "server/*.c")
244 next if $f eq "server/trace.c";
245 open FILE
, $f or die "Can't open $f";
250 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
252 elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
254 $errors{$1} = "0xc0010000 | $1";
262 ### Replace the contents of a file between ### make_requests ### marks
264 sub REPLACE_IN_FILE
($@
)
269 open(FILE
,$name) or die "Can't open $name";
273 last if /\#\#\# make_requests begin \#\#\#/;
275 push @lines, "\n", @data;
278 if (/\#\#\# make_requests end \#\#\#/) { push @lines, "\n", $_; last; }
281 open(FILE
,">$name") or die "Can't modify $name";
288 # Get the server protocol version
289 my $protocol = GET_PROTOCOL_VERSION
();
291 my %errors = GET_ERROR_NAMES
();
293 ### Create server_protocol.h and print header
295 open SERVER_PROT
, ">include/wine/server_protocol.h" or die "Cannot create include/wine/server_protocol.h";
296 print SERVER_PROT
"/*\n * Wine server protocol definitions\n *\n";
297 print SERVER_PROT
" * This file is automatically generated; DO NO EDIT!\n";
298 print SERVER_PROT
" * Edit server/protocol.def instead and re-run tools/make_requests\n";
299 print SERVER_PROT
" */\n\n";
300 print SERVER_PROT
"#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
301 print SERVER_PROT
"#define __WINE_WINE_SERVER_PROTOCOL_H\n";
303 ### Parse requests to find request/reply structure definitions
307 ### Build the request list and structures
309 print SERVER_PROT
"\n\nenum request\n{\n";
310 foreach my $req (@requests) { print SERVER_PROT
" REQ_$req,\n"; }
311 print SERVER_PROT
" REQ_NB_REQUESTS\n};\n\n";
313 print SERVER_PROT
"union generic_request\n{\n";
314 print SERVER_PROT
" struct request_max_size max_size;\n";
315 print SERVER_PROT
" struct request_header request_header;\n";
316 foreach my $req (@requests) { print SERVER_PROT
" struct ${req}_request ${req}_request;\n"; }
317 print SERVER_PROT
"};\n";
319 print SERVER_PROT
"union generic_reply\n{\n";
320 print SERVER_PROT
" struct request_max_size max_size;\n";
321 print SERVER_PROT
" struct reply_header reply_header;\n";
322 foreach my $req (@requests) { print SERVER_PROT
" struct ${req}_reply ${req}_reply;\n"; }
323 print SERVER_PROT
"};\n\n";
325 printf SERVER_PROT
"#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
326 print SERVER_PROT
"#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
329 ### Output the dumping function tables
331 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
332 foreach my $req (@requests)
334 push @trace_lines, " (dump_func)dump_${req}_request,\n";
336 push @trace_lines, "};\n\n";
338 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
339 foreach my $req (@requests)
341 push @trace_lines, " (dump_func)", $replies{$req} ?
"dump_${req}_reply,\n" : "0,\n";
343 push @trace_lines, "};\n\n";
345 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
346 foreach my $req (@requests)
348 push @trace_lines, " \"$req\",\n";
350 push @trace_lines, "};\n\n";
352 push @trace_lines, "static const struct\n{\n";
353 push @trace_lines, " const char *name;\n";
354 push @trace_lines, " unsigned int value;\n";
355 push @trace_lines, "} status_names[] =\n{\n";
357 foreach my $err (sort keys %errors)
359 push @trace_lines, sprintf(" { %-30s %s },\n", "\"$err\",", $errors{$err});
361 push @trace_lines, " { NULL, 0 }\n";
362 push @trace_lines, "};\n";
364 REPLACE_IN_FILE
( "server/trace.c", @trace_lines );
366 ### Output the request handlers list
368 my @request_lines = ();
370 foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
371 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
372 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
373 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
374 foreach my $req (@requests)
376 push @request_lines, " (req_handler)req_$req,\n";
378 push @request_lines, "};\n#endif /* WANT_REQUEST_HANDLERS */\n";
380 REPLACE_IN_FILE
( "server/request.h", @request_lines );