remote_protocol.x 63.0 KB
Newer Older
1 2 3 4 5
/* -*- c -*-
 * remote_protocol.x: private protocol for communicating between
 *   remote_internal driver and libvirtd.  This protocol is
 *   internal and may change at any time.
 *
6
 * Copyright (C) 2006-2011 Red Hat, Inc.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *
 * 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
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Author: Richard Jones <rjones@redhat.com>
 */

/* Notes:
 *
 * (1) The protocol is internal and may change at any time, without
 * notice.  Do not use it.  Instead link to libvirt and use the remote
 * driver.
 *
 * (2) See bottom of this file for a description of the home-brew RPC.
 *
 * (3) Authentication/encryption is done outside this protocol.
 *
 * (4) For namespace reasons, all exported names begin 'remote_' or
 * 'REMOTE_'.  This makes names quite long.
 */

39
%#include "internal.h"
40
%#include <arpa/inet.h>
41

42 43 44 45 46 47 48 49 50 51 52 53
/* cygwin's xdr implementation defines xdr_u_int64_t instead of xdr_uint64_t
 * and lacks IXDR_PUT_INT32 and IXDR_GET_INT32
 */
%#ifdef HAVE_XDR_U_INT64_T
%# define xdr_uint64_t xdr_u_int64_t
%#endif
%#ifndef IXDR_PUT_INT32
%# define IXDR_PUT_INT32 IXDR_PUT_LONG
%#endif
%#ifndef IXDR_GET_INT32
%# define IXDR_GET_INT32 IXDR_GET_LONG
%#endif
S
Stefan Berger 已提交
54 55 56 57 58 59
%#ifndef IXDR_PUT_U_INT32
%# define IXDR_PUT_U_INT32 IXDR_PUT_U_LONG
%#endif
%#ifndef IXDR_GET_U_INT32
%# define IXDR_GET_U_INT32 IXDR_GET_U_LONG
%#endif
60

61 62 63 64 65
/*----- Data types. -----*/

/* Maximum total message size (serialised). */
const REMOTE_MESSAGE_MAX = 262144;

66 67 68 69 70 71
/* Size of struct remote_message_header (serialized)*/
const REMOTE_MESSAGE_HEADER_MAX = 24;

/* Size of message payload */
const REMOTE_MESSAGE_PAYLOAD_MAX = 262120;

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/* Length of long, but not unbounded, strings.
 * This is an arbitrary limit designed to stop the decoder from trying
 * to allocate unbounded amounts of memory when fed with a bad message.
 */
const REMOTE_STRING_MAX = 65536;

/* A long string, which may NOT be NULL. */
typedef string remote_nonnull_string<REMOTE_STRING_MAX>;

/* A long string, which may be NULL. */
typedef remote_nonnull_string *remote_string;

/* This just places an upper limit on the length of lists of
 * domain IDs which may be sent via the protocol.
 */
const REMOTE_DOMAIN_ID_LIST_MAX = 16384;

/* Upper limit on lists of domain names. */
const REMOTE_DOMAIN_NAME_LIST_MAX = 1024;

/* Upper limit on cpumap (bytes) passed to virDomainPinVcpu. */
const REMOTE_CPUMAP_MAX = 256;

/* Upper limit on number of info fields returned by virDomainGetVcpus. */
const REMOTE_VCPUINFO_MAX = 2048;

/* Upper limit on cpumaps (bytes) passed to virDomainGetVcpus. */
const REMOTE_CPUMAPS_MAX = 16384;

101
/* Upper limit on migrate cookie. */
102
const REMOTE_MIGRATE_COOKIE_MAX = 16384;
103

104 105 106
/* Upper limit on lists of network names. */
const REMOTE_NETWORK_NAME_LIST_MAX = 256;

D
Daniel Veillard 已提交
107 108 109
/* Upper limit on lists of interface names. */
const REMOTE_INTERFACE_NAME_LIST_MAX = 256;

110 111 112
/* Upper limit on lists of defined interface names. */
const REMOTE_DEFINED_INTERFACE_NAME_LIST_MAX = 256;

113 114 115 116 117 118
/* Upper limit on lists of storage pool names. */
const REMOTE_STORAGE_POOL_NAME_LIST_MAX = 256;

/* Upper limit on lists of storage vol names. */
const REMOTE_STORAGE_VOL_NAME_LIST_MAX = 1024;

119 120 121 122 123 124
/* Upper limit on lists of node device names. */
const REMOTE_NODE_DEVICE_NAME_LIST_MAX = 16384;

/* Upper limit on lists of node device capabilities. */
const REMOTE_NODE_DEVICE_CAPS_LIST_MAX = 16384;

125 126 127
/* Upper limit on lists of network filter names. */
const REMOTE_NWFILTER_NAME_LIST_MAX = 1024;

128 129 130
/* Upper limit on list of scheduler parameters. */
const REMOTE_DOMAIN_SCHEDULER_PARAMETERS_MAX = 16;

131 132 133
/* Upper limit on list of blkio parameters. */
const REMOTE_DOMAIN_BLKIO_PARAMETERS_MAX = 16;

134 135 136
/* Upper limit on list of memory parameters. */
const REMOTE_DOMAIN_MEMORY_PARAMETERS_MAX = 16;

137 138 139
/* Upper limit on number of NUMA cells */
const REMOTE_NODE_MAX_CELLS = 1024;

140 141 142 143 144 145
/* Upper limit on SASL auth negotiation packet */
const REMOTE_AUTH_SASL_DATA_MAX = 65536;

/* Maximum number of auth types */
const REMOTE_AUTH_TYPE_LIST_MAX = 20;

146 147 148
/* Upper limit on list of memory stats */
const REMOTE_DOMAIN_MEMORY_STATS_MAX = 1024;

C
Chris Lalancette 已提交
149 150 151
/* Upper limit on lists of domain snapshots. */
const REMOTE_DOMAIN_SNAPSHOT_LIST_NAMES_MAX = 1024;

R
Richard W.M. Jones 已提交
152
/* Maximum length of a block peek buffer message.
153 154 155 156 157
 * Note applications need to be aware of this limit and issue multiple
 * requests for large amounts of data.
 */
const REMOTE_DOMAIN_BLOCK_PEEK_BUFFER_MAX = 65536;

R
Richard W.M. Jones 已提交
158 159 160 161 162 163
/* Maximum length of a memory peek buffer message.
 * Note applications need to be aware of this limit and issue multiple
 * requests for large amounts of data.
 */
const REMOTE_DOMAIN_MEMORY_PEEK_BUFFER_MAX = 65536;

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/*
 * Maximum length of a security model field.
 */
const REMOTE_SECURITY_MODEL_MAX = VIR_SECURITY_MODEL_BUFLEN;

/*
 * Maximum length of a security label field.
 */
const REMOTE_SECURITY_LABEL_MAX = VIR_SECURITY_LABEL_BUFLEN;

/*
 * Maximum length of a security DOI field.
 */
const REMOTE_SECURITY_DOI_MAX = VIR_SECURITY_DOI_BUFLEN;

179 180 181 182 183 184 185 186 187 188
/*
 * Maximum size of a secret value.
 */
const REMOTE_SECRET_VALUE_MAX = 65536;

/*
 * Upper limit on list of secrets.
 */
const REMOTE_SECRET_UUID_LIST_MAX = 16384;

189 190 191 192 193
/*
 * Upper limit on list of CPUs accepted when computing a baseline CPU.
 */
const REMOTE_CPU_BASELINE_MAX = 256;

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
/* UUID.  VIR_UUID_BUFLEN definition comes from libvirt.h */
typedef opaque remote_uuid[VIR_UUID_BUFLEN];

/* A domain which may not be NULL. */
struct remote_nonnull_domain {
    remote_nonnull_string name;
    remote_uuid uuid;
    int id;
};

/* A network which may not be NULL. */
struct remote_nonnull_network {
    remote_nonnull_string name;
    remote_uuid uuid;
};

210 211 212 213 214 215
/* A network filter which may not be NULL. */
struct remote_nonnull_nwfilter {
    remote_nonnull_string name;
    remote_uuid uuid;
};

D
Daniel Veillard 已提交
216 217 218 219 220 221
/* An interface which may not be NULL. */
struct remote_nonnull_interface {
    remote_nonnull_string name;
    remote_nonnull_string mac;
};

222 223 224 225 226 227 228 229 230 231 232 233 234
/* A storage pool which may not be NULL. */
struct remote_nonnull_storage_pool {
    remote_nonnull_string name;
    remote_uuid uuid;
};

/* A storage vol which may not be NULL. */
struct remote_nonnull_storage_vol {
    remote_nonnull_string pool;
    remote_nonnull_string name;
    remote_nonnull_string key;
};

235 236 237 238 239
/* A node device which may not be NULL. */
struct remote_nonnull_node_device {
    remote_nonnull_string name;
};

240 241
/* A secret which may not be null. */
struct remote_nonnull_secret {
242
    remote_uuid uuid;
243 244
    int usageType;
    remote_nonnull_string usageID;
245 246
};

C
Chris Lalancette 已提交
247 248 249
/* A snapshot which may not be NULL. */
struct remote_nonnull_domain_snapshot {
    remote_nonnull_string name;
250
    remote_nonnull_domain dom;
C
Chris Lalancette 已提交
251 252
};

253 254 255
/* A domain or network which may be NULL. */
typedef remote_nonnull_domain *remote_domain;
typedef remote_nonnull_network *remote_network;
256
typedef remote_nonnull_nwfilter *remote_nwfilter;
257 258
typedef remote_nonnull_storage_pool *remote_storage_pool;
typedef remote_nonnull_storage_vol *remote_storage_vol;
259
typedef remote_nonnull_node_device *remote_node_device;
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

/* Error message. See <virterror.h> for explanation of fields. */

/* NB. Fields "code", "domain" and "level" are really enums.  The
 * numeric value should remain compatible between libvirt and
 * libvirtd.  This means, no changing or reordering the enums as
 * defined in <virterror.h> (but we don't do that anyway, for separate
 * ABI reasons).
 */
