From 55bf8fd622e9f84364b505db6591ace3ec2b5447 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Fri, 3 Apr 2009 11:29:55 +0100 Subject: [PATCH] Lots more auto-generation. --- daemon/actions.h | 24 ++++ daemon/stubs.c | 81 ++++++++++++++ guestfs-actions.pod | 13 ++- guestfs.pod | 4 + src/generator.ml | 291 +++++++++++++++++++++++++++++++++++++++++++------ src/guestfs-actions.c | 157 ++++++++++++++++++++++++++ src/guestfs-actions.h | 24 ++++ src/guestfs.h | 3 +- src/guestfs_protocol.x | 13 ++- 9 files changed, 572 insertions(+), 38 deletions(-) create mode 100644 daemon/actions.h create mode 100644 daemon/stubs.c create mode 100644 src/guestfs-actions.c create mode 100644 src/guestfs-actions.h diff --git a/daemon/actions.h b/daemon/actions.h new file mode 100644 index 0000000..c7d64df --- /dev/null +++ b/daemon/actions.h @@ -0,0 +1,24 @@ +/* libguestfs generated file + * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'. + * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. + * + * Copyright (C) 2009 Red Hat Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +extern int do_mount (guestfs_h *handle, const char *device, const char *mountpoint); +extern int do_sync (guestfs_h *handle); +extern int do_touch (guestfs_h *handle, const char *path); diff --git a/daemon/stubs.c b/daemon/stubs.c new file mode 100644 index 0000000..81c5b72 --- /dev/null +++ b/daemon/stubs.c @@ -0,0 +1,81 @@ +/* libguestfs generated file + * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'. + * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. + * + * Copyright (C) 2009 Red Hat Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include +#include +#include "daemon.h" +#include "../src/guest_protocol.h" +#include "actions.h" + +static void mount_stub (XDR *xdr_in) +{ + int r; + struct guestfs_mount_args args; + const char *device; + const char *mountpoint; + + if (!xdr_guestfs_mount_args (xdr_in, &args)) { + reply_with_error ("mount: daemon failed to decode procedure arguments"); + return; + } + device = args.device; + mountpoint = args.mountpoint; + + r = do_mount (device, mountpoint); + if (r == -1) + /* do_mount has already called reply_with_error, so just return */ + return; + + reply (NULL, NULL); +} + +static void sync_stub (XDR *xdr_in) +{ + int r; + + r = do_sync (); + if (r == -1) + /* do_sync has already called reply_with_error, so just return */ + return; + + reply (NULL, NULL); +} + +static void touch_stub (XDR *xdr_in) +{ + int r; + struct guestfs_touch_args args; + const char *path; + + if (!xdr_guestfs_touch_args (xdr_in, &args)) { + reply_with_error ("touch: daemon failed to decode procedure arguments"); + return; + } + path = args.path; + + r = do_touch (path); + if (r == -1) + /* do_touch has already called reply_with_error, so just return */ + return; + + reply (NULL, NULL); +} + diff --git a/guestfs-actions.pod b/guestfs-actions.pod index 0eb2483..c8a6077 100644 --- a/guestfs-actions.pod +++ b/guestfs-actions.pod @@ -1,6 +1,8 @@ =head2 guestfs_mount - int guestfs_mount (guestfs_h *handle, const char *device, const char *mountpoint); + int guestfs_mount (guestfs_h *handle, + const char *device, + const char *mountpoint); Mount a guest disk at a position in the filesystem. Block devices are named C, C and so on, as they were added to @@ -13,6 +15,8 @@ first be mounted on C before others can be mounted. Other filesystems can only be mounted on directories which already exist. +This function return 0 on success or -1 on error. + =head2 guestfs_sync int guestfs_sync (guestfs_h *handle); @@ -23,11 +27,16 @@ underlying disk image. You should always call this if you have modified a disk image, before calling C. +This function return 0 on success or -1 on error. + =head2 guestfs_touch - int guestfs_touch (guestfs_h *handle, const char *path); + int guestfs_touch (guestfs_h *handle, + const char *path); Touch acts like the L command. It can be used to update the filesystems on a file, or, if the file does not exist, to create a new zero-length file. +This function return 0 on success or -1 on error. + diff --git a/guestfs.pod b/guestfs.pod index 829e6e5..bf75e42 100644 --- a/guestfs.pod +++ b/guestfs.pod @@ -405,6 +405,10 @@ The callback function C will be called whenever a reply is received from the child process. (This corresponds to a transition from the BUSY state to the READY state). +Note that the C that you get in the callback is in C +mode, and you need to consume it before you return from the callback +function (since it gets destroyed after). + =head2 guestfs_set_log_message_callback typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, diff --git a/src/generator.ml b/src/generator.ml index 02fe691..d08e269 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -26,13 +26,22 @@ open Printf -type styles = - | Int_Void (* int foo (guestfs_h); *) - | Int_String (* int foo (guestfs_h, const char * ); *) - | Int_StringString (* int foo (guestfs_h, const char *, const char * ); *) +type style = ret * args +and ret = + (* "Err" as a return value means an int used as a simple error + * indication, ie. 0 or -1. + *) + | Err +and args = + (* 0 arguments, 1 argument, etc. The guestfs_h param is implicit. *) + | P0 + | P1 of argt + | P2 of argt * argt +and argt = + | String of string (* const char *name, cannot be NULL *) let functions = [ - ("mount", Int_StringString, [|"device"; "mountpoint"|], + ("mount", (Err, P2 (String "device", String "mountpoint")), "Mount a guest disk at a position in the filesystem", "\ Mount a guest disk at a position in the filesystem. Block devices @@ -46,7 +55,7 @@ first be mounted on C before others can be mounted. Other filesystems can only be mounted on directories which already exist."); - ("sync", Int_Void, [||], + ("sync", (Err, P0), "Sync disks, writes are flushed through to the disk image", "\ This syncs the disk, so that any writes are flushed through to the @@ -55,7 +64,7 @@ underlying disk image. You should always call this if you have modified a disk image, before calling C."); - ("touch", Int_String, [|"path"|], + ("touch", (Err, P1 (String "path")), "Update file timestamps or create a new file", "\ Touch acts like the L command. It can be used to @@ -67,6 +76,11 @@ to create a new zero-length file."); let chan = ref stdout let pr fs = ksprintf (output_string !chan) fs +let iter_args f = function + | P0 -> () + | P1 arg1 -> f arg1 + | P2 (arg1, arg2) -> f arg1; f arg2 + type comment_style = CStyle | HashStyle | OCamlStyle type license = GPLv2 | LGPLv2 @@ -77,8 +91,8 @@ let rec generate_header comment license = | HashStyle -> pr "# "; "#" | OCamlStyle -> pr "(* "; " *" in pr "libguestfs generated file\n"; - pr "%s WARNING: This file is generated by 'src/generator.ml'.\n" c; - pr "%s Any changes you make to this file will be lost.\n" c; + pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c; + pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c; pr "%s\n" c; pr "%s Copyright (C) 2009 Red Hat Inc.\n" c; pr "%s\n" c; @@ -123,45 +137,241 @@ let rec generate_header comment license = (* Generate the pod documentation for the C API. *) and generate_pod () = List.iter ( - fun (shortname, style, params, _, longdesc) -> + fun (shortname, style, _, longdesc) -> let name = "guestfs_" ^ shortname in pr "=head2 %s\n\n" name; pr " "; - generate_prototype ~extern:false name style params; + generate_prototype ~extern:false name style; pr "\n\n"; - pr "%s\n\n" longdesc + pr "%s\n\n" longdesc; + (match style with + | (Err, _) -> + pr "This function return 0 on success or -1 on error.\n\n" + ); ) functions (* Generate the protocol (XDR) file. *) and generate_xdr () = generate_header CStyle LGPLv2; List.iter ( - fun (shortname, style, params, _, longdesc) -> + fun (shortname, style, _, _) -> + let name = "guestfs_" ^ shortname in + pr "/* %s */\n\n" name; + (match style with + | (_, P0) -> () + | (_, args) -> + pr "struct %s_args {\n" name; + iter_args ( + function + | String name -> pr " string %s<>;\n" name + ) args; + pr "};\n\n" + ); + (match style with + | (Err, _) -> () + (* | ... -> pr "struct %s_ret ...\n" name; *) + ); + ) functions + +(* Generate the guestfs-actions.h file. *) +and generate_actions_h () = + generate_header CStyle LGPLv2; + List.iter ( + fun (shortname, style, _, _) -> + let name = "guestfs_" ^ shortname in + generate_prototype ~single_line:true ~newline:true name style + ) functions + +(* Generate the client-side dispatch stubs. *) +and generate_client_actions () = + generate_header CStyle LGPLv2; + List.iter ( + fun (shortname, style, _, _) -> let name = "guestfs_" ^ shortname in - pr "/* %s */\n" name; + (* Generate the return value struct. *) + pr "struct %s_rv {\n" shortname; + pr " int err_code; /* 0 or -1 */\n"; + pr " char err_str[256];\n"; + (match style with + | (Err, _) -> () + (* | _ -> pr " struct %s_ret ret;\n" name; *) + ); + pr "};\n\n"; + + (* Generate the callback function. *) + pr "static void %s_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname; + pr "{\n"; + pr " struct %s_rv *rv = (struct %s_rv *) data;\n" shortname shortname; + pr "\n"; + pr " /* XXX */ rv.code = 0;\n"; + pr " main_loop.main_loop_quit (g);\n"; + pr "}\n\n"; + + (* Generate the action stub. *) + generate_prototype ~extern:false ~semicolon:false ~newline:true + ~handle:"g" name style; + + let error_code = + match style with + | (Err, _) -> "-1" in + + pr "{\n"; + + (match style with + | (_, P0) -> () + | _ -> pr " struct %s_args args;\n" name + ); + + pr " struct %s_rv rv;\n" shortname; + pr "\n"; + pr " if (g->state != READY) {\n"; + pr " error (g, \"%s called from the wrong state, %%d != READY\",\n" + name; + pr " g->state);\n"; + pr " return %s;\n" error_code; + pr " }\n"; + + (match style with + | (_, P0) -> () + | (_, args) -> + pr "\n"; + iter_args ( + function + | String name -> pr " args.%s = (char *) %s;\n" name name + ) args; + pr " if (dispatch (g, (xdrproc_t) xdr_%s_args, (char *) &args) == -1)\n" + name; + pr " return %s;\n" error_code; + pr "\n"; + ); + + pr " rv.err_code = 42;\n"; + pr " g->reply_cb_internal = %s_cb;\n" shortname; + pr " g->reply_cb_internal_data = &rv;\n"; + pr " main_loop.main_loop_run (g);\n"; + pr " g->reply_cb_internal = NULL;\n"; + pr " g->reply_cb_internal_data = NULL;\n"; + pr " if (rv.err_code == 42) { /* callback wasn't called */\n"; + pr " error (g, \"%s failed, see earlier error messages\");\n" name; + pr " return %s;\n" error_code; + pr " }\n"; + pr " else if (rv.err_code == -1) { /* error from remote end */\n"; + pr " error (g, \"%%s\", rv.err_str);\n"; + pr " return %s;\n" error_code; + pr " }\n"; + pr "\n"; + + (match style with + | (Err, _) -> pr " return 0;\n" + ); + + pr "}\n\n" + ) functions + +(* Generate daemon/actions.h. *) +and generate_daemon_actions_h () = + generate_header CStyle GPLv2; + List.iter ( + fun (name, style, _, _) -> + generate_prototype ~single_line:true ~newline:true ("do_" ^ name) style; + ) functions + +(* Generate the server-side stubs. *) +and generate_daemon_actions () = + generate_header CStyle GPLv2; + + pr "#include \n"; + pr "#include \n"; + pr "#include \"daemon.h\"\n"; + pr "#include \"../src/guest_protocol.h\"\n"; + pr "#include \"actions.h\"\n"; + pr "\n"; + + List.iter ( + fun (name, style, _, _) -> + (* Generate server-side stubs. *) + pr "static void %s_stub (XDR *xdr_in)\n" name; + pr "{\n"; + let error_code = + match style with + | (Err, _) -> pr " int r;\n"; "-1" in + (match style with + | (_, P0) -> () + | (_, args) -> + pr " struct guestfs_%s_args args;\n" name; + iter_args ( + function + | String name -> pr " const char *%s;\n" name + ) args + ); + pr "\n"; + + (match style with + | (_, P0) -> () + | (_, args) -> + pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name; + pr " reply_with_error (\"%s: daemon failed to decode procedure arguments\");\n" name; + pr " return;\n"; + pr " }\n"; + iter_args ( + function + | String name -> pr " %s = args.%s;\n" name name + ) args; + pr "\n" + ); + + pr " r = do_%s " name; + generate_call_args style; + pr ";\n"; + pr " if (r == %s)\n" error_code; + pr " /* do_%s has already called reply_with_error, so just return */\n" name; + pr " return;\n"; pr "\n"; + + (match style with + | (Err, _) -> pr " reply (NULL, NULL);\n" + ); + + pr "}\n\n"; ) functions -(* Generate a single line prototype. *) -and generate_prototype ~extern ?(semi = true) ?(handle = "handle") - name style params = +(* Generate a C function prototype. *) +and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true) + ?(single_line = false) ?(newline = false) + ?(handle = "handle") name style = if extern then pr "extern "; + if static then pr "static "; (match style with - | Int_Void | Int_String | Int_StringString -> pr "int " + | (Err, _) -> pr "int " ); pr "%s (guestfs_h *%s" name handle; - (match style with - | Int_Void -> () - | Int_String -> - pr ", const char *%s" params.(0) - | Int_StringString -> - pr ", const char *%s" params.(0); - pr ", const char *%s" params.(1) - ); + let next () = if single_line then pr ", " else pr ",\n\t\t" in + iter_args ( + function + | String name -> next (); pr "const char *%s" name + ) (snd style); pr ")"; - if semi then pr ";" + if semicolon then pr ";"; + if newline then pr "\n" + +(* Generate C call arguments, eg "(handle, foo, bar)" *) +and generate_call_args ?handle style = + pr "("; + let comma = ref false in + (match handle with + | None -> () + | Some handle -> pr "%s" handle; comma := true + ); + iter_args ( + fun arg -> + if !comma then pr ", "; + comma := true; + match arg with + | String name -> pr "%s" name + ) (snd style); + pr ")" let output_to filename = let filename_new = filename ^ ".new" in @@ -169,16 +379,33 @@ let output_to filename = let close () = close_out !chan; chan := stdout; - Unix.rename filename_new filename + Unix.rename filename_new filename; + printf "written %s\n%!" filename; in close (* Main program. *) let () = - let close = output_to "guestfs-actions.pod" in - generate_pod (); - close (); - let close = output_to "src/guestfs_protocol.x" in generate_xdr (); close (); + + let close = output_to "src/guestfs-actions.h" in + generate_actions_h (); + close (); + + let close = output_to "src/guestfs-actions.c" in + generate_client_actions (); + close (); + + let close = output_to "daemon/actions.h" in + generate_daemon_actions_h (); + close (); + + let close = output_to "daemon/stubs.c" in + generate_daemon_actions (); + close (); + + let close = output_to "guestfs-actions.pod" in + generate_pod (); + close () diff --git a/src/guestfs-actions.c b/src/guestfs-actions.c new file mode 100644 index 0000000..db701ef --- /dev/null +++ b/src/guestfs-actions.c @@ -0,0 +1,157 @@ +/* libguestfs generated file + * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'. + * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. + * + * Copyright (C) 2009 Red Hat Inc. + * + * 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +struct mount_rv { + int err_code; /* 0 or -1 */ + char err_str[256]; +}; + +static void mount_cb (guestfs_h *g, void *data, XDR *xdr) +{ + struct mount_rv *rv = (struct mount_rv *) data; + + /* XXX */ rv.code = 0; + main_loop.main_loop_quit (g); +} + +int guestfs_mount (guestfs_h *g, + const char *device, + const char *mountpoint) +{ + struct guestfs_mount_args args; + struct mount_rv rv; + + if (g->state != READY) { + error (g, "guestfs_mount called from the wrong state, %d != READY", + g->state); + return -1; + } + + args.device = (char *) device; + args.mountpoint = (char *) mountpoint; + if (dispatch (g, (xdrproc_t) xdr_guestfs_mount_args, (char *) &args) == -1) + return -1; + + rv.err_code = 42; + g->reply_cb_internal = mount_cb; + g->reply_cb_internal_data = &rv; + main_loop.main_loop_run (g); + g->reply_cb_internal = NULL; + g->reply_cb_internal_data = NULL; + if (rv.err_code == 42) { /* callback wasn't called */ + error (g, "guestfs_mount failed, see earlier error messages"); + return -1; + } + else if (rv.err_code == -1) { /* error from remote end */ + error (g, "%s", rv.err_str); + return -1; + } + + return 0; +} + +struct sync_rv { + int err_code; /* 0 or -1 */ + char err_str[256]; +}; + +static void sync_cb (guestfs_h *g, void *data, XDR *xdr) +{ + struct sync_rv *rv = (struct sync_rv *) data; + + /* XXX */ rv.code = 0; + main_loop.main_loop_quit (g); +} + +int guestfs_sync (guestfs_h *g) +{ + struct sync_rv rv; + + if (g->state != READY) { + error (g, "guestfs_sync called from the wrong state, %d != READY", + g->state); + return -1; + } + rv.err_code = 42; + g->reply_cb_internal = sync_cb; + g->reply_cb_internal_data = &rv; + main_loop.main_loop_run (g); + g->reply_cb_internal = NULL; + g->reply_cb_internal_data = NULL; + if (rv.err_code == 42) { /* callback wasn't called */ + error (g, "guestfs_sync failed, see earlier error messages"); + return -1; + } + else if (rv.err_code == -1) { /* error from remote end */ + error (g, "%s", rv.err_str); + return -1; + } + + return 0; +} + +struct touch_rv { + int err_code; /* 0 or -1 */ + char err_str[256]; +}; + +static void touch_cb (guestfs_h *g, void *data, XDR *xdr) +{ + struct touch_rv *rv = (struct touch_rv *) data; + + /* XXX */ rv.code = 0; + main_loop.main_loop_quit (g); +} + +int guestfs_touch (guestfs_h *g, + const char *path) +{ + struct guestfs_touch_args args; + struct touch_rv rv; + + if (g->state != READY) { + error (g, "guestfs_touch called from the wrong state, %d != READY", + g->state); + return -1; + } + + args.path = (char *) path; + if (dispatch (g, (xdrproc_t) xdr_guestfs_touch_args, (char *) &args) == -1) + return -1; + + rv.err_code = 42; + g->reply_cb_internal = touch_cb; + g->reply_cb_internal_data = &rv; + main_loop.main_loop_run (g); + g->reply_cb_internal = NULL; + g->reply_cb_internal_data = NULL; + if (rv.err_code == 42) { /* callback wasn't called */ + error (g, "guestfs_touch failed, see earlier error messages"); + return -1; + } + else if (rv.err_code == -1) { /* error from remote end */ + error (g, "%s", rv.err_str); + return -1; + } + + return 0; +} + diff --git a/src/guestfs-actions.h b/src/guestfs-actions.h new file mode 100644 index 0000000..31ee734 --- /dev/null +++ b/src/guestfs-actions.h @@ -0,0 +1,24 @@ +/* libguestfs generated file + * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'. + * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. + * + * Copyright (C) 2009 Red Hat Inc. + * + * 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +extern int guestfs_mount (guestfs_h *handle, const char *device, const char *mountpoint); +extern int guestfs_sync (guestfs_h *handle); +extern int guestfs_touch (guestfs_h *handle, const char *path); diff --git a/src/guestfs.h b/src/guestfs.h index 4e032c6..fbfcb3c 100644 --- a/src/guestfs.h +++ b/src/guestfs.h @@ -54,8 +54,7 @@ extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g); extern void guestfs_set_verbose (guestfs_h *g, int verbose); extern int guestfs_get_verbose (guestfs_h *g); -/* Actions. XXX Will be auto-generated */ -extern int guestfs_sync (guestfs_h *g); +#include /* Low-level event API. */ typedef void (*guestfs_reply_cb) (guestfs_h *g, void *data, XDR *xdr); diff --git a/src/guestfs_protocol.x b/src/guestfs_protocol.x index bf83325..6569d27 100644 --- a/src/guestfs_protocol.x +++ b/src/guestfs_protocol.x @@ -1,6 +1,6 @@ /* libguestfs generated file - * WARNING: This file is generated by 'src/generator.ml'. - * Any changes you make to this file will be lost. + * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'. + * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST. * * Copyright (C) 2009 Red Hat Inc. * @@ -21,7 +21,16 @@ /* guestfs_mount */ +struct guestfs_mount_args { + string device<>; + string mountpoint<>; +}; + /* guestfs_sync */ /* guestfs_touch */ +struct guestfs_touch_args { + string path<>; +}; + -- 1.8.3.1