gendispatch.pl 61.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#!/usr/bin/perl -w
#
# This script parses remote_protocol.x or qemu_protocol.x and produces lots of
# boilerplate code for both ends of the remote connection.
#
# The first non-option argument specifies the prefix to be searched for, and
# output to, the boilerplate code.  The second non-option argument is the
# file you want to operate on.  For instance, to generate the dispatch table
# for both remote_protocol.x and qemu_protocol.x, you would run the
# following:
#
# remote_generator.pl -c -t remote ../src/remote/remote_protocol.x
# remote_generator.pl -t qemu ../src/remote/qemu_protocol.x
#
# By Richard Jones <rjones@redhat.com>
16
# Extended by Matthias Bolte <matthias.bolte@googlemail.com>
17 18 19 20 21 22

use strict;

use Getopt::Std;

# Command line options.
23 24
our ($opt_p, $opt_t, $opt_a, $opt_r, $opt_d, $opt_c, $opt_b, $opt_k);
getopts ('ptardcbk');
25

26 27 28 29
my $structprefix = shift or die "missing prefix argument";
my $protocol = shift or die "missing protocol argument";
my @autogen;

30 31 32 33 34 35 36
my $procprefix = uc $structprefix;

# Convert name_of_call to NameOfCall.
sub name_to_ProcName {
    my $name = shift;
    my @elems = split /_/, $name;
    @elems = map ucfirst, @elems;
37
    @elems = map { $_ =~ s/Nwfilter/NWFilter/; $_ =~ s/Xml/XML/;
38
                   $_ =~ s/Uri/URI/; $_ =~ s/Uuid/UUID/; $_ =~ s/Id/ID/;
39
                   $_ =~ s/Mac/MAC/; $_ =~ s/Cpu/CPU/; $_ =~ s/Os/OS/;
40
                   $_ =~ s/Nmi/NMI/; $_ } @elems;
41 42 43 44 45
    join "", @elems
}

# Read the input file (usually remote_protocol.x) and form an
# opinion about the name, args and return type of each RPC.
46
my ($name, $ProcName, $id, $flags, %calls, @calls);
47 48 49 50 51 52 53 54 55 56 57 58 59

# only generate a close method if -c was passed
if ($opt_c) {
    # REMOTE_PROC_CLOSE has no args or ret.
    $calls{close} = {
        name => "close",
        ProcName => "Close",
        UC_NAME => "CLOSE",
        args => "void",
        ret => "void",
    };
}

60
my $collect_args_members = 0;
61
my $collect_ret_members = 0;
62 63
my $last_name;

64 65 66
open PROTOCOL, "<$protocol" or die "cannot open $protocol: $!";

while (<PROTOCOL>) {
67 68 69 70 71 72
    if ($collect_args_members) {
        if (/^};/) {
            $collect_args_members = 0;
        } elsif ($_ =~ m/^\s*(.*\S)\s*$/) {
            push(@{$calls{$name}->{args_members}}, $1);
        }
73 74 75 76 77 78
    } elsif ($collect_ret_members) {
        if (/^};/) {
            $collect_ret_members = 0;
        } elsif ($_ =~ m/^\s*(.*\S)\s*$/) {
            push(@{$calls{$name}->{ret_members}}, $1);
        }
79
    } elsif (/^struct ${structprefix}_(.*)_args/) {
80 81 82 83 84 85 86 87 88 89 90
        $name = $1;
        $ProcName = name_to_ProcName ($name);

        die "duplicate definition of ${structprefix}_${name}_args"
            if exists $calls{$name};

        $calls{$name} = {
            name => $name,
            ProcName => $ProcName,
            UC_NAME => uc $name,
            args => "${structprefix}_${name}_args",
91 92
            args_members => [],
            ret => "void"
93 94
        };

95
        $collect_args_members = 1;
96
        $collect_ret_members = 0;
97
        $last_name = $name;
98
    } elsif (/^struct ${structprefix}_(.*)_ret\s+{(.*)$/) {
99
        $name = $1;
100
        $flags = $2;
101 102 103 104 105 106 107 108 109 110
        $ProcName = name_to_ProcName ($name);

        if (exists $calls{$name}) {
            $calls{$name}->{ret} = "${structprefix}_${name}_ret";
        } else {
            $calls{$name} = {
                name => $name,
                ProcName => $ProcName,
                UC_NAME => uc $name,
                args => "void",
111 112
                ret => "${structprefix}_${name}_ret",
                ret_members => []
113 114
            }
        }
115

116 117 118 119 120 121 122 123
        if ($flags ne "" and ($opt_b or $opt_k)) {
            if (!($flags =~ m/^\s*\/\*\s*insert@(\d+)\s*\*\/\s*$/)) {
                die "invalid generator flags for $calls{$name}->{ret}";
            }

            $calls{$name}->{ret_offset} = int($1);
        }

124
        $collect_args_members = 0;
125 126
        $collect_ret_members = 1;
        $last_name = $name;
127 128 129 130 131 132 133 134 135
    } elsif (/^struct ${structprefix}_(.*)_msg/) {
        $name = $1;
        $ProcName = name_to_ProcName ($name);

        $calls{$name} = {
            name => $name,
            ProcName => $ProcName,
            UC_NAME => uc $name,
            msg => "${structprefix}_${name}_msg"
136 137 138
        };

        $collect_args_members = 0;
139
        $collect_ret_members = 0;
140
    } elsif (/^\s*${procprefix}_PROC_(.*?)\s*=\s*(\d+)\s*,?(.*)$/) {
141 142
        $name = lc $1;
        $id = $2;
143
        $flags = $3;
144 145
        $ProcName = name_to_ProcName ($name);

146
        if ($opt_b or $opt_k) {
147
            if (!($flags =~ m/^\s*\/\*\s*(\S+)\s+(\S+)\s*(.*)\*\/\s*$/)) {
148 149 150
                die "invalid generator flags for ${procprefix}_PROC_${name}"
            }

151 152
            my $genmode = $opt_b ? $1 : $2;
            my $genflags = $3;
153

154
            if ($genmode eq "autogen") {
155
                push(@autogen, $ProcName);
156
            } elsif ($genmode eq "skipgen") {
157 158 159 160
                # ignore it
            } else {
                die "invalid generator flags for ${procprefix}_PROC_${name}"
            }
161 162 163 164 165 166 167 168 169 170 171

            if (defined $genflags and $genflags ne "") {
                if ($genflags =~ m/^\|\s*(read|write)stream@(\d+)\s*$/) {
                    $calls{$name}->{streamflag} = $1;
                    $calls{$name}->{streamoffset} = int($2);
                } else {
                    die "invalid generator flags for ${procprefix}_PROC_${name}"
                }
            } else {
                $calls{$name}->{streamflag} = "none";
            }
172 173
        }

174
        $calls[$id] = $calls{$name};
175 176

        $collect_args_members = 0;
177
        $collect_ret_members = 0;
178 179
    } else {
        $collect_args_members = 0;
180
        $collect_ret_members = 0;
181 182 183
    }
}