struct remote_error {
    int code;
    int domain;
    remote_string message;
    int level;
    remote_domain dom;
    remote_string str1;
    remote_string str2;
    remote_string str3;
    int int1;
    int int2;
    remote_network net;
};

283 284 285
/* Authentication types available thus far.... */
enum remote_auth_type {
    REMOTE_AUTH_NONE = 0,
286 287
    REMOTE_AUTH_SASL = 1,
    REMOTE_AUTH_POLKIT = 2
288 289 290
};


291 292 293 294 295 296 297 298
/* Wire encoding of virVcpuInfo. */
struct remote_vcpu_info {
    unsigned int number;
    int state;
    unsigned hyper cpu_time;
    int cpu;
};

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/* Wire encoding of virDomainSchedParameter.
 * Note the enum (type) which must remain binary compatible.
 */
union remote_sched_param_value switch (int type) {
 case VIR_DOMAIN_SCHED_FIELD_INT:
     int i;
 case VIR_DOMAIN_SCHED_FIELD_UINT:
     unsigned int ui;
 case VIR_DOMAIN_SCHED_FIELD_LLONG:
     hyper l;
 case VIR_DOMAIN_SCHED_FIELD_ULLONG:
     unsigned hyper ul;
 case VIR_DOMAIN_SCHED_FIELD_DOUBLE:
     double d;
 case VIR_DOMAIN_SCHED_FIELD_BOOLEAN:
     int b;
};

struct remote_sched_param {
    remote_nonnull_string field;
    remote_sched_param_value value;
};

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
union remote_blkio_param_value switch (int type) {
 case VIR_DOMAIN_BLKIO_PARAM_INT:
     int i;
 case VIR_DOMAIN_BLKIO_PARAM_UINT:
     unsigned int ui;
 case VIR_DOMAIN_BLKIO_PARAM_LLONG:
     hyper l;
 case VIR_DOMAIN_BLKIO_PARAM_ULLONG:
     unsigned hyper ul;
 case VIR_DOMAIN_BLKIO_PARAM_DOUBLE:
     double d;
 case VIR_DOMAIN_BLKIO_PARAM_BOOLEAN:
     int b;
};

struct remote_blkio_param {
    remote_nonnull_string field;
    remote_blkio_param_value value;
};

342
union remote_memory_param_value switch (int type) {
343
 case VIR_DOMAIN_MEMORY_PARAM_INT:
344
     int i;
345
 case VIR_DOMAIN_MEMORY_PARAM_UINT:
346
     unsigned int ui;
347
 case VIR_DOMAIN_MEMORY_PARAM_LLONG:
348
     hyper l;
349
 case VIR_DOMAIN_MEMORY_PARAM_ULLONG:
350
     unsigned hyper ul;
351
 case VIR_DOMAIN_MEMORY_PARAM_DOUBLE:
352
     double d;
353
 case VIR_DOMAIN_MEMORY_PARAM_BOOLEAN:
354 355 356 357 358 359 360 361
     int b;
};

struct remote_memory_param {
    remote_nonnull_string field;
    remote_memory_param_value value;
};

362 363 364 365 366 367 368 369
/*----- Calls. -----*/

/* For each call we may have a 'remote_CALL_args' and 'remote_CALL_ret'
 * type.  These are omitted when they are void.  The virConnectPtr
 * is not passed at all (it is inferred on the remote server from the
 * connection).  Errors are returned implicitly in the RPC protocol.
 *
 * Please follow the naming convention carefully - this file is
370
 * parsed by 'remote_generator.pl'.
371 372 373 374
 *
 * 'remote_CALL_ret' members that are filled via call-by-reference must be
 * annotated with a insert@<offset> comment to indicate the offset in the
 * parameter list of the function to be called. */
375 376 377 378 379 380 381 382 383

struct remote_open_args {
    /* NB. "name" might be NULL although in practice you can't
     * yet do that using the remote_internal driver.
     */
    remote_string name;
    int flags;
};

384 385 386 387 388 389 390 391
struct remote_supports_feature_args {
    int feature;
};

struct remote_supports_feature_ret {
    int supported;
};

392 393 394 395 396
struct remote_get_type_ret {
    remote_nonnull_string type;
};

struct remote_get_version_ret {
397
    unsigned hyper hv_ver;
398 399
};

400
struct remote_get_lib_version_ret {
401
    unsigned hyper lib_ver;
402 403
};

404 405 406 407
struct remote_get_hostname_ret {
    remote_nonnull_string hostname;
};

408 409 410 411 412 413 414 415
struct remote_get_sysinfo_args {
    unsigned int flags;
};

struct remote_get_sysinfo_ret {
    remote_nonnull_string sysinfo;
};

416 417 418 419
struct remote_get_uri_ret {
    remote_nonnull_string uri;
};

420 421 422 423 424 425 426 427 428 429 430 431 432
struct remote_get_max_vcpus_args {
    /* The only backend which supports this call is Xen HV, and
     * there the type is ignored so it could be NULL.
     */
    remote_string type;
};

struct remote_get_max_vcpus_ret {
    int max_vcpus;
};

struct remote_node_get_info_ret {
    char model[32];
433
    unsigned hyper memory;
434 435 436 437 438 439 440 441 442 443 444 445
    int cpus;
    int mhz;
    int nodes;
    int sockets;
    int cores;
    int threads;
};

struct remote_get_capabilities_ret {
    remote_nonnull_string capabilities;
};

446 447
struct remote_node_get_cells_free_memory_args {
    int startCell;
448
    int maxcells;
449 450 451
};

struct remote_node_get_cells_free_memory_ret {
452
    unsigned hyper cells<REMOTE_NODE_MAX_CELLS>; /* insert@1 */
453 454 455
};

struct remote_node_get_free_memory_ret {
456
    unsigned hyper freeMem;
457 458
};

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
struct remote_domain_get_scheduler_type_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_scheduler_type_ret {
    remote_nonnull_string type;
    int nparams;
};

struct remote_domain_get_scheduler_parameters_args {
    remote_nonnull_domain dom;
    int nparams;
};

struct remote_domain_get_scheduler_parameters_ret {
    remote_sched_param params<REMOTE_DOMAIN_SCHEDULER_PARAMETERS_MAX>;
};

struct remote_domain_set_scheduler_parameters_args {
    remote_nonnull_domain dom;
    remote_sched_param params<REMOTE_DOMAIN_SCHEDULER_PARAMETERS_MAX>;
};

482 483 484 485 486 487
struct remote_domain_set_scheduler_parameters_flags_args {
    remote_nonnull_domain dom;
    remote_sched_param params<REMOTE_DOMAIN_SCHEDULER_PARAMETERS_MAX>;
    unsigned int flags;
};

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
struct remote_domain_set_blkio_parameters_args {
    remote_nonnull_domain dom;
    remote_blkio_param params<REMOTE_DOMAIN_BLKIO_PARAMETERS_MAX>;
    unsigned int flags;
};

struct remote_domain_get_blkio_parameters_args {
    remote_nonnull_domain dom;
    int nparams;
    unsigned int flags;
};

struct remote_domain_get_blkio_parameters_ret {
    remote_blkio_param params<REMOTE_DOMAIN_BLKIO_PARAMETERS_MAX>;
    int nparams;
};

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
struct remote_domain_set_memory_parameters_args {
    remote_nonnull_domain dom;
    remote_memory_param params<REMOTE_DOMAIN_MEMORY_PARAMETERS_MAX>;
    unsigned int flags;
};

struct remote_domain_get_memory_parameters_args {
    remote_nonnull_domain dom;
    int nparams;
    unsigned int flags;
};

struct remote_domain_get_memory_parameters_ret {
    remote_memory_param params<REMOTE_DOMAIN_MEMORY_PARAMETERS_MAX>;
    int nparams;
};

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
struct remote_domain_block_stats_args {
    remote_nonnull_domain dom;
    remote_nonnull_string path;
};

struct remote_domain_block_stats_ret {
    hyper rd_req;
    hyper rd_bytes;
    hyper wr_req;
    hyper wr_bytes;
    hyper errs;
};

struct remote_domain_interface_stats_args {
    remote_nonnull_domain dom;
    remote_nonnull_string path;
};

struct remote_domain_interface_stats_ret {
    hyper rx_bytes;
    hyper rx_packets;
    hyper rx_errs;
    hyper rx_drop;
    hyper tx_bytes;
    hyper tx_packets;
    hyper tx_errs;
    hyper tx_drop;
};

551
struct remote_domain_memory_stats_args {
552
    remote_nonnull_domain dom;
553 554
    unsigned int maxStats;
    unsigned int flags;
555 556 557 558 559 560 561 562 563 564 565
};

struct remote_domain_memory_stat {
    int tag;
    unsigned hyper val;
};

struct remote_domain_memory_stats_ret {
    remote_domain_memory_stat stats<REMOTE_DOMAIN_MEMORY_STATS_MAX>;
};

566 567 568 569
struct remote_domain_block_peek_args {
    remote_nonnull_domain dom;
    remote_nonnull_string path;
    unsigned hyper offset;
570 571
    unsigned int size;
    unsigned int flags;
572 573 574 575 576 577
};

struct remote_domain_block_peek_ret {
    opaque buffer<REMOTE_DOMAIN_BLOCK_PEEK_BUFFER_MAX>;
};

R
Richard W.M. Jones 已提交
578 579 580
struct remote_domain_memory_peek_args {
    remote_nonnull_domain dom;
    unsigned hyper offset;
581 582
    unsigned int size;
    unsigned int flags;
R
Richard W.M. Jones 已提交
583 584 585 586 587 588
};

struct remote_domain_memory_peek_ret {
    opaque buffer<REMOTE_DOMAIN_MEMORY_PEEK_BUFFER_MAX>;
};

589 590 591
struct remote_domain_get_block_info_args {
    remote_nonnull_domain dom;
    remote_nonnull_string path;
592
    unsigned int flags;
593 594 595 596 597 598 599 600
};

