xref: /qemu/os-posix.c (revision 10f5bff622cad71645e22c027b77ac31e51008ef)
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"
399c17d615SPaolo 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"
87*10f5bff6SFam Zheng char *os_find_datadir(void)
886170540bSJes Sorensen {
89*10f5bff6SFam Zheng     char *dir, *exec_dir;
906170540bSJes Sorensen     char *res;
916170540bSJes Sorensen     size_t max_len;
926170540bSJes Sorensen 
93*10f5bff6SFam Zheng     exec_dir = qemu_get_exec_dir();
94*10f5bff6SFam Zheng     if (exec_dir == NULL) {
956170540bSJes Sorensen         return NULL;
966170540bSJes Sorensen     }
97*10f5bff6SFam Zheng     dir = dirname(exec_dir);
986170540bSJes Sorensen 
996170540bSJes Sorensen     max_len = strlen(dir) +
1006170540bSJes Sorensen         MAX(strlen(SHARE_SUFFIX), strlen(BUILD_SUFFIX)) + 1;
1017267c094SAnthony Liguori     res = g_malloc0(max_len);
1026170540bSJes Sorensen     snprintf(res, max_len, "%s%s", dir, SHARE_SUFFIX);
1036170540bSJes Sorensen     if (access(res, R_OK)) {
1046170540bSJes Sorensen         snprintf(res, max_len, "%s%s", dir, BUILD_SUFFIX);
1056170540bSJes Sorensen         if (access(res, R_OK)) {
1067267c094SAnthony Liguori             g_free(res);
1076170540bSJes Sorensen             res = NULL;
1086170540bSJes Sorensen         }
1096170540bSJes Sorensen     }
1106170540bSJes Sorensen 
111*10f5bff6SFam Zheng     g_free(exec_dir);
1126170540bSJes Sorensen     return res;
1136170540bSJes Sorensen }
1146170540bSJes Sorensen #undef SHARE_SUFFIX
1156170540bSJes Sorensen #undef BUILD_SUFFIX
11659a5264bSJes Sorensen 
117ce798cf2SJes Sorensen void os_set_proc_name(const char *s)
118ce798cf2SJes Sorensen {
119ce798cf2SJes Sorensen #if defined(PR_SET_NAME)
120ce798cf2SJes Sorensen     char name[16];
121ce798cf2SJes Sorensen     if (!s)
122ce798cf2SJes Sorensen         return;
1233eadc68eSJim Meyering     pstrcpy(name, sizeof(name), s);
124ce798cf2SJes Sorensen     /* Could rewrite argv[0] too, but that's a bit more complicated.
125ce798cf2SJes Sorensen        This simple way is enough for `top'. */
126ce798cf2SJes Sorensen     if (prctl(PR_SET_NAME, name)) {
127ce798cf2SJes Sorensen         perror("unable to change process name");
128ce798cf2SJes Sorensen         exit(1);
129ce798cf2SJes Sorensen     }
130ce798cf2SJes Sorensen #else
131ce798cf2SJes Sorensen     fprintf(stderr, "Change of process name not supported by your OS\n");
132ce798cf2SJes Sorensen     exit(1);
133ce798cf2SJes Sorensen #endif
134ce798cf2SJes Sorensen }
135ce798cf2SJes Sorensen 
13659a5264bSJes Sorensen /*
13759a5264bSJes Sorensen  * Parse OS specific command line options.
13859a5264bSJes Sorensen  * return 0 if option handled, -1 otherwise
13959a5264bSJes Sorensen  */
14059a5264bSJes Sorensen void os_parse_cmd_args(int index, const char *optarg)
14159a5264bSJes Sorensen {
14259a5264bSJes Sorensen     switch (index) {
14359a5264bSJes Sorensen #ifdef CONFIG_SLIRP
14459a5264bSJes Sorensen     case QEMU_OPTION_smb:
14559a5264bSJes Sorensen         if (net_slirp_smb(optarg) < 0)
14659a5264bSJes Sorensen             exit(1);
14759a5264bSJes Sorensen         break;
14859a5264bSJes Sorensen #endif
1498847cfe8SJes Sorensen     case QEMU_OPTION_runas:
1508847cfe8SJes Sorensen         user_pwd = getpwnam(optarg);
1518847cfe8SJes Sorensen         if (!user_pwd) {
1528847cfe8SJes Sorensen             fprintf(stderr, "User \"%s\" doesn't exist\n", optarg);
1538847cfe8SJes Sorensen             exit(1);
1548847cfe8SJes Sorensen         }
1558847cfe8SJes Sorensen         break;
1560766379dSJes Sorensen     case QEMU_OPTION_chroot:
1570766379dSJes Sorensen         chroot_dir = optarg;
1580766379dSJes Sorensen         break;
159eb505be1SJes Sorensen     case QEMU_OPTION_daemonize:
160eb505be1SJes Sorensen         daemonize = 1;
161eb505be1SJes Sorensen         break;
16270678b82SAnthony Liguori #if defined(CONFIG_LINUX)
16370678b82SAnthony Liguori     case QEMU_OPTION_enablefips:
16470678b82SAnthony Liguori         fips_set_state(true);
16570678b82SAnthony Liguori         break;
16670678b82SAnthony Liguori #endif
16759a5264bSJes Sorensen     }
16859a5264bSJes Sorensen }
1698847cfe8SJes Sorensen 
170e06eb601SJes Sorensen static void change_process_uid(void)
1718847cfe8SJes Sorensen {
1728847cfe8SJes Sorensen     if (user_pwd) {
1738847cfe8SJes Sorensen         if (setgid(user_pwd->pw_gid) < 0) {
1748847cfe8SJes Sorensen             fprintf(stderr, "Failed to setgid(%d)\n", user_pwd->pw_gid);
1758847cfe8SJes Sorensen             exit(1);
1768847cfe8SJes Sorensen         }
177cc4662f9SStefan Hajnoczi         if (initgroups(user_pwd->pw_name, user_pwd->pw_gid) < 0) {
178cc4662f9SStefan Hajnoczi             fprintf(stderr, "Failed to initgroups(\"%s\", %d)\n",
179cc4662f9SStefan Hajnoczi                     user_pwd->pw_name, user_pwd->pw_gid);
180cc4662f9SStefan Hajnoczi             exit(1);
181cc4662f9SStefan Hajnoczi         }
1828847cfe8SJes Sorensen         if (setuid(user_pwd->pw_uid) < 0) {
1838847cfe8SJes Sorensen             fprintf(stderr, "Failed to setuid(%d)\n", user_pwd->pw_uid);
1848847cfe8SJes Sorensen             exit(1);
1858847cfe8SJes Sorensen         }
1868847cfe8SJes Sorensen         if (setuid(0) != -1) {
1878847cfe8SJes Sorensen             fprintf(stderr, "Dropping privileges failed\n");
1888847cfe8SJes Sorensen             exit(1);
1898847cfe8SJes Sorensen         }
1908847cfe8SJes Sorensen     }
1918847cfe8SJes Sorensen }
1920766379dSJes Sorensen 
193e06eb601SJes Sorensen static void change_root(void)
1940766379dSJes Sorensen {
1950766379dSJes Sorensen     if (chroot_dir) {
1960766379dSJes Sorensen         if (chroot(chroot_dir) < 0) {
1970766379dSJes Sorensen             fprintf(stderr, "chroot failed\n");
1980766379dSJes Sorensen             exit(1);
1990766379dSJes Sorensen         }
2000766379dSJes Sorensen         if (chdir("/")) {
2010766379dSJes Sorensen             perror("not able to chdir to /");
2020766379dSJes Sorensen             exit(1);
2030766379dSJes Sorensen         }
2040766379dSJes Sorensen     }
2050766379dSJes Sorensen 
2060766379dSJes Sorensen }
207eb505be1SJes Sorensen 
208eb505be1SJes Sorensen void os_daemonize(void)
209eb505be1SJes Sorensen {
210eb505be1SJes Sorensen     if (daemonize) {
211eb505be1SJes Sorensen 	pid_t pid;
212eb505be1SJes Sorensen 
213eb505be1SJes Sorensen 	if (pipe(fds) == -1)
214eb505be1SJes Sorensen 	    exit(1);
215eb505be1SJes Sorensen 
216eb505be1SJes Sorensen 	pid = fork();
217eb505be1SJes Sorensen 	if (pid > 0) {
218eb505be1SJes Sorensen 	    uint8_t status;
219eb505be1SJes Sorensen 	    ssize_t len;
220eb505be1SJes Sorensen 
221eb505be1SJes Sorensen 	    close(fds[1]);
222eb505be1SJes Sorensen 
223eb505be1SJes Sorensen 	again:
224eb505be1SJes Sorensen             len = read(fds[0], &status, 1);
225eb505be1SJes Sorensen             if (len == -1 && (errno == EINTR))
226eb505be1SJes Sorensen                 goto again;
227eb505be1SJes Sorensen 
228eb505be1SJes Sorensen             if (len != 1)
229eb505be1SJes Sorensen                 exit(1);
230eb505be1SJes Sorensen             else if (status == 1) {
231eb505be1SJes Sorensen                 fprintf(stderr, "Could not acquire pidfile: %s\n", strerror(errno));
232eb505be1SJes Sorensen                 exit(1);
233eb505be1SJes Sorensen             } else
234eb505be1SJes Sorensen                 exit(0);
235eb505be1SJes Sorensen 	} else if (pid < 0)
236eb505be1SJes Sorensen             exit(1);
237eb505be1SJes Sorensen 
238eb505be1SJes Sorensen 	close(fds[0]);
239eb505be1SJes Sorensen 	qemu_set_cloexec(fds[1]);
240eb505be1SJes Sorensen 
241eb505be1SJes Sorensen 	setsid();
242eb505be1SJes Sorensen 
243eb505be1SJes Sorensen 	pid = fork();
244eb505be1SJes Sorensen 	if (pid > 0)
245eb505be1SJes Sorensen 	    exit(0);
246eb505be1SJes Sorensen 	else if (pid < 0)
247eb505be1SJes Sorensen 	    exit(1);
248eb505be1SJes Sorensen 
249eb505be1SJes Sorensen 	umask(027);
250eb505be1SJes Sorensen 
251eb505be1SJes Sorensen         signal(SIGTSTP, SIG_IGN);
252eb505be1SJes Sorensen         signal(SIGTTOU, SIG_IGN);
253eb505be1SJes Sorensen         signal(SIGTTIN, SIG_IGN);
254eb505be1SJes Sorensen     }
255eb505be1SJes Sorensen }
256eb505be1SJes Sorensen 
257eb505be1SJes Sorensen void os_setup_post(void)
258eb505be1SJes Sorensen {
259eb505be1SJes Sorensen     int fd = 0;
260eb505be1SJes Sorensen 
261eb505be1SJes Sorensen     if (daemonize) {
262eb505be1SJes Sorensen 	uint8_t status = 0;
263eb505be1SJes Sorensen 	ssize_t len;
264eb505be1SJes Sorensen 
265eb505be1SJes Sorensen     again1:
266eb505be1SJes Sorensen 	len = write(fds[1], &status, 1);
267eb505be1SJes Sorensen 	if (len == -1 && (errno == EINTR))
268eb505be1SJes Sorensen 	    goto again1;
269eb505be1SJes Sorensen 
270eb505be1SJes Sorensen 	if (len != 1)
271eb505be1SJes Sorensen 	    exit(1);
272eb505be1SJes Sorensen 
273eb505be1SJes Sorensen         if (chdir("/")) {
274eb505be1SJes Sorensen             perror("not able to chdir to /");
275eb505be1SJes Sorensen             exit(1);
276eb505be1SJes Sorensen         }
277eb505be1SJes Sorensen 	TFR(fd = qemu_open("/dev/null", O_RDWR));
278eb505be1SJes Sorensen 	if (fd == -1)
279eb505be1SJes Sorensen 	    exit(1);
280eb505be1SJes Sorensen     }
281eb505be1SJes Sorensen 
282e06eb601SJes Sorensen     change_root();
283e06eb601SJes Sorensen     change_process_uid();
284eb505be1SJes Sorensen 
285eb505be1SJes Sorensen     if (daemonize) {
286eb505be1SJes Sorensen         dup2(fd, 0);
287eb505be1SJes Sorensen         dup2(fd, 1);
288eb505be1SJes Sorensen         dup2(fd, 2);
289eb505be1SJes Sorensen 
290eb505be1SJes Sorensen         close(fd);
291eb505be1SJes Sorensen     }
292eb505be1SJes Sorensen }
293eb505be1SJes Sorensen 
294eb505be1SJes Sorensen void os_pidfile_error(void)
295eb505be1SJes Sorensen {
296eb505be1SJes Sorensen     if (daemonize) {
297eb505be1SJes Sorensen         uint8_t status = 1;
298eb505be1SJes Sorensen         if (write(fds[1], &status, 1) != 1) {
299eb505be1SJes Sorensen             perror("daemonize. Writing to pipe\n");
300eb505be1SJes Sorensen         }
301eb505be1SJes Sorensen     } else
302eb505be1SJes Sorensen         fprintf(stderr, "Could not acquire pid file: %s\n", strerror(errno));
303eb505be1SJes Sorensen }
3049156d763SJes Sorensen 
3059156d763SJes Sorensen void os_set_line_buffering(void)
3069156d763SJes Sorensen {
3079156d763SJes Sorensen     setvbuf(stdout, NULL, _IOLBF, 0);
3089156d763SJes Sorensen }
309949d31e6SJes Sorensen 
310bc4a957cSJes Sorensen int qemu_create_pidfile(const char *filename)
311bc4a957cSJes Sorensen {
312bc4a957cSJes Sorensen     char buffer[128];
313bc4a957cSJes Sorensen     int len;
314bc4a957cSJes Sorensen     int fd;
315bc4a957cSJes Sorensen 
316bc4a957cSJes Sorensen     fd = qemu_open(filename, O_RDWR | O_CREAT, 0600);
317bc4a957cSJes Sorensen     if (fd == -1) {
318bc4a957cSJes Sorensen         return -1;
319bc4a957cSJes Sorensen     }
320bc4a957cSJes Sorensen     if (lockf(fd, F_TLOCK, 0) == -1) {
3211bbd1592SMarkus Armbruster         close(fd);
322bc4a957cSJes Sorensen         return -1;
323bc4a957cSJes Sorensen     }
324953ffe0fSAndreas Färber     len = snprintf(buffer, sizeof(buffer), FMT_pid "\n", getpid());
325bc4a957cSJes Sorensen     if (write(fd, buffer, len) != len) {
3261bbd1592SMarkus Armbruster         close(fd);
327bc4a957cSJes Sorensen         return -1;
328bc4a957cSJes Sorensen     }
329bc4a957cSJes Sorensen 
33093dd748bSLaszlo Ersek     /* keep pidfile open & locked forever */
331bc4a957cSJes Sorensen     return 0;
332bc4a957cSJes Sorensen }
333995ee2bfSHitoshi Mitake 
334995ee2bfSHitoshi Mitake bool is_daemonized(void)
335995ee2bfSHitoshi Mitake {
336995ee2bfSHitoshi Mitake     return daemonize;
337995ee2bfSHitoshi Mitake }
338888a6bc6SSatoru Moriya 
339888a6bc6SSatoru Moriya int os_mlock(void)
340888a6bc6SSatoru Moriya {
341888a6bc6SSatoru Moriya     int ret = 0;
342888a6bc6SSatoru Moriya 
343888a6bc6SSatoru Moriya     ret = mlockall(MCL_CURRENT | MCL_FUTURE);
344888a6bc6SSatoru Moriya     if (ret < 0) {
345888a6bc6SSatoru Moriya         perror("mlockall");
346888a6bc6SSatoru Moriya     }
347888a6bc6SSatoru Moriya 
348888a6bc6SSatoru Moriya     return ret;
349888a6bc6SSatoru Moriya }
350