make_requests 14.1 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1
#! /usr/bin/perl -w
Alexandre Julliard's avatar
Alexandre Julliard committed
2
#
3
# Build the server/trace.c and server/request.h files
4
# from the contents of server/protocol.def.
Alexandre Julliard's avatar
Alexandre Julliard committed
5 6 7
#
# Copyright (C) 1998 Alexandre Julliard
#
8 9 10 11 12 13 14 15 16 17 18 19
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# 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
#
Francois Gouget's avatar
Francois Gouget committed
22
use strict;
Alexandre Julliard's avatar
Alexandre Julliard committed
23

Francois Gouget's avatar
Francois Gouget committed
24
my %formats =
25 26 27 28 29 30 31 32 33
(                     # size align format
    "int"           => [  4,   4,  "%d" ],
    "short int"     => [  2,   2,  "%d" ],
    "char"          => [  1,   1,  "%c" ],
    "unsigned char" => [  1,   1,  "%02x" ],
    "unsigned short"=> [  2,   2,  "%04x" ],
    "unsigned int"  => [  4,   4,  "%08x" ],
    "data_size_t"   => [  4,   4,  "%u" ],
    "obj_handle_t"  => [  4,   4,  "%04x" ],
34
    "atom_t"        => [  4,   4,  "%04x" ],
35 36 37
    "user_handle_t" => [  4,   4,  "%08x" ],
    "process_id_t"  => [  4,   4,  "%04x" ],
    "thread_id_t"   => [  4,   4,  "%04x" ],
38
    "client_ptr_t"  => [  8,   8,  "&dump_uint64" ],
39
    "mod_handle_t"  => [  8,   8,  "&dump_uint64" ],
40
    "lparam_t"      => [  8,   8,  "&dump_uint64" ],
41
    "apc_param_t"   => [  8,   8,  "&dump_uint64" ],
42 43
    "file_pos_t"    => [  8,   8,  "&dump_uint64" ],
    "mem_size_t"    => [  8,   8,  "&dump_uint64" ],
44
    "affinity_t"    => [  8,   8,  "&dump_uint64" ],
45 46 47
    "timeout_t"     => [  8,   8,  "&dump_timeout" ],
    "rectangle_t"   => [  16,  4,  "&dump_rectangle" ],
    "char_info_t"   => [  4,   2,  "&dump_char_info" ],
48 49
    "apc_call_t"    => [  40,  8,  "&dump_apc_call" ],
    "apc_result_t"  => [  40,  8,  "&dump_apc_result" ],
50
    "async_data_t"  => [  40,  8,  "&dump_async_data" ],
51 52
    "luid_t"        => [  8,   4,  "&dump_luid" ],
    "ioctl_code_t"  => [  4,   4,  "&dump_ioctl_code" ],
53
    "cpu_type_t"    => [  4,   4,  "&dump_cpu_type" ],
Alexandre Julliard's avatar
Alexandre Julliard committed
54 55 56 57
);

my @requests = ();
my %replies = ();
58
my @asserts = ();
Alexandre Julliard's avatar
Alexandre Julliard committed
59

60
my @trace_lines = ();
Alexandre Julliard's avatar
Alexandre Julliard committed
61

62
my $max_req_size = 64;
63

64
my $warnings = scalar(@ARGV) && $ARGV[0] eq "-w";
Alexandre Julliard's avatar
Alexandre Julliard committed
65

66 67 68 69 70 71
### Generate a dumping function