struct remote_domain_get_block_info_ret {
    unsigned hyper allocation;
    unsigned hyper capacity;
    unsigned hyper physical;
};

601 602 603 604 605
struct remote_list_domains_args {
    int maxids;
};

struct remote_list_domains_ret {
606
    int ids<REMOTE_DOMAIN_ID_LIST_MAX>; /* insert@1 */
607 608 609 610 611 612
};

struct remote_num_of_domains_ret {
    int num;
};

613
struct remote_domain_create_xml_args {
614
    remote_nonnull_string xml_desc;
615
    unsigned int flags;
616 617
};

618
struct remote_domain_create_xml_ret {
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
    remote_nonnull_domain dom;
};

struct remote_domain_lookup_by_id_args {
    int id;
};

struct remote_domain_lookup_by_id_ret {
    remote_nonnull_domain dom;
};

struct remote_domain_lookup_by_uuid_args {
    remote_uuid uuid;
};

struct remote_domain_lookup_by_uuid_ret {
    remote_nonnull_domain dom;
};

struct remote_domain_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_domain_lookup_by_name_ret {
    remote_nonnull_domain dom;
};

struct remote_domain_suspend_args {
    remote_nonnull_domain dom;
};

struct remote_domain_resume_args {
    remote_nonnull_domain dom;
};

struct remote_domain_shutdown_args {
    remote_nonnull_domain dom;
};

struct remote_domain_reboot_args {
    remote_nonnull_domain dom;
660
    unsigned int flags;
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
};

struct remote_domain_destroy_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_os_type_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_os_type_ret {
    remote_nonnull_string type;
};

struct remote_domain_get_max_memory_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_max_memory_ret {
    unsigned hyper memory;
};

struct remote_domain_set_max_memory_args {
    remote_nonnull_domain dom;
    unsigned hyper memory;
};

struct remote_domain_set_memory_args {
    remote_nonnull_domain dom;
    unsigned hyper memory;
};

693 694 695 696 697 698
struct remote_domain_set_memory_flags_args {
    remote_nonnull_domain dom;
    unsigned hyper memory;
    unsigned int flags;
};

699 700 701 702 703 704
struct remote_domain_get_info_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_info_ret {
    unsigned char state;
705
    unsigned hyper maxMem;
706
    unsigned hyper memory;
707 708
    unsigned short nrVirtCpu;
    unsigned hyper cpuTime;
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
};

struct remote_domain_save_args {
    remote_nonnull_domain dom;
    remote_nonnull_string to;
};

struct remote_domain_restore_args {
    remote_nonnull_string from;
};

struct remote_domain_core_dump_args {
    remote_nonnull_domain dom;
    remote_nonnull_string to;
    int flags;
};

726 727 728 729 730 731 732 733 734 735
struct remote_domain_screenshot_args {
    remote_nonnull_domain dom;
    unsigned int screen;
    unsigned int flags;
};

struct remote_domain_screenshot_ret {
    remote_string mime;
};

736
struct remote_domain_get_xml_desc_args {
737 738 739 740
    remote_nonnull_domain dom;
    int flags;
};

741
struct remote_domain_get_xml_desc_ret {
742 743 744
    remote_nonnull_string xml;
};

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
struct remote_domain_migrate_prepare_args {
    remote_string uri_in;
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
};

struct remote_domain_migrate_prepare_ret {
    opaque cookie<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_string uri_out;
};

struct remote_domain_migrate_perform_args {
    remote_nonnull_domain dom;
    opaque cookie<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_nonnull_string uri;
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
};

struct remote_domain_migrate_finish_args {
    remote_nonnull_string dname;
    opaque cookie<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_nonnull_string uri;
    unsigned hyper flags;
};

struct remote_domain_migrate_finish_ret {
    remote_nonnull_domain ddom;
};

D
Daniel Veillard 已提交
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
struct remote_domain_migrate_prepare2_args {
    remote_string uri_in;
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
    remote_nonnull_string dom_xml;
};

struct remote_domain_migrate_prepare2_ret {
    opaque cookie<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_string uri_out;
};

struct remote_domain_migrate_finish2_args {
    remote_nonnull_string dname;
    opaque cookie<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_nonnull_string uri;
    unsigned hyper flags;
    int retcode;
};

struct remote_domain_migrate_finish2_ret {
    remote_nonnull_domain ddom;
};

802 803 804 805 806
struct remote_list_defined_domains_args {
    int maxnames;
};

struct remote_list_defined_domains_ret {
807
    remote_nonnull_string names<REMOTE_DOMAIN_NAME_LIST_MAX>; /* insert@1 */
808 809 810 811 812 813 814 815 816 817
};

struct remote_num_of_defined_domains_ret {
    int num;
};

struct remote_domain_create_args {
    remote_nonnull_domain dom;
};

818 819 820 821 822 823 824 825 826
struct remote_domain_create_with_flags_args {
    remote_nonnull_domain dom;
    unsigned int flags;
};

struct remote_domain_create_with_flags_ret {
    remote_nonnull_domain dom;
};

827 828 829 830 831 832 833 834 835 836 837 838
struct remote_domain_define_xml_args {
    remote_nonnull_string xml;
};

struct remote_domain_define_xml_ret {
    remote_nonnull_domain dom;
};

struct remote_domain_undefine_args {
    remote_nonnull_domain dom;
};

839 840 841 842 843
struct remote_domain_inject_nmi_args {
    remote_nonnull_domain dom;
    unsigned int flags;
};

844 845
struct remote_domain_set_vcpus_args {
    remote_nonnull_domain dom;
846
    unsigned int nvcpus;
847 848
};

E
Eric Blake 已提交
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
struct remote_domain_set_vcpus_flags_args {
    remote_nonnull_domain dom;
    unsigned int nvcpus;
    unsigned int flags;
};

struct remote_domain_get_vcpus_flags_args {
    remote_nonnull_domain dom;
    unsigned int flags;
};

struct remote_domain_get_vcpus_flags_ret {
    int num;
};

864 865
struct remote_domain_pin_vcpu_args {
    remote_nonnull_domain dom;
866
    unsigned int vcpu;
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
    opaque cpumap<REMOTE_CPUMAP_MAX>;
};

struct remote_domain_get_vcpus_args {
    remote_nonnull_domain dom;
    int maxinfo;
    int maplen;
};

struct remote_domain_get_vcpus_ret {
    remote_vcpu_info info<REMOTE_VCPUINFO_MAX>;
    opaque cpumaps<REMOTE_CPUMAPS_MAX>;
};

struct remote_domain_get_max_vcpus_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_max_vcpus_ret {
    int num;
};

889 890 891 892 893 894 895 896 897 898 899 900 901 902
struct remote_domain_get_security_label_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_security_label_ret {
    char label<REMOTE_SECURITY_LABEL_MAX>;
    int enforcing;
};

struct remote_node_get_security_model_ret {
    char model<REMOTE_SECURITY_MODEL_MAX>;
    char doi<REMOTE_SECURITY_DOI_MAX>;
};

903 904 905 906 907
struct remote_domain_attach_device_args {
    remote_nonnull_domain dom;
    remote_nonnull_string xml;
};

J
Jim Fehlig 已提交
908 909 910 911 912 913
struct remote_domain_attach_device_flags_args {
    remote_nonnull_domain dom;
    remote_nonnull_string xml;
    unsigned int flags;
};

914 915 916 917 918
struct remote_domain_detach_device_args {
    remote_nonnull_domain dom;
    remote_nonnull_string xml;
};

J
Jim Fehlig 已提交
919 920 921 922 923 924
struct remote_domain_detach_device_flags_args {
    remote_nonnull_domain dom;
    remote_nonnull_string xml;
    unsigned int flags;
};

925 926 927 928 929 930
struct remote_domain_update_device_flags_args {
    remote_nonnull_domain dom;
    remote_nonnull_string xml;
    unsigned int flags;
};

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
struct remote_domain_get_autostart_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_autostart_ret {
    int autostart;
};

struct remote_domain_set_autostart_args {
    remote_nonnull_domain dom;
    int autostart;
};

/* Network calls: */

struct remote_num_of_networks_ret {
    int num;
};

struct remote_list_networks_args {
    int maxnames;
};

struct remote_list_networks_ret {
955
    remote_nonnull_string names<REMOTE_NETWORK_NAME_LIST_MAX>; /* insert@1 */
956 957 958 959 960 961 962 963 964 965 966
};

struct remote_num_of_defined_networks_ret {
    int num;
};

struct remote_list_defined_networks_args {
    int maxnames;
};

struct remote_list_defined_networks_ret {
967
    remote_nonnull_string names<REMOTE_NETWORK_NAME_LIST_MAX>; /* insert@1 */
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
};

struct remote_network_lookup_by_uuid_args {
    remote_uuid uuid;
};

struct remote_network_lookup_by_uuid_ret {
    remote_nonnull_network net;
};

struct remote_network_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_network_lookup_by_name_ret {
    remote_nonnull_network net;
};

struct remote_network_create_xml_args {
    remote_nonnull_string xml;
};

struct remote_network_create_xml_ret {
    remote_nonnull_network net;
};

struct remote_network_define_xml_args {
    remote_nonnull_string xml;
};

struct remote_network_define_xml_ret {
    remote_nonnull_network net;
};

struct remote_network_undefine_args {
    remote_nonnull_network net;
};

struct remote_network_create_args {
    remote_nonnull_network net;
};

struct remote_network_destroy_args {
    remote_nonnull_network net;
};

1014
struct remote_network_get_xml_desc_args {
1015 1016 1017 1018
    remote_nonnull_network net;
    int flags;
};

1019
struct remote_network_get_xml_desc_ret {
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
    remote_nonnull_string xml;
};

struct remote_network_get_bridge_name_args {
    remote_nonnull_network net;
};

struct remote_network_get_bridge_name_ret {
    remote_nonnull_string name;
};

struct remote_network_get_autostart_args {
    remote_nonnull_network net;
};

struct remote_network_get_autostart_ret {
    int autostart;
};

