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         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         if (pid == 0)
 325                 return getuid();
 326
 327         p = procfs_file_alloca(pid, "status");
 328         f = fopen(p, "re");
 329         if (!f) {
 330                 if (errno == ENOENT)
 331                         return -ESRCH;
 332                 return -errno;
 333         }
 334
 335         FOREACH_LINE(line, f, return -errno) {
 336                 char *l;
 337
 338                 l = strstrip(line);
 339
 340                 if (startswith(l, field)) {
 341                         l += strlen(field);
 342                         l += strspn(l, WHITESPACE);
 343
 344                         l[strcspn(l, WHITESPACE)] = 0;
 345
 346                         return parse_uid(l, uid);
 347                 }
 348         }
 349
 350         return -EIO;
 351 }
 352
 353 int get_process_uid(pid_t pid, uid_t *uid) {
 354         return get_process_id(pid, "Uid:", uid);
 355 }
 356
 357 int get_process_gid(pid_t pid, gid_t *gid) {
 358         assert_cc(sizeof(uid_t) == sizeof(gid_t));
 359         return get_process_id(pid, "Gid:", gid);
 360 }
 361
 362 int get_process_cwd(pid_t pid, char **cwd) {
 363         const char *p;
 364
 365         assert(pid >= 0);
 366
 367         p = procfs_file_alloca(pid, "cwd");
 368
 369         return get_process_link_contents(p, cwd);
 370 }
 371
 372 int get_process_root(pid_t pid, char **root) {
 373         const char *p;
 374
 375         assert(pid >= 0);
 376
 377         p = procfs_file_alloca(pid, "root");
 378
 379         return get_process_link_contents(p, root);
 380 }
 381
 382 int get_process_environ(pid_t pid, char **env) {
 383         _cleanup_fclose_ FILE *f = NULL;
 384         _cleanup_free_ char *outcome = NULL;
 385         int c;
 386         const char *p;
 387         size_t allocated = 0, sz = 0;
 388
 389         assert(pid >= 0);
 390         assert(env);
 391
 392         p = procfs_file_alloca(pid, "environ");
 393
 394         f = fopen(p, "re");
 395         if (!f) {
 396                 if (errno == ENOENT)
 397                         return -ESRCH;
 398                 return -errno;
 399         }
 400
 401         while ((c = fgetc(f)) != EOF) {
 402                 if (!GREEDY_REALLOC(outcome, allocated, sz + 5))
 403                         return -ENOMEM;
 404
 405                 if (c == '\0')
 406                         outcome[sz++] = '\n';
 407                 else
 408                         sz += cescape_char(c, outcome + sz);
 409         }
 410
 411         if (!outcome) {
 412                 outcome = strdup("");
 413                 if (!outcome)
 414                         return -ENOMEM;
 415         } else
 416         outcome[sz] = '\0';
 417
 418         *env = outcome;
 419         outcome = NULL;
 420
 421         return 0;
 422 }
 423
 424 int get_process_ppid(pid_t pid, pid_t *_ppid) {
 425         int r;
 426         _cleanup_free_ char *line = NULL;
 427         long unsigned ppid;
 428         const char *p;
 429
 430         assert(pid >= 0);
 431         assert(_ppid);
 432
 433         if (pid == 0) {
 434                 *_ppid = getppid();
 435                 return 0;
 436         }
 437
 438         p = procfs_file_alloca(pid, "stat");
 439         r = read_one_line_file(p, &line);
 440         if (r == -ENOENT)
 441                 return -ESRCH;
 442         if (r < 0)
 443                 return r;
 444
 445         /* Let's skip the pid and comm fields. The latter is enclosed
 446          * in () but does not escape any () in its value, so let's
 447          * skip over it manually */
 448
 449         p = strrchr(line, ')');
 450         if (!p)
 451                 return -EIO;
 452
 453         p++;
 454
 455         if (sscanf(p, " "
 456                    "%*c "  /* state */
 457                    "%lu ", /* ppid */
 458                    &ppid) != 1)
 459                 return -EIO;
 460
 461         if ((long unsigned) (pid_t) ppid != ppid)
 462                 return -ERANGE;
 463
 464         *_ppid = (pid_t) ppid;
 465
 466         return 0;
 467 }
 468 #endif // 0
 469
 470 int wait_for_terminate(pid_t pid, siginfo_t *status) {
 471         siginfo_t dummy;
 472
 473         assert(pid >= 1);
 474
 475         if (!status)
 476                 status = &dummy;
 477
 478         for (;;) {
 479                 zero(*status);
 480
 481                 if (waitid(P_PID, pid, status, WEXITED) < 0) {
 482
 483                         if (errno == EINTR)
 484                                 continue;
 485
 486                         return -errno;
 487                 }
 488
 489                 return 0;
 490         }
 491 }
 492
 493 /*
 494  * Return values:
 495  * < 0 : wait_for_terminate() failed to get the state of the
 496  *       process, the process was terminated by a signal, or
 497  *       failed for an unknown reason.
 498  * >=0 : The process terminated normally, and its exit code is
 499  *       returned.
 500  *
 501  * That is, success is indicated by a return value of zero, and an
 502  * error is indicated by a non-zero value.
 503  *
 504  * A warning is emitted if the process terminates abnormally,
 505  * and also if it returns non-zero unless check_exit_code is true.
 506  */
 507 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code) {
 508         int r;
 509         siginfo_t status;
 510
 511         assert(name);
 512         assert(pid > 1);
 513
 514         r = wait_for_terminate(pid, &status);
 515         if (r < 0)
 516                 return log_warning_errno(r, "Failed to wait for %s: %m", name);
 517
 518         if (status.si_code == CLD_EXITED) {
 519                 if (status.si_status != 0)
 520                         log_full(check_exit_code ? LOG_WARNING : LOG_DEBUG,
 521                                  "%s failed with error code %i.", name, status.si_status);
 522                 else
 523                         log_debug("%s succeeded.", name);
 524
 525                 return status.si_status;
 526         } else if (status.si_code == CLD_KILLED ||
 527                    status.si_code == CLD_DUMPED) {
 528
 529                 log_warning("%s terminated by signal %s.", name, signal_to_string(status.si_status));
 530                 return -EPROTO;
 531         }
 532
 533         log_warning("%s failed due to unknown reason.", name);
 534         return -EPROTO;
 535 }
 536
 537 void sigkill_wait(pid_t *pid) {
 538         if (!pid)
 539                 return;
 540         if (*pid <= 1)
 541                 return;
 542
 543         if (kill(*pid, SIGKILL) > 0)
 544                 (void) wait_for_terminate(*pid, NULL);
 545 }
 546
 547 #if 0 /// UNNEEDED by elogind
 548 int kill_and_sigcont(pid_t pid, int sig) {
 549         int r;
 550
 551         r = kill(pid, sig) < 0 ? -errno : 0;
 552
 553         if (r >= 0)
 554                 kill(pid, SIGCONT);
 555
 556         return r;
 557 }
 558 #endif // 0
 559
 560 int getenv_for_pid(pid_t pid, const char *field, char **_value) {
 561         _cleanup_fclose_ FILE *f = NULL;
 562         char *value = NULL;
 563         int r;
 564         bool done = false;
 565         size_t l;
 566         const char *path;
 567
 568         assert(pid >= 0);
 569         assert(field);
 570         assert(_value);
 571
 572         path = procfs_file_alloca(pid, "environ");
 573
 574         f = fopen(path, "re");
 575         if (!f) {
 576                 if (errno == ENOENT)
 577                         return -ESRCH;
 578                 return -errno;
 579         }
 580
 581         l = strlen(field);
 582         r = 0;
 583
 584         do {
 585                 char line[LINE_MAX];
 586                 unsigned i;
 587
 588                 for (i = 0; i < sizeof(line)-1; i++) {
 589                         int c;
 590
 591                         c = getc(f);
 592                         if (_unlikely_(c == EOF)) {
 593                                 done = true;
 594                                 break;
 595                         } else if (c == 0)
 596                                 break;
 597
 598                         line[i] = c;
 599                 }
 600                 line[i] = 0;
 601
 602                 if (memcmp(line, field, l) == 0 && line[l] == '=') {
 603                         value = strdup(line + l + 1);
 604                         if (!value)
 605                                 return -ENOMEM;
 606
 607                         r = 1;
 608                         break;
 609                 }
 610
 611         } while (!done);
 612
 613         *_value = value;
 614         return r;
 615 }
 616
 617 bool pid_is_unwaited(pid_t pid) {
 618         /* Checks whether a PID is still valid at all, including a zombie */
 619
 620         if (pid < 0)
 621                 return false;
 622
 623         if (pid <= 1) /* If we or PID 1 would be dead and have been waited for, this code would not be running */
 624                 return true;
 625
 626         if (kill(pid, 0) >= 0)
 627                 return true;
 628
 629         return errno != ESRCH;
 630 }
 631
 632 bool pid_is_alive(pid_t pid) {
 633         int r;
 634
 635         /* Checks whether a PID is still valid and not a zombie */
 636
 637         if (pid < 0)
 638                 return false;
 639
 640         if (pid <= 1) /* If we or PID 1 would be a zombie, this code would not be running */
 641                 return true;
 642
 643         r = get_process_state(pid);
 644         if (r == -ESRCH || r == 'Z')
 645                 return false;
 646
 647         return true;
 648 }
 649
 650 #if 0 /// UNNEEDED by elogind
 651 int pid_from_same_root_fs(pid_t pid) {
 652         const char *root;
 653
 654         if (pid < 0)
 655                 return 0;
 656
 657         root = procfs_file_alloca(pid, "root");
 658
 659         return files_same(root, "/proc/1/root");
 660 }
 661 #endif // 0
 662
 663 bool is_main_thread(void) {
 664         static thread_local int cached = 0;
 665
 666         if (_unlikely_(cached == 0))
 667                 cached = getpid() == gettid() ? 1 : -1;
 668
 669         return cached > 0;
 670 }
 671
 672 #if 0 /// UNNEEDED by elogind
 673 noreturn void freeze(void) {
 674
 675         /* Make sure nobody waits for us on a socket anymore */
 676         close_all_fds(NULL, 0);
 677
 678         sync();
 679
 680         for (;;)
 681                 pause();
 682 }
 683
 684 bool oom_score_adjust_is_valid(int oa) {
 685         return oa >= OOM_SCORE_ADJ_MIN && oa <= OOM_SCORE_ADJ_MAX;
 686 }
 687
 688 unsigned long personality_from_string(const char *p) {
 689         int architecture;
 690
 691         if (!p)
 692                 return PERSONALITY_INVALID;
 693
 694         /* Parse a personality specifier. We use our own identifiers that indicate specific ABIs, rather than just
 695          * hints regarding the register size, since we want to keep things open for multiple locally supported ABIs for
 696          * the same register size. */
 697
 698         architecture = architecture_from_string(p);
 699         if (architecture < 0)
 700                 return PERSONALITY_INVALID;
 701
 702         if (architecture == native_architecture())
 703                 return PER_LINUX;
 704 #ifdef SECONDARY_ARCHITECTURE
 705         if (architecture == SECONDARY_ARCHITECTURE)
 706                 return PER_LINUX32;
 707 #endif
 708
 709         return PERSONALITY_INVALID;
 710 }
 711
 712 const char* personality_to_string(unsigned long p) {
 713         int architecture = _ARCHITECTURE_INVALID;
 714
 715         if (p == PER_LINUX)
 716                 architecture = native_architecture();
 717 #ifdef SECONDARY_ARCHITECTURE
 718         else if (p == PER_LINUX32)
 719                 architecture = SECONDARY_ARCHITECTURE;
 720 #endif
 721
 722         if (architecture < 0)
 723                 return NULL;
 724
 725         return architecture_to_string(architecture);
 726 }
 727
 728 void valgrind_summary_hack(void) {
 729 #ifdef HAVE_VALGRIND_VALGRIND_H
 730         if (getpid() == 1 && RUNNING_ON_VALGRIND) {
 731                 pid_t pid;
 732                 pid = raw_clone(SIGCHLD, NULL);
 733                 if (pid < 0)
 734                         log_emergency_errno(errno, "Failed to fork off valgrind helper: %m");
 735                 else if (pid == 0)
 736                         exit(EXIT_SUCCESS);
 737                 else {
 738                         log_info("Spawned valgrind helper as PID "PID_FMT".", pid);
 739                         (void) wait_for_terminate(pid, NULL);
 740                 }
 741         }
 742 #endif
 743 }
 744
 745 int pid_compare_func(const void *a, const void *b) {
 746         const pid_t *p = a, *q = b;
 747
 748         /* Suitable for usage in qsort() */
 749
 750         if (*p < *q)
 751                 return -1;
 752         if (*p > *q)
 753                 return 1;
 754         return 0;
 755 }
 756
 757 static const char *const ioprio_class_table[] = {
 758         [IOPRIO_CLASS_NONE] = "none",
 759         [IOPRIO_CLASS_RT] = "realtime",
 760         [IOPRIO_CLASS_BE] = "best-effort",
 761         [IOPRIO_CLASS_IDLE] = "idle"
 762 };
 763
 764 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(ioprio_class, int, INT_MAX);
 765
 766 static const char *const sigchld_code_table[] = {
 767         [CLD_EXITED] = "exited",
 768         [CLD_KILLED] = "killed",
 769         [CLD_DUMPED] = "dumped",
 770         [CLD_TRAPPED] = "trapped",
 771         [CLD_STOPPED] = "stopped",
 772         [CLD_CONTINUED] = "continued",
 773 };
 774
 775 DEFINE_STRING_TABLE_LOOKUP(sigchld_code, int);
 776
 777 static const char* const sched_policy_table[] = {
 778         [SCHED_OTHER] = "other",
 779         [SCHED_BATCH] = "batch",
 780         [SCHED_IDLE] = "idle",
 781         [SCHED_FIFO] = "fifo",
 782         [SCHED_RR] = "rr"
 783 };
 784
 785 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(sched_policy, int, INT_MAX);
 786 #endif // 0