184 185
close(PROTOCOL);

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
# this hash contains the procedures that are allowed to map [unsigned] hyper
# to [unsigned] long for legacy reasons in their signature and return type.
# this list is fixed. new procedures and public APIs have to map [unsigned]
# hyper to [unsigned] long long
my $long_legacy = {
    DomainGetMaxMemory          => { ret => { memory => 1 } },
    DomainGetInfo               => { ret => { maxMem => 1, memory => 1 } },
    DomainMigrate               => { arg => { flags => 1, resource => 1 } },
    DomainMigrate2              => { arg => { flags => 1, resource => 1 } },
    DomainMigrateBegin3         => { arg => { flags => 1, resource => 1 } },
    DomainMigrateConfirm3       => { arg => { flags => 1, resource => 1 } },
    DomainMigrateDirect         => { arg => { flags => 1, resource => 1 } },
    DomainMigrateFinish         => { arg => { flags => 1 } },
    DomainMigrateFinish2        => { arg => { flags => 1 } },
    DomainMigrateFinish3        => { arg => { flags => 1 } },
    DomainMigratePeer2Peer      => { arg => { flags => 1, resource => 1 } },
    DomainMigratePerform        => { arg => { flags => 1, resource => 1 } },
    DomainMigratePerform3       => { arg => { flags => 1, resource => 1 } },
    DomainMigratePrepare        => { arg => { flags => 1, resource => 1 } },
    DomainMigratePrepare2       => { arg => { flags => 1, resource => 1 } },
    DomainMigratePrepare3       => { arg => { flags => 1, resource => 1 } },
    DomainMigratePrepareTunnel  => { arg => { flags => 1, resource => 1 } },
    DomainMigratePrepareTunnel3 => { arg => { flags => 1, resource => 1 } },
    DomainMigrateToURI          => { arg => { flags => 1, resource => 1 } },
    DomainMigrateToURI2         => { arg => { flags => 1, resource => 1 } },
    DomainMigrateVersion1       => { arg => { flags => 1, resource => 1 } },
    DomainMigrateVersion2       => { arg => { flags => 1, resource => 1 } },
    DomainMigrateVersion3       => { arg => { flags => 1, resource => 1 } },
    DomainMigrateSetMaxSpeed    => { arg => { bandwidth => 1 } },
    DomainSetMaxMemory          => { arg => { memory => 1 } },
    DomainSetMemory             => { arg => { memory => 1 } },
    DomainSetMemoryFlags        => { arg => { memory => 1 } },
    GetLibVersion               => { ret => { lib_ver => 1 } },
    GetVersion                  => { ret => { hv_ver => 1 } },
    NodeGetInfo                 => { ret => { memory => 1 } },
};

sub hyper_to_long
{
    my $proc_name = shift;
    my $ret_or_arg = shift;
    my $member = shift;

    if ($long_legacy->{$proc_name} and
        $long_legacy->{$proc_name}->{$ret_or_arg} and
        $long_legacy->{$proc_name}->{$ret_or_arg}->{$member}) {
        return 1;
    } else {
        return 0
    }
}

238 239 240 241 242 243 244 245 246
#----------------------------------------------------------------------
# Output

print <<__EOF__;
/* Automatically generated by remote_generator.pl.
 * Do not edit this file.  Any changes you make will be lost.
 */
__EOF__

247 248 249 250
if (!$opt_b and !$opt_k) {
    print "\n";
}

251 252 253 254 255 256 257 258 259 260
# Debugging.
if ($opt_d) {
    my @keys = sort (keys %calls);
    foreach (@keys) {
        print "$_:\n";
        print "        name $calls{$_}->{name} ($calls{$_}->{ProcName})\n";
        print "        $calls{$_}->{args} -> $calls{$_}->{ret}\n";
    }
}