struct remote_network_set_autostart_args {
    remote_nonnull_network net;
    int autostart;
};

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/* network filter calls */

struct remote_num_of_nwfilters_ret {
    int num;
};

struct remote_list_nwfilters_args {
    int maxnames;
};

struct remote_list_nwfilters_ret {
1055
    remote_nonnull_string names<REMOTE_NWFILTER_NAME_LIST_MAX>; /* insert@1 */
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
};

struct remote_nwfilter_lookup_by_uuid_args {
    remote_uuid uuid;
};

struct remote_nwfilter_lookup_by_uuid_ret {
    remote_nonnull_nwfilter nwfilter;
};

struct remote_nwfilter_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_nwfilter_lookup_by_name_ret {
    remote_nonnull_nwfilter nwfilter;
};

struct remote_nwfilter_define_xml_args {
    remote_nonnull_string xml;
};

struct remote_nwfilter_define_xml_ret {
    remote_nonnull_nwfilter nwfilter;
};

struct remote_nwfilter_undefine_args {
    remote_nonnull_nwfilter nwfilter;
};

struct remote_nwfilter_get_xml_desc_args {
    remote_nonnull_nwfilter nwfilter;
    int flags;
};

struct remote_nwfilter_get_xml_desc_ret {
    remote_nonnull_string xml;
};

1095

D
Daniel Veillard 已提交
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
/* Interface calls: */

struct remote_num_of_interfaces_ret {
    int num;
};

struct remote_list_interfaces_args {
    int maxnames;
};

struct remote_list_interfaces_ret {
1107
    remote_nonnull_string names<REMOTE_INTERFACE_NAME_LIST_MAX>; /* insert@1 */
D
Daniel Veillard 已提交
1108 1109
};

1110 1111 1112 1113 1114 1115 1116 1117 1118
struct remote_num_of_defined_interfaces_ret {
    int num;
};

struct remote_list_defined_interfaces_args {
    int maxnames;
};

struct remote_list_defined_interfaces_ret {
1119
    remote_nonnull_string names<REMOTE_DEFINED_INTERFACE_NAME_LIST_MAX>; /* insert@1 */
1120 1121
};

D
Daniel Veillard 已提交
1122 1123 1124 1125 1126
struct remote_interface_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_interface_lookup_by_name_ret {
1127
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1128 1129 1130 1131 1132 1133 1134
};

struct remote_interface_lookup_by_mac_string_args {
    remote_nonnull_string mac;
};

struct remote_interface_lookup_by_mac_string_ret {
1135
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1136 1137 1138
};

struct remote_interface_get_xml_desc_args {
1139
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
    unsigned int flags;
};

struct remote_interface_get_xml_desc_ret {
    remote_nonnull_string xml;
};

struct remote_interface_define_xml_args {
    remote_nonnull_string xml;
    unsigned int flags;
};

struct remote_interface_define_xml_ret {
1153
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1154 1155 1156
};

struct remote_interface_undefine_args {
1157
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1158 1159 1160
};

struct remote_interface_create_args {
1161
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1162 1163 1164 1165
    unsigned int flags;
};

struct remote_interface_destroy_args {
1166
    remote_nonnull_interface iface;
D
Daniel Veillard 已提交
1167 1168 1169 1170 1171 1172
    unsigned int flags;
};


/* Auth calls: */

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
struct remote_auth_list_ret {
    remote_auth_type types<REMOTE_AUTH_TYPE_LIST_MAX>;
};

struct remote_auth_sasl_init_ret {
    remote_nonnull_string mechlist;
};

struct remote_auth_sasl_start_args {
    remote_nonnull_string mech;
    int nil;
    char data<REMOTE_AUTH_SASL_DATA_MAX>;
};

struct remote_auth_sasl_start_ret {
    int complete;
    int nil;
    char data<REMOTE_AUTH_SASL_DATA_MAX>;
};

struct remote_auth_sasl_step_args {
    int nil;
    char data<REMOTE_AUTH_SASL_DATA_MAX>;
};

struct remote_auth_sasl_step_ret {
    int complete;
    int nil;
    char data<REMOTE_AUTH_SASL_DATA_MAX>;
};

1204 1205 1206 1207
struct remote_auth_polkit_ret {
    int complete;
};

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220


/* Storage pool calls: */

struct remote_num_of_storage_pools_ret {
    int num;
};

struct remote_list_storage_pools_args {
    int maxnames;
};

struct remote_list_storage_pools_ret {
1221
    remote_nonnull_string names<REMOTE_STORAGE_POOL_NAME_LIST_MAX>; /* insert@1 */
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
};

struct remote_num_of_defined_storage_pools_ret {
    int num;
};

struct remote_list_defined_storage_pools_args {
    int maxnames;
};

struct remote_list_defined_storage_pools_ret {
1233
    remote_nonnull_string names<REMOTE_STORAGE_POOL_NAME_LIST_MAX>; /* insert@1 */
1234 1235
};

1236 1237 1238
struct remote_find_storage_pool_sources_args {
    remote_nonnull_string type;
    remote_string srcSpec;
1239
    unsigned int flags;
1240 1241 1242 1243 1244 1245
};

struct remote_find_storage_pool_sources_ret {
    remote_nonnull_string xml;
};

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
struct remote_storage_pool_lookup_by_uuid_args {
    remote_uuid uuid;
};

