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 "data_size_t" => "%u",
35 "obj_handle_t" => "%04x",
37 "user_handle_t" => "%08x",
38 "process_id_t" => "%04x",
39 "thread_id_t" => "%04x",
41 "timeout_t" => "&dump_timeout",
42 "rectangle_t" => "&dump_rectangle",
43 "char_info_t" => "&dump_char_info",
44 "apc_call_t" => "&dump_apc_call",
45 "apc_result_t" => "&dump_apc_result",
46 "async_data_t" => "&dump_async_data",
47 "luid_t" => "&dump_luid",
48 "ioctl_code_t" => "&dump_ioctl_code",
49 "file_pos_t" => "&dump_file_pos",
59 ### Generate a dumping function
65 push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
70 if (defined($formats{$type}))
72 if ($formats{$type} =~ /^&(.*)/)
75 push @trace_lines, " fprintf( stderr, \" $var=\" );\n";
76 push @trace_lines, " $func( &req->$var );\n";
77 push @trace_lines, " fprintf( stderr, \",\" );\n" if ($#_ > 0);
79 elsif ($formats{$type} =~ /^(%.*)\s+\((.*)\)/)
81 my ($format, $cast) = ($1, $2);
82 push @trace_lines, " fprintf( stderr, \" $var=$format";
83 push @trace_lines, "," if ($#_ > 0);
84 push @trace_lines, "\", ($cast)req->$var );\n";
88 push @trace_lines, " fprintf( stderr, \" $var=$formats{$type}";
89 push @trace_lines, "," if ($#_ > 0);
90 push @trace_lines, "\", req->$var );\n";
93 else # must be some varargs format
96 push @trace_lines, " fprintf( stderr, \" $var=\" );\n";
97 push @trace_lines, " $func;\n";
98 push @trace_lines, " fputc( ',', stderr );\n" if ($#_ > 0);
101 push @trace_lines, "}\n\n";
104 ### Parse the request definitions
108 # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
114 open(PROTOCOL
,"server/protocol.def") or die "Can't open server/protocol.def";
121 # strip white space at end of line
126 die "Misplaced \@HEADER" unless $state == 0;
131 # ignore everything while in state 0
134 if (/^\@REQ\(\s*(\w+)\s*\)/)
137 die "Misplaced \@REQ" unless $state == 1;
138 # start a new request
141 print SERVER_PROT
"struct ${name}_request\n{\n";
142 print SERVER_PROT
" struct request_header __header;\n";
149 die "Misplaced \@REPLY" unless $state == 2;
150 print SERVER_PROT
"};\n";
151 print SERVER_PROT
"struct ${name}_reply\n{\n";
152 print SERVER_PROT
" struct reply_header __header;\n";
159 die "Misplaced \@END" unless ($state == 2 || $state == 3);
160 print SERVER_PROT
"};\n";
162 if ($state == 2) # build dummy reply struct
164 print SERVER_PROT
"struct ${name}_reply\n{\n";
165 print SERVER_PROT
" struct reply_header __header;\n";
166 print SERVER_PROT
"};\n";
169 # got a complete request
170 push @requests, $name;
171 DO_DUMP_FUNC
( $name, "request", @in_struct);
172 if ($#out_struct >= 0)
175 DO_DUMP_FUNC
( $name, "reply", @out_struct);
183 # skip empty lines (but keep them in output file)
186 print SERVER_PROT
"\n";
190 if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
193 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
194 s!(VARARG\(.*\)\s*;)!/* $1 */!;
196 elsif (/^\s*VARARG\((\w+),(\w+)\)/)
199 $type = "dump_varargs_" . $2 . "( cur_size )";
200 s!(VARARG\(.*\)\s*;)!/* $1 */!;
202 elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
206 die "Unrecognized type $type" unless defined($formats{$type});
210 die "Unrecognized syntax $_";
212 if ($state == 2) { push @in_struct, $type, $var; }
213 if ($state == 3) { push @out_struct, $type, $var; }
216 # Pass it through into the output file
217 print SERVER_PROT
$_ . "\n";
222 ### Retrieve the server protocol version from the existing server_protocol.h file
224 sub GET_PROTOCOL_VERSION
()
227 open SERVER_PROT
, "include/wine/server_protocol.h" or return 0;
228 while (<SERVER_PROT
>)
230 if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
236 ### Retrieve the list of status and errors used in the server
238 sub GET_ERROR_NAMES
()
241 foreach my $f (glob "server/*.c")
243 next if $f eq "server/trace.c";
244 open FILE
, $f or die "Can't open $f";
249 $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
251 elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
253 $errors{$1} = "0xc0010000 | $1";
261 # update a file if changed
265 my $ret = !(-f
$file) || system "cmp $file $file.new >/dev/null";
272 rename "$file.new", "$file";
273 print "$file updated\n";
278 # replace some lines in a file between two markers
279 sub replace_in_file
($$$@
)
285 open NEW_FILE
, ">$file.new" or die "cannot create $file.new";
289 open OLD_FILE
, "$file" or die "cannot open $file";
297 print NEW_FILE
"\n", @_, "\n";
305 print NEW_FILE
$_ unless $skip;
309 close OLD_FILE
if defined($start);
311 return update_file
($file);
316 # Get the server protocol version
317 my $protocol = GET_PROTOCOL_VERSION
();
319 my %errors = GET_ERROR_NAMES
();
321 ### Create server_protocol.h and print header
323 open SERVER_PROT
, ">include/wine/server_protocol.h.new" or die "Cannot create include/wine/server_protocol.h.new";
324 print SERVER_PROT
"/*\n * Wine server protocol definitions\n *\n";
325 print SERVER_PROT
" * This file is automatically generated; DO NO EDIT!\n";
326 print SERVER_PROT
" * Edit server/protocol.def instead and re-run tools/make_requests\n";
327 print SERVER_PROT
" */\n\n";
328 print SERVER_PROT
"#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
329 print SERVER_PROT
"#define __WINE_WINE_SERVER_PROTOCOL_H\n";
331 ### Parse requests to find request/reply structure definitions
335 ### Build the request list and structures
337 print SERVER_PROT
"\n\nenum request\n{\n";
338 foreach my $req (@requests) { print SERVER_PROT
" REQ_$req,\n"; }
339 print SERVER_PROT
" REQ_NB_REQUESTS\n};\n\n";
341 print SERVER_PROT
"union generic_request\n{\n";
342 print SERVER_PROT
" struct request_max_size max_size;\n";
343 print SERVER_PROT
" struct request_header request_header;\n";
344 foreach my $req (@requests) { print SERVER_PROT
" struct ${req}_request ${req}_request;\n"; }
345 print SERVER_PROT
"};\n";
347 print SERVER_PROT
"union generic_reply\n{\n";
348 print SERVER_PROT
" struct request_max_size max_size;\n";
349 print SERVER_PROT
" struct reply_header reply_header;\n";
350 foreach my $req (@requests) { print SERVER_PROT
" struct ${req}_reply ${req}_reply;\n"; }
351 print SERVER_PROT
"};\n\n";
353 printf SERVER_PROT
"#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
354 print SERVER_PROT
"#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
356 update_file
( "include/wine/server_protocol.h" );
358 ### Output the dumping function tables
360 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
361 foreach my $req (@requests)
363 push @trace_lines, " (dump_func)dump_${req}_request,\n";
365 push @trace_lines, "};\n\n";
367 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
368 foreach my $req (@requests)
370 push @trace_lines, " ", $replies{$req} ?
"(dump_func)dump_${req}_reply,\n" : "NULL,\n";
372 push @trace_lines, "};\n\n";
374 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
375 foreach my $req (@requests)
377 push @trace_lines, " \"$req\",\n";
379 push @trace_lines, "};\n\n";
381 push @trace_lines, "static const struct\n{\n";
382 push @trace_lines, " const char *name;\n";
383 push @trace_lines, " unsigned int value;\n";
384 push @trace_lines, "} status_names[] =\n{\n";
386 foreach my $err (sort keys %errors)
388 push @trace_lines, sprintf(" { %-30s %s },\n", "\"$err\",", $errors{$err});
390 push @trace_lines, " { NULL, 0 }\n";
391 push @trace_lines, "};\n";
393 replace_in_file
( "server/trace.c",
394 "### make_requests begin ###",
395 "### make_requests end ###",
398 ### Output the request handlers list
400 my @request_lines = ();
402 foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
403 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
404 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
405 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
406 foreach my $req (@requests)
408 push @request_lines, " (req_handler)req_$req,\n";
410 push @request_lines, "};\n#endif /* WANT_REQUEST_HANDLERS */\n";
412 replace_in_file
( "server/request.h",
413 "### make_requests begin ###",
414 "### make_requests end ###",