src/guestfs_protocol.x

   1 /* libguestfs generated file
   2  * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.
   3  * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.
   4  *
   5  * Copyright (C) 2009 Red Hat Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 typedef string str<>;
  23
  24 struct guestfs_lvm_int_pv {
  25   string pv_name<>;
  26   opaque pv_uuid[32];
  27   string pv_fmt<>;
  28   hyper pv_size;
  29   hyper dev_size;
  30   hyper pv_free;
  31   hyper pv_used;
  32   string pv_attr<>;
  33   hyper pv_pe_count;
  34   hyper pv_pe_alloc_count;
  35   string pv_tags<>;
  36   hyper pe_start;
  37   hyper pv_mda_count;
  38   hyper pv_mda_free;
  39 };
  40
  41 typedef struct guestfs_lvm_int_pv guestfs_lvm_int_pv_list<>;
  42
  43 struct guestfs_lvm_int_vg {
  44   string vg_name<>;
  45   opaque vg_uuid[32];
  46   string vg_fmt<>;
  47   string vg_attr<>;
  48   hyper vg_size;
  49   hyper vg_free;
  50   string vg_sysid<>;
  51   hyper vg_extent_size;
  52   hyper vg_extent_count;
  53   hyper vg_free_count;
  54   hyper max_lv;
  55   hyper max_pv;
  56   hyper pv_count;
  57   hyper lv_count;
  58   hyper snap_count;
  59   hyper vg_seqno;
  60   string vg_tags<>;
  61   hyper vg_mda_count;
  62   hyper vg_mda_free;
  63 };
  64
  65 typedef struct guestfs_lvm_int_vg guestfs_lvm_int_vg_list<>;
  66
  67 struct guestfs_lvm_int_lv {
  68   string lv_name<>;
  69   opaque lv_uuid[32];
  70   string lv_attr<>;
  71   hyper lv_major;
  72   hyper lv_minor;
  73   hyper lv_kernel_major;
  74   hyper lv_kernel_minor;
  75   hyper lv_size;
  76   hyper seg_count;
  77   string origin<>;
  78   float snap_percent;
  79   float copy_percent;
  80   string move_pv<>;
  81   string lv_tags<>;
  82   string mirror_log<>;
  83   string modules<>;
  84 };
  85
  86 typedef struct guestfs_lvm_int_lv guestfs_lvm_int_lv_list<>;
  87
  88 struct guestfs_int_stat {
  89   hyper dev;
  90   hyper ino;
  91   hyper mode;
  92   hyper nlink;
  93   hyper uid;
  94   hyper gid;
  95   hyper rdev;
  96   hyper size;
  97   hyper blksize;
  98   hyper blocks;
  99   hyper atime;
 100   hyper mtime;
 101   hyper ctime;
 102 };
 103
 104 struct guestfs_int_statvfs {
 105   hyper bsize;
 106   hyper frsize;
 107   hyper blocks;
 108   hyper bfree;
 109   hyper bavail;
 110   hyper files;
 111   hyper ffree;
 112   hyper favail;
 113   hyper fsid;
 114   hyper flag;
 115   hyper namemax;
 116 };
 117
 118 struct guestfs_mount_args {
 119   string device<>;
 120   string mountpoint<>;
 121 };
 122
 123 struct guestfs_touch_args {
 124   string path<>;
 125 };
 126
 127 struct guestfs_cat_args {
 128   string path<>;
 129 };
 130
 131 struct guestfs_cat_ret {
 132   string content<>;
 133 };
 134
 135 struct guestfs_ll_args {
 136   string directory<>;
 137 };
 138
 139 struct guestfs_ll_ret {
 140   string listing<>;
 141 };
 142
 143 struct guestfs_ls_args {
 144   string directory<>;
 145 };
 146
 147 struct guestfs_ls_ret {
 148   str listing<>;
 149 };
 150
 151 struct guestfs_list_devices_ret {
 152   str devices<>;
 153 };
 154
 155 struct guestfs_list_partitions_ret {
 156   str partitions<>;
 157 };
 158
 159 struct guestfs_pvs_ret {
 160   str physvols<>;
 161 };
 162
 163 struct guestfs_vgs_ret {
 164   str volgroups<>;
 165 };
 166
 167 struct guestfs_lvs_ret {
 168   str logvols<>;
 169 };
 170
 171 struct guestfs_pvs_full_ret {
 172   guestfs_lvm_int_pv_list physvols;
 173 };
 174
 175 struct guestfs_vgs_full_ret {
 176   guestfs_lvm_int_vg_list volgroups;
 177 };
 178
 179 struct guestfs_lvs_full_ret {
 180   guestfs_lvm_int_lv_list logvols;
 181 };
 182
 183 struct guestfs_read_lines_args {
 184   string path<>;
 185 };
 186
 187 struct guestfs_read_lines_ret {
 188   str lines<>;
 189 };
 190
 191 struct guestfs_aug_init_args {
 192   string root<>;
 193   int flags;
 194 };
 195
 196 struct guestfs_aug_defvar_args {
 197   string name<>;
 198   str *expr;
 199 };
 200
 201 struct guestfs_aug_defvar_ret {
 202   int nrnodes;
 203 };
 204
 205 struct guestfs_aug_defnode_args {
 206   string name<>;
 207   string expr<>;
 208   string val<>;
 209 };
 210
 211 struct guestfs_aug_defnode_ret {
 212   int nrnodes;
 213   bool created;
 214 };
 215
 216 struct guestfs_aug_get_args {
 217   string path<>;
 218 };
 219
 220 struct guestfs_aug_get_ret {
 221   string val<>;
 222 };
 223
 224 struct guestfs_aug_set_args {
 225   string path<>;
 226   string val<>;
 227 };
 228
 229 struct guestfs_aug_insert_args {
 230   string path<>;
 231   string label<>;
 232   bool before;
 233 };
 234
 235 struct guestfs_aug_rm_args {
 236   string path<>;
 237 };
 238
 239 struct guestfs_aug_rm_ret {
 240   int nrnodes;
 241 };
 242
 243 struct guestfs_aug_mv_args {
 244   string src<>;
 245   string dest<>;
 246 };
 247
 248 struct guestfs_aug_match_args {
 249   string path<>;
 250 };
 251
 252 struct guestfs_aug_match_ret {
 253   str matches<>;
 254 };
 255
 256 struct guestfs_aug_ls_args {
 257   string path<>;
 258 };
 259
 260 struct guestfs_aug_ls_ret {
 261   str matches<>;
 262 };
 263
 264 struct guestfs_rm_args {
 265   string path<>;
 266 };
 267
 268 struct guestfs_rmdir_args {
 269   string path<>;
 270 };
 271
 272 struct guestfs_rm_rf_args {
 273   string path<>;
 274 };
 275
 276 struct guestfs_mkdir_args {
 277   string path<>;
 278 };
 279
 280 struct guestfs_mkdir_p_args {
 281   string path<>;
 282 };
 283
 284 struct guestfs_chmod_args {
 285   int mode;
 286   string path<>;
 287 };
 288
 289 struct guestfs_chown_args {
 290   int owner;
 291   int group;
 292   string path<>;
 293 };
 294
 295 struct guestfs_exists_args {
 296   string path<>;
 297 };
 298
 299 struct guestfs_exists_ret {
 300   bool existsflag;
 301 };
 302
 303 struct guestfs_is_file_args {
 304   string path<>;
 305 };
 306
 307 struct guestfs_is_file_ret {
 308   bool fileflag;
 309 };
 310
 311 struct guestfs_is_dir_args {
 312   string path<>;
 313 };
 314
 315 struct guestfs_is_dir_ret {
 316   bool dirflag;
 317 };
 318
 319 struct guestfs_pvcreate_args {
 320   string device<>;
 321 };
 322
 323 struct guestfs_vgcreate_args {
 324   string volgroup<>;
 325   str physvols<>;
 326 };
 327
 328 struct guestfs_lvcreate_args {
 329   string logvol<>;
 330   string volgroup<>;
 331   int mbytes;
 332 };
 333
 334 struct guestfs_mkfs_args {
 335   string fstype<>;
 336   string device<>;
 337 };
 338
 339 struct guestfs_sfdisk_args {
 340   string device<>;
 341   int cyls;
 342   int heads;
 343   int sectors;
 344   str lines<>;
 345 };
 346
 347 struct guestfs_write_file_args {
 348   string path<>;
 349   string content<>;
 350   int size;
 351 };
 352
 353 struct guestfs_umount_args {
 354   string pathordevice<>;
 355 };
 356
 357 struct guestfs_mounts_ret {
 358   str devices<>;
 359 };
 360
 361 struct guestfs_file_args {
 362   string path<>;
 363 };
 364
 365 struct guestfs_file_ret {
 366   string description<>;
 367 };
 368
 369 struct guestfs_command_args {
 370   str arguments<>;
 371 };
 372
 373 struct guestfs_command_ret {
 374   string output<>;
 375 };
 376
 377 struct guestfs_command_lines_args {
 378   str arguments<>;
 379 };
 380
 381 struct guestfs_command_lines_ret {
 382   str lines<>;
 383 };
 384
 385 struct guestfs_stat_args {
 386   string path<>;
 387 };
 388
 389 struct guestfs_stat_ret {
 390   guestfs_int_stat statbuf;
 391 };
 392
 393 struct guestfs_lstat_args {
 394   string path<>;
 395 };
 396
 397 struct guestfs_lstat_ret {
 398   guestfs_int_stat statbuf;
 399 };
 400
 401 struct guestfs_statvfs_args {
 402   string path<>;
 403 };
 404
 405 struct guestfs_statvfs_ret {
 406   guestfs_int_statvfs statbuf;
 407 };
 408
 409 struct guestfs_tune2fs_l_args {
 410   string device<>;
 411 };
 412
 413 struct guestfs_tune2fs_l_ret {
 414   str superblock<>;
 415 };
 416
 417 struct guestfs_blockdev_setro_args {
 418   string device<>;
 419 };
 420
 421 struct guestfs_blockdev_setrw_args {
 422   string device<>;
 423 };
 424
 425 struct guestfs_blockdev_getro_args {
 426   string device<>;
 427 };
 428
 429 struct guestfs_blockdev_getro_ret {
 430   bool ro;
 431 };
 432
 433 struct guestfs_blockdev_getss_args {
 434   string device<>;
 435 };
 436
 437 struct guestfs_blockdev_getss_ret {
 438   int sectorsize;
 439 };
 440
 441 struct guestfs_blockdev_getbsz_args {
 442   string device<>;
 443 };
 444
 445 struct guestfs_blockdev_getbsz_ret {
 446   int blocksize;
 447 };
 448
 449 struct guestfs_blockdev_setbsz_args {
 450   string device<>;
 451   int blocksize;
 452 };
 453
 454 struct guestfs_blockdev_getsz_args {
 455   string device<>;
 456 };
 457
 458 struct guestfs_blockdev_getsz_ret {
 459   hyper sizeinsectors;
 460 };
 461
 462 struct guestfs_blockdev_getsize64_args {
 463   string device<>;
 464 };
 465
 466 struct guestfs_blockdev_getsize64_ret {
 467   hyper sizeinbytes;
 468 };
 469
 470 struct guestfs_blockdev_flushbufs_args {
 471   string device<>;
 472 };
 473
 474 struct guestfs_blockdev_rereadpt_args {
 475   string device<>;
 476 };
 477
 478 struct guestfs_upload_args {
 479   string remotefilename<>;
 480 };
 481
 482 struct guestfs_download_args {
 483   string remotefilename<>;
 484 };
 485
 486 struct guestfs_checksum_args {
 487   string csumtype<>;
 488   string path<>;
 489 };
 490
 491 struct guestfs_checksum_ret {
 492   string checksum<>;
 493 };
 494
 495 enum guestfs_procedure {
 496   GUESTFS_PROC_MOUNT = 1,
 497   GUESTFS_PROC_SYNC = 2,
 498   GUESTFS_PROC_TOUCH = 3,
 499   GUESTFS_PROC_CAT = 4,
 500   GUESTFS_PROC_LL = 5,
 501   GUESTFS_PROC_LS = 6,
 502   GUESTFS_PROC_LIST_DEVICES = 7,
 503   GUESTFS_PROC_LIST_PARTITIONS = 8,
 504   GUESTFS_PROC_PVS = 9,
 505   GUESTFS_PROC_VGS = 10,
 506   GUESTFS_PROC_LVS = 11,
 507   GUESTFS_PROC_PVS_FULL = 12,
 508   GUESTFS_PROC_VGS_FULL = 13,
 509   GUESTFS_PROC_LVS_FULL = 14,
 510   GUESTFS_PROC_READ_LINES = 15,
 511   GUESTFS_PROC_AUG_INIT = 16,
 512   GUESTFS_PROC_AUG_CLOSE = 26,
 513   GUESTFS_PROC_AUG_DEFVAR = 17,
 514   GUESTFS_PROC_AUG_DEFNODE = 18,
 515   GUESTFS_PROC_AUG_GET = 19,
 516   GUESTFS_PROC_AUG_SET = 20,
 517   GUESTFS_PROC_AUG_INSERT = 21,
 518   GUESTFS_PROC_AUG_RM = 22,
 519   GUESTFS_PROC_AUG_MV = 23,
 520   GUESTFS_PROC_AUG_MATCH = 24,
 521   GUESTFS_PROC_AUG_SAVE = 25,
 522   GUESTFS_PROC_AUG_LOAD = 27,
 523   GUESTFS_PROC_AUG_LS = 28,
 524   GUESTFS_PROC_RM = 29,
 525   GUESTFS_PROC_RMDIR = 30,
 526   GUESTFS_PROC_RM_RF = 31,
 527   GUESTFS_PROC_MKDIR = 32,
 528   GUESTFS_PROC_MKDIR_P = 33,
 529   GUESTFS_PROC_CHMOD = 34,
 530   GUESTFS_PROC_CHOWN = 35,
 531   GUESTFS_PROC_EXISTS = 36,
 532   GUESTFS_PROC_IS_FILE = 37,
 533   GUESTFS_PROC_IS_DIR = 38,
 534   GUESTFS_PROC_PVCREATE = 39,
 535   GUESTFS_PROC_VGCREATE = 40,
 536   GUESTFS_PROC_LVCREATE = 41,
 537   GUESTFS_PROC_MKFS = 42,
 538   GUESTFS_PROC_SFDISK = 43,
 539   GUESTFS_PROC_WRITE_FILE = 44,
 540   GUESTFS_PROC_UMOUNT = 45,
 541   GUESTFS_PROC_MOUNTS = 46,
 542   GUESTFS_PROC_UMOUNT_ALL = 47,
 543   GUESTFS_PROC_LVM_REMOVE_ALL = 48,
 544   GUESTFS_PROC_FILE = 49,
 545   GUESTFS_PROC_COMMAND = 50,
 546   GUESTFS_PROC_COMMAND_LINES = 51,
 547   GUESTFS_PROC_STAT = 52,
 548   GUESTFS_PROC_LSTAT = 53,
 549   GUESTFS_PROC_STATVFS = 54,
 550   GUESTFS_PROC_TUNE2FS_L = 55,
 551   GUESTFS_PROC_BLOCKDEV_SETRO = 56,
 552   GUESTFS_PROC_BLOCKDEV_SETRW = 57,
 553   GUESTFS_PROC_BLOCKDEV_GETRO = 58,
 554   GUESTFS_PROC_BLOCKDEV_GETSS = 59,
 555   GUESTFS_PROC_BLOCKDEV_GETBSZ = 60,
 556   GUESTFS_PROC_BLOCKDEV_SETBSZ = 61,
 557   GUESTFS_PROC_BLOCKDEV_GETSZ = 62,
 558   GUESTFS_PROC_BLOCKDEV_GETSIZE64 = 63,
 559   GUESTFS_PROC_BLOCKDEV_FLUSHBUFS = 64,
 560   GUESTFS_PROC_BLOCKDEV_REREADPT = 65,
 561   GUESTFS_PROC_UPLOAD = 66,
 562   GUESTFS_PROC_DOWNLOAD = 67,
 563   GUESTFS_PROC_CHECKSUM = 68,
 564   GUESTFS_PROC_NR_PROCS
 565 };
 566
 567 const GUESTFS_MESSAGE_MAX = 4194304;
 568
 569 /* The communication protocol is now documented in the guestfs(3)
 570  * manpage.
 571  */
 572
 573 const GUESTFS_PROGRAM = 0x2000F5F5;
 574 const GUESTFS_PROTOCOL_VERSION = 1;
 575
 576 /* These constants must be larger than any possible message length. */
 577 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
 578 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
 579
 580 enum guestfs_message_direction {
 581   GUESTFS_DIRECTION_CALL = 0,        /* client -> daemon */
 582   GUESTFS_DIRECTION_REPLY = 1        /* daemon -> client */
 583 };
 584
 585 enum guestfs_message_status {
 586   GUESTFS_STATUS_OK = 0,
 587   GUESTFS_STATUS_ERROR = 1
 588 };
 589
 590 const GUESTFS_ERROR_LEN = 256;
 591
 592 struct guestfs_message_error {
 593   string error_message<GUESTFS_ERROR_LEN>;
 594 };
 595
 596 struct guestfs_message_header {
 597   unsigned prog;                     /* GUESTFS_PROGRAM */
 598   unsigned vers;                     /* GUESTFS_PROTOCOL_VERSION */
 599   guestfs_procedure proc;            /* GUESTFS_PROC_x */
 600   guestfs_message_direction direction;
 601   unsigned serial;                   /* message serial number */
 602   guestfs_message_status status;
 603 };
 604
 605 const GUESTFS_MAX_CHUNK_SIZE = 8192;
 606
 607 struct guestfs_chunk {
 608   int cancel;                        /* if non-zero, transfer is cancelled */
 609   /* data size is 0 bytes if the transfer has finished successfully */
 610   opaque data<GUESTFS_MAX_CHUNK_SIZE>;
 611 };