xref: /qemu/os-posix.c (revision 66fe09eebb813b79e14279df11d723b433a973fb)
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>
346170540bSJes Sorensen #include <libgen.h>
3586b645e7SJes Sorensen 
3686b645e7SJes Sorensen /* Needed early for CONFIG_BSD etc. */
3786b645e7SJes Sorensen #include "config-host.h"
3886b645e7SJes Sorensen #include "sysemu.h"
3959a5264bSJes Sorensen #include "net/slirp.h"
4059a5264bSJes Sorensen #include "qemu-options.h"
4186b645e7SJes Sorensen 
42ce798cf2SJes Sorensen #ifdef CONFIG_LINUX
43ce798cf2SJes Sorensen #include <sys/prctl.h>
44ce798cf2SJes Sorensen #endif
45ce798cf2SJes Sorensen 
468847cfe8SJes Sorensen static struct passwd *user_pwd;
470766379dSJes Sorensen static const char *chroot_dir;
48eb505be1SJes Sorensen static int daemonize;
49eb505be1SJes Sorensen static int fds[2];
508847cfe8SJes Sorensen 
51fe98ac14SJes Sorensen void os_setup_early_signal_handling(void)
5286b645e7SJes Sorensen {
5386b645e7SJes Sorensen     struct sigaction act;
5486b645e7SJes Sorensen     sigfillset(&act.sa_mask);
5586b645e7SJes Sorensen     act.sa_flags = 0;
5686b645e7SJes Sorensen     act.sa_handler = SIG_IGN;
5786b645e7SJes Sorensen     sigaction(SIGPIPE, &act, NULL);
5886b645e7SJes Sorensen }
598d963e6aSJes Sorensen 
608d963e6aSJes Sorensen static void termsig_handler(int signal)
618d963e6aSJes Sorensen {
628d963e6aSJes Sorensen     qemu_system_shutdown_request();
638d963e6aSJes Sorensen }
648d963e6aSJes Sorensen 
658d963e6aSJes Sorensen static void sigchld_handler(int signal)
668d963e6aSJes Sorensen {
678d963e6aSJes Sorensen     waitpid(-1, NULL, WNOHANG);
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));
758d963e6aSJes Sorensen     act.sa_handler = termsig_handler;
768d963e6aSJes Sorensen     sigaction(SIGINT,  &act, NULL);
778d963e6aSJes Sorensen     sigaction(SIGHUP,  &act, NULL);
788d963e6aSJes Sorensen     sigaction(SIGTERM, &act, NULL);
798d963e6aSJes Sorensen 
808d963e6aSJes Sorensen     act.sa_handler = sigchld_handler;
818d963e6aSJes Sorensen     act.sa_flags = SA_NOCLDSTOP;
828d963e6aSJes Sorensen     sigaction(SIGCHLD, &act, NULL);
838d963e6aSJes Sorensen }
846170540bSJes Sorensen 
856170540bSJes Sorensen /* Find a likely location for support files using the location of the binary.
866170540bSJes Sorensen    For installed binaries this will be "$bindir/../share/qemu".  When
876170540bSJes Sorensen    running from the build tree this will be "$bindir/../pc-bios".  */
886170540bSJes Sorensen #define SHARE_SUFFIX "/share/qemu"
896170540bSJes Sorensen #define BUILD_SUFFIX "/pc-bios"
906170540bSJes Sorensen char *os_find_datadir(const char *argv0)
916170540bSJes Sorensen {
926170540bSJes Sorensen     char *dir;
936170540bSJes Sorensen     char *p = NULL;
946170540bSJes Sorensen     char *res;
956170540bSJes Sorensen     char buf[PATH_MAX];
966170540bSJes Sorensen     size_t max_len;
976170540bSJes Sorensen 
986170540bSJes Sorensen #if defined(__linux__)
996170540bSJes Sorensen     {
1006170540bSJes Sorensen         int len;
1016170540bSJes Sorensen         len = readlink("/proc/self/exe", buf, sizeof(buf) - 1);
1026170540bSJes Sorensen         if (len > 0) {
1036170540bSJes Sorensen             buf[len] = 0;
1046170540bSJes Sorensen             p = buf;
1056170540bSJes Sorensen         }
1066170540bSJes Sorensen     }
1076170540bSJes Sorensen #elif defined(__FreeBSD__)
1086170540bSJes Sorensen     {
1096170540bSJes Sorensen         static int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
1106170540bSJes Sorensen         size_t len = sizeof(buf) - 1;
1116170540bSJes Sorensen 
1126170540bSJes Sorensen         *buf = '\0';
113*66fe09eeSBlue Swirl         if (!sysctl(mib, ARRAY_SIZE(mib), buf, &len, NULL, 0) &&
1146170540bSJes Sorensen             *buf) {
1156170540bSJes Sorensen             buf[sizeof(buf) - 1] = '\0';
1166170540bSJes Sorensen             p = buf;
1176170540bSJes Sorensen         }
1186170540bSJes Sorensen     }
1196170540bSJes Sorensen #endif
1206170540bSJes Sorensen     /* If we don't have any way of figuring out the actual executable
1216170540bSJes Sorensen        location then try argv[0].  */
1226170540bSJes Sorensen     if (!p) {
1236170540bSJes Sorensen         p = realpath(argv0, buf);
1246170540bSJes Sorensen         if (!p) {
1256170540bSJes Sorensen             return NULL;
1266170540bSJes Sorensen         }
1276170540bSJes Sorensen     }
1286170540bSJes Sorensen     dir = dirname(p);
1296170540bSJes Sorensen     dir = dirname(dir);
1306170540bSJes Sorensen 
1316170540bSJes Sorensen     max_len = strlen(dir) +
1326170540bSJes Sorensen         MAX(strlen(SHARE_SUFFIX), strlen(BUILD_SUFFIX)) + 1;
1336170540bSJes Sorensen     res = qemu_mallocz(max_len);
1346170540bSJes Sorensen     snprintf(res, max_len, "%s%s", dir, SHARE_SUFFIX);
1356170540bSJes Sorensen     if (access(res, R_OK)) {
1366170540bSJes Sorensen         snprintf(res, max_len, "%s%s", dir, BUILD_SUFFIX);
1376170540bSJes Sorensen         if (access(res, R_OK)) {
1386170540bSJes Sorensen             qemu_free(res);
1396170540bSJes Sorensen             res = NULL;
1406170540bSJes Sorensen         }
1416170540bSJes Sorensen     }
1426170540bSJes Sorensen 
1436170540bSJes Sorensen     return res;
1446170540bSJes Sorensen }
1456170540bSJes Sorensen #undef SHARE_SUFFIX
1466170540bSJes Sorensen #undef BUILD_SUFFIX
14759a5264bSJes Sorensen 
148ce798cf2SJes Sorensen void os_set_proc_name(const char *s)
149ce798cf2SJes Sorensen {
150ce798cf2SJes Sorensen #if defined(PR_SET_NAME)
151ce798cf2SJes Sorensen     char name[16];
152ce798cf2SJes Sorensen     if (!s)
153ce798cf2SJes Sorensen         return;
154ce798cf2SJes Sorensen     name[sizeof(name) - 1] = 0;
155ce798cf2SJes Sorensen     strncpy(name, s, sizeof(name));
156ce798cf2SJes Sorensen     /* Could rewrite argv[0] too, but that's a bit more complicated.
157ce798cf2SJes Sorensen        This simple way is enough for `top'. */
158ce798cf2SJes Sorensen     if (prctl(PR_SET_NAME, name)) {
159ce798cf2SJes Sorensen         perror("unable to change process name");
160ce798cf2SJes Sorensen         exit(1);
161ce798cf2SJes Sorensen     }
162ce798cf2SJes Sorensen #else
163ce798cf2SJes Sorensen     fprintf(stderr, "Change of process name not supported by your OS\n");
164ce798cf2SJes Sorensen     exit(1);
165ce798cf2SJes Sorensen #endif
166ce798cf2SJes Sorensen }
167ce798cf2SJes Sorensen 
16859a5264bSJes Sorensen /*
16959a5264bSJes Sorensen  * Parse OS specific command line options.
17059a5264bSJes Sorensen  * return 0 if option handled, -1 otherwise
17159a5264bSJes Sorensen  */
17259a5264bSJes Sorensen void os_parse_cmd_args(int index, const char *optarg)
17359a5264bSJes Sorensen {
17459a5264bSJes Sorensen     switch (index) {
17559a5264bSJes Sorensen #ifdef CONFIG_SLIRP
17659a5264bSJes Sorensen     case QEMU_OPTION_smb:
17759a5264bSJes Sorensen         if (net_slirp_smb(optarg) < 0)
17859a5264bSJes Sorensen             exit(1);
17959a5264bSJes Sorensen         break;
18059a5264bSJes Sorensen #endif
1818847cfe8SJes Sorensen     case QEMU_OPTION_runas:
1828847cfe8SJes Sorensen         user_pwd = getpwnam(optarg);
1838847cfe8SJes Sorensen         if (!user_pwd) {
1848847cfe8SJes Sorensen             fprintf(stderr, "User \"%s\" doesn't exist\n", optarg);
1858847cfe8SJes Sorensen             exit(1);
1868847cfe8SJes Sorensen         }
1878847cfe8SJes Sorensen         break;
1880766379dSJes Sorensen     case QEMU_OPTION_chroot:
1890766379dSJes Sorensen         chroot_dir = optarg;
1900766379dSJes Sorensen         break;
191eb505be1SJes Sorensen     case QEMU_OPTION_daemonize:
192eb505be1SJes Sorensen         daemonize = 1;
193eb505be1SJes Sorensen         break;
19459a5264bSJes Sorensen     }
19559a5264bSJes Sorensen     return;
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         }
2058847cfe8SJes Sorensen         if (setuid(user_pwd->pw_uid) < 0) {
2068847cfe8SJes Sorensen             fprintf(stderr, "Failed to setuid(%d)\n", user_pwd->pw_uid);
2078847cfe8SJes Sorensen             exit(1);
2088847cfe8SJes Sorensen         }
2098847cfe8SJes Sorensen         if (setuid(0) != -1) {
2108847cfe8SJes Sorensen             fprintf(stderr, "Dropping privileges failed\n");
2118847cfe8SJes Sorensen             exit(1);
2128847cfe8SJes Sorensen         }
2138847cfe8SJes Sorensen     }
2148847cfe8SJes Sorensen }
2150766379dSJes Sorensen 
216e06eb601SJes Sorensen static void change_root(void)
2170766379dSJes Sorensen {
2180766379dSJes Sorensen     if (chroot_dir) {
2190766379dSJes Sorensen         if (chroot(chroot_dir) < 0) {
2200766379dSJes Sorensen             fprintf(stderr, "chroot failed\n");
2210766379dSJes Sorensen             exit(1);
2220766379dSJes Sorensen         }
2230766379dSJes Sorensen         if (chdir("/")) {
2240766379dSJes Sorensen             perror("not able to chdir to /");
2250766379dSJes Sorensen             exit(1);
2260766379dSJes Sorensen         }
2270766379dSJes Sorensen     }
2280766379dSJes Sorensen 
2290766379dSJes Sorensen }
230eb505be1SJes Sorensen 
231eb505be1SJes Sorensen void os_daemonize(void)
232eb505be1SJes Sorensen {
233eb505be1SJes Sorensen     if (daemonize) {
234eb505be1SJes Sorensen 	pid_t pid;
235eb505be1SJes Sorensen 
236eb505be1SJes Sorensen 	if (pipe(fds) == -1)
237eb505be1SJes Sorensen 	    exit(1);
238eb505be1SJes Sorensen 
239eb505be1SJes Sorensen 	pid = fork();
240eb505be1SJes Sorensen 	if (pid > 0) {
241eb505be1SJes Sorensen 	    uint8_t status;
242eb505be1SJes Sorensen 	    ssize_t len;
243eb505be1SJes Sorensen 
244eb505be1SJes Sorensen 	    close(fds[1]);
245eb505be1SJes Sorensen 
246eb505be1SJes Sorensen 	again:
247eb505be1SJes Sorensen             len = read(fds[0], &status, 1);
248eb505be1SJes Sorensen             if (len == -1 && (errno == EINTR))
249eb505be1SJes Sorensen                 goto again;
250eb505be1SJes Sorensen 
251eb505be1SJes Sorensen             if (len != 1)
252eb505be1SJes Sorensen                 exit(1);
253eb505be1SJes Sorensen             else if (status == 1) {
254eb505be1SJes Sorensen                 fprintf(stderr, "Could not acquire pidfile: %s\n", strerror(errno));
255eb505be1SJes Sorensen                 exit(1);
256eb505be1SJes Sorensen             } else
257eb505be1SJes Sorensen                 exit(0);
258eb505be1SJes Sorensen 	} else if (pid < 0)
259eb505be1SJes Sorensen             exit(1);
260eb505be1SJes Sorensen 
261eb505be1SJes Sorensen 	close(fds[0]);
262eb505be1SJes Sorensen 	qemu_set_cloexec(fds[1]);
263eb505be1SJes Sorensen 
264eb505be1SJes Sorensen 	setsid();
265eb505be1SJes Sorensen 
266eb505be1SJes Sorensen 	pid = fork();
267eb505be1SJes Sorensen 	if (pid > 0)
268eb505be1SJes Sorensen 	    exit(0);
269eb505be1SJes Sorensen 	else if (pid < 0)
270eb505be1SJes Sorensen 	    exit(1);
271eb505be1SJes Sorensen 
272eb505be1SJes Sorensen 	umask(027);
273eb505be1SJes Sorensen 
274eb505be1SJes Sorensen         signal(SIGTSTP, SIG_IGN);
275eb505be1SJes Sorensen         signal(SIGTTOU, SIG_IGN);
276eb505be1SJes Sorensen         signal(SIGTTIN, SIG_IGN);
277eb505be1SJes Sorensen     }
278eb505be1SJes Sorensen }
279eb505be1SJes Sorensen 
280eb505be1SJes Sorensen void os_setup_post(void)
281eb505be1SJes Sorensen {
282eb505be1SJes Sorensen     int fd = 0;
283eb505be1SJes Sorensen 
284eb505be1SJes Sorensen     if (daemonize) {
285eb505be1SJes Sorensen 	uint8_t status = 0;
286eb505be1SJes Sorensen 	ssize_t len;
287eb505be1SJes Sorensen 
288eb505be1SJes Sorensen     again1:
289eb505be1SJes Sorensen 	len = write(fds[1], &status, 1);
290eb505be1SJes Sorensen 	if (len == -1 && (errno == EINTR))
291eb505be1SJes Sorensen 	    goto again1;
292eb505be1SJes Sorensen 
293eb505be1SJes Sorensen 	if (len != 1)
294eb505be1SJes Sorensen 	    exit(1);
295eb505be1SJes Sorensen 
296eb505be1SJes Sorensen         if (chdir("/")) {
297eb505be1SJes Sorensen             perror("not able to chdir to /");
298eb505be1SJes Sorensen             exit(1);
299eb505be1SJes Sorensen         }
300eb505be1SJes Sorensen 	TFR(fd = qemu_open("/dev/null", O_RDWR));
301eb505be1SJes Sorensen 	if (fd == -1)
302eb505be1SJes Sorensen 	    exit(1);
303eb505be1SJes Sorensen     }
304eb505be1SJes Sorensen 
305e06eb601SJes Sorensen     change_root();
306e06eb601SJes Sorensen     change_process_uid();
307eb505be1SJes Sorensen 
308eb505be1SJes Sorensen     if (daemonize) {
309eb505be1SJes Sorensen         dup2(fd, 0);
310eb505be1SJes Sorensen         dup2(fd, 1);
311eb505be1SJes Sorensen         dup2(fd, 2);
312eb505be1SJes Sorensen 
313eb505be1SJes Sorensen         close(fd);
314eb505be1SJes Sorensen     }
315eb505be1SJes Sorensen }
316eb505be1SJes Sorensen 
317eb505be1SJes Sorensen void os_pidfile_error(void)
318eb505be1SJes Sorensen {
319eb505be1SJes Sorensen     if (daemonize) {
320eb505be1SJes Sorensen         uint8_t status = 1;
321eb505be1SJes Sorensen         if (write(fds[1], &status, 1) != 1) {
322eb505be1SJes Sorensen             perror("daemonize. Writing to pipe\n");
323eb505be1SJes Sorensen         }
324eb505be1SJes Sorensen     } else
325eb505be1SJes Sorensen         fprintf(stderr, "Could not acquire pid file: %s\n", strerror(errno));
326eb505be1SJes Sorensen }
3279156d763SJes Sorensen 
3289156d763SJes Sorensen void os_set_line_buffering(void)
3299156d763SJes Sorensen {
3309156d763SJes Sorensen     setvbuf(stdout, NULL, _IOLBF, 0);
3319156d763SJes Sorensen }
332