struct remote_storage_pool_lookup_by_uuid_ret {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_storage_pool_lookup_by_name_ret {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_lookup_by_volume_args {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_pool_lookup_by_volume_ret {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_create_xml_args {
    remote_nonnull_string xml;
1272
    unsigned int flags;
1273 1274 1275 1276 1277 1278 1279 1280
};

struct remote_storage_pool_create_xml_ret {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_define_xml_args {
    remote_nonnull_string xml;
1281
    unsigned int flags;
1282 1283 1284 1285 1286 1287 1288 1289
};

struct remote_storage_pool_define_xml_ret {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_build_args {
    remote_nonnull_storage_pool pool;
1290
    unsigned int flags;
1291 1292 1293 1294 1295 1296 1297 1298
};

struct remote_storage_pool_undefine_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_create_args {
    remote_nonnull_storage_pool pool;
1299
    unsigned int flags;
1300 1301 1302 1303 1304 1305 1306 1307
};

struct remote_storage_pool_destroy_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_delete_args {
    remote_nonnull_storage_pool pool;
1308
    unsigned int flags;
1309 1310 1311 1312
};

struct remote_storage_pool_refresh_args {
    remote_nonnull_storage_pool pool;
1313
    unsigned int flags;
1314 1315
};

1316
struct remote_storage_pool_get_xml_desc_args {
1317
    remote_nonnull_storage_pool pool;
1318
    unsigned int flags;
1319 1320
};

1321
struct remote_storage_pool_get_xml_desc_ret {
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
    remote_nonnull_string xml;
};

struct remote_storage_pool_get_info_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_get_info_ret {
    unsigned char state;
    unsigned hyper capacity;
    unsigned hyper allocation;
    unsigned hyper available;
};

struct remote_storage_pool_get_autostart_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_get_autostart_ret {
    int autostart;
};

struct remote_storage_pool_set_autostart_args {
    remote_nonnull_storage_pool pool;
    int autostart;
};

struct remote_storage_pool_num_of_volumes_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_num_of_volumes_ret {
    int num;
};

struct remote_storage_pool_list_volumes_args {
    remote_nonnull_storage_pool pool;
    int maxnames;
};

struct remote_storage_pool_list_volumes_ret {
1363
    remote_nonnull_string names<REMOTE_STORAGE_VOL_NAME_LIST_MAX>; /* insert@1 */
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
};



/* Storage vol calls: */

struct remote_storage_vol_lookup_by_name_args {
    remote_nonnull_storage_pool pool;
    remote_nonnull_string name;
};

struct remote_storage_vol_lookup_by_name_ret {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_vol_lookup_by_key_args {
    remote_nonnull_string key;
};

struct remote_storage_vol_lookup_by_key_ret {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_vol_lookup_by_path_args {
    remote_nonnull_string path;
};

struct remote_storage_vol_lookup_by_path_ret {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_vol_create_xml_args {
    remote_nonnull_storage_pool pool;
    remote_nonnull_string xml;
1398
    unsigned int flags;
1399 1400 1401 1402 1403 1404
};

struct remote_storage_vol_create_xml_ret {
    remote_nonnull_storage_vol vol;
};

1405 1406 1407 1408
struct remote_storage_vol_create_xml_from_args {
    remote_nonnull_storage_pool pool;
    remote_nonnull_string xml;
    remote_nonnull_storage_vol clonevol;
1409
    unsigned int flags;
1410 1411 1412 1413 1414 1415
};

struct remote_storage_vol_create_xml_from_ret {
    remote_nonnull_storage_vol vol;
};

1416 1417
struct remote_storage_vol_delete_args {
    remote_nonnull_storage_vol vol;
1418
    unsigned int flags;
1419 1420
};

1421 1422
struct remote_storage_vol_wipe_args {
    remote_nonnull_storage_vol vol;
1423
    unsigned int flags;
1424 1425
};

1426
struct remote_storage_vol_get_xml_desc_args {
1427
    remote_nonnull_storage_vol vol;
1428
    unsigned int flags;
1429 1430
};

1431
struct remote_storage_vol_get_xml_desc_ret {
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
    remote_nonnull_string xml;
};

struct remote_storage_vol_get_info_args {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_vol_get_info_ret {
    char type;
    unsigned hyper capacity;
    unsigned hyper allocation;
};

struct remote_storage_vol_get_path_args {
    remote_nonnull_storage_vol vol;
};

struct remote_storage_vol_get_path_ret {
    remote_nonnull_string name;
};

1453 1454 1455 1456
/* Node driver calls: */

struct remote_node_num_of_devices_args {
    remote_string cap;
1457
    unsigned int flags;
1458 1459 1460 1461 1462 1463 1464 1465 1466
};

struct remote_node_num_of_devices_ret {
    int num;
};

struct remote_node_list_devices_args {
    remote_string cap;
    int maxnames;
1467
    unsigned int flags;
1468 1469 1470
};

struct remote_node_list_devices_ret {
1471
    remote_nonnull_string names<REMOTE_NODE_DEVICE_NAME_LIST_MAX>; /* insert@2 */
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
};

struct remote_node_device_lookup_by_name_args {
    remote_nonnull_string name;
};

struct remote_node_device_lookup_by_name_ret {
    remote_nonnull_node_device dev;
};

1482
struct remote_node_device_get_xml_desc_args {
1483
    remote_nonnull_string name;
1484
    unsigned int flags;
1485 1486
};

1487
struct remote_node_device_get_xml_desc_ret {
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
    remote_nonnull_string xml;
};

struct remote_node_device_get_parent_args {
    remote_nonnull_string name;
};

struct remote_node_device_get_parent_ret {
    remote_string parent;
};

struct remote_node_device_num_of_caps_args {
    remote_nonnull_string name;
};

struct remote_node_device_num_of_caps_ret {
    int num;
};

struct remote_node_device_list_caps_args {
    remote_nonnull_string name;
    int maxnames;
};

struct remote_node_device_list_caps_ret {
1513
    remote_nonnull_string names<REMOTE_NODE_DEVICE_CAPS_LIST_MAX>; /* insert@1 */
1514 1515
};

1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
struct remote_node_device_dettach_args {
    remote_nonnull_string name;
};

struct remote_node_device_re_attach_args {
    remote_nonnull_string name;
};

struct remote_node_device_reset_args {
    remote_nonnull_string name;
};

1528 1529
struct remote_node_device_create_xml_args {
    remote_nonnull_string xml_desc;
1530
    unsigned int flags;
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
};

struct remote_node_device_create_xml_ret {
    remote_nonnull_node_device dev;
};

struct remote_node_device_destroy_args {
    remote_nonnull_string name;
};

1541

1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
/**
 * Events Register/Deregister:
 * It would seem rpcgen does not like both args, and ret
 * to be null. It will not generate the prototype otherwise.
 * Pass back a redundant boolean to force prototype generation.
 */
struct remote_domain_events_register_ret {
    int cb_registered;
};

struct remote_domain_events_deregister_ret {
    int cb_registered;
};

1556
struct remote_domain_event_lifecycle_msg {
1557 1558
    remote_nonnull_domain dom;
    int event;
1559
    int detail;
1560 1561
};

1562 1563 1564 1565

struct remote_domain_xml_from_native_args {
    remote_nonnull_string nativeFormat;
    remote_nonnull_string nativeConfig;
1566
    unsigned int flags;
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
};

struct remote_domain_xml_from_native_ret {
    remote_nonnull_string domainXml;
};


struct remote_domain_xml_to_native_args {
    remote_nonnull_string nativeFormat;
    remote_nonnull_string domainXml;
1577
    unsigned int flags;
1578 1579 1580 1581 1582 1583 1584
};

struct remote_domain_xml_to_native_ret {
    remote_nonnull_string nativeConfig;
};


1585 1586 1587 1588 1589 1590 1591 1592 1593
struct remote_num_of_secrets_ret {
    int num;
};

struct remote_list_secrets_args {
    int maxuuids;
};

struct remote_list_secrets_ret {
1594
    remote_nonnull_string uuids<REMOTE_SECRET_UUID_LIST_MAX>; /* insert@1 */
1595 1596
};

1597 1598
struct remote_secret_lookup_by_uuid_args {
    remote_uuid uuid;
1599 1600
};

1601
struct remote_secret_lookup_by_uuid_ret {
1602 1603 1604 1605 1606
    remote_nonnull_secret secret;
};

struct remote_secret_define_xml_args {
    remote_nonnull_string xml;
1607
    unsigned int flags;
1608 1609 1610 1611 1612 1613 1614 1615
};

struct remote_secret_define_xml_ret {
    remote_nonnull_secret secret;
};

struct remote_secret_get_xml_desc_args {
    remote_nonnull_secret secret;
1616
    unsigned int flags;
1617 1618 1619 1620 1621 1622 1623 1624 1625
};

struct remote_secret_get_xml_desc_ret {
    remote_nonnull_string xml;
};

struct remote_secret_set_value_args {
    remote_nonnull_secret secret;
    opaque value<REMOTE_SECRET_VALUE_MAX>;
1626
    unsigned int flags;
1627 1628 1629 1630
};

struct remote_secret_get_value_args {
    remote_nonnull_secret secret;
1631
    unsigned int flags;
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
};

struct remote_secret_get_value_ret {
    opaque value<REMOTE_SECRET_VALUE_MAX>;
};

struct remote_secret_undefine_args {
    remote_nonnull_secret secret;
};

1642 1643 1644 1645 1646 1647 1648 1649 1650
struct remote_secret_lookup_by_usage_args {
    int usageType;
    remote_nonnull_string usageID;
};

struct remote_secret_lookup_by_usage_ret {
    remote_nonnull_secret secret;
};

C
Chris Lalancette 已提交
1651 1652 1653 1654 1655 1656 1657
struct remote_domain_migrate_prepare_tunnel_args {
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
    remote_nonnull_string dom_xml;
};

1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680

struct remote_is_secure_ret {
    int secure;
};


struct remote_domain_is_active_args {
    remote_nonnull_domain dom;
};

struct remote_domain_is_active_ret {
    int active;
};


struct remote_domain_is_persistent_args {
    remote_nonnull_domain dom;
};

struct remote_domain_is_persistent_ret {
    int persistent;
};

O
Osier Yang 已提交
1681 1682 1683 1684 1685 1686 1687
struct remote_domain_is_updated_args {
    remote_nonnull_domain dom;
};

struct remote_domain_is_updated_ret {
    int updated;
};
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731

struct remote_network_is_active_args {
    remote_nonnull_network net;
};

struct remote_network_is_active_ret {
    int active;
};

struct remote_network_is_persistent_args {
    remote_nonnull_network net;
};

struct remote_network_is_persistent_ret {
    int persistent;
};


struct remote_storage_pool_is_active_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_is_active_ret {
    int active;
};

struct remote_storage_pool_is_persistent_args {
    remote_nonnull_storage_pool pool;
};

struct remote_storage_pool_is_persistent_ret {
    int persistent;
};


struct remote_interface_is_active_args {
    remote_nonnull_interface iface;
};

struct remote_interface_is_active_ret {
    int active;
};


1732 1733
struct remote_cpu_compare_args {
    remote_nonnull_string xml;
1734
    unsigned int flags;
1735 1736 1737 1738 1739 1740 1741
};

struct remote_cpu_compare_ret {
    int result;
};


1742 1743
struct remote_cpu_baseline_args {
    remote_nonnull_string xmlCPUs<REMOTE_CPU_BASELINE_MAX>;
1744
    unsigned int flags;
1745 1746 1747 1748 1749 1750 1751
};

struct remote_cpu_baseline_ret {
    remote_nonnull_string cpu;
};


1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
struct remote_domain_get_job_info_args {
    remote_nonnull_domain dom;
};

struct remote_domain_get_job_info_ret {
    int type;

    unsigned hyper timeElapsed;
    unsigned hyper timeRemaining;

    unsigned hyper dataTotal;
    unsigned hyper dataProcessed;
    unsigned hyper dataRemaining;

    unsigned hyper memTotal;
    unsigned hyper memProcessed;
    unsigned hyper memRemaining;

