1 #!/usr/bin/ocamlrun ocaml
3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 * This script generates a large amount of code and documentation for
20 * all the daemon actions. To add a new action there are only two
21 * files you need to change, this one to describe the interface, and
22 * daemon/<somefile>.c to write the implementation.
29 type style = ret * args
31 (* "Err" as a return value means an int used as a simple error
32 * indication, ie. 0 or -1.
36 (* 0 arguments, 1 argument, etc. The guestfs_h param is implicit. *)
41 | String of string (* const char *name, cannot be NULL *)
44 ("mount", (Err, P2 (String "device", String "mountpoint")), 1,
45 "Mount a guest disk at a position in the filesystem",
47 Mount a guest disk at a position in the filesystem. Block devices
48 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
49 the guest. If those block devices contain partitions, they will have
50 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
53 The rules are the same as for L<mount(2)>: A filesystem must
54 first be mounted on C</> before others can be mounted. Other
55 filesystems can only be mounted on directories which already
58 ("sync", (Err, P0), 2,
59 "Sync disks, writes are flushed through to the disk image",
61 This syncs the disk, so that any writes are flushed through to the
62 underlying disk image.
64 You should always call this if you have modified a disk image, before
65 calling C<guestfs_close>.");
67 ("touch", (Err, P1 (String "path")), 3,
68 "Update file timestamps or create a new file",
70 Touch acts like the L<touch(1)> command. It can be used to
71 update the filesystems on a file, or, if the file does not exist,
72 to create a new zero-length file.");
75 (* 'pr' prints to the current output file. *)
77 let pr fs = ksprintf (output_string !chan) fs
79 let iter_args f = function
82 | P2 (arg1, arg2) -> f arg1; f arg2
84 type comment_style = CStyle | HashStyle | OCamlStyle
85 type license = GPLv2 | LGPLv2
87 (* Generate a header block in a number of standard styles. *)
88 let rec generate_header comment license =
89 let c = match comment with
90 | CStyle -> pr "/* "; " *"
91 | HashStyle -> pr "# "; "#"
92 | OCamlStyle -> pr "(* "; " *" in
93 pr "libguestfs generated file\n";
94 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
95 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
97 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
101 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
102 pr "%s it under the terms of the GNU General Public License as published by\n" c;
103 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
104 pr "%s (at your option) any later version.\n" c;
106 pr "%s This program is distributed in the hope that it will be useful,\n" c;
107 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
108 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
109 pr "%s GNU General Public License for more details.\n" c;
111 pr "%s You should have received a copy of the GNU General Public License along\n" c;
112 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
113 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
116 pr "%s This library is free software; you can redistribute it and/or\n" c;
117 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
118 pr "%s License as published by the Free Software Foundation; either\n" c;
119 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
121 pr "%s This library is distributed in the hope that it will be useful,\n" c;
122 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
123 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
124 pr "%s Lesser General Public License for more details.\n" c;
126 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
127 pr "%s License along with this library; if not, write to the Free Software\n" c;
128 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
131 | CStyle -> pr " */\n"
133 | OCamlStyle -> pr " *)\n"
137 (* Generate the pod documentation for the C API. *)
138 and generate_pod () =
140 fun (shortname, style, _, _, longdesc) ->
141 let name = "guestfs_" ^ shortname in
142 pr "=head2 %s\n\n" name;
144 generate_prototype ~extern:false ~handle:"handle" name style;
146 pr "%s\n\n" longdesc;
149 pr "This function return 0 on success or -1 on error.\n\n"
153 (* Generate the protocol (XDR) file. *)
154 and generate_xdr () =
155 generate_header CStyle LGPLv2;
158 fun (shortname, style, _, _, _) ->
159 let name = "guestfs_" ^ shortname in
160 pr "/* %s */\n\n" name;
164 pr "struct %s_args {\n" name;
167 | String name -> pr " string %s<>;\n" name
173 (* | ... -> pr "struct %s_ret ...\n" name; *)
177 (* Table of procedure numbers. *)
178 pr "enum guestfs_procedure {\n";
180 fun (shortname, _, proc_nr, _, _) ->
181 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
183 pr " GUESTFS_PROC_dummy\n"; (* so we don't have a "hanging comma" *)
187 (* Having to choose a maximum message size is annoying for several
188 * reasons (it limits what we can do in the API), but it (a) makes
189 * the protocol a lot simpler, and (b) provides a bound on the size
190 * of the daemon which operates in limited memory space. For large
191 * file transfers you should use FTP.
193 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
196 (* Message header, etc. *)
198 const GUESTFS_PROGRAM = 0x2000F5F5;
199 const GUESTFS_PROTOCOL_VERSION = 1;
201 enum guestfs_message_direction {
202 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
203 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
206 enum guestfs_message_status {
207 GUESTFS_STATUS_OK = 0,
208 GUESTFS_STATUS_ERROR = 1
211 const GUESTFS_ERROR_LEN = 256;
213 struct guestfs_message_error {
214 string error<GUESTFS_ERROR_LEN>; /* error message */
217 struct guestfs_message_header {
218 unsigned prog; /* GUESTFS_PROGRAM */
219 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
220 guestfs_procedure proc; /* GUESTFS_PROC_x */
221 guestfs_message_direction direction;
222 unsigned serial; /* message serial number */
223 guestfs_message_status status;
227 (* Generate the guestfs-actions.h file. *)
228 and generate_actions_h () =
229 generate_header CStyle LGPLv2;
231 fun (shortname, style, _, _, _) ->
232 let name = "guestfs_" ^ shortname in
233 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
237 (* Generate the client-side dispatch stubs. *)
238 and generate_client_actions () =
239 generate_header CStyle LGPLv2;
241 fun (shortname, style, _, _, _) ->
242 let name = "guestfs_" ^ shortname in
244 (* Generate the return value struct. *)
245 pr "struct %s_rv {\n" shortname;
246 pr " int err_code; /* 0 OK or -1 error */\n";
247 pr " int serial; /* serial number of reply */\n";
248 pr " char err_str[GUESTFS_ERROR_LEN]; /* error from daemon */\n";
251 (* | _ -> pr " struct %s_ret ret;\n" name; REMEMBER TO MEMSET *)
255 (* Generate the callback function. *)
256 pr "static void %s_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
258 pr " struct %s_rv *rv = (struct %s_rv *) data;\n" shortname shortname;
260 pr " /* XXX */ rv->err_code = 0;\n";
261 pr " /* XXX rv->serial = ?; */\n";
262 pr " main_loop.main_loop_quit (g);\n";
265 (* Generate the action stub. *)
266 generate_prototype ~extern:false ~semicolon:false ~newline:true
267 ~handle:"g" name style;
271 | (Err, _) -> "-1" in
277 | _ -> pr " struct %s_args args;\n" name
280 pr " struct %s_rv rv;\n" shortname;
283 pr " if (g->state != READY) {\n";
284 pr " error (g, \"%s called from the wrong state, %%d != READY\",\n"
287 pr " return %s;\n" error_code;
292 pr " serial = dispatch (g, GUESTFS_PROC_%s, NULL, NULL);\n"
293 (String.uppercase shortname)
298 | String name -> pr " args.%s = (char *) %s;\n" name name
300 pr " serial = dispatch (g, GUESTFS_PROC_%s,\n"
301 (String.uppercase shortname);
302 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
305 pr " if (serial == -1)\n";
306 pr " return %s;\n" error_code;
309 pr " rv.err_code = 42;\n";
310 pr " g->reply_cb_internal = %s_cb;\n" shortname;
311 pr " g->reply_cb_internal_data = &rv;\n";
312 pr " main_loop.main_loop_run (g);\n";
313 pr " g->reply_cb_internal = NULL;\n";
314 pr " g->reply_cb_internal_data = NULL;\n";
315 pr " if (rv.err_code == 42) { /* callback wasn't called */\n";
316 pr " error (g, \"%s failed, see earlier error messages\");\n" name;
317 pr " return %s;\n" error_code;
319 pr " else if (rv.err_code == -1) { /* error from remote end */\n";
320 pr " error (g, \"%%s\", rv.err_str);\n";
321 pr " return %s;\n" error_code;
325 pr " /* XXX check serial number agrees */\n\n";
328 | (Err, _) -> pr " return 0;\n"
334 (* Generate daemon/actions.h. *)
335 and generate_daemon_actions_h () =
336 generate_header CStyle GPLv2;
338 fun (name, style, _, _, _) ->
339 generate_prototype ~single_line:true ~newline:true ("do_" ^ name) style;
342 (* Generate the server-side stubs. *)
343 and generate_daemon_actions () =
344 generate_header CStyle GPLv2;
346 pr "#include <rpc/types.h>\n";
347 pr "#include <rpc/xdr.h>\n";
348 pr "#include \"daemon.h\"\n";
349 pr "#include \"../src/guestfs_protocol.h\"\n";
350 pr "#include \"actions.h\"\n";
354 fun (name, style, _, _, _) ->
355 (* Generate server-side stubs. *)
356 pr "static void %s_stub (XDR *xdr_in)\n" name;
360 | (Err, _) -> pr " int r;\n"; "-1" in
364 pr " struct guestfs_%s_args args;\n" name;
367 | String name -> pr " const char *%s;\n" name
375 pr " memset (&args, 0, sizeof args);\n";
377 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
378 pr " reply_with_error (\"%s: daemon failed to decode procedure arguments\");\n" name;
383 | String name -> pr " %s = args.%s;\n" name name
388 pr " r = do_%s " name;
389 generate_call_args style;
392 pr " if (r == %s)\n" error_code;
393 pr " /* do_%s has already called reply_with_error, so just return */\n" name;
398 | (Err, _) -> pr " reply (NULL, NULL);\n"
404 (* Dispatch function. *)
405 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
407 pr " switch (proc_nr) {\n";
410 fun (name, style, _, _, _) ->
411 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
412 pr " %s_stub (xdr_in);\n" name;
417 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
421 (* Generate a C function prototype. *)
422 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
423 ?(single_line = false) ?(newline = false)
425 if extern then pr "extern ";
426 if static then pr "static ";
428 | (Err, _) -> pr "int "
431 let comma = ref false in
434 | Some handle -> pr "guestfs_h *%s" handle; comma := true
438 if single_line then pr ", " else pr ",\n\t\t"
444 | String name -> next (); pr "const char *%s" name
447 if semicolon then pr ";";
448 if newline then pr "\n"
450 (* Generate C call arguments, eg "(handle, foo, bar)" *)
451 and generate_call_args ?handle style =
453 let comma = ref false in
456 | Some handle -> pr "%s" handle; comma := true
460 if !comma then pr ", ";
463 | String name -> pr "%s" name
467 let output_to filename =
468 let filename_new = filename ^ ".new" in
469 chan := open_out filename_new;
473 Unix.rename filename_new filename;
474 printf "written %s\n%!" filename;
480 let close = output_to "src/guestfs_protocol.x" in
484 let close = output_to "src/guestfs-actions.h" in
485 generate_actions_h ();
488 let close = output_to "src/guestfs-actions.c" in
489 generate_client_actions ();
492 let close = output_to "daemon/actions.h" in
493 generate_daemon_actions_h ();
496 let close = output_to "daemon/stubs.c" in
497 generate_daemon_actions ();
500 let close = output_to "guestfs-actions.pod" in