src/basic/process-util.c

   1 /***
   2   This file is part of systemd.
   3
   4   Copyright 2010 Lennart Poettering
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <limits.h>
  23 #include <linux/oom.h>
  24 #include <sched.h>
  25 #include <signal.h>
  26 #include <stdbool.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/personality.h>
  31 #include <sys/prctl.h>
  32 #include <sys/types.h>
  33 #include <sys/wait.h>
  34 #include <syslog.h>
  35 #include <unistd.h>
  36 #ifdef HAVE_VALGRIND_VALGRIND_H
  37 #include <valgrind/valgrind.h>
  38 #endif
  39
  40 #include "alloc-util.h"
  41 //#include "architecture.h"
  42 #include "escape.h"
  43 #include "fd-util.h"
  44 #include "fileio.h"
  45 #include "fs-util.h"
  46 //#include "ioprio.h"
  47 #include "log.h"
  48 #include "macro.h"
  49 #include "missing.h"
  50 #include "process-util.h"
  51 #include "signal-util.h"
  52 //#include "stat-util.h"
  53 #include "string-table.h"
  54 #include "string-util.h"
  55 #include "user-util.h"
  56 #include "util.h"
  57
  58 int get_process_state(pid_t pid) {
  59         const char *p;
  60         char state;
  61         int r;
  62         _cleanup_free_ char *line = NULL;
  63
  64         assert(pid >= 0);
  65
  66         p = procfs_file_alloca(pid, "stat");
  67
  68         r = read_one_line_file(p, &line);
  69         if (r == -ENOENT)
  70                 return -ESRCH;
  71         if (r < 0)
  72                 return r;
  73
  74         p = strrchr(line, ')');
  75         if (!p)
  76                 return -EIO;
  77
  78         p++;
  79
  80         if (sscanf(p, " %c", &state) != 1)
  81                 return -EIO;
  82
  83         return (unsigned char) state;
  84 }
  85
  86 int get_process_comm(pid_t pid, char **name) {
  87         const char *p;
  88         int r;
  89
  90         assert(name);
  91         assert(pid >= 0);
  92
  93         p = procfs_file_alloca(pid, "comm");
  94
  95         r = read_one_line_file(p, name);
  96         if (r == -ENOENT)
  97                 return -ESRCH;
  98
  99         return r;
 100 }
 101
 102 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line) {
 103         _cleanup_fclose_ FILE *f = NULL;
 104         char *r = NULL, *k;
 105         const char *p;
 106         int c;
 107
 108         assert(line);
 109         assert(pid >= 0);
 110
 111         p = procfs_file_alloca(pid, "cmdline");
 112
 113         f = fopen(p, "re");
 114         if (!f) {
 115                 if (errno == ENOENT)
 116                         return -ESRCH;
 117                 return -errno;
 118         }
 119
 120         if (max_length == 0) {
 121                 size_t len = 0, allocated = 0;
 122
 123                 while ((c = getc(f)) != EOF) {
 124
 125                         if (!GREEDY_REALLOC(r, allocated, len+2)) {
 126                                 free(r);
 127                                 return -ENOMEM;
 128                         }
 129
 130                         r[len++] = isprint(c) ? c : ' ';
 131                 }
 132
 133                 if (len > 0)
 134                         r[len-1] = 0;
 135
 136         } else {
 137                 bool space = false;
 138                 size_t left;
 139
 140                 r = new(char, max_length);
 141                 if (!r)
 142                         return -ENOMEM;
 143
 144                 k = r;
 145                 left = max_length;
 146                 while ((c = getc(f)) != EOF) {
 147
 148                         if (isprint(c)) {
 149                                 if (space) {
 150                                         if (left <= 4)
 151                                                 break;
 152
 153                                         *(k++) = ' ';
 154                                         left--;
 155                                         space = false;
 156                                 }
 157
 158                                 if (left <= 4)
 159                                         break;
 160
 161                                 *(k++) = (char) c;
 162                                 left--;
 163                         }  else
 164                                 space = true;
 165                 }
 166
 167                 if (left <= 4) {
 168                         size_t n = MIN(left-1, 3U);
 169                         memcpy(k, "...", n);
 170                         k[n] = 0;
 171                 } else
 172                         *k = 0;
 173         }
 174
 175         /* Kernel threads have no argv[] */
 176         if (isempty(r)) {
 177                 _cleanup_free_ char *t = NULL;
 178                 int h;
 179
 180                 free(r);
 181
 182                 if (!comm_fallback)
 183                         return -ENOENT;
 184
 185                 h = get_process_comm(pid, &t);
 186                 if (h < 0)
 187                         return h;
 188
 189                 r = strjoin("[", t, "]", NULL);
 190                 if (!r)
 191                         return -ENOMEM;
 192         }
 193
 194         *line = r;
 195         return 0;
 196 }
 197
 198 #if 0 /// UNNEEDED by elogind
 199 void rename_process(const char name[8]) {
 200         assert(name);
 201
 202         /* This is a like a poor man's setproctitle(). It changes the
 203          * comm field, argv[0], and also the glibc's internally used
 204          * name of the process. For the first one a limit of 16 chars
 205          * applies, to the second one usually one of 10 (i.e. length
 206          * of "/sbin/init"), to the third one one of 7 (i.e. length of
 207          * "systemd"). If you pass a longer string it will be
 208          * truncated */
 209
 210         (void) prctl(PR_SET_NAME, name);
 211
 212         if (program_invocation_name)
 213                 strncpy(program_invocation_name, name, strlen(program_invocation_name));
 214
 215         if (saved_argc > 0) {
 216                 int i;
 217
 218                 if (saved_argv[0])
 219                         strncpy(saved_argv[0], name, strlen(saved_argv[0]));
 220
 221                 for (i = 1; i < saved_argc; i++) {
 222                         if (!saved_argv[i])
 223                                 break;
 224
 225                         memzero(saved_argv[i], strlen(saved_argv[i]));
 226                 }
 227         }
 228 }
 229 #endif // 0
 230
 231 int is_kernel_thread(pid_t pid) {
 232         const char *p;
 233         size_t count;
 234         char c;
 235         bool eof;
 236         FILE *f;
 237
 238         if (pid == 0 || pid == 1) /* pid 1, and we ourselves certainly aren't a kernel thread */
 239                 return 0;
 240
 241         assert(pid > 1);
 242
 243         p = procfs_file_alloca(pid, "cmdline");
 244         f = fopen(p, "re");
 245         if (!f) {
 246                 if (errno == ENOENT)
 247                         return -ESRCH;
 248                 return -errno;
 249         }
 250
 251         count = fread(&c, 1, 1, f);
 252         eof = feof(f);
 253         fclose(f);
 254
 255         /* Kernel threads have an empty cmdline */
 256
 257         if (count <= 0)
 258                 return eof ? 1 : -errno;
 259
 260         return 0;
 261 }
 262
 263 #if 0 /// UNNEEDED by elogind
 264 int get_process_capeff(pid_t pid, char **capeff) {
 265         const char *p;
 266         int r;
 267
 268         assert(capeff);
 269         assert(pid >= 0);
 270
 271         p = procfs_file_alloca(pid, "status");
 272
 273         r = get_proc_field(p, "CapEff", WHITESPACE, capeff);
 274         if (r == -ENOENT)
 275                 return -ESRCH;
 276
 277         return r;
 278 }
 279 #endif // 0
 280
 281 static int get_process_link_contents(const char *proc_file, char **name) {
 282         int r;
 283
 284         assert(proc_file);
 285         assert(name);
 286
 287         r = readlink_malloc(proc_file, name);
 288         if (r == -ENOENT)
 289                 return -ESRCH;
 290         if (r < 0)
 291                 return r;
 292
 293         return 0;
 294 }
 295
 296 int get_process_exe(pid_t pid, char **name) {
 297         const char *p;
 298         char *d;
 299         int r;
 300
 301         assert(pid >= 0);
 302
 303         p = procfs_file_alloca(pid, "exe");
 304         r = get_process_link_contents(p, name);
 305         if (r < 0)
 306                 return r;
 307
 308         d = endswith(*name, " (deleted)");
 309         if (d)
 310                 *d = '\0';
 311
 312         return 0;
 313 }
 314
 315 #if 0 /// UNNEEDED by elogind
 316 static int get_process_id(pid_t pid, const char *field, uid_t *uid) {
 317         _cleanup_fclose_ FILE *f = NULL;
 318         char line[LINE_MAX];
 319         const char *p;
 320
 321         assert(field);
 322         assert(uid);
 323
 324         p = procfs_file_alloca(pid, "status");
 325         f = fopen(p, "re");
 326         if (!f) {
 327                 if (errno == ENOENT)
 328                         return -ESRCH;
 329                 return -errno;
 330         }
 331
 332         FOREACH_LINE(line, f, return -errno) {
 333                 char *l;
 334
 335                 l = strstrip(line);
 336
 337                 if (startswith(l, field)) {
 338                         l += strlen(field);
 339                         l += strspn(l, WHITESPACE);
 340
 341                         l[strcspn(l, WHITESPACE)] = 0;
 342
 343                         return parse_uid(l, uid);
 344                 }
 345         }
 346
 347         return -EIO;
 348 }
 349
 350 int get_process_uid(pid_t pid, uid_t *uid) {
 351         return get_process_id(pid, "Uid:", uid);
 352 }
 353
 354 int get_process_gid(pid_t pid, gid_t *gid) {
 355         assert_cc(sizeof(uid_t) == sizeof(gid_t));
 356         return get_process_id(pid, "Gid:", gid);
 357 }
 358
 359 int get_process_cwd(pid_t pid, char **cwd) {
 360         const char *p;
 361
 362         assert(pid >= 0);
 363
 364         p = procfs_file_alloca(pid, "cwd");
 365
 366         return get_process_link_contents(p, cwd);
 367 }
 368
 369 int get_process_root(pid_t pid, char **root) {
 370         const char *p;
 371
 372         assert(pid >= 0);
 373
 374         p = procfs_file_alloca(pid, "root");
 375
 376         return get_process_link_contents(p, root);
 377 }
 378
 379 int get_process_environ(pid_t pid, char **env) {
 380         _cleanup_fclose_ FILE *f = NULL;
 381         _cleanup_free_ char *outcome = NULL;
 382         int c;
 383         const char *p;
 384         size_t allocated = 0, sz = 0;
 385
 386         assert(pid >= 0);
 387         assert(env);
 388
 389         p = procfs_file_alloca(pid, "environ");
 390
 391         f = fopen(p, "re");
 392         if (!f) {
 393                 if (errno == ENOENT)
 394                         return -ESRCH;
 395                 return -errno;
 396         }
 397
 398         while ((c = fgetc(f)) != EOF) {
 399                 if (!GREEDY_REALLOC(outcome, allocated, sz + 5))
 400                         return -ENOMEM;
 401
 402                 if (c == '\0')
 403                         outcome[sz++] = '\n';
 404                 else
 405                         sz += cescape_char(c, outcome + sz);
 406         }
 407
 408         if (!outcome) {
 409                 outcome = strdup("");
 410                 if (!outcome)
 411                         return -ENOMEM;
 412         } else
 413                 outcome[sz] = '\0';
 414
 415         *env = outcome;
 416         outcome = NULL;
 417
 418         return 0;
 419 }
 420
 421 int get_process_ppid(pid_t pid, pid_t *_ppid) {
 422         int r;
 423         _cleanup_free_ char *line = NULL;
 424         long unsigned ppid;
 425         const char *p;
 426
 427         assert(pid >= 0);
 428         assert(_ppid);
 429
 430         if (pid == 0) {
 431                 *_ppid = getppid();
 432                 return 0;
 433         }
 434
 435         p = procfs_file_alloca(pid, "stat");
 436         r = read_one_line_file(p, &line);
 437         if (r == -ENOENT)
 438                 return -ESRCH;
 439         if (r < 0)
 440                 return r;
 441
 442         /* Let's skip the pid and comm fields. The latter is enclosed
 443          * in () but does not escape any () in its value, so let's
 444          * skip over it manually */
 445
 446         p = strrchr(line, ')');
 447         if (!p)
 448                 return -EIO;
 449
 450         p++;
 451
 452         if (sscanf(p, " "
 453                    "%*c "  /* state */
 454                    "%lu ", /* ppid */
 455                    &ppid) != 1)
 456                 return -EIO;
 457
 458         if ((long unsigned) (pid_t) ppid != ppid)
 459                 return -ERANGE;
 460
 461         *_ppid = (pid_t) ppid;
 462
 463         return 0;
 464 }
 465 #endif // 0
 466
 467 int wait_for_terminate(pid_t pid, siginfo_t *status) {
 468         siginfo_t dummy;
 469
 470         assert(pid >= 1);
 471
 472         if (!status)
 473                 status = &dummy;
 474
 475         for (;;) {
 476                 zero(*status);
 477
 478                 if (waitid(P_PID, pid, status, WEXITED) < 0) {
 479
 480                         if (errno == EINTR)
 481                                 continue;
 482
 483                         return -errno;
 484                 }
 485
 486                 return 0;
 487         }
 488 }
 489
 490 /*
 491  * Return values:
 492  * < 0 : wait_for_terminate() failed to get the state of the
 493  *       process, the process was terminated by a signal, or
 494  *       failed for an unknown reason.
 495  * >=0 : The process terminated normally, and its exit code is
 496  *       returned.
 497  *
 498  * That is, success is indicated by a return value of zero, and an
 499  * error is indicated by a non-zero value.
 500  *
 501  * A warning is emitted if the process terminates abnormally,
 502  * and also if it returns non-zero unless check_exit_code is true.
 503  */
 504 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code) {
 505         int r;
 506         siginfo_t status;
 507
 508         assert(name);
 509         assert(pid > 1);
 510
 511         r = wait_for_terminate(pid, &status);
 512         if (r < 0)
 513                 return log_warning_errno(r, "Failed to wait for %s: %m", name);
 514
 515         if (status.si_code == CLD_EXITED) {
 516                 if (status.si_status != 0)
 517                         log_full(check_exit_code ? LOG_WARNING : LOG_DEBUG,
 518                                  "%s failed with error code %i.", name, status.si_status);
 519                 else
 520                         log_debug("%s succeeded.", name);
 521
 522                 return status.si_status;
 523         } else if (status.si_code == CLD_KILLED ||
 524                    status.si_code == CLD_DUMPED) {
 525
 526                 log_warning("%s terminated by signal %s.", name, signal_to_string(status.si_status));
 527                 return -EPROTO;
 528         }
 529
 530         log_warning("%s failed due to unknown reason.", name);
 531         return -EPROTO;
 532 }
 533
 534 #if 0 /// UNNEEDED by elogind
 535 void sigkill_wait(pid_t pid) {
 536         assert(pid > 1);
 537
 538         if (kill(pid, SIGKILL) > 0)
 539                 (void) wait_for_terminate(pid, NULL);
 540 }
 541
 542 void sigkill_waitp(pid_t *pid) {
 543         if (!pid)
 544                 return;
 545         if (*pid <= 1)
 546                 return;
 547
 548         sigkill_wait(*pid);
 549 }
 550
 551 int kill_and_sigcont(pid_t pid, int sig) {
 552         int r;
 553
 554         r = kill(pid, sig) < 0 ? -errno : 0;
 555
 556         if (r >= 0)
 557                 kill(pid, SIGCONT);
 558
 559         return r;
 560 }
 561 #endif // 0
 562
 563 int getenv_for_pid(pid_t pid, const char *field, char **_value) {
 564         _cleanup_fclose_ FILE *f = NULL;
 565         char *value = NULL;
 566         int r;
 567         bool done = false;
 568         size_t l;
 569         const char *path;
 570
 571         assert(pid >= 0);
 572         assert(field);
 573         assert(_value);
 574
 575         path = procfs_file_alloca(pid, "environ");
 576
 577         f = fopen(path, "re");
 578         if (!f) {
 579                 if (errno == ENOENT)
 580                         return -ESRCH;
 581                 return -errno;
 582         }
 583
 584         l = strlen(field);
 585         r = 0;
 586
 587         do {
 588                 char line[LINE_MAX];
 589                 unsigned i;
 590
 591                 for (i = 0; i < sizeof(line)-1; i++) {
 592                         int c;
 593
 594                         c = getc(f);
 595                         if (_unlikely_(c == EOF)) {
 596                                 done = true;
 597                                 break;
 598                         } else if (c == 0)
 599                                 break;
 600
 601                         line[i] = c;
 602                 }
 603                 line[i] = 0;
 604
 605                 if (memcmp(line, field, l) == 0 && line[l] == '=') {
 606                         value = strdup(line + l + 1);
 607                         if (!value)
 608                                 return -ENOMEM;
 609
 610                         r = 1;
 611                         break;
 612                 }
 613
 614         } while (!done);
 615
 616         *_value = value;
 617         return r;
 618 }
 619
 620 bool pid_is_unwaited(pid_t pid) {
 621         /* Checks whether a PID is still valid at all, including a zombie */
 622
 623         if (pid < 0)
 624                 return false;
 625
 626         if (pid <= 1) /* If we or PID 1 would be dead and have been waited for, this code would not be running */
 627                 return true;
 628
 629         if (kill(pid, 0) >= 0)
 630                 return true;
 631
 632         return errno != ESRCH;
 633 }
 634
 635 bool pid_is_alive(pid_t pid) {
 636         int r;
 637
 638         /* Checks whether a PID is still valid and not a zombie */
 639
 640         if (pid < 0)
 641                 return false;
 642
 643         if (pid <= 1) /* If we or PID 1 would be a zombie, this code would not be running */
 644                 return true;
 645
 646         r = get_process_state(pid);
 647         if (r == -ESRCH || r == 'Z')
 648                 return false;
 649
 650         return true;
 651 }
 652
 653 #if 0 /// UNNEEDED by elogind
 654 int pid_from_same_root_fs(pid_t pid) {
 655         const char *root;
 656
 657         if (pid < 0)
 658                 return 0;
 659
 660         root = procfs_file_alloca(pid, "root");
 661
 662         return files_same(root, "/proc/1/root");
 663 }
 664 #endif // 0
 665
 666 bool is_main_thread(void) {
 667         static thread_local int cached = 0;
 668
 669         if (_unlikely_(cached == 0))
 670                 cached = getpid() == gettid() ? 1 : -1;
 671
 672         return cached > 0;
 673 }
 674
 675 #if 0 /// UNNEEDED by elogind
 676 noreturn void freeze(void) {
 677
 678         log_close();
 679
 680         /* Make sure nobody waits for us on a socket anymore */
 681         close_all_fds(NULL, 0);
 682
 683         sync();
 684
 685         for (;;)
 686                 pause();
 687 }
 688
 689 bool oom_score_adjust_is_valid(int oa) {
 690         return oa >= OOM_SCORE_ADJ_MIN && oa <= OOM_SCORE_ADJ_MAX;
 691 }
 692
 693 unsigned long personality_from_string(const char *p) {
 694         int architecture;
 695
 696         if (!p)
 697                 return PERSONALITY_INVALID;
 698
 699         /* Parse a personality specifier. We use our own identifiers that indicate specific ABIs, rather than just
 700          * hints regarding the register size, since we want to keep things open for multiple locally supported ABIs for
 701          * the same register size. */
 702
 703         architecture = architecture_from_string(p);
 704         if (architecture < 0)
 705                 return PERSONALITY_INVALID;
 706
 707         if (architecture == native_architecture())
 708                 return PER_LINUX;
 709 #ifdef SECONDARY_ARCHITECTURE
 710         if (architecture == SECONDARY_ARCHITECTURE)
 711                 return PER_LINUX32;
 712 #endif
 713
 714         return PERSONALITY_INVALID;
 715 }
 716
 717 const char* personality_to_string(unsigned long p) {
 718         int architecture = _ARCHITECTURE_INVALID;
 719
 720         if (p == PER_LINUX)
 721                 architecture = native_architecture();
 722 #ifdef SECONDARY_ARCHITECTURE
 723         else if (p == PER_LINUX32)
 724                 architecture = SECONDARY_ARCHITECTURE;
 725 #endif
 726
 727         if (architecture < 0)
 728                 return NULL;
 729
 730         return architecture_to_string(architecture);
 731 }
 732
 733 void valgrind_summary_hack(void) {
 734 #ifdef HAVE_VALGRIND_VALGRIND_H
 735         if (getpid() == 1 && RUNNING_ON_VALGRIND) {
 736                 pid_t pid;
 737                 pid = raw_clone(SIGCHLD, NULL);
 738                 if (pid < 0)
 739                         log_emergency_errno(errno, "Failed to fork off valgrind helper: %m");
 740                 else if (pid == 0)
 741                         exit(EXIT_SUCCESS);
 742                 else {
 743                         log_info("Spawned valgrind helper as PID "PID_FMT".", pid);
 744                         (void) wait_for_terminate(pid, NULL);
 745                 }
 746         }
 747 #endif
 748 }
 749
 750 int pid_compare_func(const void *a, const void *b) {
 751         const pid_t *p = a, *q = b;
 752
 753         /* Suitable for usage in qsort() */
 754
 755         if (*p < *q)
 756                 return -1;
 757         if (*p > *q)
 758                 return 1;
 759         return 0;
 760 }
 761
 762 static const char *const ioprio_class_table[] = {
 763         [IOPRIO_CLASS_NONE] = "none",
 764         [IOPRIO_CLASS_RT] = "realtime",
 765         [IOPRIO_CLASS_BE] = "best-effort",
 766         [IOPRIO_CLASS_IDLE] = "idle"
 767 };
 768
 769 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(ioprio_class, int, INT_MAX);
 770
 771 static const char *const sigchld_code_table[] = {
 772         [CLD_EXITED] = "exited",
 773         [CLD_KILLED] = "killed",
 774         [CLD_DUMPED] = "dumped",
 775         [CLD_TRAPPED] = "trapped",
 776         [CLD_STOPPED] = "stopped",
 777         [CLD_CONTINUED] = "continued",
 778 };
 779
 780 DEFINE_STRING_TABLE_LOOKUP(sigchld_code, int);
 781
 782 static const char* const sched_policy_table[] = {
 783         [SCHED_OTHER] = "other",
 784         [SCHED_BATCH] = "batch",
 785         [SCHED_IDLE] = "idle",
 786         [SCHED_FIFO] = "fifo",
 787         [SCHED_RR] = "rr"
 788 };
 789
 790 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(sched_policy, int, INT_MAX);
 791 #endif // 0