4 * (C) Copyright 1991-2000 Linus Torvalds
6 * We have a per-user structure to keep track of how many
7 * processes, files etc the user has claimed, in order to be
8 * able to have per-user limits for system resources.
11 #include <linux/init.h>
12 #include <linux/sched.h>
13 #include <linux/slab.h>
14 #include <linux/bitops.h>
15 #include <linux/key.h>
16 #include <linux/interrupt.h>
17 #include <linux/module.h>
18 #include <linux/user_namespace.h>
20 struct user_namespace init_user_ns = {
22 .refcount = ATOMIC_INIT(2),
24 .root_user = &root_user,
26 EXPORT_SYMBOL_GPL(init_user_ns);
29 * UID task count cache, to get fast user lookup in "alloc_uid"
30 * when changing user ID's (ie setuid() and friends).
33 #define UIDHASH_MASK (UIDHASH_SZ - 1)
34 #define __uidhashfn(uid) (((uid >> UIDHASH_BITS) + uid) & UIDHASH_MASK)
35 #define uidhashentry(ns, uid) ((ns)->uidhash_table + __uidhashfn((uid)))
37 static struct kmem_cache *uid_cachep;
40 * The uidhash_lock is mostly taken from process context, but it is
41 * occasionally also taken from softirq/tasklet context, when
42 * task-structs get RCU-freed. Hence all locking must be softirq-safe.
43 * But free_uid() is also called with local interrupts disabled, and running
44 * local_bh_enable() with local interrupts disabled is an error - we'll run
45 * softirq callbacks, and they can unconditionally enable interrupts, and
46 * the caller of free_uid() didn't expect that..
48 static DEFINE_SPINLOCK(uidhash_lock);
50 struct user_struct root_user = {
51 .__count = ATOMIC_INIT(1),
52 .processes = ATOMIC_INIT(1),
53 .files = ATOMIC_INIT(0),
54 .sigpending = ATOMIC_INIT(0),
56 #ifdef CONFIG_USER_SCHED
57 .tg = &init_task_group,
62 * These routines must be called with the uidhash spinlock held!
64 static void uid_hash_insert(struct user_struct *up, struct hlist_head *hashent)
66 hlist_add_head(&up->uidhash_node, hashent);
69 static void uid_hash_remove(struct user_struct *up)
71 hlist_del_init(&up->uidhash_node);
74 static struct user_struct *uid_hash_find(uid_t uid, struct hlist_head *hashent)
76 struct user_struct *user;
79 hlist_for_each_entry(user, h, hashent, uidhash_node) {
80 if (user->uid == uid) {
81 atomic_inc(&user->__count);
89 #ifdef CONFIG_USER_SCHED
91 static void sched_destroy_user(struct user_struct *up)
93 sched_destroy_group(up->tg);
96 static int sched_create_user(struct user_struct *up)
100 up->tg = sched_create_group(&root_task_group);
107 static void sched_switch_user(struct task_struct *p)
112 #else /* CONFIG_USER_SCHED */
114 static void sched_destroy_user(struct user_struct *up) { }
115 static int sched_create_user(struct user_struct *up) { return 0; }
116 static void sched_switch_user(struct task_struct *p) { }
118 #endif /* CONFIG_USER_SCHED */
120 #if defined(CONFIG_USER_SCHED) && defined(CONFIG_SYSFS)
122 static struct kset *uids_kset; /* represents the /sys/kernel/uids/ directory */
123 static DEFINE_MUTEX(uids_mutex);
125 static inline void uids_mutex_lock(void)
127 mutex_lock(&uids_mutex);
130 static inline void uids_mutex_unlock(void)
132 mutex_unlock(&uids_mutex);
135 /* uid directory attributes */
136 #ifdef CONFIG_FAIR_GROUP_SCHED
137 static ssize_t cpu_shares_show(struct kobject *kobj,
138 struct kobj_attribute *attr,
141 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
143 return sprintf(buf, "%lu\n", sched_group_shares(up->tg));
146 static ssize_t cpu_shares_store(struct kobject *kobj,
147 struct kobj_attribute *attr,
148 const char *buf, size_t size)
150 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
151 unsigned long shares;
154 sscanf(buf, "%lu", &shares);
156 rc = sched_group_set_shares(up->tg, shares);
158 return (rc ? rc : size);
161 static struct kobj_attribute cpu_share_attr =
162 __ATTR(cpu_share, 0644, cpu_shares_show, cpu_shares_store);
165 #ifdef CONFIG_RT_GROUP_SCHED
166 static ssize_t cpu_rt_runtime_show(struct kobject *kobj,
167 struct kobj_attribute *attr,
170 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
172 return sprintf(buf, "%ld\n", sched_group_rt_runtime(up->tg));
175 static ssize_t cpu_rt_runtime_store(struct kobject *kobj,
176 struct kobj_attribute *attr,
177 const char *buf, size_t size)
179 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
180 unsigned long rt_runtime;
183 sscanf(buf, "%ld", &rt_runtime);
185 rc = sched_group_set_rt_runtime(up->tg, rt_runtime);
187 return (rc ? rc : size);
190 static struct kobj_attribute cpu_rt_runtime_attr =
191 __ATTR(cpu_rt_runtime, 0644, cpu_rt_runtime_show, cpu_rt_runtime_store);
193 static ssize_t cpu_rt_period_show(struct kobject *kobj,
194 struct kobj_attribute *attr,
197 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
199 return sprintf(buf, "%lu\n", sched_group_rt_period(up->tg));
202 static ssize_t cpu_rt_period_store(struct kobject *kobj,
203 struct kobj_attribute *attr,
204 const char *buf, size_t size)
206 struct user_struct *up = container_of(kobj, struct user_struct, kobj);
207 unsigned long rt_period;
210 sscanf(buf, "%lu", &rt_period);
212 rc = sched_group_set_rt_period(up->tg, rt_period);
214 return (rc ? rc : size);
217 static struct kobj_attribute cpu_rt_period_attr =
218 __ATTR(cpu_rt_period, 0644, cpu_rt_period_show, cpu_rt_period_store);
221 /* default attributes per uid directory */
222 static struct attribute *uids_attributes[] = {
223 #ifdef CONFIG_FAIR_GROUP_SCHED
224 &cpu_share_attr.attr,
226 #ifdef CONFIG_RT_GROUP_SCHED
227 &cpu_rt_runtime_attr.attr,
228 &cpu_rt_period_attr.attr,
233 /* the lifetime of user_struct is not managed by the core (now) */
234 static void uids_release(struct kobject *kobj)
239 static struct kobj_type uids_ktype = {
240 .sysfs_ops = &kobj_sysfs_ops,
241 .default_attrs = uids_attributes,
242 .release = uids_release,
245 /* create /sys/kernel/uids/<uid>/cpu_share file for this user */
246 static int uids_user_create(struct user_struct *up)
248 struct kobject *kobj = &up->kobj;
251 memset(kobj, 0, sizeof(struct kobject));
252 kobj->kset = uids_kset;
253 error = kobject_init_and_add(kobj, &uids_ktype, NULL, "%d", up->uid);
259 kobject_uevent(kobj, KOBJ_ADD);
264 /* create these entries in sysfs:
265 * "/sys/kernel/uids" directory
266 * "/sys/kernel/uids/0" directory (for root user)
267 * "/sys/kernel/uids/0/cpu_share" file (for root user)
269 int __init uids_sysfs_init(void)
271 uids_kset = kset_create_and_add("uids", NULL, kernel_kobj);
275 return uids_user_create(&root_user);
278 /* work function to remove sysfs directory for a user and free up
279 * corresponding structures.
281 static void remove_user_sysfs_dir(struct work_struct *w)
283 struct user_struct *up = container_of(w, struct user_struct, work);
287 /* Make uid_hash_remove() + sysfs_remove_file() + kobject_del()
292 local_irq_save(flags);
294 if (atomic_dec_and_lock(&up->__count, &uidhash_lock)) {
297 spin_unlock_irqrestore(&uidhash_lock, flags);
299 local_irq_restore(flags);
305 kobject_uevent(&up->kobj, KOBJ_REMOVE);
306 kobject_del(&up->kobj);
307 kobject_put(&up->kobj);
309 sched_destroy_user(up);
310 key_put(up->uid_keyring);
311 key_put(up->session_keyring);
312 kmem_cache_free(uid_cachep, up);
318 /* IRQs are disabled and uidhash_lock is held upon function entry.
319 * IRQ state (as stored in flags) is restored and uidhash_lock released
320 * upon function exit.
322 static inline void free_user(struct user_struct *up, unsigned long flags)
324 /* restore back the count */
325 atomic_inc(&up->__count);
326 spin_unlock_irqrestore(&uidhash_lock, flags);
328 INIT_WORK(&up->work, remove_user_sysfs_dir);
329 schedule_work(&up->work);
332 #else /* CONFIG_USER_SCHED && CONFIG_SYSFS */
334 int uids_sysfs_init(void) { return 0; }
335 static inline int uids_user_create(struct user_struct *up) { return 0; }
336 static inline void uids_mutex_lock(void) { }
337 static inline void uids_mutex_unlock(void) { }
339 /* IRQs are disabled and uidhash_lock is held upon function entry.
340 * IRQ state (as stored in flags) is restored and uidhash_lock released
341 * upon function exit.
343 static inline void free_user(struct user_struct *up, unsigned long flags)
346 spin_unlock_irqrestore(&uidhash_lock, flags);
347 sched_destroy_user(up);
348 key_put(up->uid_keyring);
349 key_put(up->session_keyring);
350 kmem_cache_free(uid_cachep, up);
356 * Locate the user_struct for the passed UID. If found, take a ref on it. The
357 * caller must undo that ref with free_uid().
359 * If the user_struct could not be found, return NULL.
361 struct user_struct *find_user(uid_t uid)
363 struct user_struct *ret;
365 struct user_namespace *ns = current->nsproxy->user_ns;
367 spin_lock_irqsave(&uidhash_lock, flags);
368 ret = uid_hash_find(uid, uidhashentry(ns, uid));
369 spin_unlock_irqrestore(&uidhash_lock, flags);
373 void free_uid(struct user_struct *up)
380 local_irq_save(flags);
381 if (atomic_dec_and_lock(&up->__count, &uidhash_lock))
382 free_user(up, flags);
384 local_irq_restore(flags);
387 struct user_struct *alloc_uid(struct user_namespace *ns, uid_t uid)
389 struct hlist_head *hashent = uidhashentry(ns, uid);
390 struct user_struct *up, *new;
392 /* Make uid_hash_find() + uids_user_create() + uid_hash_insert()
397 spin_lock_irq(&uidhash_lock);
398 up = uid_hash_find(uid, hashent);
399 spin_unlock_irq(&uidhash_lock);
402 new = kmem_cache_zalloc(uid_cachep, GFP_KERNEL);
407 atomic_set(&new->__count, 1);
409 if (sched_create_user(new) < 0)
412 if (uids_user_create(new))
413 goto out_destoy_sched;
416 * Before adding this, check whether we raced
417 * on adding the same user already..
419 spin_lock_irq(&uidhash_lock);
420 up = uid_hash_find(uid, hashent);
422 /* This case is not possible when CONFIG_USER_SCHED
423 * is defined, since we serialize alloc_uid() using
424 * uids_mutex. Hence no need to call
425 * sched_destroy_user() or remove_user_sysfs_dir().
427 key_put(new->uid_keyring);
428 key_put(new->session_keyring);
429 kmem_cache_free(uid_cachep, new);
431 uid_hash_insert(new, hashent);
434 spin_unlock_irq(&uidhash_lock);
443 sched_destroy_user(new);
445 kmem_cache_free(uid_cachep, new);
451 void switch_uid(struct user_struct *new_user)
453 struct user_struct *old_user;
455 /* What if a process setreuid()'s and this brings the
456 * new uid over his NPROC rlimit? We can check this now
457 * cheaply with the new uid cache, so if it matters
458 * we should be checking for it. -DaveM
460 old_user = current->user;
461 atomic_inc(&new_user->processes);
462 atomic_dec(&old_user->processes);
463 switch_uid_keyring(new_user);
464 current->user = new_user;
465 sched_switch_user(current);
468 * We need to synchronize with __sigqueue_alloc()
469 * doing a get_uid(p->user).. If that saw the old
470 * user value, we need to wait until it has exited
471 * its critical region before we can free the old
475 spin_unlock_wait(¤t->sighand->siglock);
481 #ifdef CONFIG_USER_NS
482 void release_uids(struct user_namespace *ns)
486 struct hlist_head *head;
487 struct hlist_node *nd;
489 spin_lock_irqsave(&uidhash_lock, flags);
491 * collapse the chains so that the user_struct-s will
492 * be still alive, but not in hashes. subsequent free_uid()
495 for (i = 0; i < UIDHASH_SZ; i++) {
496 head = ns->uidhash_table + i;
497 while (!hlist_empty(head)) {
502 spin_unlock_irqrestore(&uidhash_lock, flags);
504 free_uid(ns->root_user);
508 static int __init uid_cache_init(void)
512 uid_cachep = kmem_cache_create("uid_cache", sizeof(struct user_struct),
513 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
515 for(n = 0; n < UIDHASH_SZ; ++n)
516 INIT_HLIST_HEAD(init_user_ns.uidhash_table + n);
518 /* Insert the root user immediately (init already runs as root) */
519 spin_lock_irq(&uidhash_lock);
520 uid_hash_insert(&root_user, uidhashentry(&init_user_ns, 0));
521 spin_unlock_irq(&uidhash_lock);
526 module_init(uid_cache_init);