blob: 2381c973d897e8ae9147e465f5884ee7481012b2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_PID_H
2#define _LINUX_PID_H
3
Eric W. Biederman92476d72006-03-31 02:31:42 -08004#include <linux/rcupdate.h>
5
Linus Torvalds1da177e2005-04-16 15:20:36 -07006enum pid_type
7{
8 PIDTYPE_PID,
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 PIDTYPE_PGID,
10 PIDTYPE_SID,
11 PIDTYPE_MAX
12};
13
Eric W. Biederman92476d72006-03-31 02:31:42 -080014/*
15 * What is struct pid?
16 *
17 * A struct pid is the kernel's internal notion of a process identifier.
18 * It refers to individual tasks, process groups, and sessions. While
19 * there are processes attached to it the struct pid lives in a hash
20 * table, so it and then the processes that it refers to can be found
21 * quickly from the numeric pid value. The attached processes may be
22 * quickly accessed by following pointers from struct pid.
23 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -030024 * Storing pid_t values in the kernel and referring to them later has a
Eric W. Biederman92476d72006-03-31 02:31:42 -080025 * problem. The process originally with that pid may have exited and the
26 * pid allocator wrapped, and another process could have come along
27 * and been assigned that pid.
28 *
29 * Referring to user space processes by holding a reference to struct
30 * task_struct has a problem. When the user space process exits
31 * the now useless task_struct is still kept. A task_struct plus a
32 * stack consumes around 10K of low kernel memory. More precisely
33 * this is THREAD_SIZE + sizeof(struct task_struct). By comparison
34 * a struct pid is about 64 bytes.
35 *
36 * Holding a reference to struct pid solves both of these problems.
37 * It is small so holding a reference does not consume a lot of
Sukadev Bhattiprolu84d73782006-12-08 02:38:01 -080038 * resources, and since a new struct pid is allocated when the numeric pid
39 * value is reused (when pids wrap around) we don't mistakenly refer to new
40 * processes.
Eric W. Biederman92476d72006-03-31 02:31:42 -080041 */
42
Sukadev Bhattiprolu4c3f2ea2007-10-18 23:40:03 -070043
44/*
45 * struct upid is used to get the id of the struct pid, as it is
46 * seen in particular namespace. Later the struct pid is found with
47 * find_pid_ns() using the int nr and struct pid_namespace *ns.
48 */
49
50struct upid {
Pavel Emelyanove49859e2008-07-25 01:48:36 -070051 /* Try to keep pid_chain in the same cacheline as nr for find_vpid */
Sukadev Bhattiprolu4c3f2ea2007-10-18 23:40:03 -070052 int nr;
53 struct pid_namespace *ns;
54 struct hlist_node pid_chain;
55};
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057struct pid
58{
Eric W. Biederman92476d72006-03-31 02:31:42 -080059 atomic_t count;
Richard Kennedy33166b12008-07-25 01:48:35 -070060 unsigned int level;
Eric W. Biederman92476d72006-03-31 02:31:42 -080061 /* lists of tasks that use this pid */
62 struct hlist_head tasks[PIDTYPE_MAX];
63 struct rcu_head rcu;
Sukadev Bhattiprolu4c3f2ea2007-10-18 23:40:03 -070064 struct upid numbers[1];
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
66
Sukadev Bhattiprolu820e45d2007-05-10 22:23:00 -070067extern struct pid init_struct_pid;
68
Eric W. Biederman92476d72006-03-31 02:31:42 -080069struct pid_link
70{
71 struct hlist_node node;
72 struct pid *pid;
73};
74
75static inline struct pid *get_pid(struct pid *pid)
76{
77 if (pid)
78 atomic_inc(&pid->count);
79 return pid;
80}
81
Harvey Harrisonb3c97522008-02-13 15:03:15 -080082extern void put_pid(struct pid *pid);
83extern struct task_struct *pid_task(struct pid *pid, enum pid_type);
84extern struct task_struct *get_pid_task(struct pid *pid, enum pid_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Oleg Nesterov1a657f782006-10-02 02:18:59 -070086extern struct pid *get_task_pid(struct task_struct *task, enum pid_type type);
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/*
89 * attach_pid() and detach_pid() must be called with the tasklist_lock
90 * write-held.
91 */
Oleg Nesterov24336ea2008-04-30 00:54:26 -070092extern void attach_pid(struct task_struct *task, enum pid_type type,
93 struct pid *pid);
Harvey Harrisonb3c97522008-02-13 15:03:15 -080094extern void detach_pid(struct task_struct *task, enum pid_type);
Oleg Nesterov24336ea2008-04-30 00:54:26 -070095extern void change_pid(struct task_struct *task, enum pid_type,
96 struct pid *pid);
Harvey Harrisonb3c97522008-02-13 15:03:15 -080097extern void transfer_pid(struct task_struct *old, struct task_struct *new,
98 enum pid_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Pavel Emelyanov198fe212007-10-18 23:40:06 -0700100struct pid_namespace;
101extern struct pid_namespace init_pid_ns;
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/*
104 * look up a PID in the hash table. Must be called with the tasklist_lock
Eric W. Biederman92476d72006-03-31 02:31:42 -0800105 * or rcu_read_lock() held.
Pavel Emelyanov198fe212007-10-18 23:40:06 -0700106 *
107 * find_pid_ns() finds the pid in the namespace specified
Sisir Koppaka26498e82011-05-26 16:25:57 -0700108 * find_vpid() finds the pid by its virtual id, i.e. in the current namespace
Pavel Emelyanov198fe212007-10-18 23:40:06 -0700109 *
Pavel Emelyanovdbda0de2008-07-25 01:48:37 -0700110 * see also find_task_by_vpid() set in include/linux/sched.h
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800112extern struct pid *find_pid_ns(int nr, struct pid_namespace *ns);
Pavel Emelyanov89905712007-10-18 23:40:19 -0700113extern struct pid *find_vpid(int nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Eric W. Biederman92476d72006-03-31 02:31:42 -0800115/*
116 * Lookup a PID in the hash table, and return with it's count elevated.
117 */
118extern struct pid *find_get_pid(int nr);
Pavel Emelyanov198fe212007-10-18 23:40:06 -0700119extern struct pid *find_ge_pid(int nr, struct pid_namespace *);
Linus Torvaldsc78193e2011-04-18 10:35:30 -0700120int next_pidmap(struct pid_namespace *pid_ns, unsigned int last);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Pavel Emelyanov8ef047a2007-10-18 23:40:05 -0700122extern struct pid *alloc_pid(struct pid_namespace *ns);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800123extern void free_pid(struct pid *pid);
Eric W. Biedermanc876ad762012-12-21 20:27:12 -0800124extern void disable_pid_allocation(struct pid_namespace *ns);
Eric W. Biederman92476d72006-03-31 02:31:42 -0800125
Pavel Emelyanov7af57292007-10-18 23:40:06 -0700126/*
Eric W. Biedermanf9fb8602009-01-07 18:08:46 -0800127 * ns_of_pid() returns the pid namespace in which the specified pid was
128 * allocated.
129 *
130 * NOTE:
131 * ns_of_pid() is expected to be called for a process (task) that has
132 * an attached 'struct pid' (see attach_pid(), detach_pid()) i.e @pid
133 * is expected to be non-NULL. If @pid is NULL, caller should handle
134 * the resulting NULL pid-ns.
135 */
136static inline struct pid_namespace *ns_of_pid(struct pid *pid)
137{
138 struct pid_namespace *ns = NULL;
139 if (pid)
140 ns = pid->numbers[pid->level].ns;
141 return ns;
142}
143
144/*
Eric W. Biederman45a68622011-03-23 16:43:12 -0700145 * is_child_reaper returns true if the pid is the init process
146 * of the current namespace. As this one could be checked before
147 * pid_ns->child_reaper is assigned in copy_process, we check
148 * with the pid number.
149 */
150static inline bool is_child_reaper(struct pid *pid)
151{
152 return pid->numbers[pid->level].nr == 1;
153}
154
155/*
Pavel Emelyanov7af57292007-10-18 23:40:06 -0700156 * the helpers to get the pid's id seen from different namespaces
157 *
158 * pid_nr() : global id, i.e. the id seen from the init namespace;
Eric W. Biederman44c4e1b2008-02-08 04:19:15 -0800159 * pid_vnr() : virtual id, i.e. the id seen from the pid namespace of
160 * current.
Pavel Emelyanov7af57292007-10-18 23:40:06 -0700161 * pid_nr_ns() : id seen from the ns specified.
162 *
163 * see also task_xid_nr() etc in include/linux/sched.h
164 */
165
Eric W. Biederman5feb8f52006-10-02 02:17:12 -0700166static inline pid_t pid_nr(struct pid *pid)
167{
168 pid_t nr = 0;
169 if (pid)
Pavel Emelyanov7af57292007-10-18 23:40:06 -0700170 nr = pid->numbers[0].nr;
171 return nr;
172}
173
174pid_t pid_nr_ns(struct pid *pid, struct pid_namespace *ns);
Eric W. Biederman44c4e1b2008-02-08 04:19:15 -0800175pid_t pid_vnr(struct pid *pid);
Eric W. Biederman5feb8f52006-10-02 02:17:12 -0700176
Andrew Morton1d328492006-10-03 01:13:45 -0700177#define do_each_pid_task(pid, type, task) \
178 do { \
179 struct hlist_node *pos___; \
Steven Rostedt5ef64762008-12-04 00:26:39 -0500180 if ((pid) != NULL) \
Andrew Morton1d328492006-10-03 01:13:45 -0700181 hlist_for_each_entry_rcu((task), pos___, \
Steven Rostedt5ef64762008-12-04 00:26:39 -0500182 &(pid)->tasks[type], pids[type].node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Oleg Nesterov46f382d2008-02-08 04:19:19 -0800184 /*
185 * Both old and new leaders may be attached to
186 * the same pid in the middle of de_thread().
187 */
Andrew Morton1d328492006-10-03 01:13:45 -0700188#define while_each_pid_task(pid, type, task) \
Oleg Nesterov46f382d2008-02-08 04:19:19 -0800189 if (type == PIDTYPE_PID) \
190 break; \
Andrew Morton1d328492006-10-03 01:13:45 -0700191 } \
Oleg Nesterovd387cae2006-10-02 02:17:22 -0700192 } while (0)
Eric W. Biederman558cb322006-10-02 02:17:09 -0700193
Ken Chen2d70b682008-08-20 14:09:17 -0700194#define do_each_pid_thread(pid, type, task) \
195 do_each_pid_task(pid, type, task) { \
196 struct task_struct *tg___ = task; \
197 do {
198
199#define while_each_pid_thread(pid, type, task) \
200 } while_each_thread(tg___, task); \
201 task = tg___; \
202 } while_each_pid_task(pid, type, task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203#endif /* _LINUX_PID_H */