blob: e5865a9c58a6ab07bd9a909cbfd254028e17f5fe [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 *
24 * Storing pid_t values in the kernel and refering to them later has a
25 * 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 {
51 /* Try to keep pid_chain in the same cacheline as nr for find_pid */
52 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 /* Try to keep pid_chain in the same cacheline as nr for find_pid */
61 int nr;
62 struct hlist_node pid_chain;
Eric W. Biederman92476d72006-03-31 02:31:42 -080063 /* lists of tasks that use this pid */
64 struct hlist_head tasks[PIDTYPE_MAX];
65 struct rcu_head rcu;
Sukadev Bhattiprolu4c3f2ea2007-10-18 23:40:03 -070066 int level;
67 struct upid numbers[1];
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
Sukadev Bhattiprolu820e45d2007-05-10 22:23:00 -070070extern struct pid init_struct_pid;
71
Eric W. Biederman92476d72006-03-31 02:31:42 -080072struct pid_link
73{
74 struct hlist_node node;
75 struct pid *pid;
76};
77
78static inline struct pid *get_pid(struct pid *pid)
79{
80 if (pid)
81 atomic_inc(&pid->count);
82 return pid;
83}
84
85extern void FASTCALL(put_pid(struct pid *pid));
86extern struct task_struct *FASTCALL(pid_task(struct pid *pid, enum pid_type));
87extern struct task_struct *FASTCALL(get_pid_task(struct pid *pid,
88 enum pid_type));
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Oleg Nesterov1a657f72006-10-02 02:18:59 -070090extern struct pid *get_task_pid(struct task_struct *task, enum pid_type type);
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092/*
93 * attach_pid() and detach_pid() must be called with the tasklist_lock
94 * write-held.
95 */
Eric W. Biederman92476d72006-03-31 02:31:42 -080096extern int FASTCALL(attach_pid(struct task_struct *task,
Sukadev Bhattiprolue713d0d2007-05-10 22:22:58 -070097 enum pid_type type, struct pid *pid));
Linus Torvalds1da177e2005-04-16 15:20:36 -070098extern void FASTCALL(detach_pid(struct task_struct *task, enum pid_type));
Eric W. Biedermanc18258c2006-09-27 01:51:06 -070099extern void FASTCALL(transfer_pid(struct task_struct *old,
100 struct task_struct *new, enum pid_type));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/*
103 * look up a PID in the hash table. Must be called with the tasklist_lock
Eric W. Biederman92476d72006-03-31 02:31:42 -0800104 * or rcu_read_lock() held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 */
Eric W. Biederman92476d72006-03-31 02:31:42 -0800106extern struct pid *FASTCALL(find_pid(int nr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Eric W. Biederman92476d72006-03-31 02:31:42 -0800108/*
109 * Lookup a PID in the hash table, and return with it's count elevated.
110 */
111extern struct pid *find_get_pid(int nr);
Eric W. Biederman0804ef42006-10-02 02:17:04 -0700112extern struct pid *find_ge_pid(int nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Eric W. Biederman92476d72006-03-31 02:31:42 -0800114extern struct pid *alloc_pid(void);
115extern void FASTCALL(free_pid(struct pid *pid));
116
Eric W. Biederman5feb8f52006-10-02 02:17:12 -0700117static inline pid_t pid_nr(struct pid *pid)
118{
119 pid_t nr = 0;
120 if (pid)
121 nr = pid->nr;
122 return nr;
123}
124
Andrew Morton1d328492006-10-03 01:13:45 -0700125#define do_each_pid_task(pid, type, task) \
126 do { \
127 struct hlist_node *pos___; \
128 if (pid != NULL) \
129 hlist_for_each_entry_rcu((task), pos___, \
Oleg Nesterovd387cae2006-10-02 02:17:22 -0700130 &pid->tasks[type], pids[type].node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Andrew Morton1d328492006-10-03 01:13:45 -0700132#define while_each_pid_task(pid, type, task) \
133 } \
Oleg Nesterovd387cae2006-10-02 02:17:22 -0700134 } while (0)
Eric W. Biederman558cb322006-10-02 02:17:09 -0700135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136#endif /* _LINUX_PID_H */