    unsigned hyper fileTotal;
    unsigned hyper fileProcessed;
    unsigned hyper fileRemaining;
};


1776 1777 1778 1779 1780
struct remote_domain_abort_job_args {
    remote_nonnull_domain dom;
};


1781 1782 1783
struct remote_domain_migrate_set_max_downtime_args {
    remote_nonnull_domain dom;
    unsigned hyper downtime;
1784
    unsigned int flags;
1785 1786
};

1787 1788 1789
struct remote_domain_migrate_set_max_speed_args {
    remote_nonnull_domain dom;
    unsigned hyper bandwidth;
1790
    unsigned int flags;
1791 1792
};

1793 1794 1795 1796 1797 1798 1799 1800
struct remote_domain_events_register_any_args {
    int eventID;
};

struct remote_domain_events_deregister_any_args {
    int eventID;
};

1801 1802 1803
struct remote_domain_event_reboot_msg {
    remote_nonnull_domain dom;
};
1804

1805 1806 1807 1808 1809
struct remote_domain_event_rtc_change_msg {
    remote_nonnull_domain dom;
    hyper offset;
};

1810 1811 1812 1813 1814
struct remote_domain_event_watchdog_msg {
    remote_nonnull_domain dom;
    int action;
};

1815 1816 1817 1818 1819 1820 1821
struct remote_domain_event_io_error_msg {
    remote_nonnull_domain dom;
    remote_nonnull_string srcPath;
    remote_nonnull_string devAlias;
    int action;
};

1822 1823 1824 1825 1826 1827 1828 1829
struct remote_domain_event_io_error_reason_msg {
    remote_nonnull_domain dom;
    remote_nonnull_string srcPath;
    remote_nonnull_string devAlias;
    int action;
    remote_nonnull_string reason;
};

1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
struct remote_domain_event_graphics_address {
    int family;
    remote_nonnull_string node;
    remote_nonnull_string service;
};

const REMOTE_DOMAIN_EVENT_GRAPHICS_IDENTITY_MAX = 20;

struct remote_domain_event_graphics_identity {
    remote_nonnull_string type;
    remote_nonnull_string name;
};

struct remote_domain_event_graphics_msg {
    remote_nonnull_domain dom;
    int phase;
    remote_domain_event_graphics_address local;
    remote_domain_event_graphics_address remote;
    remote_nonnull_string authScheme;
    remote_domain_event_graphics_identity subject<REMOTE_DOMAIN_EVENT_GRAPHICS_IDENTITY_MAX>;
};

1852 1853
struct remote_domain_managed_save_args {
    remote_nonnull_domain dom;
1854
    unsigned int flags;
1855 1856 1857 1858
};

struct remote_domain_has_managed_save_image_args {
    remote_nonnull_domain dom;
1859
    unsigned int flags;
1860 1861 1862
};

struct remote_domain_has_managed_save_image_ret {
1863
    int result;
1864 1865 1866 1867
};

struct remote_domain_managed_save_remove_args {
    remote_nonnull_domain dom;
1868
    unsigned int flags;
1869 1870
};

C
Chris Lalancette 已提交
1871
struct remote_domain_snapshot_create_xml_args {
1872
    remote_nonnull_domain dom;
C
Chris Lalancette 已提交
1873
    remote_nonnull_string xml_desc;
1874
    unsigned int flags;
C
Chris Lalancette 已提交
1875 1876 1877 1878 1879 1880
};

struct remote_domain_snapshot_create_xml_ret {
    remote_nonnull_domain_snapshot snap;
};

1881
struct remote_domain_snapshot_get_xml_desc_args {
C
Chris Lalancette 已提交
1882
    remote_nonnull_domain_snapshot snap;
1883
    unsigned int flags;
C
Chris Lalancette 已提交
1884 1885
};

1886
struct remote_domain_snapshot_get_xml_desc_ret {
C
Chris Lalancette 已提交
1887 1888 1889 1890
    remote_nonnull_string xml;
};

struct remote_domain_snapshot_num_args {
1891
    remote_nonnull_domain dom;
1892
    unsigned int flags;
C
Chris Lalancette 已提交
1893 1894 1895 1896 1897 1898 1899
};

struct remote_domain_snapshot_num_ret {
    int num;
};

struct remote_domain_snapshot_list_names_args {
1900
    remote_nonnull_domain dom;
1901
    int maxnames;
1902
    unsigned int flags;
C
Chris Lalancette 已提交
1903 1904 1905
};

struct remote_domain_snapshot_list_names_ret {
1906
    remote_nonnull_string names<REMOTE_DOMAIN_SNAPSHOT_LIST_NAMES_MAX>; /* insert@1 */
C
Chris Lalancette 已提交
1907 1908 1909
};

struct remote_domain_snapshot_lookup_by_name_args {
1910
    remote_nonnull_domain dom;
C
Chris Lalancette 已提交
1911
    remote_nonnull_string name;
1912
    unsigned int flags;
C
Chris Lalancette 已提交
1913 1914 1915 1916 1917 1918 1919
};

struct remote_domain_snapshot_lookup_by_name_ret {
    remote_nonnull_domain_snapshot snap;
};

struct remote_domain_has_current_snapshot_args {
1920
    remote_nonnull_domain dom;
1921
    unsigned int flags;
C
Chris Lalancette 已提交
1922 1923 1924 1925 1926 1927 1928
};

struct remote_domain_has_current_snapshot_ret {
    int result;
};

struct remote_domain_snapshot_current_args {
1929
    remote_nonnull_domain dom;
1930
    unsigned int flags;
C
Chris Lalancette 已提交
1931 1932 1933 1934 1935 1936 1937 1938
};

struct remote_domain_snapshot_current_ret {
    remote_nonnull_domain_snapshot snap;
};

struct remote_domain_revert_to_snapshot_args {
    remote_nonnull_domain_snapshot snap;
1939
    unsigned int flags;
C
Chris Lalancette 已提交
1940 1941 1942 1943
};

struct remote_domain_snapshot_delete_args {
    remote_nonnull_domain_snapshot snap;
1944
    unsigned int flags;
C
Chris Lalancette 已提交
1945 1946
};

1947
struct remote_domain_open_console_args {
1948
    remote_nonnull_domain dom;
1949 1950 1951
    remote_string devname;
    unsigned int flags;
};
C
Chris Lalancette 已提交
1952

1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
struct remote_storage_vol_upload_args {
    remote_nonnull_storage_vol vol;
    unsigned hyper offset;
    unsigned hyper length;
    unsigned int flags;
};

struct remote_storage_vol_download_args {
    remote_nonnull_storage_vol vol;
    unsigned hyper offset;
    unsigned hyper length;
    unsigned int flags;
};

1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
struct remote_domain_get_state_args {
    remote_nonnull_domain dom;
    unsigned int flags;
};

struct remote_domain_get_state_ret {
    int state;
    int reason;
};

1977 1978
struct remote_domain_migrate_begin3_args {
    remote_nonnull_domain dom;
1979
    remote_string xmlin;
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
};

struct remote_domain_migrate_begin3_ret {
    opaque cookie_out<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_nonnull_string xml;
};

struct remote_domain_migrate_prepare3_args {
    opaque cookie_in<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_string uri_in;
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
    remote_nonnull_string dom_xml;
};

struct remote_domain_migrate_prepare3_ret {
    opaque cookie_out<REMOTE_MIGRATE_COOKIE_MAX>;
    remote_string uri_out;
};

struct remote_domain_migrate_prepare_tunnel3_args {
    opaque cookie_in<REMOTE_MIGRATE_COOKIE_MAX>;
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
    remote_nonnull_string dom_xml;
};

struct remote_domain_migrate_prepare_tunnel3_ret {
2013
    opaque cookie_out<REMOTE_MIGRATE_COOKIE_MAX>; /* insert@3 */
2014 2015 2016 2017
};

struct remote_domain_migrate_perform3_args {
    remote_nonnull_domain dom;
2018
    remote_string xmlin;
2019
    opaque cookie_in<REMOTE_MIGRATE_COOKIE_MAX>;
2020 2021
    remote_string dconnuri;
    remote_string uri;
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
    unsigned hyper flags;
    remote_string dname;
    unsigned hyper resource;
};

struct remote_domain_migrate_perform3_ret {
    opaque cookie_out<REMOTE_MIGRATE_COOKIE_MAX>;
};

struct remote_domain_migrate_finish3_args {
    remote_nonnull_string dname;
    opaque cookie_in<REMOTE_MIGRATE_COOKIE_MAX>;
2034 2035
    remote_string dconnuri;
    remote_string uri;
2036 2037 2038 2039 2040
    unsigned hyper flags;
    int cancelled;
};

struct remote_domain_migrate_finish3_ret {
2041
    remote_nonnull_domain dom;
2042 2043 2044 2045 2046 2047 2048 2049 2050
    opaque cookie_out<REMOTE_MIGRATE_COOKIE_MAX>;
};

struct remote_domain_migrate_confirm3_args {
    remote_nonnull_domain dom;
    opaque cookie_in<REMOTE_MIGRATE_COOKIE_MAX>;
    unsigned hyper flags;
    int cancelled;
};
2051

2052 2053 2054 2055 2056 2057 2058
/*----- Protocol. -----*/

/* Define the program number, protocol version and procedure numbers here. */
const REMOTE_PROGRAM = 0x20008086;
const REMOTE_PROTOCOL_VERSION = 1;

enum remote_procedure {
2059 2060
    /* Each function must have a two-word comment.  The first word is
     * whether remote_generator.pl handles daemon, the second whether
2061 2062 2063 2064 2065 2066 2067 2068
     * it handles src/remote.  Additional flags can be specified after a
     * pipe.
     *
     * The (readstream|writestream)@<offset> flag lets daemon and src/remote
     * create a stream.  The direction is defined from the src/remote point
     * of view.  A readstream transfers data from daemon to src/remote.  The
     * <offset> specifies at which offset the stream parameter is inserted
     * in the function parameter list. */
2069 2070
    REMOTE_PROC_OPEN = 1, /* skipgen skipgen */
    REMOTE_PROC_CLOSE = 2, /* skipgen skipgen */
2071
    REMOTE_PROC_GET_TYPE = 3, /* autogen skipgen */
2072 2073 2074 2075 2076 2077 2078 2079 2080
    REMOTE_PROC_GET_VERSION = 4, /* autogen autogen */
    REMOTE_PROC_GET_MAX_VCPUS = 5, /* autogen autogen */
    REMOTE_PROC_NODE_GET_INFO = 6, /* autogen autogen */
    REMOTE_PROC_GET_CAPABILITIES = 7, /* autogen autogen */
    REMOTE_PROC_DOMAIN_ATTACH_DEVICE = 8, /* autogen autogen */
    REMOTE_PROC_DOMAIN_CREATE = 9, /* autogen skipgen */
    REMOTE_PROC_DOMAIN_CREATE_XML = 10, /* autogen autogen */

    REMOTE_PROC_DOMAIN_DEFINE_XML = 11, /* autogen autogen */
2081
    REMOTE_PROC_DOMAIN_DESTROY = 12, /* autogen autogen */
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
    REMOTE_PROC_DOMAIN_DETACH_DEVICE = 13, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_XML_DESC = 14, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_AUTOSTART = 15, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_INFO = 16, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_MAX_MEMORY = 17, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_MAX_VCPUS = 18, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_OS_TYPE = 19, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_VCPUS = 20, /* skipgen skipgen */

    REMOTE_PROC_LIST_DEFINED_DOMAINS = 21, /* autogen autogen */
    REMOTE_PROC_DOMAIN_LOOKUP_BY_ID = 22, /* autogen autogen */
    REMOTE_PROC_DOMAIN_LOOKUP_BY_NAME = 23, /* autogen autogen */
    REMOTE_PROC_DOMAIN_LOOKUP_BY_UUID = 24, /* autogen autogen */
    REMOTE_PROC_NUM_OF_DEFINED_DOMAINS = 25, /* autogen autogen */
    REMOTE_PROC_DOMAIN_PIN_VCPU = 26, /* skipgen autogen */
    REMOTE_PROC_DOMAIN_REBOOT = 27, /* autogen autogen */
    REMOTE_PROC_DOMAIN_RESUME = 28, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SET_AUTOSTART = 29, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SET_MAX_MEMORY = 30, /* autogen autogen */

