xref: /qemu/os-posix.c (revision 55ad781ca7fcaed19e04554b558727206d638a99)
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 
26d38ea87aSPeter Maydell #include "qemu/osdep.h"
278d963e6aSJes Sorensen #include <sys/wait.h>
2869e8b162SJes Sorensen /*needed for MAP_POPULATE before including qemu-options.h */
298847cfe8SJes Sorensen #include <pwd.h>
30cc4662f9SStefan Hajnoczi #include <grp.h>
316170540bSJes Sorensen #include <libgen.h>
3286b645e7SJes Sorensen 
3386b645e7SJes Sorensen /* Needed early for CONFIG_BSD etc. */
349c17d615SPaolo Bonzini #include "sysemu/sysemu.h"
3559a5264bSJes Sorensen #include "net/slirp.h"
3659a5264bSJes Sorensen #include "qemu-options.h"
37a59629fcSPaolo Bonzini #include "qemu/rcu.h"
38f853ac66SThomas Huth #include "qemu/error-report.h"
3996c33a45SDimitris Aragiorgis #include "qemu/log.h"
40f348b6d1SVeronia Bahaa #include "qemu/cutils.h"
4186b645e7SJes Sorensen 
42ce798cf2SJes Sorensen #ifdef CONFIG_LINUX
43ce798cf2SJes Sorensen #include <sys/prctl.h>
44949d31e6SJes Sorensen #endif
45949d31e6SJes Sorensen 
468847cfe8SJes Sorensen static struct passwd *user_pwd;
470766379dSJes Sorensen static const char *chroot_dir;
48eb505be1SJes Sorensen static int daemonize;
490be5e436SMichael Tokarev static int daemon_pipe;
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 
60f64622c4SGleb Natapov static void termsig_handler(int signal, siginfo_t *info, void *c)
618d963e6aSJes Sorensen {
62f64622c4SGleb Natapov     qemu_system_killed(info->si_signo, info->si_pid);
638d963e6aSJes Sorensen }
648d963e6aSJes Sorensen 
658d963e6aSJes Sorensen void os_setup_signal_handling(void)
668d963e6aSJes Sorensen {
678d963e6aSJes Sorensen     struct sigaction act;
688d963e6aSJes Sorensen 
698d963e6aSJes Sorensen     memset(&act, 0, sizeof(act));
70f64622c4SGleb Natapov     act.sa_sigaction = termsig_handler;
71f64622c4SGleb Natapov     act.sa_flags = SA_SIGINFO;
728d963e6aSJes Sorensen     sigaction(SIGINT,  &act, NULL);
738d963e6aSJes Sorensen     sigaction(SIGHUP,  &act, NULL);
748d963e6aSJes Sorensen     sigaction(SIGTERM, &act, NULL);
758d963e6aSJes Sorensen }
766170540bSJes Sorensen 
776170540bSJes Sorensen /* Find a likely location for support files using the location of the binary.
786170540bSJes Sorensen    For installed binaries this will be "$bindir/../share/qemu".  When
796170540bSJes Sorensen    running from the build tree this will be "$bindir/../pc-bios".  */
806170540bSJes Sorensen #define SHARE_SUFFIX "/share/qemu"
816170540bSJes Sorensen #define BUILD_SUFFIX "/pc-bios"
8210f5bff6SFam Zheng char *os_find_datadir(void)
836170540bSJes Sorensen {
8410f5bff6SFam Zheng     char *dir, *exec_dir;
856170540bSJes Sorensen     char *res;
866170540bSJes Sorensen     size_t max_len;
876170540bSJes Sorensen 
8810f5bff6SFam Zheng     exec_dir = qemu_get_exec_dir();
8910f5bff6SFam Zheng     if (exec_dir == NULL) {
906170540bSJes Sorensen         return NULL;
916170540bSJes Sorensen     }
92*55ad781cSWei Jiangang     dir = g_path_get_dirname(exec_dir);
936170540bSJes Sorensen 
946170540bSJes Sorensen     max_len = strlen(dir) +
956170540bSJes Sorensen         MAX(strlen(SHARE_SUFFIX), strlen(BUILD_SUFFIX)) + 1;
967267c094SAnthony Liguori     res = g_malloc0(max_len);
976170540bSJes Sorensen     snprintf(res, max_len, "%s%s", dir, SHARE_SUFFIX);
986170540bSJes Sorensen     if (access(res, R_OK)) {
996170540bSJes Sorensen         snprintf(res, max_len, "%s%s", dir, BUILD_SUFFIX);
1006170540bSJes Sorensen         if (access(res, R_OK)) {
1017267c094SAnthony Liguori             g_free(res);
1026170540bSJes Sorensen             res = NULL;
1036170540bSJes Sorensen         }
1046170540bSJes Sorensen     }
1056170540bSJes Sorensen 
106*55ad781cSWei Jiangang     g_free(dir);
10710f5bff6SFam Zheng     g_free(exec_dir);
1086170540bSJes Sorensen     return res;
1096170540bSJes Sorensen }
1106170540bSJes Sorensen #undef SHARE_SUFFIX
1116170540bSJes Sorensen #undef BUILD_SUFFIX
11259a5264bSJes Sorensen 
113ce798cf2SJes Sorensen void os_set_proc_name(const char *s)
114ce798cf2SJes Sorensen {
115ce798cf2SJes Sorensen #if defined(PR_SET_NAME)
116ce798cf2SJes Sorensen     char name[16];
117ce798cf2SJes Sorensen     if (!s)
118ce798cf2SJes Sorensen         return;
1193eadc68eSJim Meyering     pstrcpy(name, sizeof(name), s);
120ce798cf2SJes Sorensen     /* Could rewrite argv[0] too, but that's a bit more complicated.
121ce798cf2SJes Sorensen        This simple way is enough for `top'. */
122ce798cf2SJes Sorensen     if (prctl(PR_SET_NAME, name)) {
123ce798cf2SJes Sorensen         perror("unable to change process name");
124ce798cf2SJes Sorensen         exit(1);
125ce798cf2SJes Sorensen     }
126ce798cf2SJes Sorensen #else
127ce798cf2SJes Sorensen     fprintf(stderr, "Change of process name not supported by your OS\n");
128ce798cf2SJes Sorensen     exit(1);
129ce798cf2SJes Sorensen #endif
130ce798cf2SJes Sorensen }
131ce798cf2SJes Sorensen 
13259a5264bSJes Sorensen /*
13359a5264bSJes Sorensen  * Parse OS specific command line options.
13459a5264bSJes Sorensen  * return 0 if option handled, -1 otherwise
13559a5264bSJes Sorensen  */
13659a5264bSJes Sorensen void os_parse_cmd_args(int index, const char *optarg)
13759a5264bSJes Sorensen {
13859a5264bSJes Sorensen     switch (index) {
13959a5264bSJes Sorensen #ifdef CONFIG_SLIRP
14059a5264bSJes Sorensen     case QEMU_OPTION_smb:
141f853ac66SThomas Huth         error_report("The -smb option is deprecated. "
142f853ac66SThomas Huth                      "Please use '-netdev user,smb=...' instead.");
14359a5264bSJes Sorensen         if (net_slirp_smb(optarg) < 0)
14459a5264bSJes Sorensen             exit(1);
14559a5264bSJes Sorensen         break;
14659a5264bSJes Sorensen #endif
1478847cfe8SJes Sorensen     case QEMU_OPTION_runas:
1488847cfe8SJes Sorensen         user_pwd = getpwnam(optarg);
1498847cfe8SJes Sorensen         if (!user_pwd) {
1508847cfe8SJes Sorensen             fprintf(stderr, "User \"%s\" doesn't exist\n", optarg);
1518847cfe8SJes Sorensen             exit(1);
1528847cfe8SJes Sorensen         }
1538847cfe8SJes Sorensen         break;
1540766379dSJes Sorensen     case QEMU_OPTION_chroot:
1550766379dSJes Sorensen         chroot_dir = optarg;
1560766379dSJes Sorensen         break;
157eb505be1SJes Sorensen     case QEMU_OPTION_daemonize:
158eb505be1SJes Sorensen         daemonize = 1;
159eb505be1SJes Sorensen         break;
16070678b82SAnthony Liguori #if defined(CONFIG_LINUX)
16170678b82SAnthony Liguori     case QEMU_OPTION_enablefips:
16270678b82SAnthony Liguori         fips_set_state(true);
16370678b82SAnthony Liguori         break;
16470678b82SAnthony Liguori #endif
16559a5264bSJes Sorensen     }
16659a5264bSJes Sorensen }
1678847cfe8SJes Sorensen 
168e06eb601SJes Sorensen static void change_process_uid(void)
1698847cfe8SJes Sorensen {
1708847cfe8SJes Sorensen     if (user_pwd) {
1718847cfe8SJes Sorensen         if (setgid(user_pwd->pw_gid) < 0) {
1728847cfe8SJes Sorensen             fprintf(stderr, "Failed to setgid(%d)\n", user_pwd->pw_gid);
1738847cfe8SJes Sorensen             exit(1);
1748847cfe8SJes Sorensen         }
175cc4662f9SStefan Hajnoczi         if (initgroups(user_pwd->pw_name, user_pwd->pw_gid) < 0) {
176cc4662f9SStefan Hajnoczi             fprintf(stderr, "Failed to initgroups(\"%s\", %d)\n",
177cc4662f9SStefan Hajnoczi                     user_pwd->pw_name, user_pwd->pw_gid);
178cc4662f9SStefan Hajnoczi             exit(1);
179cc4662f9SStefan Hajnoczi         }
1808847cfe8SJes Sorensen         if (setuid(user_pwd->pw_uid) < 0) {
1818847cfe8SJes Sorensen             fprintf(stderr, "Failed to setuid(%d)\n", user_pwd->pw_uid);
1828847cfe8SJes Sorensen             exit(1);
1838847cfe8SJes Sorensen         }
1848847cfe8SJes Sorensen         if (setuid(0) != -1) {
1858847cfe8SJes Sorensen             fprintf(stderr, "Dropping privileges failed\n");
1868847cfe8SJes Sorensen             exit(1);
1878847cfe8SJes Sorensen         }
1888847cfe8SJes Sorensen     }
1898847cfe8SJes Sorensen }
1900766379dSJes Sorensen 
191e06eb601SJes Sorensen static void change_root(void)
1920766379dSJes Sorensen {
1930766379dSJes Sorensen     if (chroot_dir) {
1940766379dSJes Sorensen         if (chroot(chroot_dir) < 0) {
1950766379dSJes Sorensen             fprintf(stderr, "chroot failed\n");
1960766379dSJes Sorensen             exit(1);
1970766379dSJes Sorensen         }
1980766379dSJes Sorensen         if (chdir("/")) {
1990766379dSJes Sorensen             perror("not able to chdir to /");
2000766379dSJes Sorensen             exit(1);
2010766379dSJes Sorensen         }
2020766379dSJes Sorensen     }
2030766379dSJes Sorensen 
2040766379dSJes Sorensen }
205eb505be1SJes Sorensen 
206eb505be1SJes Sorensen void os_daemonize(void)
207eb505be1SJes Sorensen {
208eb505be1SJes Sorensen     if (daemonize) {
209eb505be1SJes Sorensen         pid_t pid;
2100be5e436SMichael Tokarev         int fds[2];
211eb505be1SJes Sorensen 
21263ce8e15SGonglei         if (pipe(fds) == -1) {
213eb505be1SJes Sorensen             exit(1);
21463ce8e15SGonglei         }
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 
223ccea25f1SMichael Tokarev             do {
224eb505be1SJes Sorensen                 len = read(fds[0], &status, 1);
225ccea25f1SMichael Tokarev             } while (len < 0 && errno == EINTR);
226fee78fd6SMichael Tokarev 
227fee78fd6SMichael Tokarev             /* only exit successfully if our child actually wrote
228fee78fd6SMichael Tokarev              * a one-byte zero to our pipe, upon successful init */
229fee78fd6SMichael Tokarev             exit(len == 1 && status == 0 ? 0 : 1);
230fee78fd6SMichael Tokarev 
23163ce8e15SGonglei         } else if (pid < 0) {
232eb505be1SJes Sorensen             exit(1);
23363ce8e15SGonglei         }
234eb505be1SJes Sorensen 
235eb505be1SJes Sorensen         close(fds[0]);
2360be5e436SMichael Tokarev         daemon_pipe = fds[1];
2370be5e436SMichael Tokarev         qemu_set_cloexec(daemon_pipe);
238eb505be1SJes Sorensen 
239eb505be1SJes Sorensen         setsid();
240eb505be1SJes Sorensen 
241eb505be1SJes Sorensen         pid = fork();
24263ce8e15SGonglei         if (pid > 0) {
243eb505be1SJes Sorensen             exit(0);
24463ce8e15SGonglei         } else if (pid < 0) {
245eb505be1SJes Sorensen             exit(1);
24663ce8e15SGonglei         }
247eb505be1SJes Sorensen         umask(027);
248eb505be1SJes Sorensen 
249eb505be1SJes Sorensen         signal(SIGTSTP, SIG_IGN);
250eb505be1SJes Sorensen         signal(SIGTTOU, SIG_IGN);
251eb505be1SJes Sorensen         signal(SIGTTIN, SIG_IGN);
252a59629fcSPaolo Bonzini         rcu_after_fork();
253eb505be1SJes Sorensen     }
254eb505be1SJes Sorensen }
255eb505be1SJes Sorensen 
256eb505be1SJes Sorensen void os_setup_post(void)
257eb505be1SJes Sorensen {
258eb505be1SJes Sorensen     int fd = 0;
259eb505be1SJes Sorensen 
260eb505be1SJes Sorensen     if (daemonize) {
261eb505be1SJes Sorensen         if (chdir("/")) {
262eb505be1SJes Sorensen             perror("not able to chdir to /");
263eb505be1SJes Sorensen             exit(1);
264eb505be1SJes Sorensen         }
265eb505be1SJes Sorensen         TFR(fd = qemu_open("/dev/null", O_RDWR));
26663ce8e15SGonglei         if (fd == -1) {
267eb505be1SJes Sorensen             exit(1);
268eb505be1SJes Sorensen         }
26963ce8e15SGonglei     }
270eb505be1SJes Sorensen 
271e06eb601SJes Sorensen     change_root();
272e06eb601SJes Sorensen     change_process_uid();
273eb505be1SJes Sorensen 
274eb505be1SJes Sorensen     if (daemonize) {
27525cec2b8SMichael Tokarev         uint8_t status = 0;
27625cec2b8SMichael Tokarev         ssize_t len;
27725cec2b8SMichael Tokarev 
278eb505be1SJes Sorensen         dup2(fd, 0);
279eb505be1SJes Sorensen         dup2(fd, 1);
28096c33a45SDimitris Aragiorgis         /* In case -D is given do not redirect stderr to /dev/null */
28196c33a45SDimitris Aragiorgis         if (!qemu_logfile) {
282eb505be1SJes Sorensen             dup2(fd, 2);
28396c33a45SDimitris Aragiorgis         }
284eb505be1SJes Sorensen 
285eb505be1SJes Sorensen         close(fd);
28625cec2b8SMichael Tokarev 
28725cec2b8SMichael Tokarev         do {
28825cec2b8SMichael Tokarev             len = write(daemon_pipe, &status, 1);
28925cec2b8SMichael Tokarev         } while (len < 0 && errno == EINTR);
29025cec2b8SMichael Tokarev         if (len != 1) {
29125cec2b8SMichael Tokarev             exit(1);
29225cec2b8SMichael Tokarev         }
293eb505be1SJes Sorensen     }
294eb505be1SJes Sorensen }
295eb505be1SJes Sorensen 
2969156d763SJes Sorensen void os_set_line_buffering(void)
2979156d763SJes Sorensen {
2989156d763SJes Sorensen     setvbuf(stdout, NULL, _IOLBF, 0);
2999156d763SJes Sorensen }
300949d31e6SJes Sorensen 
301bc4a957cSJes Sorensen int qemu_create_pidfile(const char *filename)
302bc4a957cSJes Sorensen {
303bc4a957cSJes Sorensen     char buffer[128];
304bc4a957cSJes Sorensen     int len;
305bc4a957cSJes Sorensen     int fd;
306bc4a957cSJes Sorensen 
307bc4a957cSJes Sorensen     fd = qemu_open(filename, O_RDWR | O_CREAT, 0600);
308bc4a957cSJes Sorensen     if (fd == -1) {
309bc4a957cSJes Sorensen         return -1;
310bc4a957cSJes Sorensen     }
311bc4a957cSJes Sorensen     if (lockf(fd, F_TLOCK, 0) == -1) {
3121bbd1592SMarkus Armbruster         close(fd);
313bc4a957cSJes Sorensen         return -1;
314bc4a957cSJes Sorensen     }
315953ffe0fSAndreas Färber     len = snprintf(buffer, sizeof(buffer), FMT_pid "\n", getpid());
316bc4a957cSJes Sorensen     if (write(fd, buffer, len) != len) {
3171bbd1592SMarkus Armbruster         close(fd);
318bc4a957cSJes Sorensen         return -1;
319bc4a957cSJes Sorensen     }
320bc4a957cSJes Sorensen 
32193dd748bSLaszlo Ersek     /* keep pidfile open & locked forever */
322bc4a957cSJes Sorensen     return 0;
323bc4a957cSJes Sorensen }
324995ee2bfSHitoshi Mitake 
325995ee2bfSHitoshi Mitake bool is_daemonized(void)
326995ee2bfSHitoshi Mitake {
327995ee2bfSHitoshi Mitake     return daemonize;
328995ee2bfSHitoshi Mitake }
329888a6bc6SSatoru Moriya 
330888a6bc6SSatoru Moriya int os_mlock(void)
331888a6bc6SSatoru Moriya {
332888a6bc6SSatoru Moriya     int ret = 0;
333888a6bc6SSatoru Moriya 
334888a6bc6SSatoru Moriya     ret = mlockall(MCL_CURRENT | MCL_FUTURE);
335888a6bc6SSatoru Moriya     if (ret < 0) {
336888a6bc6SSatoru Moriya         perror("mlockall");
337888a6bc6SSatoru Moriya     }
338888a6bc6SSatoru Moriya 
339888a6bc6SSatoru Moriya     return ret;
340888a6bc6SSatoru Moriya }
341