xref: /linux-6.15/include/linux/cn_proc.h (revision 71ccc212)
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 		PROC_EVENT_SID  = 0x00000080,
56 		/* "next" should be 0x00000400 */
57 		/* "last" is the last process event: exit */
58 		PROC_EVENT_EXIT = 0x80000000
59 	} what;
60 	__u32 cpu;
61 	__u64 __attribute__((aligned(8))) timestamp_ns;
62 		/* Number of nano seconds since system boot */
63 	union { /* must be last field of proc_event struct */
64 		struct {
65 			__u32 err;
66 		} ack;
67 
68 		struct fork_proc_event {
69 			__kernel_pid_t parent_pid;
70 			__kernel_pid_t parent_tgid;
71 			__kernel_pid_t child_pid;
72 			__kernel_pid_t child_tgid;
73 		} fork;
74 
75 		struct exec_proc_event {
76 			__kernel_pid_t process_pid;
77 			__kernel_pid_t process_tgid;
78 		} exec;
79 
80 		struct id_proc_event {
81 			__kernel_pid_t process_pid;
82 			__kernel_pid_t process_tgid;
83 			union {
84 				__u32 ruid; /* task uid */
85 				__u32 rgid; /* task gid */
86 			} r;
87 			union {
88 				__u32 euid;
89 				__u32 egid;
90 			} e;
91 		} id;
92 
93 		struct sid_proc_event {
94 			__kernel_pid_t process_pid;
95 			__kernel_pid_t process_tgid;
96 		} sid;
97 
98 		struct exit_proc_event {
99 			__kernel_pid_t process_pid;
100 			__kernel_pid_t process_tgid;
101 			__u32 exit_code, exit_signal;
102 		} exit;
103 	} event_data;
104 };
105 
106 #ifdef __KERNEL__
107 #ifdef CONFIG_PROC_EVENTS
108 void proc_fork_connector(struct task_struct *task);
109 void proc_exec_connector(struct task_struct *task);
110 void proc_id_connector(struct task_struct *task, int which_id);
111 void proc_sid_connector(struct task_struct *task);
112 void proc_exit_connector(struct task_struct *task);
113 #else
114 static inline void proc_fork_connector(struct task_struct *task)
115 {}
116 
117 static inline void proc_exec_connector(struct task_struct *task)
118 {}
119 
120 static inline void proc_id_connector(struct task_struct *task,
121 				     int which_id)
122 {}
123 
124 static inline void proc_sid_connector(struct task_struct *task)
125 {}
126 
127 static inline void proc_exit_connector(struct task_struct *task)
128 {}
129 #endif	/* CONFIG_PROC_EVENTS */
130 #endif	/* __KERNEL__ */
131 #endif	/* CN_PROC_H */
132