    REMOTE_PROC_DOMAIN_SET_MEMORY = 31, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SET_VCPUS = 32, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SHUTDOWN = 33, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SUSPEND = 34, /* autogen autogen */
    REMOTE_PROC_DOMAIN_UNDEFINE = 35, /* autogen autogen */
    REMOTE_PROC_LIST_DEFINED_NETWORKS = 36, /* autogen autogen */
    REMOTE_PROC_LIST_DOMAINS = 37, /* autogen skipgen */
    REMOTE_PROC_LIST_NETWORKS = 38, /* autogen autogen */
    REMOTE_PROC_NETWORK_CREATE = 39, /* autogen autogen */
    REMOTE_PROC_NETWORK_CREATE_XML = 40, /* autogen autogen */

    REMOTE_PROC_NETWORK_DEFINE_XML = 41, /* autogen autogen */
    REMOTE_PROC_NETWORK_DESTROY = 42, /* autogen autogen */
    REMOTE_PROC_NETWORK_GET_XML_DESC = 43, /* autogen autogen */
    REMOTE_PROC_NETWORK_GET_AUTOSTART = 44, /* autogen autogen */
    REMOTE_PROC_NETWORK_GET_BRIDGE_NAME = 45, /* autogen autogen */
    REMOTE_PROC_NETWORK_LOOKUP_BY_NAME = 46, /* autogen autogen */
    REMOTE_PROC_NETWORK_LOOKUP_BY_UUID = 47, /* autogen autogen */
    REMOTE_PROC_NETWORK_SET_AUTOSTART = 48, /* autogen autogen */
    REMOTE_PROC_NETWORK_UNDEFINE = 49, /* autogen autogen */
    REMOTE_PROC_NUM_OF_DEFINED_NETWORKS = 50, /* autogen autogen */

    REMOTE_PROC_NUM_OF_DOMAINS = 51, /* autogen autogen */
    REMOTE_PROC_NUM_OF_NETWORKS = 52, /* autogen autogen */
    REMOTE_PROC_DOMAIN_CORE_DUMP = 53, /* autogen autogen */
    REMOTE_PROC_DOMAIN_RESTORE = 54, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SAVE = 55, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_SCHEDULER_TYPE = 56, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_GET_SCHEDULER_PARAMETERS = 57, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_SET_SCHEDULER_PARAMETERS = 58, /* skipgen skipgen */
    REMOTE_PROC_GET_HOSTNAME = 59, /* autogen autogen */
2133
    REMOTE_PROC_SUPPORTS_FEATURE = 60, /* autogen autogen */
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193

    REMOTE_PROC_DOMAIN_MIGRATE_PREPARE = 61, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_PERFORM = 62, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MIGRATE_FINISH = 63, /* autogen autogen */
    REMOTE_PROC_DOMAIN_BLOCK_STATS = 64, /* autogen autogen */
    REMOTE_PROC_DOMAIN_INTERFACE_STATS = 65, /* autogen autogen */
    REMOTE_PROC_AUTH_LIST = 66, /* skipgen skipgen */
    REMOTE_PROC_AUTH_SASL_INIT = 67, /* skipgen skipgen */
    REMOTE_PROC_AUTH_SASL_START = 68, /* skipgen skipgen */
    REMOTE_PROC_AUTH_SASL_STEP = 69, /* skipgen skipgen */
    REMOTE_PROC_AUTH_POLKIT = 70, /* skipgen skipgen */

    REMOTE_PROC_NUM_OF_STORAGE_POOLS = 71, /* autogen autogen */
    REMOTE_PROC_LIST_STORAGE_POOLS = 72, /* autogen autogen */
    REMOTE_PROC_NUM_OF_DEFINED_STORAGE_POOLS = 73, /* autogen autogen */
    REMOTE_PROC_LIST_DEFINED_STORAGE_POOLS = 74, /* autogen autogen */
    REMOTE_PROC_FIND_STORAGE_POOL_SOURCES = 75, /* autogen skipgen */
    REMOTE_PROC_STORAGE_POOL_CREATE_XML = 76, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_DEFINE_XML = 77, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_CREATE = 78, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_BUILD = 79, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_DESTROY = 80, /* autogen autogen */

    REMOTE_PROC_STORAGE_POOL_DELETE = 81, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_UNDEFINE = 82, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_REFRESH = 83, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_LOOKUP_BY_NAME = 84, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_LOOKUP_BY_UUID = 85, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_LOOKUP_BY_VOLUME = 86, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_GET_INFO = 87, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_GET_XML_DESC = 88, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_GET_AUTOSTART = 89, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_SET_AUTOSTART = 90, /* autogen autogen */

    REMOTE_PROC_STORAGE_POOL_NUM_OF_VOLUMES = 91, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_LIST_VOLUMES = 92, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_CREATE_XML = 93, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_DELETE = 94, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_LOOKUP_BY_NAME = 95, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_LOOKUP_BY_KEY = 96, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_LOOKUP_BY_PATH = 97, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_GET_INFO = 98, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_GET_XML_DESC = 99, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_GET_PATH = 100, /* autogen autogen */

    REMOTE_PROC_NODE_GET_CELLS_FREE_MEMORY = 101, /* autogen skipgen */
    REMOTE_PROC_NODE_GET_FREE_MEMORY = 102, /* autogen autogen */
    REMOTE_PROC_DOMAIN_BLOCK_PEEK = 103, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MEMORY_PEEK = 104, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_EVENTS_REGISTER = 105, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_EVENTS_DEREGISTER = 106, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_EVENT_LIFECYCLE = 107, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MIGRATE_PREPARE2 = 108, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_FINISH2 = 109, /* autogen autogen */
    REMOTE_PROC_GET_URI = 110, /* autogen skipgen */

    REMOTE_PROC_NODE_NUM_OF_DEVICES = 111, /* autogen autogen */
    REMOTE_PROC_NODE_LIST_DEVICES = 112, /* autogen autogen */
    REMOTE_PROC_NODE_DEVICE_LOOKUP_BY_NAME = 113, /* autogen autogen */
    REMOTE_PROC_NODE_DEVICE_GET_XML_DESC = 114, /* autogen autogen */
2194
    REMOTE_PROC_NODE_DEVICE_GET_PARENT = 115, /* skipgen autogen */
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
    REMOTE_PROC_NODE_DEVICE_NUM_OF_CAPS = 116, /* autogen autogen */
    REMOTE_PROC_NODE_DEVICE_LIST_CAPS = 117, /* autogen autogen */
    REMOTE_PROC_NODE_DEVICE_DETTACH = 118, /* autogen skipgen */
    REMOTE_PROC_NODE_DEVICE_RE_ATTACH = 119, /* autogen skipgen */
    REMOTE_PROC_NODE_DEVICE_RESET = 120, /* autogen skipgen */

    REMOTE_PROC_DOMAIN_GET_SECURITY_LABEL = 121, /* skipgen skipgen */
    REMOTE_PROC_NODE_GET_SECURITY_MODEL = 122, /* skipgen skipgen */
    REMOTE_PROC_NODE_DEVICE_CREATE_XML = 123, /* autogen autogen */
    REMOTE_PROC_NODE_DEVICE_DESTROY = 124, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_CREATE_XML_FROM = 125, /* autogen autogen */
    REMOTE_PROC_NUM_OF_INTERFACES = 126, /* autogen autogen */
    REMOTE_PROC_LIST_INTERFACES = 127, /* autogen autogen */
    REMOTE_PROC_INTERFACE_LOOKUP_BY_NAME = 128, /* autogen autogen */
    REMOTE_PROC_INTERFACE_LOOKUP_BY_MAC_STRING = 129, /* autogen autogen */
    REMOTE_PROC_INTERFACE_GET_XML_DESC = 130, /* autogen autogen */

    REMOTE_PROC_INTERFACE_DEFINE_XML = 131, /* autogen autogen */
    REMOTE_PROC_INTERFACE_UNDEFINE = 132, /* autogen autogen */
    REMOTE_PROC_INTERFACE_CREATE = 133, /* autogen autogen */
    REMOTE_PROC_INTERFACE_DESTROY = 134, /* autogen autogen */
    REMOTE_PROC_DOMAIN_XML_FROM_NATIVE = 135, /* autogen autogen */
    REMOTE_PROC_DOMAIN_XML_TO_NATIVE = 136, /* autogen autogen */
    REMOTE_PROC_NUM_OF_DEFINED_INTERFACES = 137, /* autogen autogen */
    REMOTE_PROC_LIST_DEFINED_INTERFACES = 138, /* autogen autogen */
    REMOTE_PROC_NUM_OF_SECRETS = 139, /* autogen autogen */
    REMOTE_PROC_LIST_SECRETS = 140, /* autogen autogen */

    REMOTE_PROC_SECRET_LOOKUP_BY_UUID = 141, /* autogen autogen */
    REMOTE_PROC_SECRET_DEFINE_XML = 142, /* autogen autogen */
    REMOTE_PROC_SECRET_GET_XML_DESC = 143, /* autogen autogen */
    REMOTE_PROC_SECRET_SET_VALUE = 144, /* autogen autogen */
    REMOTE_PROC_SECRET_GET_VALUE = 145, /* skipgen skipgen */
    REMOTE_PROC_SECRET_UNDEFINE = 146, /* autogen autogen */
    REMOTE_PROC_SECRET_LOOKUP_BY_USAGE = 147, /* autogen autogen */
2230
    REMOTE_PROC_DOMAIN_MIGRATE_PREPARE_TUNNEL = 148, /* autogen autogen | writestream@1 */
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
    REMOTE_PROC_IS_SECURE = 149, /* autogen skipgen */
    REMOTE_PROC_DOMAIN_IS_ACTIVE = 150, /* autogen autogen */

    REMOTE_PROC_DOMAIN_IS_PERSISTENT = 151, /* autogen autogen */
    REMOTE_PROC_NETWORK_IS_ACTIVE = 152, /* autogen autogen */
    REMOTE_PROC_NETWORK_IS_PERSISTENT = 153, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_IS_ACTIVE = 154, /* autogen autogen */
    REMOTE_PROC_STORAGE_POOL_IS_PERSISTENT = 155, /* autogen autogen */
    REMOTE_PROC_INTERFACE_IS_ACTIVE = 156, /* autogen autogen */
    REMOTE_PROC_GET_LIB_VERSION = 157, /* autogen autogen */
    REMOTE_PROC_CPU_COMPARE = 158, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MEMORY_STATS = 159, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_ATTACH_DEVICE_FLAGS = 160, /* autogen autogen */

