]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/process-util.c
2 This file is part of systemd.
4 Copyright 2010 Lennart Poettering
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.
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.
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/>.
23 #include <linux/oom.h>
30 #include <sys/personality.h>
31 #include <sys/prctl.h>
32 #include <sys/types.h>
36 #ifdef HAVE_VALGRIND_VALGRIND_H
37 #include <valgrind/valgrind.h>
40 #include "alloc-util.h"
41 #include "architecture.h"
50 #include "process-util.h"
51 #include "raw-clone.h"
52 #include "signal-util.h"
53 #include "stat-util.h"
54 #include "string-table.h"
55 #include "string-util.h"
56 #include "user-util.h"
59 int get_process_state(pid_t pid
) {
63 _cleanup_free_
char *line
= NULL
;
67 p
= procfs_file_alloca(pid
, "stat");
69 r
= read_one_line_file(p
, &line
);
75 p
= strrchr(line
, ')');
81 if (sscanf(p
, " %c", &state
) != 1)
84 return (unsigned char) state
;
87 int get_process_comm(pid_t pid
, char **name
) {
94 p
= procfs_file_alloca(pid
, "comm");
96 r
= read_one_line_file(p
, name
);
103 int get_process_cmdline(pid_t pid
, size_t max_length
, bool comm_fallback
, char **line
) {
104 _cleanup_fclose_
FILE *f
= NULL
;
113 /* Retrieves a process' command line. Replaces unprintable characters while doing so by whitespace (coalescing
114 * multiple sequential ones into one). If max_length is != 0 will return a string of the specified size at most
115 * (the trailing NUL byte does count towards the length here!), abbreviated with a "..." ellipsis. If
116 * comm_fallback is true and the process has no command line set (the case for kernel threads), or has a
117 * command line that resolves to the empty string will return the "comm" name of the process instead.
119 * Returns -ESRCH if the process doesn't exist, and -ENOENT if the process has no command line (and
120 * comm_fallback is false). */
122 p
= procfs_file_alloca(pid
, "cmdline");
131 if (max_length
== 1) {
133 /* If there's only room for one byte, return the empty string */
141 } else if (max_length
== 0) {
142 size_t len
= 0, allocated
= 0;
144 while ((c
= getc(f
)) != EOF
) {
146 if (!GREEDY_REALLOC(r
, allocated
, len
+3)) {
166 bool dotdotdot
= false;
169 r
= new(char, max_length
);
175 while ((c
= getc(f
)) != EOF
) {
202 if (max_length
<= 4) {
206 k
= r
+ max_length
- 4;
209 /* Eat up final spaces */
210 while (k
> r
&& isspace(k
[-1])) {
216 strncpy(k
, "...", left
-1);
222 /* Kernel threads have no argv[] */
224 _cleanup_free_
char *t
= NULL
;
232 h
= get_process_comm(pid
, &t
);
237 r
= strjoin("[", t
, "]", NULL
);
243 if (l
+ 3 <= max_length
)
244 r
= strjoin("[", t
, "]", NULL
);
245 else if (max_length
<= 6) {
247 r
= new(char, max_length
);
251 memcpy(r
, "[...]", max_length
-1);
256 t
[max_length
- 6] = 0;
258 /* Chop off final spaces */
260 while (e
> t
&& isspace(e
[-1]))
264 r
= strjoin("[", t
, "...]", NULL
);
275 void rename_process(const char name
[8]) {
278 /* This is a like a poor man's setproctitle(). It changes the
279 * comm field, argv[0], and also the glibc's internally used
280 * name of the process. For the first one a limit of 16 chars
281 * applies, to the second one usually one of 10 (i.e. length
282 * of "/sbin/init"), to the third one one of 7 (i.e. length of
283 * "systemd"). If you pass a longer string it will be
286 (void) prctl(PR_SET_NAME
, name
);
288 if (program_invocation_name
)
289 strncpy(program_invocation_name
, name
, strlen(program_invocation_name
));
291 if (saved_argc
> 0) {
295 strncpy(saved_argv
[0], name
, strlen(saved_argv
[0]));
297 for (i
= 1; i
< saved_argc
; i
++) {
301 memzero(saved_argv
[i
], strlen(saved_argv
[i
]));
306 int is_kernel_thread(pid_t pid
) {
313 if (pid
== 0 || pid
== 1) /* pid 1, and we ourselves certainly aren't a kernel thread */
318 p
= procfs_file_alloca(pid
, "cmdline");
326 count
= fread(&c
, 1, 1, f
);
330 /* Kernel threads have an empty cmdline */
333 return eof
? 1 : -errno
;
338 int get_process_capeff(pid_t pid
, char **capeff
) {
345 p
= procfs_file_alloca(pid
, "status");
347 r
= get_proc_field(p
, "CapEff", WHITESPACE
, capeff
);
354 static int get_process_link_contents(const char *proc_file
, char **name
) {
360 r
= readlink_malloc(proc_file
, name
);
369 int get_process_exe(pid_t pid
, char **name
) {
376 p
= procfs_file_alloca(pid
, "exe");
377 r
= get_process_link_contents(p
, name
);
381 d
= endswith(*name
, " (deleted)");
388 static int get_process_id(pid_t pid
, const char *field
, uid_t
*uid
) {
389 _cleanup_fclose_
FILE *f
= NULL
;
396 p
= procfs_file_alloca(pid
, "status");
404 FOREACH_LINE(line
, f
, return -errno
) {
409 if (startswith(l
, field
)) {
411 l
+= strspn(l
, WHITESPACE
);
413 l
[strcspn(l
, WHITESPACE
)] = 0;
415 return parse_uid(l
, uid
);
422 int get_process_uid(pid_t pid
, uid_t
*uid
) {
423 return get_process_id(pid
, "Uid:", uid
);
426 int get_process_gid(pid_t pid
, gid_t
*gid
) {
427 assert_cc(sizeof(uid_t
) == sizeof(gid_t
));
428 return get_process_id(pid
, "Gid:", gid
);
431 int get_process_cwd(pid_t pid
, char **cwd
) {
436 p
= procfs_file_alloca(pid
, "cwd");
438 return get_process_link_contents(p
, cwd
);
441 int get_process_root(pid_t pid
, char **root
) {
446 p
= procfs_file_alloca(pid
, "root");
448 return get_process_link_contents(p
, root
);
451 int get_process_environ(pid_t pid
, char **env
) {
452 _cleanup_fclose_
FILE *f
= NULL
;
453 _cleanup_free_
char *outcome
= NULL
;
456 size_t allocated
= 0, sz
= 0;
461 p
= procfs_file_alloca(pid
, "environ");
470 while ((c
= fgetc(f
)) != EOF
) {
471 if (!GREEDY_REALLOC(outcome
, allocated
, sz
+ 5))
475 outcome
[sz
++] = '\n';
477 sz
+= cescape_char(c
, outcome
+ sz
);
481 outcome
= strdup("");
493 int get_process_ppid(pid_t pid
, pid_t
*_ppid
) {
495 _cleanup_free_
char *line
= NULL
;
507 p
= procfs_file_alloca(pid
, "stat");
508 r
= read_one_line_file(p
, &line
);
514 /* Let's skip the pid and comm fields. The latter is enclosed
515 * in () but does not escape any () in its value, so let's
516 * skip over it manually */
518 p
= strrchr(line
, ')');
530 if ((long unsigned) (pid_t
) ppid
!= ppid
)
533 *_ppid
= (pid_t
) ppid
;
538 int wait_for_terminate(pid_t pid
, siginfo_t
*status
) {
549 if (waitid(P_PID
, pid
, status
, WEXITED
) < 0) {
563 * < 0 : wait_for_terminate() failed to get the state of the
564 * process, the process was terminated by a signal, or
565 * failed for an unknown reason.
566 * >=0 : The process terminated normally, and its exit code is
569 * That is, success is indicated by a return value of zero, and an
570 * error is indicated by a non-zero value.
572 * A warning is emitted if the process terminates abnormally,
573 * and also if it returns non-zero unless check_exit_code is true.
575 int wait_for_terminate_and_warn(const char *name
, pid_t pid
, bool check_exit_code
) {
582 r
= wait_for_terminate(pid
, &status
);
584 return log_warning_errno(r
, "Failed to wait for %s: %m", name
);
586 if (status
.si_code
== CLD_EXITED
) {
587 if (status
.si_status
!= 0)
588 log_full(check_exit_code
? LOG_WARNING
: LOG_DEBUG
,
589 "%s failed with error code %i.", name
, status
.si_status
);
591 log_debug("%s succeeded.", name
);
593 return status
.si_status
;
594 } else if (status
.si_code
== CLD_KILLED
||
595 status
.si_code
== CLD_DUMPED
) {
597 log_warning("%s terminated by signal %s.", name
, signal_to_string(status
.si_status
));
601 log_warning("%s failed due to unknown reason.", name
);
605 void sigkill_wait(pid_t pid
) {
608 if (kill(pid
, SIGKILL
) > 0)
609 (void) wait_for_terminate(pid
, NULL
);
612 void sigkill_waitp(pid_t
*pid
) {
621 int kill_and_sigcont(pid_t pid
, int sig
) {
624 r
= kill(pid
, sig
) < 0 ? -errno
: 0;
632 int getenv_for_pid(pid_t pid
, const char *field
, char **_value
) {
633 _cleanup_fclose_
FILE *f
= NULL
;
644 path
= procfs_file_alloca(pid
, "environ");
646 f
= fopen(path
, "re");
660 for (i
= 0; i
< sizeof(line
)-1; i
++) {
664 if (_unlikely_(c
== EOF
)) {
674 if (memcmp(line
, field
, l
) == 0 && line
[l
] == '=') {
675 value
= strdup(line
+ l
+ 1);
689 bool pid_is_unwaited(pid_t pid
) {
690 /* Checks whether a PID is still valid at all, including a zombie */
695 if (pid
<= 1) /* If we or PID 1 would be dead and have been waited for, this code would not be running */
698 if (kill(pid
, 0) >= 0)
701 return errno
!= ESRCH
;
704 bool pid_is_alive(pid_t pid
) {
707 /* Checks whether a PID is still valid and not a zombie */
712 if (pid
<= 1) /* If we or PID 1 would be a zombie, this code would not be running */
715 r
= get_process_state(pid
);
716 if (r
== -ESRCH
|| r
== 'Z')
722 int pid_from_same_root_fs(pid_t pid
) {
728 root
= procfs_file_alloca(pid
, "root");
730 return files_same(root
, "/proc/1/root");
733 bool is_main_thread(void) {
734 static thread_local
int cached
= 0;
736 if (_unlikely_(cached
== 0))
737 cached
= getpid() == gettid() ? 1 : -1;
742 noreturn
void freeze(void) {
746 /* Make sure nobody waits for us on a socket anymore */
747 close_all_fds(NULL
, 0);
755 bool oom_score_adjust_is_valid(int oa
) {
756 return oa
>= OOM_SCORE_ADJ_MIN
&& oa
<= OOM_SCORE_ADJ_MAX
;
759 unsigned long personality_from_string(const char *p
) {
763 return PERSONALITY_INVALID
;
765 /* Parse a personality specifier. We use our own identifiers that indicate specific ABIs, rather than just
766 * hints regarding the register size, since we want to keep things open for multiple locally supported ABIs for
767 * the same register size. */
769 architecture
= architecture_from_string(p
);
770 if (architecture
< 0)
771 return PERSONALITY_INVALID
;
773 if (architecture
== native_architecture())
775 #ifdef SECONDARY_ARCHITECTURE
776 if (architecture
== SECONDARY_ARCHITECTURE
)
780 return PERSONALITY_INVALID
;
783 const char* personality_to_string(unsigned long p
) {
784 int architecture
= _ARCHITECTURE_INVALID
;
787 architecture
= native_architecture();
788 #ifdef SECONDARY_ARCHITECTURE
789 else if (p
== PER_LINUX32
)
790 architecture
= SECONDARY_ARCHITECTURE
;
793 if (architecture
< 0)
796 return architecture_to_string(architecture
);
799 void valgrind_summary_hack(void) {
800 #ifdef HAVE_VALGRIND_VALGRIND_H
801 if (getpid() == 1 && RUNNING_ON_VALGRIND
) {
803 pid
= raw_clone(SIGCHLD
);
805 log_emergency_errno(errno
, "Failed to fork off valgrind helper: %m");
809 log_info("Spawned valgrind helper as PID "PID_FMT
".", pid
);
810 (void) wait_for_terminate(pid
, NULL
);
816 int pid_compare_func(const void *a
, const void *b
) {
817 const pid_t
*p
= a
, *q
= b
;
819 /* Suitable for usage in qsort() */
828 static const char *const ioprio_class_table
[] = {
829 [IOPRIO_CLASS_NONE
] = "none",
830 [IOPRIO_CLASS_RT
] = "realtime",
831 [IOPRIO_CLASS_BE
] = "best-effort",
832 [IOPRIO_CLASS_IDLE
] = "idle"
835 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(ioprio_class
, int, INT_MAX
);
837 static const char *const sigchld_code_table
[] = {
838 [CLD_EXITED
] = "exited",
839 [CLD_KILLED
] = "killed",
840 [CLD_DUMPED
] = "dumped",
841 [CLD_TRAPPED
] = "trapped",
842 [CLD_STOPPED
] = "stopped",
843 [CLD_CONTINUED
] = "continued",
846 DEFINE_STRING_TABLE_LOOKUP(sigchld_code
, int);
848 static const char* const sched_policy_table
[] = {
849 [SCHED_OTHER
] = "other",
850 [SCHED_BATCH
] = "batch",
851 [SCHED_IDLE
] = "idle",
852 [SCHED_FIFO
] = "fifo",
856 DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(sched_policy
, int, INT_MAX
);