sub DO_DUMP_FUNC($$@)
{
    my $name = shift;
    my $req = shift;
72
    my $prefix = " ";
73 74 75 76 77
    push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
    while ($#_ >= 0)
    {
	my $type = shift;
	my $var = shift;
78
        next if $var =~ /^__pad/;
79 80
	if (defined($formats{$type}))
	{
81 82
            my $fmt = ${$formats{$type}}[2];
            if ($fmt =~ /^&(.*)/)
83 84
            {
                my $func = $1;
85
                push @trace_lines, "    $func( \"$prefix$var=\", &req->$var );\n";
86
            }
87
            elsif ($fmt =~ /^(%.*)\s+\((.*)\)/)
88 89
            {
                my ($format, $cast) = ($1, $2);
90
                push @trace_lines, "    fprintf( stderr, \"$prefix$var=$format\", ($cast)req->$var );\n";
91
            }
92 93
            else
            {
94
                push @trace_lines, "    fprintf( stderr, \"$prefix$var=$fmt\", req->$var );\n";
95 96 97 98
            }
	}
	else  # must be some varargs format
	{
99
            push @trace_lines, "    " . sprintf($type, "$prefix$var=") . ";\n";
100
        }
101
        $prefix = ", ";
102 103 104 105
    }
    push @trace_lines, "}\n\n";
}

106
### Parse the request definitions
Alexandre Julliard's avatar
Alexandre Julliard committed
107

Francois Gouget's avatar
Francois Gouget committed
108
sub PARSE_REQUESTS()
Alexandre Julliard's avatar
Alexandre Julliard committed
109
{
110 111
    # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
    my $state = 0;
112
    my $offset = 0;
113
    my $name = "";
114 115
    my @in_struct = ();
    my @out_struct = ();
116 117 118 119

    open(PROTOCOL,"server/protocol.def") or die "Can't open server/protocol.def";

    while (<PROTOCOL>)
Alexandre Julliard's avatar
Alexandre Julliard committed
120
    {
121 122
        my ($type, $var);
        # strip comments
Alexandre Julliard's avatar
Alexandre Julliard committed
123
	s!/\*.*\*/!!g;
124 125 126 127 128 129 130 131 132 133 134 135 136 137
        # strip white space at end of line
        s/\s+$//;

        if (/^\@HEADER/)
        {
            die "Misplaced \@HEADER" unless $state == 0;
            $state++;
            next;
        }

        # ignore everything while in state 0
        next if $state == 0;

        if (/^\@REQ\(\s*(\w+)\s*\)/)
138
        {
139 140 141 142 143
            $name = $1;
            die "Misplaced \@REQ" unless $state == 1;
            # start a new request
            @in_struct = ();
            @out_struct = ();
144
            $offset = 12;
145 146 147
            print SERVER_PROT "struct ${name}_request\n{\n";
            print SERVER_PROT "    struct request_header __header;\n";
            $state++;
148 149
            next;
        }
150 151

        if (/^\@REPLY/)
152
        {
153
            die "Misplaced \@REPLY" unless $state == 2;
154 155 156
            print SERVER_PROT "};\n";
            print SERVER_PROT "struct ${name}_reply\n{\n";
            print SERVER_PROT "    struct reply_header __header;\n";
157 158
            die "request $name too large ($offset)" if ($offset > $max_req_size);
            $offset = 8;
159 160
            $state++;
            next;
161
        }
162 163

        if (/^\@END/)
164
        {
165 166
            die "Misplaced \@END" unless ($state == 2 || $state == 3);

167 168 169 170 171 172 173
            if ($offset & 7)  # all requests should be 8-byte aligned
            {
                my $count = 8 - ($offset & 7);
                print SERVER_PROT "    char __pad_$offset\[$count\];\n";
                $offset += $count;
            }
            print SERVER_PROT "};\n";
174 175
            if ($state == 2)  # build dummy reply struct
            {
176
                die "request $name too large ($offset)" if ($offset > $max_req_size);
177
                push @asserts, "C_ASSERT( sizeof(struct ${name}_request) == $offset );\n";
178 179 180 181
                print SERVER_PROT "struct ${name}_reply\n{\n";
                print SERVER_PROT "    struct reply_header __header;\n";
                print SERVER_PROT "};\n";
            }
182 183 184
            else
            {
                die "reply $name too large ($offset)" if ($offset > $max_req_size);
185
                push @asserts, "C_ASSERT( sizeof(struct ${name}_reply) == $offset );\n";
186
            }
187 188
            # got a complete request
            push @requests, $name;
189
            DO_DUMP_FUNC( $name, "request", @in_struct);
190 191 192
            if ($#out_struct >= 0)
            {
                $replies{$name} = 1;
193
                DO_DUMP_FUNC( $name, "reply", @out_struct);
194 195 196
            }
            $state = 1;
            next;
197
        }
198 199

        if ($state != 1)
200
        {
201 202 203 204 205 206 207
            # skip empty lines (but keep them in output file)
            if (/^$/)
            {
                print SERVER_PROT "\n";
                next;
            }

208 209 210
            if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
            {
                $var = $1;
211
                $type = "dump_varargs_" . $2 . "( \"%s\", min(cur_size,req->" . $3 . ") )";
212 213 214
                s!(VARARG\(.*\)\s*;)!/* $1 */!;
            }
            elsif (/^\s*VARARG\((\w+),(\w+)\)/)
215 216
            {
                $var = $1;
217
                $type = "dump_varargs_" . $2 . "( \"%s\", cur_size )";
218 219
                s!(VARARG\(.*\)\s*;)!/* $1 */!;
            }
220
            elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
221
            {
222
                $type = $1;
223
                $var = $3;
224
                die "Unrecognized type $type" unless defined($formats{$type});
225 226 227
                my @fmt = @{$formats{$type}};
                if ($offset & ($fmt[1] - 1))
                {
228
                    my $count = $fmt[1] - ($offset & ($fmt[1] - 1));
229
                    print "protocol.def:$.: warning: $name $offset $type $var needs padding\n" if $warnings;
230 231 232 233 234 235 236 237 238 239
                    print SERVER_PROT "    char __pad_$offset\[$count\];\n";
                    $offset += $count;
                }
                if ($state == 2)
                {
                    push @asserts, "C_ASSERT( FIELD_OFFSET(struct ${name}_request, $var) == $offset );\n";
                }
                else
                {
                    push @asserts, "C_ASSERT( FIELD_OFFSET(struct ${name}_reply, $var) == $offset );\n";
240 241
                }
                $offset += $fmt[0];
242 243 244 245 246 247 248
            }
            else
            {
                die "Unrecognized syntax $_";
            }
            if ($state == 2) { push @in_struct, $type, $var; }
            if ($state == 3) { push @out_struct, $type, $var; }
249
        }
250 251 252

        # Pass it through into the output file
        print SERVER_PROT $_ . "\n";
Alexandre Julliard's avatar
Alexandre Julliard committed
253
    }
254
    close PROTOCOL;
Alexandre Julliard's avatar
Alexandre Julliard committed
255 256
}

257 258
### Retrieve the server protocol version from the existing server_protocol.h file

Francois Gouget's avatar
Francois Gouget committed
259
sub GET_PROTOCOL_VERSION()
260 261 262 263 264 265 266 267 268 269 270
{
    my $protocol = 0;
    open SERVER_PROT, "include/wine/server_protocol.h" or return 0;
    while (<SERVER_PROT>)
    {
        if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
    }
    close SERVER_PROT;
    return $protocol;
}

271 272 273 274 275 276 277
### Retrieve the list of status and errors used in the server

sub GET_ERROR_NAMES()
{
    my %errors = ();
    foreach my $f (glob "server/*.c")
    {
278
        next if $f eq "server/trace.c";
279 280 281
        open FILE, $f or die "Can't open $f";
        while (<FILE>)
        {
282
            if (/STATUS_(\w+)/)
283 284
            {
                $errors{$1} = "STATUS_$1" unless $1 eq "SUCCESS";
285 286 287 288 289 290 291 292 293 294 295
            }
            elsif (/set_win32_error\s*\(\s*(\w+)\s*\)/)
            {
                $errors{$1} = "0xc0010000 | $1";
            }
        }
        close FILE;
    }
    return %errors;
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
# update a file if changed
sub update_file($)
{
    my $file = shift;
    my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
    if (!$ret)
    {
        unlink "$file.new";
    }
    else
    {
        rename "$file.new", "$file";
        print "$file updated\n";
    }
    return $ret;
}
312

313 314
# replace some lines in a file between two markers
sub replace_in_file($$$@)
315
{
316 317 318 319 320 321 322
    my $file = shift;
    my $start = shift;
    my $end = shift;

    open NEW_FILE, ">$file.new" or die "cannot create $file.new";

    if (defined($start))
323
    {
324 325 326 327 328 329
        open OLD_FILE, "$file" or die "cannot open $file";
        while (<OLD_FILE>)
        {
            print NEW_FILE $_;
            last if /$start/;
        }
330
    }
331 332 333 334

    print NEW_FILE "\n", @_, "\n";

    if (defined($end))
335
    {
336 337 338 339 340 341
        my $skip=1;
        while (<OLD_FILE>)
        {
            $skip = 0 if /$end/;
            print NEW_FILE $_ unless $skip;
        }
342
    }
343 344 345 346

    close OLD_FILE if defined($start);
    close NEW_FILE;
    return update_file($file);
Alexandre Julliard's avatar
Alexandre Julliard committed
347
}
Francois Gouget's avatar
Francois Gouget committed
348 349 350 351 352 353

### Main

# Get the server protocol version
my $protocol = GET_PROTOCOL_VERSION();

354 355
my %errors = GET_ERROR_NAMES();

Francois Gouget's avatar
Francois Gouget committed
356 357
### Create server_protocol.h and print header

358
open SERVER_PROT, ">include/wine/server_protocol.h.new" or die "Cannot create include/wine/server_protocol.h.new";
Francois Gouget's avatar
Francois Gouget committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
print SERVER_PROT "/*\n * Wine server protocol definitions\n *\n";
print SERVER_PROT " * This file is automatically generated; DO NO EDIT!\n";
print SERVER_PROT " * Edit server/protocol.def instead and re-run tools/make_requests\n";
print SERVER_PROT " */\n\n";
print SERVER_PROT "#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
print SERVER_PROT "#define __WINE_WINE_SERVER_PROTOCOL_H\n";

### Parse requests to find request/reply structure definitions

PARSE_REQUESTS();

### Build the request list and structures

print SERVER_PROT "\n\nenum request\n{\n";
foreach my $req (@requests) { print SERVER_PROT "    REQ_$req,\n"; }
print SERVER_PROT "    REQ_NB_REQUESTS\n};\n\n";

print SERVER_PROT "union generic_request\n{\n";
print SERVER_PROT "    struct request_max_size max_size;\n";
print SERVER_PROT "    struct request_header request_header;\n";
foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_request ${req}_request;\n"; }
print SERVER_PROT "};\n";

print SERVER_PROT "union generic_reply\n{\n";
print SERVER_PROT "    struct request_max_size max_size;\n";
print SERVER_PROT "    struct reply_header reply_header;\n";
foreach my $req (@requests) { print SERVER_PROT "    struct ${req}_reply ${req}_reply;\n"; }
print SERVER_PROT "};\n\n";

printf SERVER_PROT "#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
print SERVER_PROT "#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
close SERVER_PROT;
391
update_file( "include/wine/server_protocol.h" );
Francois Gouget's avatar
Francois Gouget committed
392 393 394 395 396 397 398 399 400 401 402 403 404

### Output the dumping function tables

push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
foreach my $req (@requests)
{
    push @trace_lines, "    (dump_func)dump_${req}_request,\n";
}
push @trace_lines, "};\n\n";

push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
foreach my $req (@requests)
{
405
    push @trace_lines, "    ", $replies{$req} ? "(dump_func)dump_${req}_reply,\n" : "NULL,\n";
Francois Gouget's avatar
Francois Gouget committed
406 407 408 409 410 411 412 413
}
push @trace_lines, "};\n\n";

push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
foreach my $req (@requests)
{
    push @trace_lines, "    \"$req\",\n";
}
414 415 416 417 418 419 420 421 422 423 424 425
push @trace_lines, "};\n\n";

push @trace_lines, "static const struct\n{\n";
push @trace_lines, "    const char  *name;\n";
push @trace_lines, "    unsigned int value;\n";
push @trace_lines, "} status_names[] =\n{\n";

foreach my $err (sort keys %errors)
{
    push @trace_lines, sprintf("    { %-30s %s },\n", "\"$err\",", $errors{$err});
}
push @trace_lines, "    { NULL, 0 }\n";
Francois Gouget's avatar
Francois Gouget committed
426 427
push @trace_lines, "};\n";

428 429 430 431
replace_in_file( "server/trace.c",
                 "### make_requests begin ###",
                 "### make_requests end ###",
                 @trace_lines );
432 433 434 435 436 437 438 439 440 441 442 443 444

### Output the request handlers list

my @request_lines = ();

foreach my $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
foreach my $req (@requests)
{
    push @request_lines, "    (req_handler)req_$req,\n";
}
445 446 447 448 449 450 451 452 453
push @request_lines, "};\n\n";

foreach my $type (sort keys %formats)
{
    my $size = ${$formats{$type}}[0];
    push @request_lines, "C_ASSERT( sizeof($type) == $size );\n";
}
push @request_lines, @asserts;
push @request_lines, "\n#endif  /* WANT_REQUEST_HANDLERS */\n";
454

455 456 457 458
replace_in_file( "server/request.h",
                 "### make_requests begin ###",
                 "### make_requests end ###",
                 @request_lines );