xref: /qemu/os-posix.c (revision 9c17d615a66ebd655871bf891ec0fe901ad8b332)
186b645e7SJes Sorensen /*
286b645e7SJes Sorensen  * os-posix.c
386b645e7SJes Sorensen  *
486b645e7SJes Sorensen  * Copyright (c) 2003-2008 Fabrice Bellard
586b645e7SJes Sorensen  * Copyright (c) 2010 Red Hat, Inc.
686b645e7SJes Sorensen  *
786b645e7SJes Sorensen  * Permission is hereby granted, free of charge, to any person obtaining a copy
886b645e7SJes Sorensen  * of this software and associated documentation files (the "Software"), to deal
986b645e7SJes Sorensen  * in the Software without restriction, including without limitation the rights
1086b645e7SJes Sorensen  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
1186b645e7SJes Sorensen  * copies of the Software, and to permit persons to whom the Software is
1286b645e7SJes Sorensen  * furnished to do so, subject to the following conditions:
1386b645e7SJes Sorensen  *
1486b645e7SJes Sorensen  * The above copyright notice and this permission notice shall be included in
1586b645e7SJes Sorensen  * all copies or substantial portions of the Software.
1686b645e7SJes Sorensen  *
1786b645e7SJes Sorensen  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1886b645e7SJes Sorensen  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1986b645e7SJes Sorensen  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
2086b645e7SJes Sorensen  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2186b645e7SJes Sorensen  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2286b645e7SJes Sorensen  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2386b645e7SJes Sorensen  * THE SOFTWARE.
2486b645e7SJes Sorensen  */
2586b645e7SJes Sorensen 
2686b645e7SJes Sorensen #include <unistd.h>
2786b645e7SJes Sorensen #include <fcntl.h>
2886b645e7SJes Sorensen #include <signal.h>
298d963e6aSJes Sorensen #include <sys/types.h>
308d963e6aSJes Sorensen #include <sys/wait.h>
3169e8b162SJes Sorensen /*needed for MAP_POPULATE before including qemu-options.h */
3269e8b162SJes Sorensen #include <sys/mman.h>
338847cfe8SJes Sorensen #include <pwd.h>
34cc4662f9SStefan Hajnoczi #include <grp.h>
356170540bSJes Sorensen #include <libgen.h>
3686b645e7SJes Sorensen 
3786b645e7SJes Sorensen /* Needed early for CONFIG_BSD etc. */
3886b645e7SJes Sorensen #include "config-host.h"
39*9c17d615SPaolo Bonzini #include "sysemu/sysemu.h"
4059a5264bSJes Sorensen #include "net/slirp.h"
4159a5264bSJes Sorensen #include "qemu-options.h"
4286b645e7SJes Sorensen 
43ce798cf2SJes Sorensen #ifdef CONFIG_LINUX
44ce798cf2SJes Sorensen #include <sys/prctl.h>
45949d31e6SJes Sorensen #endif
46949d31e6SJes Sorensen 
4715fdaee3SNathan Whitehorn #ifdef __FreeBSD__
4815fdaee3SNathan Whitehorn #include <sys/sysctl.h>
4915fdaee3SNathan Whitehorn #endif
5015fdaee3SNathan Whitehorn 
518847cfe8SJes Sorensen static struct passwd *user_pwd;
520766379dSJes Sorensen static const char *chroot_dir;
53eb505be1SJes Sorensen static int daemonize;
54eb505be1SJes Sorensen static int fds[2];
558847cfe8SJes Sorensen 
56fe98ac14SJes Sorensen void os_setup_early_signal_handling(void)
5786b645e7SJes Sorensen {
5886b645e7SJes Sorensen     struct sigaction act;
5986b645e7SJes Sorensen     sigfillset(&act.sa_mask);
6086b645e7SJes Sorensen     act.sa_flags = 0;
6186b645e7SJes Sorensen     act.sa_handler = SIG_IGN;
6286b645e7SJes Sorensen     sigaction(SIGPIPE, &act, NULL);
6386b645e7SJes Sorensen }
648d963e6aSJes Sorensen 
65f64622c4SGleb Natapov static void termsig_handler(int signal, siginfo_t *info, void *c)
668d963e6aSJes Sorensen {
67f64622c4SGleb Natapov     qemu_system_killed(info->si_signo, info->si_pid);
688d963e6aSJes Sorensen }
698d963e6aSJes Sorensen 
708d963e6aSJes Sorensen void os_setup_signal_handling(void)
718d963e6aSJes Sorensen {
728d963e6aSJes Sorensen     struct sigaction act;
738d963e6aSJes Sorensen 
748d963e6aSJes Sorensen     memset(&act, 0, sizeof(act));
75f64622c4SGleb Natapov     act.sa_sigaction = termsig_handler;
76f64622c4SGleb Natapov     act.sa_flags = SA_SIGINFO;
778d963e6aSJes Sorensen     sigaction(SIGINT,  &act, NULL);
788d963e6aSJes Sorensen     sigaction(SIGHUP,  &act, NULL);
798d963e6aSJes Sorensen     sigaction(SIGTERM, &act, NULL);
808d963e6aSJes Sorensen }
816170540bSJes Sorensen 
826170540bSJes Sorensen /* Find a likely location for support files using the location of the binary.
836170540bSJes Sorensen    For installed binaries this will be "$bindir/../share/qemu".  When
846170540bSJes Sorensen    running from the build tree this will be "$bindir/../pc-bios".  */
856170540bSJes Sorensen #define SHARE_SUFFIX "/share/qemu"
866170540bSJes Sorensen #define BUILD_SUFFIX "/pc-bios"
876170540bSJes Sorensen char *os_find_datadir(const char *argv0)
886170540bSJes Sorensen {
896170540bSJes Sorensen     char *dir;
906170540bSJes Sorensen     char *p = NULL;
916170540bSJes Sorensen     char *res;
926170540bSJes Sorensen     char buf[PATH_MAX];
936170540bSJes Sorensen     size_t max_len;
946170540bSJes Sorensen 
956170540bSJes Sorensen #if defined(__linux__)
966170540bSJes Sorensen     {
976170540bSJes Sorensen         int len;
986170540bSJes Sorensen         len = readlink("/proc/self/exe", buf, sizeof(buf) - 1);
996170540bSJes Sorensen         if (len > 0) {
1006170540bSJes Sorensen             buf[len] = 0;
1016170540bSJes Sorensen             p = buf;
1026170540bSJes Sorensen         }
1036170540bSJes Sorensen     }
1046170540bSJes Sorensen #elif defined(__FreeBSD__)
1056170540bSJes Sorensen     {
1066170540bSJes Sorensen         static int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
1076170540bSJes Sorensen         size_t len = sizeof(buf) - 1;
1086170540bSJes Sorensen 
1096170540bSJes Sorensen         *buf = '\0';
11066fe09eeSBlue Swirl         if (!sysctl(mib, ARRAY_SIZE(mib), buf, &len, NULL, 0) &&
1116170540bSJes Sorensen             *buf) {
1126170540bSJes Sorensen             buf[sizeof(buf) - 1] = '\0';
1136170540bSJes Sorensen             p = buf;
1146170540bSJes Sorensen         }
1156170540bSJes Sorensen     }
1166170540bSJes Sorensen #endif
1176170540bSJes Sorensen     /* If we don't have any way of figuring out the actual executable
1186170540bSJes Sorensen        location then try argv[0].  */
1196170540bSJes Sorensen     if (!p) {
1206170540bSJes Sorensen         p = realpath(argv0, buf);
1216170540bSJes Sorensen         if (!p) {
1226170540bSJes Sorensen             return NULL;
1236170540bSJes Sorensen         }
1246170540bSJes Sorensen     }
1256170540bSJes Sorensen     dir = dirname(p);
1266170540bSJes Sorensen     dir = dirname(dir);
1276170540bSJes Sorensen 
1286170540bSJes Sorensen     max_len = strlen(dir) +
1296170540bSJes Sorensen         MAX(strlen(SHARE_SUFFIX), strlen(BUILD_SUFFIX)) + 1;
1307267c094SAnthony Liguori     res = g_malloc0(max_len);
1316170540bSJes Sorensen     snprintf(res, max_len, "%s%s", dir, SHARE_SUFFIX);
1326170540bSJes Sorensen     if (access(res, R_OK)) {
1336170540bSJes Sorensen         snprintf(res, max_len, "%s%s", dir, BUILD_SUFFIX);
1346170540bSJes Sorensen         if (access(res, R_OK)) {
1357267c094SAnthony Liguori             g_free(res);
1366170540bSJes Sorensen             res = NULL;
1376170540bSJes Sorensen         }
1386170540bSJes Sorensen     }
1396170540bSJes Sorensen 
1406170540bSJes Sorensen     return res;
1416170540bSJes Sorensen }
1426170540bSJes Sorensen #undef SHARE_SUFFIX
1436170540bSJes Sorensen #undef BUILD_SUFFIX
14459a5264bSJes Sorensen 
145ce798cf2SJes Sorensen void os_set_proc_name(const char *s)
146ce798cf2SJes Sorensen {
147ce798cf2SJes Sorensen #if defined(PR_SET_NAME)
148ce798cf2SJes Sorensen     char name[16];
149ce798cf2SJes Sorensen     if (!s)
150ce798cf2SJes Sorensen         return;
1513eadc68eSJim Meyering     pstrcpy(name, sizeof(name), s);
152ce798cf2SJes Sorensen     /* Could rewrite argv[0] too, but that's a bit more complicated.
153ce798cf2SJes Sorensen        This simple way is enough for `top'. */
154ce798cf2SJes Sorensen     if (prctl(PR_SET_NAME, name)) {
155ce798cf2SJes Sorensen         perror("unable to change process name");
156ce798cf2SJes Sorensen         exit(1);
157ce798cf2SJes Sorensen     }
158ce798cf2SJes Sorensen #else
159ce798cf2SJes Sorensen     fprintf(stderr, "Change of process name not supported by your OS\n");
160ce798cf2SJes Sorensen     exit(1);
161ce798cf2SJes Sorensen #endif
162ce798cf2SJes Sorensen }
163ce798cf2SJes Sorensen 
16459a5264bSJes Sorensen /*
16559a5264bSJes Sorensen  * Parse OS specific command line options.
16659a5264bSJes Sorensen  * return 0 if option handled, -1 otherwise
16759a5264bSJes Sorensen  */
16859a5264bSJes Sorensen void os_parse_cmd_args(int index, const char *optarg)
16959a5264bSJes Sorensen {
17059a5264bSJes Sorensen     switch (index) {
17159a5264bSJes Sorensen #ifdef CONFIG_SLIRP
17259a5264bSJes Sorensen     case QEMU_OPTION_smb:
17359a5264bSJes Sorensen         if (net_slirp_smb(optarg) < 0)
17459a5264bSJes Sorensen             exit(1);
17559a5264bSJes Sorensen         break;
17659a5264bSJes Sorensen #endif
1778847cfe8SJes Sorensen     case QEMU_OPTION_runas:
1788847cfe8SJes Sorensen         user_pwd = getpwnam(optarg);
1798847cfe8SJes Sorensen         if (!user_pwd) {
1808847cfe8SJes Sorensen             fprintf(stderr, "User \"%s\" doesn't exist\n", optarg);
1818847cfe8SJes Sorensen             exit(1);
1828847cfe8SJes Sorensen         }
1838847cfe8SJes Sorensen         break;
1840766379dSJes Sorensen     case QEMU_OPTION_chroot:
1850766379dSJes Sorensen         chroot_dir = optarg;
1860766379dSJes Sorensen         break;
187eb505be1SJes Sorensen     case QEMU_OPTION_daemonize:
188eb505be1SJes Sorensen         daemonize = 1;
189eb505be1SJes Sorensen         break;
19070678b82SAnthony Liguori #if defined(CONFIG_LINUX)
19170678b82SAnthony Liguori     case QEMU_OPTION_enablefips:
19270678b82SAnthony Liguori         fips_set_state(true);
19370678b82SAnthony Liguori         break;
19470678b82SAnthony Liguori #endif
19559a5264bSJes Sorensen     }
19659a5264bSJes Sorensen }
1978847cfe8SJes Sorensen 
198e06eb601SJes Sorensen static void change_process_uid(void)
1998847cfe8SJes Sorensen {
2008847cfe8SJes Sorensen     if (user_pwd) {
2018847cfe8SJes Sorensen         if (setgid(user_pwd->pw_gid) < 0) {
2028847cfe8SJes Sorensen             fprintf(stderr, "Failed to setgid(%d)\n", user_pwd->pw_gid);
2038847cfe8SJes Sorensen             exit(1);
2048847cfe8SJes Sorensen         }
205cc4662f9SStefan Hajnoczi         if (initgroups(user_pwd->pw_name, user_pwd->pw_gid) < 0) {
206cc4662f9SStefan Hajnoczi             fprintf(stderr, "Failed to initgroups(\"%s\", %d)\n",
207cc4662f9SStefan Hajnoczi                     user_pwd->pw_name, user_pwd->pw_gid);
208cc4662f9SStefan Hajnoczi             exit(1);
209cc4662f9SStefan Hajnoczi         }
2108847cfe8SJes Sorensen         if (setuid(user_pwd->pw_uid) < 0) {
2118847cfe8SJes Sorensen             fprintf(stderr, "Failed to setuid(%d)\n", user_pwd->pw_uid);
2128847cfe8SJes Sorensen             exit(1);
2138847cfe8SJes Sorensen         }
2148847cfe8SJes Sorensen         if (setuid(0) != -1) {
2158847cfe8SJes Sorensen             fprintf(stderr, "Dropping privileges failed\n");
2168847cfe8SJes Sorensen             exit(1);
2178847cfe8SJes Sorensen         }
2188847cfe8SJes Sorensen     }
2198847cfe8SJes Sorensen }
2200766379dSJes Sorensen 
221e06eb601SJes Sorensen static void change_root(void)
2220766379dSJes Sorensen {
2230766379dSJes Sorensen     if (chroot_dir) {
2240766379dSJes Sorensen         if (chroot(chroot_dir) < 0) {
2250766379dSJes Sorensen             fprintf(stderr, "chroot failed\n");
2260766379dSJes Sorensen             exit(1);
2270766379dSJes Sorensen         }
2280766379dSJes Sorensen         if (chdir("/")) {
2290766379dSJes Sorensen             perror("not able to chdir to /");
2300766379dSJes Sorensen             exit(1);
2310766379dSJes Sorensen         }
2320766379dSJes Sorensen     }
2330766379dSJes Sorensen 
2340766379dSJes Sorensen }
235eb505be1SJes Sorensen 
236eb505be1SJes Sorensen void os_daemonize(void)
237eb505be1SJes Sorensen {
238eb505be1SJes Sorensen     if (daemonize) {
239eb505be1SJes Sorensen 	pid_t pid;
240eb505be1SJes Sorensen 
241eb505be1SJes Sorensen 	if (pipe(fds) == -1)
242eb505be1SJes Sorensen 	    exit(1);
243eb505be1SJes Sorensen 
244eb505be1SJes Sorensen 	pid = fork();
245eb505be1SJes Sorensen 	if (pid > 0) {
246eb505be1SJes Sorensen 	    uint8_t status;
247eb505be1SJes Sorensen 	    ssize_t len;
248eb505be1SJes Sorensen 
249eb505be1SJes Sorensen 	    close(fds[1]);
250eb505be1SJes Sorensen 
251eb505be1SJes Sorensen 	again:
252eb505be1SJes Sorensen             len = read(fds[0], &status, 1);
253eb505be1SJes Sorensen             if (len == -1 && (errno == EINTR))
254eb505be1SJes Sorensen                 goto again;
255eb505be1SJes Sorensen 
256eb505be1SJes Sorensen             if (len != 1)
257eb505be1SJes Sorensen                 exit(1);
258eb505be1SJes Sorensen             else if (status == 1) {
259eb505be1SJes Sorensen                 fprintf(stderr, "Could not acquire pidfile: %s\n", strerror(errno));
260eb505be1SJes Sorensen                 exit(1);
261eb505be1SJes Sorensen             } else
262eb505be1SJes Sorensen                 exit(0);
263eb505be1SJes Sorensen 	} else if (pid < 0)
264eb505be1SJes Sorensen             exit(1);
265eb505be1SJes Sorensen 
266eb505be1SJes Sorensen 	close(fds[0]);
267eb505be1SJes Sorensen 	qemu_set_cloexec(fds[1]);
268eb505be1SJes Sorensen 
269eb505be1SJes Sorensen 	setsid();
270eb505be1SJes Sorensen 
271eb505be1SJes Sorensen 	pid = fork();
272eb505be1SJes Sorensen 	if (pid > 0)
273eb505be1SJes Sorensen 	    exit(0);
274eb505be1SJes Sorensen 	else if (pid < 0)
275eb505be1SJes Sorensen 	    exit(1);
276eb505be1SJes Sorensen 
277eb505be1SJes Sorensen 	umask(027);
278eb505be1SJes Sorensen 
279eb505be1SJes Sorensen         signal(SIGTSTP, SIG_IGN);
280eb505be1SJes Sorensen         signal(SIGTTOU, SIG_IGN);
281eb505be1SJes Sorensen         signal(SIGTTIN, SIG_IGN);
282eb505be1SJes Sorensen     }
283eb505be1SJes Sorensen }
284eb505be1SJes Sorensen 
285eb505be1SJes Sorensen void os_setup_post(void)
286eb505be1SJes Sorensen {
287eb505be1SJes Sorensen     int fd = 0;
288eb505be1SJes Sorensen 
289eb505be1SJes Sorensen     if (daemonize) {
290eb505be1SJes Sorensen 	uint8_t status = 0;
291eb505be1SJes Sorensen 	ssize_t len;
292eb505be1SJes Sorensen 
293eb505be1SJes Sorensen     again1:
294eb505be1SJes Sorensen 	len = write(fds[1], &status, 1);
295eb505be1SJes Sorensen 	if (len == -1 && (errno == EINTR))
296eb505be1SJes Sorensen 	    goto again1;
297eb505be1SJes Sorensen 
298eb505be1SJes Sorensen 	if (len != 1)
299eb505be1SJes Sorensen 	    exit(1);
300eb505be1SJes Sorensen 
301eb505be1SJes Sorensen         if (chdir("/")) {
302eb505be1SJes Sorensen             perror("not able to chdir to /");
303eb505be1SJes Sorensen             exit(1);
304eb505be1SJes Sorensen         }
305eb505be1SJes Sorensen 	TFR(fd = qemu_open("/dev/null", O_RDWR));
306eb505be1SJes Sorensen 	if (fd == -1)
307eb505be1SJes Sorensen 	    exit(1);
308eb505be1SJes Sorensen     }
309eb505be1SJes Sorensen 
310e06eb601SJes Sorensen     change_root();
311e06eb601SJes Sorensen     change_process_uid();
312eb505be1SJes Sorensen 
313eb505be1SJes Sorensen     if (daemonize) {
314eb505be1SJes Sorensen         dup2(fd, 0);
315eb505be1SJes Sorensen         dup2(fd, 1);
316eb505be1SJes Sorensen         dup2(fd, 2);
317eb505be1SJes Sorensen 
318eb505be1SJes Sorensen         close(fd);
319eb505be1SJes Sorensen     }
320eb505be1SJes Sorensen }
321eb505be1SJes Sorensen 
322eb505be1SJes Sorensen void os_pidfile_error(void)
323eb505be1SJes Sorensen {
324eb505be1SJes Sorensen     if (daemonize) {
325eb505be1SJes Sorensen         uint8_t status = 1;
326eb505be1SJes Sorensen         if (write(fds[1], &status, 1) != 1) {
327eb505be1SJes Sorensen             perror("daemonize. Writing to pipe\n");
328eb505be1SJes Sorensen         }
329eb505be1SJes Sorensen     } else
330eb505be1SJes Sorensen         fprintf(stderr, "Could not acquire pid file: %s\n", strerror(errno));
331eb505be1SJes Sorensen }
3329156d763SJes Sorensen 
3339156d763SJes Sorensen void os_set_line_buffering(void)
3349156d763SJes Sorensen {
3359156d763SJes Sorensen     setvbuf(stdout, NULL, _IOLBF, 0);
3369156d763SJes Sorensen }
337949d31e6SJes Sorensen 
338bc4a957cSJes Sorensen int qemu_create_pidfile(const char *filename)
339bc4a957cSJes Sorensen {
340bc4a957cSJes Sorensen     char buffer[128];
341bc4a957cSJes Sorensen     int len;
342bc4a957cSJes Sorensen     int fd;
343bc4a957cSJes Sorensen 
344bc4a957cSJes Sorensen     fd = qemu_open(filename, O_RDWR | O_CREAT, 0600);
345bc4a957cSJes Sorensen     if (fd == -1) {
346bc4a957cSJes Sorensen         return -1;
347bc4a957cSJes Sorensen     }
348bc4a957cSJes Sorensen     if (lockf(fd, F_TLOCK, 0) == -1) {
3491bbd1592SMarkus Armbruster         close(fd);
350bc4a957cSJes Sorensen         return -1;
351bc4a957cSJes Sorensen     }
352953ffe0fSAndreas Färber     len = snprintf(buffer, sizeof(buffer), FMT_pid "\n", getpid());
353bc4a957cSJes Sorensen     if (write(fd, buffer, len) != len) {
3541bbd1592SMarkus Armbruster         close(fd);
355bc4a957cSJes Sorensen         return -1;
356bc4a957cSJes Sorensen     }
357bc4a957cSJes Sorensen 
35893dd748bSLaszlo Ersek     /* keep pidfile open & locked forever */
359bc4a957cSJes Sorensen     return 0;
360bc4a957cSJes Sorensen }
361995ee2bfSHitoshi Mitake 
362995ee2bfSHitoshi Mitake bool is_daemonized(void)
363995ee2bfSHitoshi Mitake {
364995ee2bfSHitoshi Mitake     return daemonize;
365995ee2bfSHitoshi Mitake }
366