Prepare for 1.0.46.
[libguestfs.git] / 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 struct guestfs_tar_in_args {
496   string directory<>;
497 };
498
499 struct guestfs_tar_out_args {
500   string directory<>;
501 };
502
503 struct guestfs_tgz_in_args {
504   string directory<>;
505 };
506
507 struct guestfs_tgz_out_args {
508   string directory<>;
509 };
510
511 struct guestfs_mount_ro_args {
512   string device<>;
513   string mountpoint<>;
514 };
515
516 struct guestfs_mount_options_args {
517   string options<>;
518   string device<>;
519   string mountpoint<>;
520 };
521
522 struct guestfs_mount_vfs_args {
523   string options<>;
524   string vfstype<>;
525   string device<>;
526   string mountpoint<>;
527 };
528
529 struct guestfs_debug_args {
530   string subcmd<>;
531   str extraargs<>;
532 };
533
534 struct guestfs_debug_ret {
535   string result<>;
536 };
537
538 struct guestfs_lvremove_args {
539   string device<>;
540 };
541
542 struct guestfs_vgremove_args {
543   string vgname<>;
544 };
545
546 struct guestfs_pvremove_args {
547   string device<>;
548 };
549
550 struct guestfs_set_e2label_args {
551   string device<>;
552   string label<>;
553 };
554
555 struct guestfs_get_e2label_args {
556   string device<>;
557 };
558
559 struct guestfs_get_e2label_ret {
560   string label<>;
561 };
562
563 struct guestfs_set_e2uuid_args {
564   string device<>;
565   string uuid<>;
566 };
567
568 struct guestfs_get_e2uuid_args {
569   string device<>;
570 };
571
572 struct guestfs_get_e2uuid_ret {
573   string uuid<>;
574 };
575
576 struct guestfs_fsck_args {
577   string fstype<>;
578   string device<>;
579 };
580
581 struct guestfs_fsck_ret {
582   int status;
583 };
584
585 struct guestfs_zero_args {
586   string device<>;
587 };
588
589 struct guestfs_grub_install_args {
590   string root<>;
591   string device<>;
592 };
593
594 struct guestfs_cp_args {
595   string src<>;
596   string dest<>;
597 };
598
599 struct guestfs_cp_a_args {
600   string src<>;
601   string dest<>;
602 };
603
604 struct guestfs_mv_args {
605   string src<>;
606   string dest<>;
607 };
608
609 struct guestfs_drop_caches_args {
610   int whattodrop;
611 };
612
613 struct guestfs_dmesg_ret {
614   string kmsgs<>;
615 };
616
617 struct guestfs_equal_args {
618   string file1<>;
619   string file2<>;
620 };
621
622 struct guestfs_equal_ret {
623   bool equality;
624 };
625
626 struct guestfs_strings_args {
627   string path<>;
628 };
629
630 struct guestfs_strings_ret {
631   str stringsout<>;
632 };
633
634 struct guestfs_strings_e_args {
635   string encoding<>;
636   string path<>;
637 };
638
639 struct guestfs_strings_e_ret {
640   str stringsout<>;
641 };
642
643 struct guestfs_hexdump_args {
644   string path<>;
645 };
646
647 struct guestfs_hexdump_ret {
648   string dump<>;
649 };
650
651 struct guestfs_zerofree_args {
652   string device<>;
653 };
654
655 struct guestfs_pvresize_args {
656   string device<>;
657 };
658
659 struct guestfs_sfdisk_N_args {
660   string device<>;
661   int n;
662   int cyls;
663   int heads;
664   int sectors;
665   string line<>;
666 };
667
668 struct guestfs_sfdisk_l_args {
669   string device<>;
670 };
671
672 struct guestfs_sfdisk_l_ret {
673   string partitions<>;
674 };
675
676 struct guestfs_sfdisk_kernel_geometry_args {
677   string device<>;
678 };
679
680 struct guestfs_sfdisk_kernel_geometry_ret {
681   string partitions<>;
682 };
683
684 struct guestfs_sfdisk_disk_geometry_args {
685   string device<>;
686 };
687
688 struct guestfs_sfdisk_disk_geometry_ret {
689   string partitions<>;
690 };
691
692 struct guestfs_vg_activate_all_args {
693   bool activate;
694 };
695
696 struct guestfs_vg_activate_args {
697   bool activate;
698   str volgroups<>;
699 };
700
701 struct guestfs_lvresize_args {
702   string device<>;
703   int mbytes;
704 };
705
706 struct guestfs_resize2fs_args {
707   string device<>;
708 };
709
710 struct guestfs_find_args {
711   string directory<>;
712 };
713
714 struct guestfs_find_ret {
715   str names<>;
716 };
717
718 struct guestfs_e2fsck_f_args {
719   string device<>;
720 };
721
722 struct guestfs_sleep_args {
723   int secs;
724 };
725
726 struct guestfs_ntfs_3g_probe_args {
727   bool rw;
728   string device<>;
729 };
730
731 struct guestfs_ntfs_3g_probe_ret {
732   int status;
733 };
734
735 enum guestfs_procedure {
736   GUESTFS_PROC_MOUNT = 1,
737   GUESTFS_PROC_SYNC = 2,
738   GUESTFS_PROC_TOUCH = 3,
739   GUESTFS_PROC_CAT = 4,
740   GUESTFS_PROC_LL = 5,
741   GUESTFS_PROC_LS = 6,
742   GUESTFS_PROC_LIST_DEVICES = 7,
743   GUESTFS_PROC_LIST_PARTITIONS = 8,
744   GUESTFS_PROC_PVS = 9,
745   GUESTFS_PROC_VGS = 10,
746   GUESTFS_PROC_LVS = 11,
747   GUESTFS_PROC_PVS_FULL = 12,
748   GUESTFS_PROC_VGS_FULL = 13,
749   GUESTFS_PROC_LVS_FULL = 14,
750   GUESTFS_PROC_READ_LINES = 15,
751   GUESTFS_PROC_AUG_INIT = 16,
752   GUESTFS_PROC_AUG_CLOSE = 26,
753   GUESTFS_PROC_AUG_DEFVAR = 17,
754   GUESTFS_PROC_AUG_DEFNODE = 18,
755   GUESTFS_PROC_AUG_GET = 19,
756   GUESTFS_PROC_AUG_SET = 20,
757   GUESTFS_PROC_AUG_INSERT = 21,
758   GUESTFS_PROC_AUG_RM = 22,
759   GUESTFS_PROC_AUG_MV = 23,
760   GUESTFS_PROC_AUG_MATCH = 24,
761   GUESTFS_PROC_AUG_SAVE = 25,
762   GUESTFS_PROC_AUG_LOAD = 27,
763   GUESTFS_PROC_AUG_LS = 28,
764   GUESTFS_PROC_RM = 29,
765   GUESTFS_PROC_RMDIR = 30,
766   GUESTFS_PROC_RM_RF = 31,
767   GUESTFS_PROC_MKDIR = 32,
768   GUESTFS_PROC_MKDIR_P = 33,
769   GUESTFS_PROC_CHMOD = 34,
770   GUESTFS_PROC_CHOWN = 35,
771   GUESTFS_PROC_EXISTS = 36,
772   GUESTFS_PROC_IS_FILE = 37,
773   GUESTFS_PROC_IS_DIR = 38,
774   GUESTFS_PROC_PVCREATE = 39,
775   GUESTFS_PROC_VGCREATE = 40,
776   GUESTFS_PROC_LVCREATE = 41,
777   GUESTFS_PROC_MKFS = 42,
778   GUESTFS_PROC_SFDISK = 43,
779   GUESTFS_PROC_WRITE_FILE = 44,
780   GUESTFS_PROC_UMOUNT = 45,
781   GUESTFS_PROC_MOUNTS = 46,
782   GUESTFS_PROC_UMOUNT_ALL = 47,
783   GUESTFS_PROC_LVM_REMOVE_ALL = 48,
784   GUESTFS_PROC_FILE = 49,
785   GUESTFS_PROC_COMMAND = 50,
786   GUESTFS_PROC_COMMAND_LINES = 51,
787   GUESTFS_PROC_STAT = 52,
788   GUESTFS_PROC_LSTAT = 53,
789   GUESTFS_PROC_STATVFS = 54,
790   GUESTFS_PROC_TUNE2FS_L = 55,
791   GUESTFS_PROC_BLOCKDEV_SETRO = 56,
792   GUESTFS_PROC_BLOCKDEV_SETRW = 57,
793   GUESTFS_PROC_BLOCKDEV_GETRO = 58,
794   GUESTFS_PROC_BLOCKDEV_GETSS = 59,
795   GUESTFS_PROC_BLOCKDEV_GETBSZ = 60,
796   GUESTFS_PROC_BLOCKDEV_SETBSZ = 61,
797   GUESTFS_PROC_BLOCKDEV_GETSZ = 62,
798   GUESTFS_PROC_BLOCKDEV_GETSIZE64 = 63,
799   GUESTFS_PROC_BLOCKDEV_FLUSHBUFS = 64,
800   GUESTFS_PROC_BLOCKDEV_REREADPT = 65,
801   GUESTFS_PROC_UPLOAD = 66,
802   GUESTFS_PROC_DOWNLOAD = 67,
803   GUESTFS_PROC_CHECKSUM = 68,
804   GUESTFS_PROC_TAR_IN = 69,
805   GUESTFS_PROC_TAR_OUT = 70,
806   GUESTFS_PROC_TGZ_IN = 71,
807   GUESTFS_PROC_TGZ_OUT = 72,
808   GUESTFS_PROC_MOUNT_RO = 73,
809   GUESTFS_PROC_MOUNT_OPTIONS = 74,
810   GUESTFS_PROC_MOUNT_VFS = 75,
811   GUESTFS_PROC_DEBUG = 76,
812   GUESTFS_PROC_LVREMOVE = 77,
813   GUESTFS_PROC_VGREMOVE = 78,
814   GUESTFS_PROC_PVREMOVE = 79,
815   GUESTFS_PROC_SET_E2LABEL = 80,
816   GUESTFS_PROC_GET_E2LABEL = 81,
817   GUESTFS_PROC_SET_E2UUID = 82,
818   GUESTFS_PROC_GET_E2UUID = 83,
819   GUESTFS_PROC_FSCK = 84,
820   GUESTFS_PROC_ZERO = 85,
821   GUESTFS_PROC_GRUB_INSTALL = 86,
822   GUESTFS_PROC_CP = 87,
823   GUESTFS_PROC_CP_A = 88,
824   GUESTFS_PROC_MV = 89,
825   GUESTFS_PROC_DROP_CACHES = 90,
826   GUESTFS_PROC_DMESG = 91,
827   GUESTFS_PROC_PING_DAEMON = 92,
828   GUESTFS_PROC_EQUAL = 93,
829   GUESTFS_PROC_STRINGS = 94,
830   GUESTFS_PROC_STRINGS_E = 95,
831   GUESTFS_PROC_HEXDUMP = 96,
832   GUESTFS_PROC_ZEROFREE = 97,
833   GUESTFS_PROC_PVRESIZE = 98,
834   GUESTFS_PROC_SFDISK_N = 99,
835   GUESTFS_PROC_SFDISK_L = 100,
836   GUESTFS_PROC_SFDISK_KERNEL_GEOMETRY = 101,
837   GUESTFS_PROC_SFDISK_DISK_GEOMETRY = 102,
838   GUESTFS_PROC_VG_ACTIVATE_ALL = 103,
839   GUESTFS_PROC_VG_ACTIVATE = 104,
840   GUESTFS_PROC_LVRESIZE = 105,
841   GUESTFS_PROC_RESIZE2FS = 106,
842   GUESTFS_PROC_FIND = 107,
843   GUESTFS_PROC_E2FSCK_F = 108,
844   GUESTFS_PROC_SLEEP = 109,
845   GUESTFS_PROC_NTFS_3G_PROBE = 110,
846   GUESTFS_PROC_NR_PROCS
847 };
848
849 const GUESTFS_MESSAGE_MAX = 4194304;
850
851 /* The communication protocol is now documented in the guestfs(3)
852  * manpage.
853  */
854
855 const GUESTFS_PROGRAM = 0x2000F5F5;
856 const GUESTFS_PROTOCOL_VERSION = 1;
857
858 /* These constants must be larger than any possible message length. */
859 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
860 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
861
862 enum guestfs_message_direction {
863   GUESTFS_DIRECTION_CALL = 0,        /* client -> daemon */
864   GUESTFS_DIRECTION_REPLY = 1        /* daemon -> client */
865 };
866
867 enum guestfs_message_status {
868   GUESTFS_STATUS_OK = 0,
869   GUESTFS_STATUS_ERROR = 1
870 };
871
872 const GUESTFS_ERROR_LEN = 256;
873
874 struct guestfs_message_error {
875   string error_message<GUESTFS_ERROR_LEN>;
876 };
877
878 struct guestfs_message_header {
879   unsigned prog;                     /* GUESTFS_PROGRAM */
880   unsigned vers;                     /* GUESTFS_PROTOCOL_VERSION */
881   guestfs_procedure proc;            /* GUESTFS_PROC_x */
882   guestfs_message_direction direction;
883   unsigned serial;                   /* message serial number */
884   guestfs_message_status status;
885 };
886
887 const GUESTFS_MAX_CHUNK_SIZE = 8192;
888
889 struct guestfs_chunk {
890   int cancel;                        /* if non-zero, transfer is cancelled */
891   /* data size is 0 bytes if the transfer has finished successfully */
892   opaque data<GUESTFS_MAX_CHUNK_SIZE>;
893 };