Hostinfo day 4: Implement command processing code.
[virt-hostinfo.git] / hostinfod / hostinfod.h
1 /* virt-hostinfo
2  * Copyright (C) 2009 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., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #ifndef HOSTINFOD_H
20 #define HOSTINFOD_H
21
22 #include <time.h>
23
24 #include <apr_general.h>
25 #include <apr_errno.h>
26 #include <apr_pools.h>
27 #include <apr_network_io.h>
28 #include <apr_poll.h>
29
30 enum guest_state {
31   guest_state_connecting,       /* Connecting to socket. */
32   guest_state_request,          /* Waiting or reading the request. */
33   guest_state_reply,            /* Sending the reply. */
34   guest_state_dead              /* Connection is dead. */
35 };
36
37 struct guest_description {
38   apr_pool_t *pool;             /* Pool for lifetime of guest connection. */
39
40   apr_pool_t *rpool;            /* Pool for lifetime of single req/resp. */
41
42   const char *name;             /* "driver-name" */
43   const char *sock_path;        /* Full path to socket. */
44   int sock;                     /* Real socket. */
45   apr_socket_t *aprsock;        /* APR socket. */
46   apr_pollfd_t pollfd;          /* APR poll descriptor. */
47   enum guest_state state;       /* State of the connection. */
48   int counter;                  /* Used in reread_socket_dir. */
49
50   unsigned request_max;         /* Max. length of request buffer. */
51   unsigned request_posn;        /* Position in request buffer. */
52   char *request;                /* Request buffer. */
53
54   unsigned reply_size;          /* Size of reply buffer. */
55   unsigned reply_posn;          /* Position in reply buffer. */
56   char *reply;                  /* Reply buffer. */
57
58   /* Increments every time guest does something bad, decremented once per min */
59   unsigned penalty;
60   struct timespec last_penalty_decr;
61 };
62
63 enum arg_type {
64   arg_type_string,
65   arg_type_int,
66   arg_type_bool,
67 };
68
69 struct arg {
70   enum arg_type type;
71   union {
72     long i;                     /* For int, bool types. */
73     char *str;                  /* For string type. */
74   } u;
75 };
76
77 /* main.c */
78 extern const char *conf_file;
79 extern char *socket_dir;
80 extern char *guests_file;
81 extern int verbose;
82 extern int verbose_set_on_cmdline;
83 extern int foreground;
84 extern int foreground_set_on_cmdline;
85 extern int messages_to_stderr;
86 extern apr_pool_t *pool;        /* pool for global memory allocation */
87
88 /* error.c */
89 extern void init_syslog (void);
90 extern void error (const char *fs, ...)
91   __attribute__((format (printf,1,2)));
92 extern void perrorf (const char *fs, ...)
93   __attribute__((format (printf,1,2)));
94 extern void warning (const char *fs, ...)
95   __attribute__((format (printf,1,2)));
96 extern void pwarningf (const char *fs, ...)
97   __attribute__((format (printf,1,2)));
98 extern void debug (const char *fs, ...)
99   __attribute__((format (printf,1,2)));
100 extern void message (const char *fs, ...)
101   __attribute__((format (printf,1,2)));
102 extern void paprerror (apr_status_t r, const char *fs, ...)
103   __attribute__((format (printf,2,3)));
104
105 /* configuration.c */
106 extern void read_main_conf_file (void);
107
108 /* monitor_sockets.c */
109 extern int sockets_inotify_fd;
110 extern void monitor_socket_dir (void);
111
112 /* commands.c */
113 extern apr_hash_t *commands;
114 extern void execute_command (const struct timespec *now, struct guest_description *hval, const char *command);
115 extern void send_error (struct guest_description *hval, int code);
116
117 typedef void (*command_fn) (struct guest_description *hval, const char *cmd, apr_array_header_t *args);
118
119 #define REGISTER_COMMAND(name,callback) \
120   static void register_##name (void) __attribute__((constructor));      \
121                                                                         \
122   static void                                                           \
123   register_##name (void)                                                \
124   {                                                                     \
125     if (commands == NULL)                                               \
126       commands = apr_hash_make (pool);                                  \
127                                                                         \
128     /* The assignment below just causes a warning                       \
129      * if the callback has the wrong type.                              \
130      */                                                                 \
131     command_fn cb = (callback);                                         \
132     apr_hash_set (commands, (name), APR_HASH_KEY_STRING, cb);           \
133   }
134
135 #endif /* HOSTINFOD_H */