    REMOTE_PROC_DOMAIN_DETACH_DEVICE_FLAGS = 161, /* autogen autogen */
    REMOTE_PROC_CPU_BASELINE = 162, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_JOB_INFO = 163, /* autogen autogen */
    REMOTE_PROC_DOMAIN_ABORT_JOB = 164, /* autogen autogen */
    REMOTE_PROC_STORAGE_VOL_WIPE = 165, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MIGRATE_SET_MAX_DOWNTIME = 166, /* autogen autogen */
    REMOTE_PROC_DOMAIN_EVENTS_REGISTER_ANY = 167, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_EVENTS_DEREGISTER_ANY = 168, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_EVENT_REBOOT = 169, /* autogen autogen */
    REMOTE_PROC_DOMAIN_EVENT_RTC_CHANGE = 170, /* autogen autogen */

    REMOTE_PROC_DOMAIN_EVENT_WATCHDOG = 171, /* autogen autogen */
    REMOTE_PROC_DOMAIN_EVENT_IO_ERROR = 172, /* autogen autogen */
    REMOTE_PROC_DOMAIN_EVENT_GRAPHICS = 173, /* autogen autogen */
    REMOTE_PROC_DOMAIN_UPDATE_DEVICE_FLAGS = 174, /* autogen autogen */
    REMOTE_PROC_NWFILTER_LOOKUP_BY_NAME = 175, /* autogen autogen */
    REMOTE_PROC_NWFILTER_LOOKUP_BY_UUID = 176, /* autogen autogen */
    REMOTE_PROC_NWFILTER_GET_XML_DESC = 177, /* autogen autogen */
    REMOTE_PROC_NUM_OF_NWFILTERS = 178, /* autogen autogen */
    REMOTE_PROC_LIST_NWFILTERS = 179, /* autogen autogen */
    REMOTE_PROC_NWFILTER_DEFINE_XML = 180, /* autogen autogen */

    REMOTE_PROC_NWFILTER_UNDEFINE = 181, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MANAGED_SAVE = 182, /* autogen autogen */
    REMOTE_PROC_DOMAIN_HAS_MANAGED_SAVE_IMAGE = 183, /* autogen autogen */
    REMOTE_PROC_DOMAIN_MANAGED_SAVE_REMOVE = 184, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_CREATE_XML = 185, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_GET_XML_DESC = 186, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_NUM = 187, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_LIST_NAMES = 188, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_LOOKUP_BY_NAME = 189, /* autogen autogen */
    REMOTE_PROC_DOMAIN_HAS_CURRENT_SNAPSHOT = 190, /* autogen autogen */

    REMOTE_PROC_DOMAIN_SNAPSHOT_CURRENT = 191, /* autogen autogen */
    REMOTE_PROC_DOMAIN_REVERT_TO_SNAPSHOT = 192, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SNAPSHOT_DELETE = 193, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_BLOCK_INFO = 194, /* autogen autogen */
    REMOTE_PROC_DOMAIN_EVENT_IO_ERROR_REASON = 195, /* autogen autogen */
2283
    REMOTE_PROC_DOMAIN_CREATE_WITH_FLAGS = 196, /* autogen autogen */
2284 2285 2286 2287 2288
    REMOTE_PROC_DOMAIN_SET_MEMORY_PARAMETERS = 197, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_GET_MEMORY_PARAMETERS = 198, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_SET_VCPUS_FLAGS = 199, /* autogen autogen */
    REMOTE_PROC_DOMAIN_GET_VCPUS_FLAGS = 200, /* autogen autogen */

2289
    REMOTE_PROC_DOMAIN_OPEN_CONSOLE = 201, /* autogen autogen | readstream@2 */
2290 2291 2292 2293 2294 2295
    REMOTE_PROC_DOMAIN_IS_UPDATED = 202, /* autogen autogen */
    REMOTE_PROC_GET_SYSINFO = 203, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SET_MEMORY_FLAGS = 204, /* autogen autogen */
    REMOTE_PROC_DOMAIN_SET_BLKIO_PARAMETERS = 205, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_GET_BLKIO_PARAMETERS = 206, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_SET_MAX_SPEED = 207, /* autogen autogen */
2296 2297
    REMOTE_PROC_STORAGE_VOL_UPLOAD = 208, /* autogen autogen | writestream@1 */
    REMOTE_PROC_STORAGE_VOL_DOWNLOAD = 209, /* autogen autogen | readstream@1 */
2298
    REMOTE_PROC_DOMAIN_INJECT_NMI = 210, /* autogen autogen */
2299

2300
    REMOTE_PROC_DOMAIN_SCREENSHOT = 211, /* skipgen autogen | readstream@1 */
2301 2302 2303
    REMOTE_PROC_DOMAIN_GET_STATE = 212, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_BEGIN3 = 213, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_PREPARE3 = 214, /* skipgen skipgen */
2304
    REMOTE_PROC_DOMAIN_MIGRATE_PREPARE_TUNNEL3 = 215, /* autogen skipgen | writestream@1 */
2305 2306
    REMOTE_PROC_DOMAIN_MIGRATE_PERFORM3 = 216, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_MIGRATE_FINISH3 = 217, /* skipgen skipgen */
2307 2308
    REMOTE_PROC_DOMAIN_MIGRATE_CONFIRM3 = 218, /* skipgen skipgen */
    REMOTE_PROC_DOMAIN_SET_SCHEDULER_PARAMETERS_FLAGS = 219 /* skipgen skipgen */
2309

2310
    /* Notice how the entries are grouped in sets of 10 ?
2311
     * Nice isn't it. Please keep it this way when adding more.
2312 2313
     *
     * Each function must have a two-word comment.  The first word is
2314
     * whether remote_generator.pl handles daemon, the second whether
2315 2316 2317 2318 2319 2320 2321 2322
     * it handles src/remote.  Additional flags can be specified after a
     * pipe.
     *
     * The (readstream|writestream)@<offset> flag lets daemon and src/remote
     * create a stream.  The direction is defined from the src/remote point
     * of view.  A readstream transfers data from daemon to src/remote.  The
     * <offset> specifies at which offset the stream parameter is inserted
     * in the function parameter list. */
2323 2324
};

2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
/*
 * RPC wire format
 *
 * Each message consists of:
 *
 *    Name    | Type                  | Description
 * -----------+-----------------------+------------------
 *    Length  | int                   | Total number of bytes in message _including_ length.
 *    Header  | remote_message_header | Control information about procedure call
 *    Payload | -                     | Variable payload data per procedure
 *
 * In header, the 'serial' field varies according to:
 *
 *  - type == REMOTE_CALL
 *      * serial is set by client, incrementing by 1 each time
 *
 *  - type == REMOTE_REPLY
 *      * serial matches that from the corresponding REMOTE_CALL
 *
 *  - type == REMOTE_MESSAGE
2345 2346 2347 2348
 *      * serial is always zero
 *
 *  - type == REMOTE_STREAM
 *      * serial matches that from the corresponding REMOTE_CALL
2349
 *
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
 * and the 'status' field varies according to:
 *
 *  - type == REMOTE_CALL
 *     * REMOTE_OK always
 *
 *  - type == REMOTE_REPLY
 *     * REMOTE_OK if RPC finished successfully
 *     * REMOTE_ERROR if something failed
 *
 *  - type == REMOTE_MESSAGE
 *     * REMOTE_OK always
 *
 *  - type == REMOTE_STREAM
 *     * REMOTE_CONTINUE if more data is following
 *     * REMOTE_OK if stream is complete
 *     * REMOTE_ERROR if stream had an error
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382
 *
 * Payload varies according to type and status:
 *
 *  - type == REMOTE_CALL
 *          XXX_args  for procedure
 *
 *  - type == REMOTE_REPLY
 *     * status == REMOTE_OK
 *          XXX_ret         for procedure
 *     * status == REMOTE_ERROR
 *          remote_error    Error information
 *
 *  - type == REMOTE_MESSAGE
 *     * status == REMOTE_OK
 *          XXX_args        for procedure
 *     * status == REMOTE_ERROR
 *          remote_error    Error information
2383
 *
2384 2385 2386 2387 2388 2389 2390
 *  - type == REMOTE_STREAM
 *     * status == REMOTE_CONTINUE
 *          byte[]       raw stream data
 *     * status == REMOTE_ERROR
 *          remote_error error information
 *     * status == REMOTE_OK
 *          <empty>
2391
 */
2392 2393 2394 2395 2396 2397
enum remote_message_type {
    /* client -> server. args from a method call */
    REMOTE_CALL = 0,
    /* server -> client. reply/error from a method call */
    REMOTE_REPLY = 1,
    /* either direction. async notification */
2398 2399 2400
    REMOTE_MESSAGE = 2,
    /* either direction. stream data packet */
    REMOTE_STREAM = 3
2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
};

enum remote_message_status {
    /* Status is always REMOTE_OK for calls.
     * For replies, indicates no error.
     */
    REMOTE_OK = 0,

    /* For replies, indicates that an error happened, and a struct
     * remote_error follows.
     */
2412 2413 2414 2415 2416
    REMOTE_ERROR = 1,

    /* For streams, indicates that more data is still expected
     */
    REMOTE_CONTINUE = 2
2417 2418
};

2419 2420 2421
/* 4 byte length word per header */
const REMOTE_MESSAGE_HEADER_XDR_LEN = 4;

2422 2423 2424
struct remote_message_header {
    unsigned prog;              /* REMOTE_PROGRAM */
    unsigned vers;              /* REMOTE_PROTOCOL_VERSION */
C
Chris Lalancette 已提交
2425
    int proc;      /* REMOTE_PROC_x */
2426
    remote_message_type type;
2427 2428 2429
    unsigned serial;            /* Serial number of message. */
    remote_message_status status;
};