src/guestfs.h

   1 /* libguestfs
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library 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 GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef GUESTFS_H_
  20 #define GUESTFS_H_
  21
  22 /* IMPORTANT NOTE!
  23  * All API documentation is in the manual page --> guestfs(3) <--
  24  * Go and read it now, I'll wait.
  25  */
  26
  27 #include <rpc/xdr.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #define STREQ(a,b) (strcmp((a),(b)) == 0)
  34 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
  35 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
  36 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
  37 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
  38 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
  39 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
  40 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
  41 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
  42
  43 typedef struct guestfs_h guestfs_h;
  44
  45 /* Connection management. */
  46 extern guestfs_h *guestfs_create (void);
  47 extern void guestfs_close (guestfs_h *g);
  48
  49 /* Error handling. */
  50 extern const char *guestfs_last_error (guestfs_h *g);
  51
  52 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
  53 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
  54
  55 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
  56 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
  57
  58 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
  59 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
  60
  61 #include <guestfs-structs.h>
  62 #include <guestfs-actions.h>
  63
  64 /* Events. */
  65 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
  66 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
  67 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
  68
  69 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
  70 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
  71 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
  72
  73 /* Private, for use only by the actions. */
  74 struct guestfs_message_header;
  75 struct guestfs_message_error;
  76 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
  77   __attribute__((format (printf,2,3)));
  78 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
  79   __attribute__((format (printf,2,3)));
  80 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
  81 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
  82 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
  83 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
  84 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
  85 extern int guestfs___set_busy (guestfs_h *g);
  86 extern int guestfs___end_busy (guestfs_h *g);
  87 extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args);
  88 extern int guestfs___recv (guestfs_h *g, const char *fn, struct guestfs_message_header *hdr, struct guestfs_message_error *err, xdrproc_t xdrp, char *ret);
  89 extern int guestfs___send_file (guestfs_h *g, const char *filename);
  90 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96 #endif /* GUESTFS_H_ */