xref: /linux/include/linux/sched/user.h (revision 546b928da0427b0d6c663cbb992bd7bfa9ac7971)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SCHED_USER_H
3 #define _LINUX_SCHED_USER_H
4 
5 #include <linux/uidgid.h>
6 #include <linux/atomic.h>
7 #include <linux/percpu_counter.h>
8 #include <linux/refcount.h>
9 #include <linux/ratelimit.h>
10 
11 /*
12  * Some day this will be a full-fledged user tracking system..
13  */
14 struct user_struct {
15 	refcount_t __count;	/* reference count */
16 #ifdef CONFIG_EPOLL
17 	struct percpu_counter epoll_watches; /* The number of file descriptors currently watched */
18 #endif
19 	unsigned long unix_inflight;	/* How many files in flight in unix sockets */
20 	atomic_long_t pipe_bufs;  /* how many pages are allocated in pipe buffers */
21 
22 	/* Hash table maintenance information */
23 	struct hlist_node uidhash_node;
24 	kuid_t uid;
25 
26 #if defined(CONFIG_PERF_EVENTS) || defined(CONFIG_BPF_SYSCALL) || \
27 	defined(CONFIG_NET) || defined(CONFIG_IO_URING) || \
28 	defined(CONFIG_VFIO_PCI_ZDEV_KVM) || IS_ENABLED(CONFIG_IOMMUFD) || \
29 	defined(CONFIG_SECRETMEM)
30 	atomic_long_t locked_vm;
31 #endif
32 #ifdef CONFIG_WATCH_QUEUE
33 	atomic_t nr_watches;	/* The number of watches this user currently has */
34 #endif
35 
36 	/* Miscellaneous per-user rate limit */
37 	struct ratelimit_state ratelimit;
38 };
39 
40 extern int uids_sysfs_init(void);
41 
42 extern struct user_struct *find_user(kuid_t);
43 
44 extern struct user_struct root_user;
45 #define INIT_USER (&root_user)
46 
47 
48 /* per-UID process charging. */
49 extern struct user_struct * alloc_uid(kuid_t);
get_uid(struct user_struct * u)50 static inline struct user_struct *get_uid(struct user_struct *u)
51 {
52 	refcount_inc(&u->__count);
53 	return u;
54 }
55 extern void free_uid(struct user_struct *);
56 
57 #endif /* _LINUX_SCHED_USER_H */
58