util/oslib-posix.c

   1 /*
   2  * os-posix-lib.c
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  * Copyright (c) 2010 Red Hat, Inc.
   6  *
   7  * QEMU library functions on POSIX which are shared between QEMU and
   8  * the QEMU tools.
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26  * THE SOFTWARE.
  27  */
  28
  29 #include "qemu/osdep.h"
  30 #include <termios.h>
  31
  32 #include <glib/gprintf.h>
  33
  34 #include "sysemu/sysemu.h"
  35 #include "trace.h"
  36 #include "qapi/error.h"
  37 #include "qemu/sockets.h"
  38 #include <libgen.h>
  39 #include <sys/signal.h>
  40 #include "qemu/cutils.h"
  41
  42 #ifdef CONFIG_LINUX
  43 #include <sys/syscall.h>
  44 #endif
  45
  46 #ifdef __FreeBSD__
  47 #include <sys/sysctl.h>
  48 #include <sys/user.h>
  49 #include <libutil.h>
  50 #endif
  51
  52 #include "qemu/mmap-alloc.h"
  53
  54 #ifdef CONFIG_DEBUG_STACK_USAGE
  55 #include "qemu/error-report.h"
  56 #endif
  57
  58 #ifdef CONFIG_MARU
  59 #include "qemu/error-report.h"
  60 #include "../../tizen/src/emulator_common.h"
  61 #endif
  62
  63 int qemu_get_thread_id(void)
  64 {
  65 #if defined(__linux__)
  66     return syscall(SYS_gettid);
  67 #else
  68     return getpid();
  69 #endif
  70 }
  71
  72 int qemu_daemon(int nochdir, int noclose)
  73 {
  74     return daemon(nochdir, noclose);
  75 }
  76
  77 void *qemu_oom_check(void *ptr)
  78 {
  79     if (ptr == NULL) {
  80 #ifdef CONFIG_MARU
  81         error_report("Failed to allocate memory: %s", strerror(errno));
  82 #else
  83         fprintf(stderr, "Failed to allocate memory: %s\n", strerror(errno));
  84 #endif
  85         abort();
  86     }
  87     return ptr;
  88 }
  89
  90 void *qemu_try_memalign(size_t alignment, size_t size)
  91 {
  92     void *ptr;
  93
  94     if (alignment < sizeof(void*)) {
  95         alignment = sizeof(void*);
  96     }
  97
  98 #if defined(_POSIX_C_SOURCE) && !defined(__sun__)
  99     int ret;
 100     ret = posix_memalign(&ptr, alignment, size);
 101     if (ret != 0) {
 102         errno = ret;
 103         ptr = NULL;
 104     }
 105 #elif defined(CONFIG_BSD)
 106     ptr = valloc(size);
 107 #else
 108     ptr = memalign(alignment, size);
 109 #endif
 110     trace_qemu_memalign(alignment, size, ptr);
 111     return ptr;
 112 }
 113
 114 void *qemu_memalign(size_t alignment, size_t size)
 115 {
 116     return qemu_oom_check(qemu_try_memalign(alignment, size));
 117 }
 118
 119 #ifdef CONFIG_MARU
 120 void *preallocated_ram_ptr = NULL;
 121 int preallocated_ram_size = -1;
 122 #endif
 123
 124 /* alloc shared memory pages */
 125 void *qemu_anon_ram_alloc(size_t size, uint64_t *alignment)
 126 {
 127 #ifdef CONFIG_MARU
 128     if (size == preallocated_ram_size && preallocated_ram_ptr) {
 129         void *ptr = preallocated_ram_ptr;
 130         preallocated_ram_ptr = NULL;
 131         preallocated_ram_size = -1;
 132         return ptr;
 133     }
 134 #endif
 135     size_t align = QEMU_VMALLOC_ALIGN;
 136     void *ptr = qemu_ram_mmap(-1, size, align, false);
 137
 138     if (ptr == MAP_FAILED) {
 139         return NULL;
 140     }
 141
 142     if (alignment) {
 143         *alignment = align;
 144     }
 145
 146     trace_qemu_anon_ram_alloc(size, ptr);
 147     return ptr;
 148 }
 149
 150 void qemu_vfree(void *ptr)
 151 {
 152     trace_qemu_vfree(ptr);
 153     free(ptr);
 154 }
 155
 156 void qemu_anon_ram_free(void *ptr, size_t size)
 157 {
 158     trace_qemu_anon_ram_free(ptr, size);
 159     qemu_ram_munmap(ptr, size);
 160 }
 161
 162 void qemu_set_block(int fd)
 163 {
 164     int f;
 165     f = fcntl(fd, F_GETFL);
 166     fcntl(fd, F_SETFL, f & ~O_NONBLOCK);
 167 }
 168
 169 void qemu_set_nonblock(int fd)
 170 {
 171     int f;
 172     f = fcntl(fd, F_GETFL);
 173     fcntl(fd, F_SETFL, f | O_NONBLOCK);
 174 }
 175
 176 int socket_set_fast_reuse(int fd)
 177 {
 178     int val = 1, ret;
 179
 180     ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
 181                      (const char *)&val, sizeof(val));
 182
 183     assert(ret == 0);
 184
 185     return ret;
 186 }
 187
 188 void qemu_set_cloexec(int fd)
 189 {
 190     int f;
 191     f = fcntl(fd, F_GETFD);
 192     fcntl(fd, F_SETFD, f | FD_CLOEXEC);
 193 }
 194
 195 /*
 196  * Creates a pipe with FD_CLOEXEC set on both file descriptors
 197  */
 198 int qemu_pipe(int pipefd[2])
 199 {
 200     int ret;
 201
 202 #ifdef CONFIG_PIPE2
 203     ret = pipe2(pipefd, O_CLOEXEC);
 204     if (ret != -1 || errno != ENOSYS) {
 205         return ret;
 206     }
 207 #endif
 208     ret = pipe(pipefd);
 209     if (ret == 0) {
 210         qemu_set_cloexec(pipefd[0]);
 211         qemu_set_cloexec(pipefd[1]);
 212     }
 213
 214     return ret;
 215 }
 216
 217 int qemu_utimens(const char *path, const struct timespec *times)
 218 {
 219     struct timeval tv[2], tv_now;
 220     struct stat st;
 221     int i;
 222 #ifdef CONFIG_UTIMENSAT
 223     int ret;
 224
 225     ret = utimensat(AT_FDCWD, path, times, AT_SYMLINK_NOFOLLOW);
 226     if (ret != -1 || errno != ENOSYS) {
 227         return ret;
 228     }
 229 #endif
 230     /* Fallback: use utimes() instead of utimensat() */
 231
 232     /* happy if special cases */
 233     if (times[0].tv_nsec == UTIME_OMIT && times[1].tv_nsec == UTIME_OMIT) {
 234         return 0;
 235     }
 236     if (times[0].tv_nsec == UTIME_NOW && times[1].tv_nsec == UTIME_NOW) {
 237         return utimes(path, NULL);
 238     }
 239
 240     /* prepare for hard cases */
 241     if (times[0].tv_nsec == UTIME_NOW || times[1].tv_nsec == UTIME_NOW) {
 242         gettimeofday(&tv_now, NULL);
 243     }
 244     if (times[0].tv_nsec == UTIME_OMIT || times[1].tv_nsec == UTIME_OMIT) {
 245         stat(path, &st);
 246     }
 247
 248     for (i = 0; i < 2; i++) {
 249         if (times[i].tv_nsec == UTIME_NOW) {
 250             tv[i].tv_sec = tv_now.tv_sec;
 251             tv[i].tv_usec = tv_now.tv_usec;
 252         } else if (times[i].tv_nsec == UTIME_OMIT) {
 253             tv[i].tv_sec = (i == 0) ? st.st_atime : st.st_mtime;
 254             tv[i].tv_usec = 0;
 255         } else {
 256             tv[i].tv_sec = times[i].tv_sec;
 257             tv[i].tv_usec = times[i].tv_nsec / 1000;
 258         }
 259     }
 260
 261     return utimes(path, &tv[0]);
 262 }
 263
 264 char *
 265 qemu_get_local_state_pathname(const char *relative_pathname)
 266 {
 267     return g_strdup_printf("%s/%s", CONFIG_QEMU_LOCALSTATEDIR,
 268                            relative_pathname);
 269 }
 270
 271 void qemu_set_tty_echo(int fd, bool echo)
 272 {
 273     struct termios tty;
 274
 275     tcgetattr(fd, &tty);
 276
 277     if (echo) {
 278         tty.c_lflag |= ECHO | ECHONL | ICANON | IEXTEN;
 279     } else {
 280         tty.c_lflag &= ~(ECHO | ECHONL | ICANON | IEXTEN);
 281     }
 282
 283     tcsetattr(fd, TCSANOW, &tty);
 284 }
 285
 286 static char exec_dir[PATH_MAX];
 287
 288 void qemu_init_exec_dir(const char *argv0)
 289 {
 290     char *dir;
 291     char *p = NULL;
 292     char buf[PATH_MAX];
 293
 294     assert(!exec_dir[0]);
 295
 296 #if defined(__linux__)
 297     {
 298         int len;
 299         len = readlink("/proc/self/exe", buf, sizeof(buf) - 1);
 300         if (len > 0) {
 301             buf[len] = 0;
 302             p = buf;
 303         }
 304     }
 305 #elif defined(__FreeBSD__)
 306     {
 307         static int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
 308         size_t len = sizeof(buf) - 1;
 309
 310         *buf = '\0';
 311         if (!sysctl(mib, ARRAY_SIZE(mib), buf, &len, NULL, 0) &&
 312             *buf) {
 313             buf[sizeof(buf) - 1] = '\0';
 314             p = buf;
 315         }
 316     }
 317 #endif
 318     /* If we don't have any way of figuring out the actual executable
 319        location then try argv[0].  */
 320     if (!p) {
 321         if (!argv0) {
 322             return;
 323         }
 324         p = realpath(argv0, buf);
 325         if (!p) {
 326             return;
 327         }
 328     }
 329     dir = g_path_get_dirname(p);
 330
 331     pstrcpy(exec_dir, sizeof(exec_dir), dir);
 332
 333     g_free(dir);
 334 }
 335
 336 char *qemu_get_exec_dir(void)
 337 {
 338     return g_strdup(exec_dir);
 339 }
 340
 341 static sigjmp_buf sigjump;
 342
 343 static void sigbus_handler(int signal)
 344 {
 345     siglongjmp(sigjump, 1);
 346 }
 347
 348 void os_mem_prealloc(int fd, char *area, size_t memory, Error **errp)
 349 {
 350     int ret;
 351     struct sigaction act, oldact;
 352     sigset_t set, oldset;
 353
 354     memset(&act, 0, sizeof(act));
 355     act.sa_handler = &sigbus_handler;
 356     act.sa_flags = 0;
 357
 358     ret = sigaction(SIGBUS, &act, &oldact);
 359     if (ret) {
 360         error_setg_errno(errp, errno,
 361             "os_mem_prealloc: failed to install signal handler");
 362         return;
 363     }
 364
 365     /* unblock SIGBUS */
 366     sigemptyset(&set);
 367     sigaddset(&set, SIGBUS);
 368     pthread_sigmask(SIG_UNBLOCK, &set, &oldset);
 369
 370     if (sigsetjmp(sigjump, 1)) {
 371         error_setg(errp, "os_mem_prealloc: Insufficient free host memory "
 372             "pages available to allocate guest RAM\n");
 373     } else {
 374         int i;
 375         size_t hpagesize = qemu_fd_getpagesize(fd);
 376         size_t numpages = DIV_ROUND_UP(memory, hpagesize);
 377
 378         /* MAP_POPULATE silently ignores failures */
 379         for (i = 0; i < numpages; i++) {
 380             memset(area + (hpagesize * i), 0, 1);
 381         }
 382     }
 383
 384     ret = sigaction(SIGBUS, &oldact, NULL);
 385     if (ret) {
 386         /* Terminate QEMU since it can't recover from error */
 387         perror("os_mem_prealloc: failed to reinstall signal handler");
 388         exit(1);
 389     }
 390     pthread_sigmask(SIG_SETMASK, &oldset, NULL);
 391 }
 392
 393
 394 static struct termios oldtty;
 395
 396 static void term_exit(void)
 397 {
 398     tcsetattr(0, TCSANOW, &oldtty);
 399 }
 400
 401 static void term_init(void)
 402 {
 403     struct termios tty;
 404
 405     tcgetattr(0, &tty);
 406     oldtty = tty;
 407
 408     tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
 409                           |INLCR|IGNCR|ICRNL|IXON);
 410     tty.c_oflag |= OPOST;
 411     tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
 412     tty.c_cflag &= ~(CSIZE|PARENB);
 413     tty.c_cflag |= CS8;
 414     tty.c_cc[VMIN] = 1;
 415     tty.c_cc[VTIME] = 0;
 416
 417     tcsetattr(0, TCSANOW, &tty);
 418
 419     atexit(term_exit);
 420 }
 421
 422 int qemu_read_password(char *buf, int buf_size)
 423 {
 424     uint8_t ch;
 425     int i, ret;
 426
 427     printf("password: ");
 428     fflush(stdout);
 429     term_init();
 430     i = 0;
 431     for (;;) {
 432         ret = read(0, &ch, 1);
 433         if (ret == -1) {
 434             if (errno == EAGAIN || errno == EINTR) {
 435                 continue;
 436             } else {
 437                 break;
 438             }
 439         } else if (ret == 0) {
 440             ret = -1;
 441             break;
 442         } else {
 443             if (ch == '\r' ||
 444                 ch == '\n') {
 445                 ret = 0;
 446                 break;
 447             }
 448             if (i < (buf_size - 1)) {
 449                 buf[i++] = ch;
 450             }
 451         }
 452     }
 453     term_exit();
 454     buf[i] = '\0';
 455     printf("\n");
 456     return ret;
 457 }
 458
 459
 460 char *qemu_get_pid_name(pid_t pid)
 461 {
 462     char *name = NULL;
 463
 464 #if defined(__FreeBSD__)
 465     /* BSDs don't have /proc, but they provide a nice substitute */
 466     struct kinfo_proc *proc = kinfo_getproc(pid);
 467
 468     if (proc) {
 469         name = g_strdup(proc->ki_comm);
 470         free(proc);
 471     }
 472 #else
 473     /* Assume a system with reasonable procfs */
 474     char *pid_path;
 475     size_t len;
 476
 477     pid_path = g_strdup_printf("/proc/%d/cmdline", pid);
 478     g_file_get_contents(pid_path, &name, &len, NULL);
 479     g_free(pid_path);
 480 #endif
 481
 482     return name;
 483 }
 484
 485
 486 pid_t qemu_fork(Error **errp)
 487 {
 488     sigset_t oldmask, newmask;
 489     struct sigaction sig_action;
 490     int saved_errno;
 491     pid_t pid;
 492
 493     /*
 494      * Need to block signals now, so that child process can safely
 495      * kill off caller's signal handlers without a race.
 496      */
 497     sigfillset(&newmask);
 498     if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) {
 499         error_setg_errno(errp, errno,
 500                          "cannot block signals");
 501         return -1;
 502     }
 503
 504     pid = fork();
 505     saved_errno = errno;
 506
 507     if (pid < 0) {
 508         /* attempt to restore signal mask, but ignore failure, to
 509          * avoid obscuring the fork failure */
 510         (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
 511         error_setg_errno(errp, saved_errno,
 512                          "cannot fork child process");
 513         errno = saved_errno;
 514         return -1;
 515     } else if (pid) {
 516         /* parent process */
 517
 518         /* Restore our original signal mask now that the child is
 519          * safely running. Only documented failures are EFAULT (not
 520          * possible, since we are using just-grabbed mask) or EINVAL
 521          * (not possible, since we are using correct arguments).  */
 522         (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
 523     } else {
 524         /* child process */
 525         size_t i;
 526
 527         /* Clear out all signal handlers from parent so nothing
 528          * unexpected can happen in our child once we unblock
 529          * signals */
 530         sig_action.sa_handler = SIG_DFL;
 531         sig_action.sa_flags = 0;
 532         sigemptyset(&sig_action.sa_mask);
 533
 534         for (i = 1; i < NSIG; i++) {
 535             /* Only possible errors are EFAULT or EINVAL The former
 536              * won't happen, the latter we expect, so no need to check
 537              * return value */
 538             (void)sigaction(i, &sig_action, NULL);
 539         }
 540
 541         /* Unmask all signals in child, since we've no idea what the
 542          * caller's done with their signal mask and don't want to
 543          * propagate that to children */
 544         sigemptyset(&newmask);
 545         if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) {
 546             Error *local_err = NULL;
 547             error_setg_errno(&local_err, errno,
 548                              "cannot unblock signals");
 549             error_report_err(local_err);
 550             _exit(1);
 551         }
 552     }
 553     return pid;
 554 }
 555
 556 void *qemu_alloc_stack(size_t *sz)
 557 {
 558     void *ptr, *guardpage;
 559 #ifdef CONFIG_DEBUG_STACK_USAGE
 560     void *ptr2;
 561 #endif
 562     size_t pagesz = getpagesize();
 563 #ifdef _SC_THREAD_STACK_MIN
 564     /* avoid stacks smaller than _SC_THREAD_STACK_MIN */
 565     long min_stack_sz = sysconf(_SC_THREAD_STACK_MIN);
 566     *sz = MAX(MAX(min_stack_sz, 0), *sz);
 567 #endif
 568     /* adjust stack size to a multiple of the page size */
 569     *sz = ROUND_UP(*sz, pagesz);
 570     /* allocate one extra page for the guard page */
 571     *sz += pagesz;
 572
 573     ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE,
 574                MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
 575     if (ptr == MAP_FAILED) {
 576         abort();
 577     }
 578
 579 #if defined(HOST_IA64)
 580     /* separate register stack */
 581     guardpage = ptr + (((*sz - pagesz) / 2) & ~pagesz);
 582 #elif defined(HOST_HPPA)
 583     /* stack grows up */
 584     guardpage = ptr + *sz - pagesz;
 585 #else
 586     /* stack grows down */
 587     guardpage = ptr;
 588 #endif
 589     if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
 590         abort();
 591     }
 592
 593 #ifdef CONFIG_DEBUG_STACK_USAGE
 594     for (ptr2 = ptr + pagesz; ptr2 < ptr + *sz; ptr2 += sizeof(uint32_t)) {
 595         *(uint32_t *)ptr2 = 0xdeadbeaf;
 596     }
 597 #endif
 598
 599     return ptr;
 600 }
 601
 602 #ifdef CONFIG_DEBUG_STACK_USAGE
 603 static __thread unsigned int max_stack_usage;
 604 #endif
 605
 606 void qemu_free_stack(void *stack, size_t sz)
 607 {
 608 #ifdef CONFIG_DEBUG_STACK_USAGE
 609     unsigned int usage;
 610     void *ptr;
 611
 612     for (ptr = stack + getpagesize(); ptr < stack + sz;
 613          ptr += sizeof(uint32_t)) {
 614         if (*(uint32_t *)ptr != 0xdeadbeaf) {
 615             break;
 616         }
 617     }
 618     usage = sz - (uintptr_t) (ptr - stack);
 619     if (usage > max_stack_usage) {
 620         error_report("thread %d max stack usage increased from %u to %u",
 621                      qemu_get_thread_id(), max_stack_usage, usage);
 622         max_stack_usage = usage;
 623     }
 624 #endif
 625
 626     munmap(stack, sz);
 627 }