261
# Bodies for dispatch functions ("remote_dispatch_bodies.h").
262
elsif ($opt_b) {
263
    my %generate = map { $_ => 1 } @autogen;
264 265 266
    my @keys = sort (keys %calls);

    foreach (@keys) {
267 268
        my $call = $calls{$_};

269
        # skip things which are REMOTE_MESSAGE
270
        next if $call->{msg};
271

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
	my $name = $structprefix . "Dispatch" . $call->{ProcName};
	my $argtype = $call->{args};
	my $rettype = $call->{ret};

	my $argann = $argtype ne "void" ? "" : " ATTRIBUTE_UNUSED";
	my $retann = $rettype ne "void" ? "" : " ATTRIBUTE_UNUSED";

	# First we print out a function declaration for the
	# real dispatcher body
	print "static int ${name}(\n";
	print "    virNetServerPtr server,\n";
	print "    virNetServerClientPtr client,\n";
	print "    virNetMessageHeaderPtr hdr,\n";
	print "    virNetMessageErrorPtr rerr";
	if ($argtype ne "void") {
	    print ",\n    $argtype *args";
	}
	if ($rettype ne "void") {
	    print ",\n    $rettype *ret";
	}
	print ");\n";


	# Next we print out a generic wrapper method which has
	# fixed function signature, for use in the dispatcher
	# table. This simply callers the real dispatcher method
	print "static int ${name}Helper(\n";
	print "    virNetServerPtr server,\n";
	print "    virNetServerClientPtr client,\n";
	print "    virNetMessageHeaderPtr hdr,\n";
	print "    virNetMessageErrorPtr rerr,\n";
	print "    void *args$argann,\n";
	print "    void *ret$retann)\n";
	print "{\n";
	print "  VIR_DEBUG(\"server=%p client=%p hdr=%p rerr=%p args=%p ret=%p\", server, client, hdr, rerr, args, ret);\n";
	print "  return $name(server, client, hdr, rerr";
	if ($argtype ne "void") {
	    print ", args";
	}
	if ($rettype ne "void") {
	    print ", ret";
	}
	print ");\n";
	print "}\n";

	# Finally we print out the dispatcher method body impl
	# (if possible)
        if (!exists($generate{$call->{ProcName}})) {
            print "/* ${structprefix}Dispatch$call->{ProcName} body has " .
                  "to be implemented manually */\n\n\n\n";
            next;
        }
324 325 326

        my $has_node_device = 0;
        my @vars_list = ();
327
        my @optionals_list = ();
328 329
        my @getters_list = ();
        my @args_list = ();
330
        my @prepare_ret_list = ();
331
        my @ret_list = ();
332
        my @free_list = ();
333
        my @free_list_on_error = ("virNetMessageSaveError(rerr);");
334

335
        # handle arguments to the function
336
        if ($argtype ne "void") {
337
            # node device is special, as it's identified by name
338 339 340
            if ($argtype =~ m/^remote_node_device_/ and
                !($argtype =~ m/^remote_node_device_lookup_by_name_/) and
                !($argtype =~ m/^remote_node_device_create_xml_/)) {
341 342 343
                $has_node_device = 1;
                push(@vars_list, "virNodeDevicePtr dev = NULL");
                push(@getters_list,
344
                     "    if (!(dev = virNodeDeviceLookupByName(priv->conn, args->name)))\n" .
345 346 347 348 349 350 351
                     "        goto cleanup;\n");
                push(@args_list, "dev");
                push(@free_list,
                     "    if (dev)\n" .
                     "        virNodeDeviceFree(dev);");
            }

352
            foreach my $args_member (@{$call->{args_members}}) {
353 354 355
                if ($args_member =~ m/^remote_nonnull_string name;/ and $has_node_device) {
                    # ignore the name arg for node devices
                    next
356 357 358 359
                } elsif ($args_member =~ m/^remote_nonnull_(domain|network|storage_pool|storage_vol|interface|secret|nwfilter) (\S+);/) {
                    my $type_name = name_to_ProcName($1);

                    push(@vars_list, "vir${type_name}Ptr $2 = NULL");
360
                    push(@getters_list,
361
                         "    if (!($2 = get_nonnull_$1(priv->conn, args->$2)))\n" .
362
                         "        goto cleanup;\n");
363
                    push(@args_list, "$2");
364
                    push(@free_list,
365 366
                         "    if ($2)\n" .
                         "        vir${type_name}Free($2);");
367 368 369 370
                } elsif ($args_member =~ m/^remote_nonnull_domain_snapshot /) {
                    push(@vars_list, "virDomainPtr dom = NULL");
                    push(@vars_list, "virDomainSnapshotPtr snapshot = NULL");
                    push(@getters_list,
371
                         "    if (!(dom = get_nonnull_domain(priv->conn, args->snap.dom)))\n" .
372 373 374 375 376 377 378 379 380 381
                         "        goto cleanup;\n" .
                         "\n" .
                         "    if (!(snapshot = get_nonnull_domain_snapshot(dom, args->snap)))\n" .
                         "        goto cleanup;\n");
                    push(@args_list, "snapshot");
                    push(@free_list,
                         "    if (snapshot)\n" .
                         "        virDomainSnapshotFree(snapshot);\n" .
                         "    if (dom)\n" .
                         "        virDomainFree(dom);");
382
                } elsif ($args_member =~ m/^(?:remote_string|remote_uuid) (\S+)<\S+>;/) {
383
                    if (! @args_list) {
384
                        push(@args_list, "priv->conn");
385 386
                    }

387 388 389 390
                    push(@args_list, "args->$1.$1_val");
                    push(@args_list, "args->$1.$1_len");
                } elsif ($args_member =~ m/^(?:opaque|remote_nonnull_string) (\S+)<\S+>;(.*)$/) {
                    if (! @args_list) {
391
                        push(@args_list, "priv->conn");
392 393
                    }

394 395 396 397 398 399 400 401 402 403 404 405 406 407
                    my $cast = "";
                    my $arg_name = $1;
                    my $annotation = $2;

                    if ($annotation ne "") {
                        if ($annotation =~ m/\s*\/\*\s*(.*)\s*\*\//) {
                            $cast = $1;
                        } else {
                            die "malformed cast annotation for argument: $args_member";
                        }
                    }

                    push(@args_list, "${cast}args->$arg_name.${arg_name}_val");
                    push(@args_list, "args->$arg_name.${arg_name}_len");
408 409
                } elsif ($args_member =~ m/^(?:unsigned )?int (\S+)<\S+>;/) {
                    if (! @args_list) {
410
                        push(@args_list, "priv->conn");
411 412 413 414
                    }

                    push(@args_list, "args->$1.$1_val");
                    push(@args_list, "args->$1.$1_len");
415 416 417 418 419 420 421 422 423 424 425
                } elsif ($args_member =~ m/^remote_typed_param (\S+)<(\S+)>;/) {
                    push(@vars_list, "virTypedParameterPtr $1 = NULL");
                    push(@vars_list, "int n$1");
                    push(@args_list, "$1");
                    push(@args_list, "n$1");
                    push(@getters_list, "    if (($1 = remoteDeserializeTypedParameters(args->$1.$1_val,\n" .
                                        "                                                   args->$1.$1_len,\n" .
                                        "                                                   $2,\n" .
                                        "                                                   &n$1)) == NULL)\n" .
                                        "        goto cleanup;\n");
                    push(@free_list, "    VIR_FREE(params);");
426 427 428 429
                } elsif ($args_member =~ m/<\S+>;/ or $args_member =~ m/\[\S+\];/) {
                    # just make all other array types fail
                    die "unhandled type for argument value: $args_member";
                } elsif ($args_member =~ m/^remote_uuid (\S+);/) {
430
                    if (! @args_list) {
431
                        push(@args_list, "priv->conn");
432 433
                    }

434 435 436
                    push(@args_list, "(unsigned char *) args->$1");
                } elsif ($args_member =~ m/^remote_string (\S+);/) {
                    if (! @args_list) {
437
                        push(@args_list, "priv->conn");
438
                    }
439 440 441 442 443 444

                    push(@vars_list, "char *$1");
                    push(@optionals_list, "$1");
                    push(@args_list, "$1");
                } elsif ($args_member =~ m/^remote_nonnull_string (\S+);/) {
                    if (! @args_list) {
445
                        push(@args_list, "priv->conn");
446 447 448
                    }

                    push(@args_list, "args->$1");
449
                } elsif ($args_member =~ m/^(unsigned )?int (\S+);/) {
450
                    if (! @args_list) {
451
                        push(@args_list, "priv->conn");
452 453
                    }

454 455 456
                    push(@args_list, "args->$2");
                } elsif ($args_member =~ m/^(unsigned )?hyper (\S+);/) {
                    if (! @args_list) {
457
                        push(@args_list, "priv->conn");
458 459 460 461 462 463 464 465 466 467 468 469 470 471
                    }

                    my $arg_name = $2;

                    if (hyper_to_long($call->{ProcName}, "arg", $arg_name)) {
                        my $type_name = $1; $type_name .= "long";
                        my $sign = ""; $sign = "U" if ($1);

                        push(@vars_list, "$type_name $arg_name");
                        push(@getters_list, "    HYPER_TO_${sign}LONG($arg_name, args->$arg_name);\n");
                        push(@args_list, "$arg_name");
                    } else {
                        push(@args_list, "args->$arg_name");
                    }
472
                } elsif ($args_member =~ m/^(\/)?\*/) {
473 474 475
                    # ignore comments
                } else {
                    die "unhandled type for argument value: $args_member";
476 477 478 479
                }
            }
        }

480
        # handle return values of the function
481 482 483
        my $single_ret_var = "undefined";
        my $single_ret_by_ref = 0;
        my $single_ret_check = " == undefined";
484 485 486 487
        my $single_ret_as_list = 0;
        my $single_ret_list_name = "undefined";
        my $single_ret_list_max_var = "undefined";
        my $single_ret_list_max_define = "undefined";
488 489
        my $multi_ret = 0;

490
        if ($rettype ne "void" and
491
            scalar(@{$call->{ret_members}}) > 1) {
492 493
            $multi_ret = 1;
        }
494

495
        if ($rettype ne "void") {
496
            foreach my $ret_member (@{$call->{ret_members}}) {
497
                if ($multi_ret) {
498
                    if ($ret_member =~ m/^(unsigned )?(char|short|int|hyper) (\S+)\[\S+\];/) {
499 500 501 502
                        if ($2 eq "hyper" and hyper_to_long($call->{ProcName}, "ret", $3)) {
                            die "legacy [u]long hyper arrays aren't supported";
                        }

503 504 505
                        push(@ret_list, "memcpy(ret->$3, tmp.$3, sizeof ret->$3);");
                    } elsif ($ret_member =~ m/^(unsigned )?(char|short|int|hyper) (\S+);/) {
                        push(@ret_list, "ret->$3 = tmp.$3;");
506 507 508
                    } else {
                        die "unhandled type for multi-return-value: $ret_member";
                    }
509
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
510
                    push(@vars_list, "int len");
511
                    splice(@args_list, int($3), 0, ("ret->$1.$1_val"));
512
                    push(@ret_list, "ret->$1.$1_len = len;");
513
                    push(@free_list_on_error, "VIR_FREE(ret->$1.$1_val);");
514 515 516 517 518 519 520
                    $single_ret_var = "len";
                    $single_ret_by_ref = 0;
                    $single_ret_check = " < 0";
                    $single_ret_as_list = 1;
                    $single_ret_list_name = $1;
                    $single_ret_list_max_var = "max$1";
                    $single_ret_list_max_define = $2;
521 522 523
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+)<\S+>;/) {
                    # error out on unannotated arrays
                    die "remote_nonnull_string array without insert@<offset> annotation: $ret_member";
524
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+);/) {
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
                    if ($call->{ProcName} eq "GetType") {
                        # SPECIAL: virConnectGetType returns a constant string that must
                        #          not be freed. Therefore, duplicate the string here.
                        push(@vars_list, "const char *$1");
                        push(@ret_list, "/* We have to strdup because remoteDispatchClientRequest will");
                        push(@ret_list, " * free this string after it's been serialised. */");
                        push(@ret_list, "if (!(ret->type = strdup(type))) {");
                        push(@ret_list, "    virReportOOMError();");
                        push(@ret_list, "    goto cleanup;");
                        push(@ret_list, "}");
                    } else {
                        push(@vars_list, "char *$1");
                        push(@ret_list, "ret->$1 = $1;");
                    }

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
                    $single_ret_var = $1;
                    $single_ret_by_ref = 0;
                    $single_ret_check = " == NULL";
                } elsif ($ret_member =~ m/^remote_string (\S+);/) {
                    push(@vars_list, "char *$1 = NULL");
                    push(@vars_list, "char **$1_p = NULL");
                    push(@ret_list, "ret->$1 = $1_p;");
                    push(@free_list, "    VIR_FREE($1);");
                    push(@free_list_on_error, "VIR_FREE($1_p);");
                    push(@prepare_ret_list,
                         "if (VIR_ALLOC($1_p) < 0) {\n" .
                         "        virReportOOMError();\n" .
                         "        goto cleanup;\n" .
                         "    }\n" .
                         "    \n" .
                         "    *$1_p = strdup($1);\n" .
                         "    if (*$1_p == NULL) {\n" .
                         "        virReportOOMError();\n" .
                         "        goto cleanup;\n" .
                         "    }\n");

561 562 563
                    $single_ret_var = $1;
                    $single_ret_by_ref = 0;
                    $single_ret_check = " == NULL";
564
                } elsif ($ret_member =~ m/^remote_nonnull_(domain|network|storage_pool|storage_vol|interface|node_device|secret|nwfilter|domain_snapshot) (\S+);/) {
565 566
                    my $type_name = name_to_ProcName($1);

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
                    if ($call->{ProcName} eq "DomainCreateWithFlags") {
                        # SPECIAL: virDomainCreateWithFlags updates the given
                        #          domain object instead of returning a new one
                        push(@ret_list, "make_nonnull_$1(&ret->$2, $2);");
                        $single_ret_var = undef;
                        $single_ret_by_ref = 1;
                    } else {
                        push(@vars_list, "vir${type_name}Ptr $2 = NULL");
                        push(@ret_list, "make_nonnull_$1(&ret->$2, $2);");
                        push(@free_list,
                             "    if ($2)\n" .
                             "        vir${type_name}Free($2);");
                        $single_ret_var = $2;
                        $single_ret_by_ref = 0;
                        $single_ret_check = " == NULL";
                    }
583
                } elsif ($ret_member =~ m/^int (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
584
                    push(@vars_list, "int len");
585
                    splice(@args_list, int($3), 0, ("ret->$1.$1_val"));
586
                    push(@ret_list, "ret->$1.$1_len = len;");
587
                    push(@free_list_on_error, "VIR_FREE(ret->$1.$1_val);");
588 589 590 591 592 593 594
                    $single_ret_var = "len";
                    $single_ret_by_ref = 0;
                    $single_ret_check = " < 0";
                    $single_ret_as_list = 1;
                    $single_ret_list_name = $1;
                    $single_ret_list_max_var = "max$1";
                    $single_ret_list_max_define = $2;
595 596 597
                } elsif ($ret_member =~ m/^int (\S+)<\S+>;/) {
                    # error out on unannotated arrays
                    die "int array without insert@<offset> annotation: $ret_member";
598
                } elsif ($ret_member =~ m/^int (\S+);/) {
599 600 601 602
                    push(@vars_list, "int $1");
                    push(@ret_list, "ret->$1 = $1;");
                    $single_ret_var = $1;

603
                    if ($call->{ProcName} =~ m/GetAutostart$/) {
604 605 606
                        $single_ret_by_ref = 1;
                    } else {
                        $single_ret_by_ref = 0;
607

608
                        if ($call->{ProcName} eq "CPUCompare") {
609 610 611 612
                            $single_ret_check = " == VIR_CPU_COMPARE_ERROR";
                        } else {
                            $single_ret_check = " < 0";
                        }
613
                    }
614
                } elsif ($ret_member =~ m/^(?:unsigned )?hyper (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
615 616 617 618
                    if (hyper_to_long($call->{ProcName}, "ret", $1)) {
                        die "legacy [u]long hyper arrays aren't supported";
                    }

619 620
                    push(@vars_list, "int len");
                    push(@ret_list, "ret->$1.$1_len = len;");
621
                    push(@free_list_on_error, "VIR_FREE(ret->$1.$1_val);");
622 623 624 625
                    $single_ret_var = "len";
                    $single_ret_by_ref = 0;
                    $single_ret_as_list = 1;
                    $single_ret_list_name = $1;
626
                    $single_ret_list_max_var = "max$1";
627 628
                    $single_ret_list_max_define = $2;

629
                    if ($call->{ProcName} eq "NodeGetCellsFreeMemory") {
630
                        $single_ret_check = " <= 0";
631
                        splice(@args_list, int($3), 0, ("(unsigned long long *)ret->$1.$1_val"));
632 633
                    } else {
                        $single_ret_check = " < 0";
634
                        splice(@args_list, int($3), 0, ("ret->$1.$1_val"));
635
                    }
636
                } elsif ($ret_member =~ m/^(?:unsigned )?hyper (\S+)<\S+>;/) {
637 638
                    # error out on unannotated arrays
                    die "hyper array without insert@<offset> annotation: $ret_member";
639
                } elsif ($ret_member =~ m/^(unsigned )?hyper (\S+);/) {
640
                    my $type_name = $1;
641
                    my $ret_name = $2;
642
                    my $ret_assign;
643

644 645 646 647 648 649 650 651 652
                    if (hyper_to_long($call->{ProcName}, "ret", $ret_name)) {
                        my $sign = ""; $sign = "U" if ($1);

                        $type_name .= "long";
                        $ret_assign = "HYPER_TO_${sign}LONG(ret->$ret_name, $ret_name);";
                    } else {
                        $type_name .= "long long";
                        $ret_assign = "ret->$ret_name = $ret_name;";
                    }
653 654

                    push(@vars_list, "$type_name $ret_name");
655
                    push(@ret_list, $ret_assign);
656
                    $single_ret_var = $ret_name;
657

658 659
                    if ($call->{ProcName} eq "DomainGetMaxMemory" or
                        $call->{ProcName} eq "NodeGetFreeMemory") {
660 661 662
                        # SPECIAL: virDomainGetMaxMemory and virNodeGetFreeMemory
                        #          return the actual value directly and 0 indicates
                        #          an error
663 664 665 666 667
                        $single_ret_by_ref = 0;
                        $single_ret_check = " == 0";
                    } else {
                        $single_ret_by_ref = 1;
                    }
668 669 670 671 672 673 674 675 676 677 678 679
                } elsif ($ret_member =~ m/^opaque (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
                    push(@vars_list, "char *$1 = NULL");
                    push(@vars_list, "int $1_len = 0");
                    splice(@args_list, int($3), 0, ("&$1", "&$1_len"));
                    push(@ret_list, "ret->$1.$1_val = $1;");
                    push(@ret_list, "ret->$1.$1_len = $1_len;");
                    push(@free_list_on_error, "VIR_FREE($1);");
                    $single_ret_var = undef;
                    $single_ret_by_ref = 1;
                } elsif ($ret_member =~ m/^opaque (\S+)<\S+>;/) {
                    # error out on unannotated arrays
                    die "opaque array without insert@<offset> annotation: $ret_member";
680 681
                } elsif ($ret_member =~ m/^(\/)?\*/) {
                    # ignore comments
682 683
                } else {
                    die "unhandled type for return value: $ret_member";
684 685 686 687
                }
            }
        }

688
        # select struct type for multi-return-value functions
689
        if ($multi_ret) {
690 691 692 693
            if (!(defined $call->{ret_offset})) {
                die "multi-return-value without insert@<offset> annotation: $call->{ret}";
            }

694 695
            if (! @args_list) {
                push(@args_list, "priv->conn");
696 697
            }

698
            my $struct_name = $call->{ProcName};
699 700
            $struct_name =~ s/Get//;

701 702 703 704
            splice(@args_list, $call->{ret_offset}, 0, ("&tmp"));

            if ($call->{ProcName} eq "DomainBlockStats" ||
                $call->{ProcName} eq "DomainInterfaceStats") {
705 706 707
                # SPECIAL: virDomainBlockStats and virDomainInterfaceStats
                #          have a 'Struct' suffix on the actual struct name
                #          and take the struct size as additional argument
708
                $struct_name .= "Struct";
709
                splice(@args_list, $call->{ret_offset} + 1, 0, ("sizeof tmp"));
710 711 712 713 714
            }

            push(@vars_list, "vir$struct_name tmp");
        }

715
        if ($call->{streamflag} ne "none") {
716
            splice(@args_list, $call->{streamoffset}, 0, ("st"));
717
            push(@free_list_on_error, "if (stream) {");
718 719 720 721
            push(@free_list_on_error, "    virStreamAbort(st);");
            push(@free_list_on_error, "    daemonFreeClientStream(client, stream);");
            push(@free_list_on_error, "} else {");
            push(@free_list_on_error, "    virStreamFree(st);");
722 723 724
            push(@free_list_on_error, "}");
        }

725
        # print functions signature
726 727 728 729 730 731 732 733 734 735 736 737
	print "static int $name(\n";
	print "    virNetServerPtr server ATTRIBUTE_UNUSED,\n";
	print "    virNetServerClientPtr client,\n";
	print "    virNetMessageHeaderPtr hdr ATTRIBUTE_UNUSED,\n";
	print "    virNetMessageErrorPtr rerr";
        if ($argtype ne "void") {
	    print ",\n    $argtype *args";
	}
        if ($rettype ne "void") {
	    print ",\n    $rettype *ret";
	}
	print ")\n";
738 739 740 741 742

        # print function body
        print "{\n";
        print "    int rv = -1;\n";

743 744 745
        foreach my $var (@vars_list) {
            print "    $var;\n";
        }
746 747
	print "    struct daemonClientPrivate *priv =\n";
        print "        virNetServerClientGetPrivateData(client);\n";
748

749
        if ($call->{streamflag} ne "none") {
750 751
            print "    virStreamPtr st = NULL;\n";
            print "    daemonClientStreamPtr stream = NULL;\n";
752 753
        }

754
        print "\n";
755
        print "    if (!priv->conn) {\n";
756 757 758 759 760
        print "        virNetError(VIR_ERR_INTERNAL_ERROR, \"%s\", _(\"connection not open\"));\n";
        print "        goto cleanup;\n";
        print "    }\n";
        print "\n";

761 762 763 764 765 766 767 768 769
        if ($single_ret_as_list) {
            print "    if (args->$single_ret_list_max_var > $single_ret_list_max_define) {\n";
            print "        virNetError(VIR_ERR_INTERNAL_ERROR,\n";
            print "                    \"%s\", _(\"max$single_ret_list_name > $single_ret_list_max_define\"));\n";
            print "        goto cleanup;\n";
            print "    }\n";
            print "\n";
        }

770 771
        print join("\n", @getters_list);

772 773 774
        if (@getters_list) {
            print "\n";
        }
775

776 777 778 779 780 781 782 783
        foreach my $optional (@optionals_list) {
            print "    $optional = args->$optional ? *args->$optional : NULL;\n";
        }

        if (@optionals_list) {
            print "\n";
        }

784
        if ($call->{streamflag} ne "none") {
785 786 787 788
            print "    if (!(st = virStreamNew(priv->conn, VIR_STREAM_NONBLOCK)))\n";
            print "        goto cleanup;\n";
            print "\n";
            print "    if (!(stream = daemonCreateClientStream(client, st, remoteProgram, hdr)))\n";
789 790 791 792
            print "        goto cleanup;\n";
            print "\n";
        }

793
        if ($rettype eq "void") {
794
            print "    if (vir$call->{ProcName}(";
795 796 797 798
            print join(', ', @args_list);
            print ") < 0)\n";
            print "        goto cleanup;\n";
            print "\n";
799
        } elsif (!$multi_ret) {
800
            my $prefix = "";
801
            my $proc_name = $call->{ProcName};
802 803

            if (! @args_list) {
804
                push(@args_list, "priv->conn");
805

806
                if ($call->{ProcName} ne "NodeGetFreeMemory") {
807 808
                    $prefix = "Connect"
                }
809 810
            }

811 812 813 814 815 816
            if ($call->{ProcName} eq "GetSysinfo" or
                $call->{ProcName} eq "GetMaxVcpus" or
                $call->{ProcName} eq "DomainXMLFromNative" or
                $call->{ProcName} eq "DomainXMLToNative" or
                $call->{ProcName} eq "FindStoragePoolSources" or
                $call->{ProcName} =~ m/^List/) {
817
                $prefix = "Connect"
818
            } elsif ($call->{ProcName} eq "SupportsFeature") {
819
                $prefix = "Drv"
820
            } elsif ($call->{ProcName} eq "CPUBaseline") {
821
                $proc_name = "ConnectBaselineCPU"
822
            } elsif ($call->{ProcName} eq "CPUCompare") {
823
                $proc_name = "ConnectCompareCPU"
824 825
            } elsif ($structprefix eq "qemu" && $call->{ProcName} =~ /^Domain/) {
                $proc_name =~ s/^(Domain)/${1}Qemu/;
826 827
            }

828 829 830 831 832 833 834 835 836 837
            if ($single_ret_as_list) {
                print "    /* Allocate return buffer. */\n";
                print "    if (VIR_ALLOC_N(ret->$single_ret_list_name.${single_ret_list_name}_val," .
                      " args->$single_ret_list_max_var) < 0) {\n";
                print "        virReportOOMError();\n";
                print "        goto cleanup;\n";
                print "    }\n";
                print "\n";
            }

838 839 840
            if ($single_ret_by_ref) {
                print "    if (vir$prefix$proc_name(";
                print join(', ', @args_list);
841 842 843 844 845 846

                if (defined $single_ret_var) {
                    print ", &$single_ret_var";
                }

                print ") < 0)\n";
847 848 849 850 851 852 853 854
            } else {
                print "    if (($single_ret_var = vir$prefix$proc_name(";
                print join(', ', @args_list);
                print "))$single_ret_check)\n";
            }

            print "        goto cleanup;\n";
            print "\n";
855
        } else {
856
            print "    if (vir$call->{ProcName}(";
857 858 859 860
            print join(', ', @args_list);
            print ") < 0)\n";
            print "        goto cleanup;\n";
            print "\n";
861
        }
862

863
        if ($call->{streamflag} ne "none") {
864
            print "    if (daemonAddClientStream(client, stream, ";
865 866

            if ($call->{streamflag} eq "write") {
867
                print "false";
868
            } else {
869
                print "true";
870 871
            }

872 873 874 875 876
            print ") < 0)\n";
            print "        goto cleanup;\n";
            print "\n";
        }

877 878 879 880 881 882
        if (@prepare_ret_list) {
            print "    ";
            print join("\n    ", @prepare_ret_list);
            print "\n";
        }

883 884
        if (@ret_list) {
            print "    ";
885
            print join("\n    ", @ret_list);
886
            print "\n";
887 888 889 890 891
        }

        print "    rv = 0;\n";
        print "\n";
        print "cleanup:\n";
892 893 894 895 896 897 898 899 900 901 902 903 904
        print "    if (rv < 0)";

        if (scalar(@free_list_on_error) > 1) {
            print " {";
        }

        print "\n        ";
        print join("\n        ", @free_list_on_error);
        print "\n";

        if (scalar(@free_list_on_error) > 1) {
            print "    }\n";
        }
905 906 907

        print join("\n", @free_list);

908 909 910 911
        if (@free_list) {
            print "\n";
        }

912
        print "    return rv;\n";
913
        print "}\n\n\n\n";
914
    }
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952


    # Finally we write out the huge dispatch table which lists
    # the dispatch helper method. the XDR proc for processing
    # args and return values, and the size of the args and
    # return value structs. All methods are marked as requiring
    # authentication. Methods are selectively relaxed in the
    # daemon code which registers the program.

    print "virNetServerProgramProc ${structprefix}Procs[] = {\n";
    for ($id = 0 ; $id <= $#calls ; $id++) {
	my ($comment, $name, $argtype, $arglen, $argfilter, $retlen, $retfilter);

	if (defined $calls[$id] && !$calls[$id]->{msg}) {
	    $comment = "/* Method $calls[$id]->{ProcName} => $id */";
	    $name = $structprefix . "Dispatch" . $calls[$id]->{ProcName} . "Helper";
	    my $argtype = $calls[$id]->{args};
	    my $rettype = $calls[$id]->{ret};
	    $arglen = $argtype ne "void" ? "sizeof($argtype)" : "0";
	    $retlen = $rettype ne "void" ? "sizeof($rettype)" : "0";
	    $argfilter = $argtype ne "void" ? "xdr_$argtype" : "xdr_void";
	    $retfilter = $rettype ne "void" ? "xdr_$rettype" : "xdr_void";
	} else {
	    if ($calls[$id]->{msg}) {
		$comment = "/* Async event $calls[$id]->{ProcName} => $id */";
	    } else {
		$comment = "/* Unused $id */";
	    }
	    $name = "NULL";
	    $arglen = $retlen = 0;
	    $argfilter = "xdr_void";
	    $retfilter = "xdr_void";
	}

	print "{ $comment\n   ${name},\n   $arglen,\n   (xdrproc_t)$argfilter,\n   $retlen,\n   (xdrproc_t)$retfilter,\n   true \n},\n";
    }
    print "};\n";
    print "size_t ${structprefix}NProcs = ARRAY_CARDINALITY(${structprefix}Procs);\n";
953
}
954

955
# Bodies for client functions ("remote_client_bodies.h").
956
elsif ($opt_k) {
957
    my %generate = map { $_ => 1 } @autogen;
958 959 960 961 962 963 964 965
    my @keys = sort (keys %calls);

    foreach (@keys) {
        my $call = $calls{$_};

        # skip things which are REMOTE_MESSAGE
        next if $call->{msg};

966 967
        # skip procedures not on generate list
        next if ! exists($generate{$call->{ProcName}});
968

969 970 971
	my $argtype = $call->{args};
	my $rettype = $call->{ret};

972
        # handle arguments to the function
973 974
        my @args_list = ();
        my @vars_list = ();
975
        my @args_check_list = ();
976
        my @setters_list = ();
977
        my @setters_list2 = ();
978 979
        my $priv_src = "conn";
        my $priv_name = "privateData";
980
        my $call_args = "&args";
981

982
        if ($argtype eq "void") {
983
            $call_args = "NULL";
984
        } else {
985
            push(@vars_list, "$argtype args");
986 987 988 989 990

            my $is_first_arg = 1;
            my $has_node_device = 0;

            # node device is special
991 992 993
            if ($argtype =~ m/^remote_node_/ and
                !($argtype =~ m/^remote_node_device_lookup_by_name_/) and
                !($argtype =~ m/^remote_node_device_create_xml_/)) {
994
                $has_node_device = 1;
995
                $priv_name = "devMonPrivateData";
996 997 998 999 1000 1001 1002 1003 1004
            }

            foreach my $args_member (@{$call->{args_members}}) {
                if ($args_member =~ m/^remote_nonnull_string name;/ and $has_node_device) {
                    $priv_src = "dev->conn";
                    push(@args_list, "virNodeDevicePtr dev");
                    push(@setters_list, "args.name = dev->name;");
                } elsif ($args_member =~ m/^remote_nonnull_(domain|network|storage_pool|storage_vol|interface|secret|nwfilter|domain_snapshot) (\S+);/) {
                    my $name = $1;
1005
                    my $arg_name = $2;
1006 1007 1008 1009
                    my $type_name = name_to_ProcName($name);

                    if ($is_first_arg) {
                        if ($name eq "domain_snapshot") {
1010
                            $priv_src = "$arg_name->domain->conn";
1011
                        } else {
1012
                            $priv_src = "$arg_name->conn";
1013 1014 1015 1016 1017 1018 1019 1020 1021
                        }

                        if ($name =~ m/^storage_/) {
                            $priv_name = "storagePrivateData";
                        } elsif (!($name =~ m/^domain/)) {
                            $priv_name = "${name}PrivateData";
                        }
                    }

1022 1023 1024 1025 1026
                    push(@args_list, "vir${type_name}Ptr $arg_name");
                    push(@setters_list, "make_nonnull_$1(&args.$arg_name, $arg_name);");
                } elsif ($args_member =~ m/^remote_uuid (\S+);/) {
                    push(@args_list, "const unsigned char *$1");
                    push(@setters_list, "memcpy(args.$1, $1, VIR_UUID_BUFLEN);");
1027 1028 1029
                } elsif ($args_member =~ m/^remote_string (\S+);/) {
                    push(@args_list, "const char *$1");
                    push(@setters_list, "args.$1 = $1 ? (char **)&$1 : NULL;");
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
                } elsif ($args_member =~ m/^remote_nonnull_string (\S+)<(\S+)>;(.*)$/) {
                    my $type_name = "const char **";
                    my $arg_name = $1;
                    my $limit = $2;
                    my $annotation = $3;

                    if ($annotation ne "") {
                        if ($annotation =~ m/\s*\/\*\s*\((.*)\)\s*\*\//) {
                            $type_name = $1;
                        } else {
                            die "malformed cast annotation for argument: $args_member";
                        }
                    }

                    push(@args_list, "$type_name$arg_name");
                    push(@args_list, "unsigned int ${arg_name}len");
                    push(@setters_list, "args.$arg_name.${arg_name}_val = (char **)$arg_name;");
                    push(@setters_list, "args.$arg_name.${arg_name}_len = ${arg_name}len;");
                    push(@args_check_list, { name => "\"$arg_name\"", arg => "${arg_name}len", limit => $2 });
1049 1050 1051
                } elsif ($args_member =~ m/^remote_nonnull_string (\S+);/) {
                    push(@args_list, "const char *$1");
                    push(@setters_list, "args.$1 = (char *)$1;");
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
                } elsif ($args_member =~ m/^opaque (\S+)<(\S+)>;(.*)$/) {
                    my $type_name = "const char *";
                    my $arg_name = $1;
                    my $limit = $2;
                    my $annotation = $3;

                    if ($annotation ne "") {
                        if ($annotation =~ m/\s*\/\*\s*\((.*)\)\s*\*\//) {
                            $type_name = $1;
                        } else {
                            die "malformed cast annotation for argument: $args_member";
                        }
                    }

                    push(@args_list, "$type_name$arg_name");
1067

1068
                    if ($call->{ProcName} eq "SecretSetValue") {
1069
                        # SPECIAL: virSecretSetValue uses size_t instead of int
1070
                        push(@args_list, "size_t ${arg_name}len");
1071
                    } else {
1072
                        push(@args_list, "int ${arg_name}len");
1073 1074
                    }

1075 1076 1077 1078 1079 1080 1081 1082 1083
                    push(@setters_list, "args.$arg_name.${arg_name}_val = (char *)$arg_name;");
                    push(@setters_list, "args.$arg_name.${arg_name}_len = ${arg_name}len;");
                    push(@args_check_list, { name => "\"$arg_name\"", arg => "${arg_name}len", limit => $limit });
                } elsif ($args_member =~ m/^remote_string (\S+)<(\S+)>;/) {
                    my $arg_name = $1;
                    my $limit = $2;

                    push(@args_list, "const char *$arg_name");
                    push(@args_list, "int ${arg_name}len");
1084 1085 1086
                    push(@setters_list, "args.$arg_name.${arg_name}_val = (char *)$arg_name;");
                    push(@setters_list, "args.$arg_name.${arg_name}_len = ${arg_name}len;");
                    push(@args_check_list, { name => "\"$arg_name\"", arg => "${arg_name}len", limit => $limit });
1087 1088 1089 1090 1091 1092
                } elsif ($args_member =~ m/^((?:unsigned )?int) (\S+)<(\S+)>;/) {
                    my $type_name = $1;
                    my $arg_name = $2;
                    my $limit = $3;

                    push(@args_list, "${type_name} *$arg_name");
1093
                    push(@args_list, "int ${arg_name}len");
1094 1095 1096
                    push(@setters_list, "args.$arg_name.${arg_name}_val = $arg_name;");
                    push(@setters_list, "args.$arg_name.${arg_name}_len = ${arg_name}len;");
                    push(@args_check_list, { name => "\"$arg_name\"", arg => "${arg_name}len", limit => $limit });
1097 1098 1099 1100 1101 1102 1103
                } elsif ($args_member =~ m/^remote_typed_param (\S+)<(\S+)>;/) {
                    push(@args_list, "virTypedParameterPtr $1");
                    push(@args_list, "int n$1");
                    push(@setters_list2, "if (remoteSerializeTypedParameters($1, n$1, &args.$1.$1_val, &args.$1.$1_len) < 0) {\n" .
                                         "        xdr_free((xdrproc_t)xdr_$call->{args}, (char *)&args);\n" .
                                         "        goto done;\n" .
                                         "    }");
1104 1105
                } elsif ($args_member =~ m/^((?:unsigned )?int) (\S+);\s*\/\*\s*call-by-reference\s*\*\//) {
                    my $type_name = "$1 *";
1106 1107 1108 1109
                    my $arg_name = $2;

                    push(@args_list, "$type_name $arg_name");
                    push(@setters_list, "args.$arg_name = *$arg_name;");
1110 1111
                } elsif ($args_member =~ m/^((?:unsigned )?int) (\S+);/) {
                    my $type_name = $1;
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
                    my $arg_name = $2;

                    push(@args_list, "$type_name $arg_name");
                    push(@setters_list, "args.$arg_name = $arg_name;");
                } elsif ($args_member =~ m/^(unsigned )?hyper (\S+);/) {
                    my $type_name = $1;
                    my $arg_name = $2;

                    if (hyper_to_long($call->{ProcName}, "arg", $arg_name)) {
                        $type_name .= "long";
                    } else {
                        $type_name .= "long long";
1124 1125 1126 1127
                    }

                    push(@args_list, "$type_name $arg_name");
                    push(@setters_list, "args.$arg_name = $arg_name;");
1128
                } elsif ($args_member =~ m/^(\/)?\*/) {
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
                    # ignore comments
                } else {
                    die "unhandled type for argument value: $args_member";
                }

                if ($is_first_arg and $priv_src eq "conn") {
                    unshift(@args_list, "virConnectPtr conn");
                }

                $is_first_arg = 0;
            }
        }

1142 1143 1144 1145
        if (! @args_list) {
            push(@args_list, "virConnectPtr conn");
        }

1146 1147
        # fix priv_name for the NumOf* functions
        if ($priv_name eq "privateData" and
1148 1149 1150
            !($call->{ProcName} =~ m/(Domains|DomainSnapshot)/) and
            ($call->{ProcName} =~ m/NumOf(Defined|Domain)*(\S+)s/ or
             $call->{ProcName} =~ m/List(Defined|Domain)*(\S+)s/)) {
1151 1152 1153 1154 1155
            my $prefix = lc $2;
            $prefix =~ s/(pool|vol)$//;
            $priv_name = "${prefix}PrivateData";
        }

1156 1157
        # handle return values of the function
        my @ret_list = ();
1158
        my @ret_list2 = ();
1159 1160 1161
        my $call_ret = "&ret";
        my $single_ret_var = "int rv = -1";
        my $single_ret_type = "int";
1162 1163 1164 1165 1166
        my $single_ret_as_list = 0;
        my $single_ret_list_error_msg_type = "undefined";
        my $single_ret_list_name = "undefined";
        my $single_ret_list_max_var = "undefined";
        my $single_ret_list_max_define = "undefined";
1167
        my $single_ret_cleanup = 0;
1168 1169
        my $multi_ret = 0;

1170
        if ($rettype ne "void" and
1171 1172 1173 1174
            scalar(@{$call->{ret_members}}) > 1) {
            $multi_ret = 1;
        }

1175
        if ($rettype eq "void") {
1176
            $call_ret = "NULL";
1177
        } else {
1178
            push(@vars_list, "$rettype ret");
1179 1180

            foreach my $ret_member (@{$call->{ret_members}}) {
1181
                if ($multi_ret) {
1182
                    if ($ret_member =~ m/^(unsigned )?(char|short|int|hyper) (\S+)\[\S+\];/) {
1183 1184 1185 1186
                        if ($2 eq "hyper" and hyper_to_long($call->{ProcName}, "ret", $3)) {
                            die "legacy [u]long hyper arrays aren't supported";
                        }

1187 1188 1189
                        push(@ret_list, "memcpy(result->$3, ret.$3, sizeof result->$3);");
                    } elsif ($ret_member =~ m/<\S+>;/ or $ret_member =~ m/\[\S+\];/) {
                        # just make all other array types fail
1190 1191
                        die "unhandled type for multi-return-value for " .
                            "procedure $call->{name}: $ret_member";
1192
                    } elsif ($ret_member =~ m/^(unsigned )?(char|short|int|hyper) (\S+);/) {
1193 1194 1195 1196 1197 1198 1199
                        if ($2 eq "hyper" and hyper_to_long($call->{ProcName}, "ret", $3)) {
                            my $sign = ""; $sign = "U" if ($1);

                            push(@ret_list, "HYPER_TO_${sign}LONG(result->$3, ret.$3);");
                        } else {
                            push(@ret_list, "result->$3 = ret.$3;");
                        }
1200
                    } else {
1201 1202
                        die "unhandled type for multi-return-value for " .
                            "procedure $call->{name}: $ret_member";
1203
                    }
1204 1205 1206 1207 1208
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
                    splice(@args_list, int($3), 0, ("char **const $1"));
                    push(@ret_list, "rv = ret.$1.$1_len;");
                    $single_ret_var = "int rv = -1";
                    $single_ret_type = "int";
1209 1210 1211 1212
                    $single_ret_as_list = 1;
                    $single_ret_list_name = $1;
                    $single_ret_list_max_var = "max$1";
                    $single_ret_list_max_define = $2;
1213 1214 1215
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+)<\S+>;/) {
                    # error out on unannotated arrays
                    die "remote_nonnull_string array without insert@<offset> annotation: $ret_member";
1216
                } elsif ($ret_member =~ m/^remote_nonnull_string (\S+);/) {
1217 1218 1219
                    push(@ret_list, "rv = ret.$1;");
                    $single_ret_var = "char *rv = NULL";
                    $single_ret_type = "char *";
1220 1221 1222 1223 1224
                } elsif ($ret_member =~ m/^remote_string (\S+);/) {
                    push(@ret_list, "rv = ret.$1 ? *ret.$1 : NULL;");
                    push(@ret_list, "VIR_FREE(ret.$1);");
                    $single_ret_var = "char *rv = NULL";
                    $single_ret_type = "char *";
1225
                } elsif ($ret_member =~ m/^remote_nonnull_(domain|network|storage_pool|storage_vol|node_device|interface|secret|nwfilter|domain_snapshot) (\S+);/) {
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
                    my $name = $1;
                    my $arg_name = $2;
                    my $type_name = name_to_ProcName($name);

                    if ($name eq "node_device") {
                        $priv_name = "devMonPrivateData";
                    } elsif ($name =~ m/^storage_/) {
                        $priv_name = "storagePrivateData";
                    } elsif (!($name =~ m/^domain/)) {
                        $priv_name = "${name}PrivateData";
                    }

1238 1239 1240 1241 1242 1243 1244 1245
                    if ($call->{ProcName} eq "DomainCreateWithFlags") {
                        # SPECIAL: virDomainCreateWithFlags updates the given
                        #          domain object instead of returning a new one
                        push(@ret_list, "dom->id = ret.dom.id;");
                        push(@ret_list, "xdr_free((xdrproc_t)xdr_$call->{ret}, (char *)&ret);");
                        push(@ret_list, "rv = 0;");
                        $single_ret_var = "int rv = -1";
                        $single_ret_type = "int";
1246
                    } else {
1247 1248 1249 1250 1251
                        if ($name eq "domain_snapshot") {
                            push(@ret_list, "rv = get_nonnull_$name(dom, ret.$arg_name);");
                        } else {
                            push(@ret_list, "rv = get_nonnull_$name($priv_src, ret.$arg_name);");
                        }
1252

1253
                        push(@ret_list, "xdr_free((xdrproc_t)xdr_$rettype, (char *)&ret);");
1254 1255 1256
                        $single_ret_var = "vir${type_name}Ptr rv = NULL";
                        $single_ret_type = "vir${type_name}Ptr";
                    }
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
                } elsif ($ret_member =~ m/^remote_typed_param (\S+)<(\S+)>;\s*\/\*\s*insert@(\d+)\s*\*\//) {
                    splice(@args_list, int($3), 0, ("virTypedParameterPtr $1"));
                    push(@ret_list2, "if (remoteDeserializeTypedParameters(ret.$1.$1_val,\n" .
                                     "                                         ret.$1.$1_len,\n" .
                                     "                                         $2,\n" .
                                     "                                         $1,\n" .
                                     "                                         n$1) < 0)\n" .
                                     "        goto cleanup;\n");
                    $single_ret_cleanup = 1;
                } elsif ($ret_member =~ m/^remote_typed_param (\S+)<\S+>;/) {
                    # error out on unannotated arrays
                    die "remote_typed_param array without insert@<offset> annotation: $ret_member";
1269
                } elsif ($ret_member =~ m/^int (\S+);/) {
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
                    my $arg_name = $1;

                    if ($call->{ProcName} =~ m/GetAutostart$/) {
                        push(@args_list, "int *$arg_name");
                        push(@ret_list, "if ($arg_name) *$arg_name = ret.$arg_name;");
                        push(@ret_list, "rv = 0;");
                    } else {
                        push(@ret_list, "rv = ret.$arg_name;");
                    }

1280 1281
                    $single_ret_var = "int rv = -1";
                    $single_ret_type = "int";
1282
                } elsif ($ret_member =~ m/^unsigned hyper (\S+);/) {
1283
                    my $ret_name = $1;
1284

1285
                    if ($call->{ProcName} =~ m/Get(Lib)?Version/) {
1286 1287
                        push(@args_list, "unsigned long *$ret_name");
                        push(@ret_list, "if ($ret_name) HYPER_TO_ULONG(*$ret_name, ret.$ret_name);");
1288 1289 1290
                        push(@ret_list, "rv = 0;");
                        $single_ret_var = "int rv = -1";
                        $single_ret_type = "int";
1291 1292
                    } elsif (hyper_to_long($call->{ProcName}, "ret", $ret_name)) {
                        push(@ret_list, "HYPER_TO_ULONG(rv, ret.$ret_name);");
1293 1294
                        $single_ret_var = "unsigned long rv = 0";
                        $single_ret_type = "unsigned long";
1295 1296 1297 1298
                    } else {
                        push(@ret_list, "rv = ret.$ret_name;");
                        $single_ret_var = "unsigned long long rv = 0";
                        $single_ret_type = "unsigned long long";
1299
                    }
1300 1301
                } elsif ($ret_member =~ m/^(\/)?\*/) {
                    # ignore comments
1302
                } else {
1303 1304
                    die "unhandled type for return value for procedure " .
                        "$call->{name}: $ret_member";
1305 1306 1307 1308
                }
            }
        }

1309 1310
        # select struct type for multi-return-value functions
        if ($multi_ret) {
1311 1312
            if (!(defined $call->{ret_offset})) {
                die "multi-return-value without insert@<offset> annotation: $call->{ret}";
1313 1314
            }

1315 1316
            my $struct_name = $call->{ProcName};
            $struct_name =~ s/Get//;
1317

1318
            splice(@args_list, $call->{ret_offset}, 0, ("vir${struct_name}Ptr result"));
1319 1320
        }

1321 1322 1323 1324
        if ($call->{streamflag} ne "none") {
            splice(@args_list, $call->{streamoffset}, 0, ("virStreamPtr st"));
        }

1325 1326
        # print function
        print "\n";
1327
        print "static $single_ret_type\n";
1328
        print "$structprefix$call->{ProcName}(";
1329 1330 1331 1332 1333

        print join(", ", @args_list);

        print ")\n";
        print "{\n";
1334
        print "    $single_ret_var;\n";
1335 1336 1337 1338 1339 1340
        print "    struct private_data *priv = $priv_src->$priv_name;\n";

        foreach my $var (@vars_list) {
            print "    $var;\n";
        }

1341 1342 1343 1344
        if ($single_ret_as_list) {
            print "    int i;\n";
        }

1345
        if ($call->{streamflag} ne "none") {
1346
            print "    virNetClientStreamPtr netst = NULL;\n";
1347 1348
        }

1349 1350 1351
        print "\n";
        print "    remoteDriverLock(priv);\n";

1352 1353
        if ($call->{streamflag} ne "none") {
            print "\n";
1354
            print "    if (!(netst = virNetClientStreamNew(priv->remoteProgram, REMOTE_PROC_$call->{UC_NAME}, priv->counter)))\n";
1355
            print "        goto done;\n";
1356
            print "\n";
1357 1358 1359
            print "    if (virNetClientAddStream(priv->client, netst) < 0) {\n";
            print "        virNetClientStreamFree(netst);\n";
            print "        goto done;\n";
1360 1361
            print "    }";
            print "\n";
1362
            print "    st->driver = &remoteStreamDrv;\n";
1363
            print "    st->privateData = netst;\n";
1364 1365
        }

1366 1367 1368 1369 1370 1371 1372 1373 1374
        if ($call->{ProcName} eq "SupportsFeature") {
            # SPECIAL: VIR_DRV_FEATURE_REMOTE feature is handled directly
            print "\n";
            print "    if (feature == VIR_DRV_FEATURE_REMOTE) {\n";
            print "        rv = 1;\n";
            print "        goto done;\n";
            print "    }\n";
        }

1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
        foreach my $args_check (@args_check_list) {
            print "\n";
            print "    if ($args_check->{arg} > $args_check->{limit}) {\n";
            print "        remoteError(VIR_ERR_RPC,\n";
            print "                    _(\"%s length greater than maximum: %d > %d\"),\n";
            print "                    $args_check->{name}, (int)$args_check->{arg}, $args_check->{limit});\n";
            print "        goto done;\n";
            print "    }\n";
        }

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
        if ($single_ret_as_list) {
            print "\n";
            print "    if ($single_ret_list_max_var > $single_ret_list_max_define) {\n";
            print "        remoteError(VIR_ERR_RPC,\n";
            print "                    _(\"too many remote ${single_ret_list_error_msg_type}s: %d > %d\"),\n";
            print "                    $single_ret_list_max_var, $single_ret_list_max_define);\n";
            print "        goto done;\n";
            print "    }\n";
        }

1395
        if (@setters_list) {
1396
            print "\n";
1397 1398 1399 1400 1401 1402 1403 1404 1405
            print "    ";
        }

        print join("\n    ", @setters_list);

        if (@setters_list) {
            print "\n";
        }

1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
        if (@setters_list2) {
            print "\n";
            print "    ";
        }

        print join("\n    ", @setters_list2);

        if (@setters_list2) {
            print "\n";
        }

1417
        if ($rettype ne "void") {
1418 1419 1420 1421
            print "\n";
            print "    memset(&ret, 0, sizeof ret);\n";
        }

1422 1423 1424 1425 1426
        my $callflags = "0";
        if ($structprefix eq "qemu") {
            $callflags = "REMOTE_CALL_QEMU";
        }

1427
        print "\n";
1428
        print "    if (call($priv_src, priv, $callflags, ${procprefix}_PROC_$call->{UC_NAME},\n";
1429 1430
        print "             (xdrproc_t)xdr_$argtype, (char *)$call_args,\n";
        print "             (xdrproc_t)xdr_$rettype, (char *)$call_ret) == -1) {\n";
1431 1432

        if ($call->{streamflag} ne "none") {
1433 1434
            print "        virNetClientRemoveStream(priv->client, netst);\n";
            print "        virNetClientStreamFree(netst);\n";
1435 1436
        }

1437
        print "        goto done;\n";
1438
        print "    }\n";
1439
        print "\n";
1440

1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
        if ($single_ret_as_list) {
            print "    if (ret.$single_ret_list_name.${single_ret_list_name}_len > $single_ret_list_max_var) {\n";
            print "        remoteError(VIR_ERR_RPC,\n";
            print "                    _(\"too many remote ${single_ret_list_error_msg_type}s: %d > %d\"),\n";
            print "                    ret.$single_ret_list_name.${single_ret_list_name}_len, $single_ret_list_max_var);\n";
            print "        goto cleanup;\n";
            print "    }\n";
            print "\n";
            print "    /* This call is caller-frees (although that isn't clear from\n";
            print "     * the documentation).  However xdr_free will free up both the\n";
            print "     * names and the list of pointers, so we have to strdup the\n";
            print "     * names here. */\n";
            print "    for (i = 0; i < ret.$single_ret_list_name.${single_ret_list_name}_len; ++i) {\n";
            print "        ${single_ret_list_name}[i] = strdup(ret.$single_ret_list_name.${single_ret_list_name}_val[i]);\n";
            print "\n";
            print "        if (${single_ret_list_name}[i] == NULL) {\n";
            print "            for (--i; i >= 0; --i)\n";
            print "                VIR_FREE(${single_ret_list_name}[i]);\n";
            print "\n";
            print "            virReportOOMError();\n";
            print "            goto cleanup;\n";
            print "        }\n";
            print "    }\n";
            print "\n";
        }

1467 1468 1469 1470 1471 1472
        if (@ret_list2) {
            print "    ";
            print join("\n    ", @ret_list2);
            print "\n";
        }

1473 1474 1475 1476
        if (@ret_list) {
            print "    ";
            print join("\n    ", @ret_list);
            print "\n";
1477 1478
        }

1479 1480 1481 1482 1483
        if ($call->{ProcName} eq "DomainDestroy" ||
	    $call->{ProcName} eq "DomainSave" ||
	    $call->{ProcName} eq "DomainManagedSave") {
            # SPECIAL: virDomain{Destroy|Save|ManagedSave} need to reset
	    # the domain id explicitly on success
1484 1485 1486
            print "    dom->id = -1;\n";
        }

1487
        if ($multi_ret or !@ret_list) {
1488 1489 1490
            print "    rv = 0;\n";
        }

1491
        if ($single_ret_as_list or $single_ret_cleanup) {
1492 1493 1494 1495 1496
            print "\n";
            print "cleanup:\n";
            print "    xdr_free((xdrproc_t)xdr_remote_$call->{name}_ret, (char *)&ret);\n";
        }

1497 1498 1499 1500 1501 1502 1503
        print "\n";
        print "done:\n";
        print "    remoteDriverUnlock(priv);\n";
        print "    return rv;\n";
        print "}\n";
    }
}