2 * Copyright 6WIND S.A., 2014
4 * This work is licensed under the terms of the GNU GPL, version 2 or
5 * (at your option) any later version. See the COPYING file in the
9 #include "qemu/osdep.h"
10 #include "qapi/error.h"
11 #include "qemu/cutils.h"
13 #include "ivshmem-server.h"
15 #define IVSHMEM_SERVER_DEFAULT_VERBOSE 0
16 #define IVSHMEM_SERVER_DEFAULT_FOREGROUND 0
17 #define IVSHMEM_SERVER_DEFAULT_PID_FILE "/var/run/ivshmem-server.pid"
18 #define IVSHMEM_SERVER_DEFAULT_UNIX_SOCK_PATH "/tmp/ivshmem_socket"
19 #define IVSHMEM_SERVER_DEFAULT_SHM_PATH "ivshmem"
20 #define IVSHMEM_SERVER_DEFAULT_SHM_SIZE (4*1024*1024)
21 #define IVSHMEM_SERVER_DEFAULT_N_VECTORS 1
23 /* used to quit on signal SIGTERM */
24 static int ivshmem_server_quit;
26 /* arguments given by the user */
27 typedef struct IvshmemServerArgs {
31 const char *unix_socket_path;
39 ivshmem_server_usage(const char *progname)
41 printf("Usage: %s [OPTION]...\n"
42 " -h: show this help\n"
44 " -F: foreground mode (default is to daemonize)\n"
45 " -p <pid-file>: path to the PID file (used in daemon mode only)\n"
46 " default " IVSHMEM_SERVER_DEFAULT_PID_FILE "\n"
47 " -S <unix-socket-path>: path to the unix socket to listen to\n"
48 " default " IVSHMEM_SERVER_DEFAULT_UNIX_SOCK_PATH "\n"
49 " -M <shm-name>: POSIX shared memory object to use\n"
50 " default " IVSHMEM_SERVER_DEFAULT_SHM_PATH "\n"
51 " -m <dir-name>: where to create shared memory\n"
52 " -l <size>: size of shared memory in bytes\n"
53 " suffixes K, M and G can be used, e.g. 1K means 1024\n"
55 " -n <nvectors>: number of vectors\n"
57 progname, IVSHMEM_SERVER_DEFAULT_SHM_SIZE,
58 IVSHMEM_SERVER_DEFAULT_N_VECTORS);
62 ivshmem_server_help(const char *progname)
64 fprintf(stderr, "Try '%s -h' for more information.\n", progname);
67 /* parse the program arguments, exit on error */
69 ivshmem_server_parse_args(IvshmemServerArgs *args, int argc, char *argv[])
75 while ((c = getopt(argc, argv, "hvFp:S:m:M:l:n:")) != -1) {
79 ivshmem_server_usage(argv[0]);
83 case 'v': /* verbose */
87 case 'F': /* foreground */
91 case 'p': /* pid file */
92 args->pid_file = optarg;
95 case 'S': /* unix socket path */
96 args->unix_socket_path = optarg;
99 case 'M': /* shm name */
100 case 'm': /* dir name */
101 args->shm_path = optarg;
102 args->use_shm_open = c == 'M';
105 case 'l': /* shm size */
106 parse_option_size("shm_size", optarg, &args->shm_size, &err);
108 error_report_err(err);
109 ivshmem_server_help(argv[0]);
114 case 'n': /* number of vectors */
115 if (parse_uint_full(optarg, &v, 0) < 0) {
116 fprintf(stderr, "cannot parse n_vectors\n");
117 ivshmem_server_help(argv[0]);
124 ivshmem_server_usage(argv[0]);
130 if (args->n_vectors > IVSHMEM_SERVER_MAX_VECTORS) {
131 fprintf(stderr, "too many requested vectors (max is %d)\n",
132 IVSHMEM_SERVER_MAX_VECTORS);
133 ivshmem_server_help(argv[0]);
137 if (args->verbose == 1 && args->foreground == 0) {
138 fprintf(stderr, "cannot use verbose in daemon mode\n");
139 ivshmem_server_help(argv[0]);
144 /* wait for events on listening server unix socket and connected client
147 ivshmem_server_poll_events(IvshmemServer *server)
152 while (!ivshmem_server_quit) {
156 ivshmem_server_get_fds(server, &fds, &maxfd);
158 ret = select(maxfd, &fds, NULL, NULL, NULL);
161 if (errno == EINTR) {
165 fprintf(stderr, "select error: %s\n", strerror(errno));
172 if (ivshmem_server_handle_fds(server, &fds, maxfd) < 0) {
173 fprintf(stderr, "ivshmem_server_handle_fds() failed\n");
182 ivshmem_server_quit_cb(int signum)
184 ivshmem_server_quit = 1;
188 main(int argc, char *argv[])
190 IvshmemServer server;
191 struct sigaction sa, sa_quit;
192 IvshmemServerArgs args = {
193 .verbose = IVSHMEM_SERVER_DEFAULT_VERBOSE,
194 .foreground = IVSHMEM_SERVER_DEFAULT_FOREGROUND,
195 .pid_file = IVSHMEM_SERVER_DEFAULT_PID_FILE,
196 .unix_socket_path = IVSHMEM_SERVER_DEFAULT_UNIX_SOCK_PATH,
197 .shm_path = IVSHMEM_SERVER_DEFAULT_SHM_PATH,
198 .use_shm_open = true,
199 .shm_size = IVSHMEM_SERVER_DEFAULT_SHM_SIZE,
200 .n_vectors = IVSHMEM_SERVER_DEFAULT_N_VECTORS,
205 * Do not remove this notice without adding proper error handling!
206 * Start with handling ivshmem_server_send_one_msg() failure.
208 printf("*** Example code, do not use in production ***\n");
210 /* parse arguments, will exit on error */
211 ivshmem_server_parse_args(&args, argc, argv);
213 /* Ignore SIGPIPE, see this link for more info:
214 * http://www.mail-archive.com/libevent-users@monkey.org/msg01606.html */
215 sa.sa_handler = SIG_IGN;
217 if (sigemptyset(&sa.sa_mask) == -1 ||
218 sigaction(SIGPIPE, &sa, 0) == -1) {
219 perror("failed to ignore SIGPIPE; sigaction");
223 sa_quit.sa_handler = ivshmem_server_quit_cb;
224 sa_quit.sa_flags = 0;
225 if (sigemptyset(&sa_quit.sa_mask) == -1 ||
226 sigaction(SIGTERM, &sa_quit, 0) == -1) {
227 perror("failed to add SIGTERM handler; sigaction");
231 /* init the ivshms structure */
232 if (ivshmem_server_init(&server, args.unix_socket_path,
233 args.shm_path, args.use_shm_open,
234 args.shm_size, args.n_vectors, args.verbose) < 0) {
235 fprintf(stderr, "cannot init server\n");
239 /* start the ivshmem server (open shm & unix socket) */
240 if (ivshmem_server_start(&server) < 0) {
241 fprintf(stderr, "cannot bind\n");
245 /* daemonize if asked to */
246 if (!args.foreground) {
249 if (qemu_daemon(1, 1) < 0) {
250 fprintf(stderr, "cannot daemonize: %s\n", strerror(errno));
255 fp = fopen(args.pid_file, "w");
257 fprintf(stderr, "cannot write pid file: %s\n", strerror(errno));
261 fprintf(fp, "%d\n", (int) getpid());
265 ivshmem_server_poll_events(&server);
266 fprintf(stdout, "server disconnected\n");
270 ivshmem_server_close(&server);