inspect: Inspection support for FreeBSD.
[libguestfs.git] / generator / generator_xdr.ml
1 (* libguestfs
2  * Copyright (C) 2009-2010 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *)
18
19 (* Please read generator/README first. *)
20
21 open Printf
22
23 open Generator_types
24 open Generator_utils
25 open Generator_pr
26 open Generator_docstrings
27 open Generator_optgroups
28 open Generator_actions
29 open Generator_structs
30
31 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
32  * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
33  *
34  * We have to use an underscore instead of a dash because otherwise
35  * rpcgen generates incorrect code.
36  *
37  * This header is NOT exported to clients, but see also generate_structs_h.
38  *)
39 let generate_xdr () =
40   generate_header CStyle LGPLv2plus;
41
42   (* This has to be defined to get around a limitation in Sun's rpcgen. *)
43   pr "typedef string guestfs_str<>;\n";
44   pr "\n";
45
46   (* Internal structures. *)
47   List.iter (
48     function
49     | typ, cols ->
50         pr "struct guestfs_int_%s {\n" typ;
51         List.iter (function
52                    | name, FChar -> pr "  char %s;\n" name
53                    | name, FString -> pr "  string %s<>;\n" name
54                    | name, FBuffer -> pr "  opaque %s<>;\n" name
55                    | name, FUUID -> pr "  opaque %s[32];\n" name
56                    | name, (FInt32|FUInt32) -> pr "  int %s;\n" name
57                    | name, (FInt64|FUInt64|FBytes) -> pr "  hyper %s;\n" name
58                    | name, FOptPercent -> pr "  float %s;\n" name
59                   ) cols;
60         pr "};\n";
61         pr "\n";
62         pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
63         pr "\n";
64   ) structs;
65
66   List.iter (
67     fun (shortname, (ret, args, optargs), _, _, _, _, _) ->
68       if optargs <> [] then
69         failwithf "optional arguments not supported in XDR yet";
70
71       let name = "guestfs_" ^ shortname in
72
73       (match args with
74        | [] -> ()
75        | args ->
76            pr "struct %s_args {\n" name;
77            List.iter (
78              function
79              | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
80                  pr "  string %s<>;\n" n
81              | OptString n -> pr "  guestfs_str *%s;\n" n
82              | StringList n | DeviceList n -> pr "  guestfs_str %s<>;\n" n
83              | Bool n -> pr "  bool %s;\n" n
84              | Int n -> pr "  int %s;\n" n
85              | Int64 n -> pr "  hyper %s;\n" n
86              | BufferIn n ->
87                  pr "  opaque %s<>;\n" n
88              | FileIn _ | FileOut _ -> ()
89              | Pointer _ -> assert false
90            ) args;
91            pr "};\n\n"
92       );
93       (match ret with
94        | RErr -> ()
95        | RInt n ->
96            pr "struct %s_ret {\n" name;
97            pr "  int %s;\n" n;
98            pr "};\n\n"
99        | RInt64 n ->
100            pr "struct %s_ret {\n" name;
101            pr "  hyper %s;\n" n;
102            pr "};\n\n"
103        | RBool n ->
104            pr "struct %s_ret {\n" name;
105            pr "  bool %s;\n" n;
106            pr "};\n\n"
107        | RConstString _ | RConstOptString _ ->
108            failwithf "RConstString|RConstOptString cannot be used by daemon functions"
109        | RString n ->
110            pr "struct %s_ret {\n" name;
111            pr "  string %s<>;\n" n;
112            pr "};\n\n"
113        | RStringList n ->
114            pr "struct %s_ret {\n" name;
115            pr "  guestfs_str %s<>;\n" n;
116            pr "};\n\n"
117        | RStruct (n, typ) ->
118            pr "struct %s_ret {\n" name;
119            pr "  guestfs_int_%s %s;\n" typ n;
120            pr "};\n\n"
121        | RStructList (n, typ) ->
122            pr "struct %s_ret {\n" name;
123            pr "  guestfs_int_%s_list %s;\n" typ n;
124            pr "};\n\n"
125        | RHashtable n ->
126            pr "struct %s_ret {\n" name;
127            pr "  guestfs_str %s<>;\n" n;
128            pr "};\n\n"
129        | RBufferOut n ->
130            pr "struct %s_ret {\n" name;
131            pr "  opaque %s<>;\n" n;
132            pr "};\n\n"
133       );
134   ) daemon_functions;
135
136   (* Table of procedure numbers. *)
137   pr "enum guestfs_procedure {\n";
138   List.iter (
139     fun (shortname, _, proc_nr, _, _, _, _) ->
140       pr "  GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
141   ) daemon_functions;
142   pr "  GUESTFS_PROC_NR_PROCS\n";
143   pr "};\n";
144   pr "\n";
145
146   (* Having to choose a maximum message size is annoying for several
147    * reasons (it limits what we can do in the API), but it (a) makes
148    * the protocol a lot simpler, and (b) provides a bound on the size
149    * of the daemon which operates in limited memory space.
150    *)
151   pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
152   pr "\n";
153
154   (* Message header, etc. *)
155   pr "\
156 /* The communication protocol is now documented in the guestfs(3)
157  * manpage.
158  */
159
160 const GUESTFS_PROGRAM = 0x2000F5F5;
161 const GUESTFS_PROTOCOL_VERSION = 3;
162
163 /* These constants must be larger than any possible message length. */
164 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
165 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
166 const GUESTFS_PROGRESS_FLAG = 0xffff5555;
167
168 enum guestfs_message_direction {
169   GUESTFS_DIRECTION_CALL = 0,        /* client -> daemon */
170   GUESTFS_DIRECTION_REPLY = 1        /* daemon -> client */
171 };
172
173 enum guestfs_message_status {
174   GUESTFS_STATUS_OK = 0,
175   GUESTFS_STATUS_ERROR = 1
176 };
177
178 ";
179
180   pr "const GUESTFS_ERROR_LEN = %d;\n" (64 * 1024);
181   pr "\n";
182
183   pr "\
184 struct guestfs_message_error {
185   string errno_string<32>;           /* errno eg. \"EINVAL\", empty string
186                                         if errno not available */
187   string error_message<GUESTFS_ERROR_LEN>;
188 };
189
190 struct guestfs_message_header {
191   unsigned prog;                     /* GUESTFS_PROGRAM */
192   unsigned vers;                     /* GUESTFS_PROTOCOL_VERSION */
193   guestfs_procedure proc;            /* GUESTFS_PROC_x */
194   guestfs_message_direction direction;
195   unsigned serial;                   /* message serial number */
196   guestfs_message_status status;
197 };
198
199 const GUESTFS_MAX_CHUNK_SIZE = 8192;
200
201 struct guestfs_chunk {
202   int cancel;                        /* if non-zero, transfer is cancelled */
203   /* data size is 0 bytes if the transfer has finished successfully */
204   opaque data<GUESTFS_MAX_CHUNK_SIZE>;
205 };
206
207 /* Progress notifications.  Daemon self-limits these messages to
208  * at most one per second.  The daemon can send these messages
209  * at any time, and the caller should discard unexpected messages.
210  * 'position' and 'total' have undefined units; however they may
211  * have meaning for some calls.
212  *
213  * NB. guestfs___recv_from_daemon assumes the XDR-encoded
214  * structure is 24 bytes long.
215  */
216 struct guestfs_progress {
217   guestfs_procedure proc;            /* @0:  GUESTFS_PROC_x */
218   unsigned serial;                   /* @4:  message serial number */
219   unsigned hyper position;           /* @8:  0 <= position <= total */
220   unsigned hyper total;              /* @16: total size of operation */
221                                      /* @24: size of structure */
222 };
223 "