xref: /linux-6.15/include/linux/cn_proc.h (revision 3fa2164d)
1 /*
2  * cn_proc.h - process events connector
3  *
4  * Copyright (C) Matt Helsley, IBM Corp. 2005
5  * Based on cn_fork.h by Nguyen Anh Quynh and Guillaume Thouvenin
6  * Copyright (C) 2005 Nguyen Anh Quynh <[email protected]>
7  * Copyright (C) 2005 Guillaume Thouvenin <[email protected]>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of version 2.1 of the GNU Lesser General Public License
11  * as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it would be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  */
17 
18 #ifndef CN_PROC_H
19 #define CN_PROC_H
20 
21 #include <linux/types.h>
22 
23 /*
24  * Userspace sends this enum to register with the kernel that it is listening
25  * for events on the connector.
26  */
27 enum proc_cn_mcast_op {
28 	PROC_CN_MCAST_LISTEN = 1,
29 	PROC_CN_MCAST_IGNORE = 2
30 };
31 
32 /*
33  * From the user's point of view, the process
34  * ID is the thread group ID and thread ID is the internal
35  * kernel "pid". So, fields are assigned as follow:
36  *
37  *  In user space     -  In  kernel space
38  *
39  * parent process ID  =  parent->tgid
40  * parent thread  ID  =  parent->pid
41  * child  process ID  =  child->tgid
42  * child  thread  ID  =  child->pid
43  */
44 
45 struct proc_event {
46 	enum what {
47 		/* Use successive bits so the enums can be used to record
48 		 * sets of events as well
49 		 */
50 		PROC_EVENT_NONE = 0x00000000,
51 		PROC_EVENT_FORK = 0x00000001,
52 		PROC_EVENT_EXEC = 0x00000002,
53 		PROC_EVENT_UID  = 0x00000004,
54 		PROC_EVENT_GID  = 0x00000040,
55 		/* "next" should be 0x00000400 */
56 		/* "last" is the last process event: exit */
57 		PROC_EVENT_EXIT = 0x80000000
58 	} what;
59 	__u32 cpu;
60 	struct timespec timestamp;
61 	union { /* must be last field of proc_event struct */
62 		struct {
63 			__u32 err;
64 		} ack;
65 
66 		struct fork_proc_event {
67 			pid_t parent_pid;
68 			pid_t parent_tgid;
69 			pid_t child_pid;
70 			pid_t child_tgid;
71 		} fork;
72 
73 		struct exec_proc_event {
74 			pid_t process_pid;
75 			pid_t process_tgid;
76 		} exec;
77 
78 		struct id_proc_event {
79 			pid_t process_pid;
80 			pid_t process_tgid;
81 			union {
82 				__u32 ruid; /* task uid */
83 				__u32 rgid; /* task gid */
84 			} r;
85 			union {
86 				__u32 euid;
87 				__u32 egid;
88 			} e;
89 		} id;
90 
91 		struct exit_proc_event {
92 			pid_t process_pid;
93 			pid_t process_tgid;
94 			__u32 exit_code, exit_signal;
95 		} exit;
96 	} event_data;
97 };
98 
99 #ifdef __KERNEL__
100 #ifdef CONFIG_PROC_EVENTS
101 void proc_fork_connector(struct task_struct *task);
102 void proc_exec_connector(struct task_struct *task);
103 void proc_id_connector(struct task_struct *task, int which_id);
104 void proc_exit_connector(struct task_struct *task);
105 #else
106 static inline void proc_fork_connector(struct task_struct *task)
107 {}
108 
109 static inline void proc_exec_connector(struct task_struct *task)
110 {}
111 
112 static inline void proc_id_connector(struct task_struct *task,
113 				     int which_id)
114 {}
115 
116 static inline void proc_exit_connector(struct task_struct *task)
117 {}
118 #endif	/* CONFIG_PROC_EVENTS */
119 #endif	/* __KERNEL__ */
120 #endif	/* CN_PROC_H */
121