kernel/user.c

   1 /*
   2  * The "user cache".
   3  *
   4  * (C) Copyright 1991-2000 Linus Torvalds
   5  *
   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.
   9  */
  10
  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>
  19
  20 /*
  21  * UID task count cache, to get fast user lookup in "alloc_uid"
  22  * when changing user ID's (ie setuid() and friends).
  23  */
  24
  25 #define UIDHASH_MASK            (UIDHASH_SZ - 1)
  26 #define __uidhashfn(uid)        (((uid >> UIDHASH_BITS) + uid) & UIDHASH_MASK)
  27 #define uidhashentry(ns, uid)   ((ns)->uidhash_table + __uidhashfn((uid)))
  28
  29 static struct kmem_cache *uid_cachep;
  30
  31 /*
  32  * The uidhash_lock is mostly taken from process context, but it is
  33  * occasionally also taken from softirq/tasklet context, when
  34  * task-structs get RCU-freed. Hence all locking must be softirq-safe.
  35  * But free_uid() is also called with local interrupts disabled, and running
  36  * local_bh_enable() with local interrupts disabled is an error - we'll run
  37  * softirq callbacks, and they can unconditionally enable interrupts, and
  38  * the caller of free_uid() didn't expect that..
  39  */
  40 static DEFINE_SPINLOCK(uidhash_lock);
  41
  42 struct user_struct root_user = {
  43         .__count        = ATOMIC_INIT(1),
  44         .processes      = ATOMIC_INIT(1),
  45         .files          = ATOMIC_INIT(0),
  46         .sigpending     = ATOMIC_INIT(0),
  47         .mq_bytes       = 0,
  48         .locked_shm     = 0,
  49 #ifdef CONFIG_KEYS
  50         .uid_keyring    = &root_user_keyring,
  51         .session_keyring = &root_session_keyring,
  52 #endif
  53 #ifdef CONFIG_FAIR_USER_SCHED
  54         .tg             = &init_task_group,
  55 #endif
  56 };
  57
  58 /*
  59  * These routines must be called with the uidhash spinlock held!
  60  */
  61 static void uid_hash_insert(struct user_struct *up, struct hlist_head *hashent)
  62 {
  63         hlist_add_head(&up->uidhash_node, hashent);
  64 }
  65
  66 static void uid_hash_remove(struct user_struct *up)
  67 {
  68         hlist_del_init(&up->uidhash_node);
  69 }
  70
  71 static struct user_struct *uid_hash_find(uid_t uid, struct hlist_head *hashent)
  72 {
  73         struct user_struct *user;
  74         struct hlist_node *h;
  75
  76         hlist_for_each_entry(user, h, hashent, uidhash_node) {
  77                 if (user->uid == uid) {
  78                         atomic_inc(&user->__count);
  79                         return user;
  80                 }
  81         }
  82
  83         return NULL;
  84 }
  85
  86 #ifdef CONFIG_FAIR_USER_SCHED
  87
  88 static struct kobject uids_kobject; /* represents /sys/kernel/uids directory */
  89 static DEFINE_MUTEX(uids_mutex);
  90
  91 static void sched_destroy_user(struct user_struct *up)
  92 {
  93         sched_destroy_group(up->tg);
  94 }
  95
  96 static int sched_create_user(struct user_struct *up)
  97 {
  98         int rc = 0;
  99
 100         up->tg = sched_create_group();
 101         if (IS_ERR(up->tg))
 102                 rc = -ENOMEM;
 103
 104         return rc;
 105 }
 106
 107 static void sched_switch_user(struct task_struct *p)
 108 {
 109         sched_move_task(p);
 110 }
 111
 112 static inline void uids_mutex_lock(void)
 113 {
 114         mutex_lock(&uids_mutex);
 115 }
 116
 117 static inline void uids_mutex_unlock(void)
 118 {
 119         mutex_unlock(&uids_mutex);
 120 }
 121
 122 /* return cpu shares held by the user */
 123 ssize_t cpu_shares_show(struct kset *kset, char *buffer)
 124 {
 125         struct user_struct *up = container_of(kset, struct user_struct, kset);
 126
 127         return sprintf(buffer, "%lu\n", sched_group_shares(up->tg));
 128 }
 129
 130 /* modify cpu shares held by the user */
 131 ssize_t cpu_shares_store(struct kset *kset, const char *buffer, size_t size)
 132 {
 133         struct user_struct *up = container_of(kset, struct user_struct, kset);
 134         unsigned long shares;
 135         int rc;
 136
 137         sscanf(buffer, "%lu", &shares);
 138
 139         rc = sched_group_set_shares(up->tg, shares);
 140
 141         return (rc ? rc : size);
 142 }
 143
 144 static void user_attr_init(struct subsys_attribute *sa, char *name, int mode)
 145 {
 146         sa->attr.name = name;
 147         sa->attr.mode = mode;
 148         sa->show = cpu_shares_show;
 149         sa->store = cpu_shares_store;
 150 }
 151
 152 /* Create "/sys/kernel/uids/<uid>" directory and
 153  *  "/sys/kernel/uids/<uid>/cpu_share" file for this user.
 154  */
 155 static int user_kobject_create(struct user_struct *up)
 156 {
 157         struct kset *kset = &up->kset;
 158         struct kobject *kobj = &kset->kobj;
 159         int error;
 160
 161         memset(kset, 0, sizeof(struct kset));
 162         kobj->parent = &uids_kobject;   /* create under /sys/kernel/uids dir */
 163         kobject_set_name(kobj, "%d", up->uid);
 164         kset_init(kset);
 165         user_attr_init(&up->user_attr, "cpu_share", 0644);
 166
 167         error = kobject_add(kobj);
 168         if (error)
 169                 goto done;
 170
 171         error = sysfs_create_file(kobj, &up->user_attr.attr);
 172         if (error)
 173                 kobject_del(kobj);
 174
 175         kobject_uevent(kobj, KOBJ_ADD);
 176
 177 done:
 178         return error;
 179 }
 180
 181 /* create these in sysfs filesystem:
 182  *      "/sys/kernel/uids" directory
 183  *      "/sys/kernel/uids/0" directory (for root user)
 184  *      "/sys/kernel/uids/0/cpu_share" file (for root user)
 185  */
 186 int __init uids_kobject_init(void)
 187 {
 188         int error;
 189
 190         /* create under /sys/kernel dir */
 191         uids_kobject.parent = &kernel_subsys.kobj;
 192         uids_kobject.kset = &kernel_subsys;
 193         kobject_set_name(&uids_kobject, "uids");
 194         kobject_init(&uids_kobject);
 195
 196         error = kobject_add(&uids_kobject);
 197         if (!error)
 198                 error = user_kobject_create(&root_user);
 199
 200         return error;
 201 }
 202
 203 /* work function to remove sysfs directory for a user and free up
 204  * corresponding structures.
 205  */
 206 static void remove_user_sysfs_dir(struct work_struct *w)
 207 {
 208         struct user_struct *up = container_of(w, struct user_struct, work);
 209         struct kobject *kobj = &up->kset.kobj;
 210         unsigned long flags;
 211         int remove_user = 0;
 212
 213         /* Make uid_hash_remove() + sysfs_remove_file() + kobject_del()
 214          * atomic.
 215          */
 216         uids_mutex_lock();
 217
 218         local_irq_save(flags);
 219
 220         if (atomic_dec_and_lock(&up->__count, &uidhash_lock)) {
 221                 uid_hash_remove(up);
 222                 remove_user = 1;
 223                 spin_unlock_irqrestore(&uidhash_lock, flags);
 224         } else {
 225                 local_irq_restore(flags);
 226         }
 227
 228         if (!remove_user)
 229                 goto done;
 230
 231         sysfs_remove_file(kobj, &up->user_attr.attr);
 232         kobject_uevent(kobj, KOBJ_REMOVE);
 233         kobject_del(kobj);
 234
 235         sched_destroy_user(up);
 236         key_put(up->uid_keyring);
 237         key_put(up->session_keyring);
 238         kmem_cache_free(uid_cachep, up);
 239
 240 done:
 241         uids_mutex_unlock();
 242 }
 243
 244 /* IRQs are disabled and uidhash_lock is held upon function entry.
 245  * IRQ state (as stored in flags) is restored and uidhash_lock released
 246  * upon function exit.
 247  */
 248 static inline void free_user(struct user_struct *up, unsigned long flags)
 249 {
 250         /* restore back the count */
 251         atomic_inc(&up->__count);
 252         spin_unlock_irqrestore(&uidhash_lock, flags);
 253
 254         INIT_WORK(&up->work, remove_user_sysfs_dir);
 255         schedule_work(&up->work);
 256 }
 257
 258 #else   /* CONFIG_FAIR_USER_SCHED */
 259
 260 static void sched_destroy_user(struct user_struct *up) { }
 261 static int sched_create_user(struct user_struct *up) { return 0; }
 262 static void sched_switch_user(struct task_struct *p) { }
 263 static inline int user_kobject_create(struct user_struct *up) { return 0; }
 264 static inline void uids_mutex_lock(void) { }
 265 static inline void uids_mutex_unlock(void) { }
 266
 267 /* IRQs are disabled and uidhash_lock is held upon function entry.
 268  * IRQ state (as stored in flags) is restored and uidhash_lock released
 269  * upon function exit.
 270  */
 271 static inline void free_user(struct user_struct *up, unsigned long flags)
 272 {
 273         uid_hash_remove(up);
 274         spin_unlock_irqrestore(&uidhash_lock, flags);
 275         sched_destroy_user(up);
 276         key_put(up->uid_keyring);
 277         key_put(up->session_keyring);
 278         kmem_cache_free(uid_cachep, up);
 279 }
 280
 281 #endif  /* CONFIG_FAIR_USER_SCHED */
 282
 283 /*
 284  * Locate the user_struct for the passed UID.  If found, take a ref on it.  The
 285  * caller must undo that ref with free_uid().
 286  *
 287  * If the user_struct could not be found, return NULL.
 288  */
 289 struct user_struct *find_user(uid_t uid)
 290 {
 291         struct user_struct *ret;
 292         unsigned long flags;
 293         struct user_namespace *ns = current->nsproxy->user_ns;
 294
 295         spin_lock_irqsave(&uidhash_lock, flags);
 296         ret = uid_hash_find(uid, uidhashentry(ns, uid));
 297         spin_unlock_irqrestore(&uidhash_lock, flags);
 298         return ret;
 299 }
 300
 301 void free_uid(struct user_struct *up)
 302 {
 303         unsigned long flags;
 304
 305         if (!up)
 306                 return;
 307
 308         local_irq_save(flags);
 309         if (atomic_dec_and_lock(&up->__count, &uidhash_lock))
 310                 free_user(up, flags);
 311         else
 312                 local_irq_restore(flags);
 313 }
 314
 315 struct user_struct * alloc_uid(struct user_namespace *ns, uid_t uid)
 316 {
 317         struct hlist_head *hashent = uidhashentry(ns, uid);
 318         struct user_struct *up;
 319
 320         /* Make uid_hash_find() + user_kobject_create() + uid_hash_insert()
 321          * atomic.
 322          */
 323         uids_mutex_lock();
 324
 325         spin_lock_irq(&uidhash_lock);
 326         up = uid_hash_find(uid, hashent);
 327         spin_unlock_irq(&uidhash_lock);
 328
 329         if (!up) {
 330                 struct user_struct *new;
 331
 332                 new = kmem_cache_alloc(uid_cachep, GFP_KERNEL);
 333                 if (!new)
 334                         return NULL;
 335                 new->uid = uid;
 336                 atomic_set(&new->__count, 1);
 337                 atomic_set(&new->processes, 0);
 338                 atomic_set(&new->files, 0);
 339                 atomic_set(&new->sigpending, 0);
 340 #ifdef CONFIG_INOTIFY_USER
 341                 atomic_set(&new->inotify_watches, 0);
 342                 atomic_set(&new->inotify_devs, 0);
 343 #endif
 344
 345                 new->mq_bytes = 0;
 346                 new->locked_shm = 0;
 347
 348                 if (alloc_uid_keyring(new, current) < 0) {
 349                         kmem_cache_free(uid_cachep, new);
 350                         return NULL;
 351                 }
 352
 353                 if (sched_create_user(new) < 0) {
 354                         key_put(new->uid_keyring);
 355                         key_put(new->session_keyring);
 356                         kmem_cache_free(uid_cachep, new);
 357                         return NULL;
 358                 }
 359
 360                 if (user_kobject_create(new)) {
 361                         sched_destroy_user(new);
 362                         key_put(new->uid_keyring);
 363                         key_put(new->session_keyring);
 364                         kmem_cache_free(uid_cachep, new);
 365                         uids_mutex_unlock();
 366                         return NULL;
 367                 }
 368
 369                 /*
 370                  * Before adding this, check whether we raced
 371                  * on adding the same user already..
 372                  */
 373                 spin_lock_irq(&uidhash_lock);
 374                 up = uid_hash_find(uid, hashent);
 375                 if (up) {
 376                         /* This case is not possible when CONFIG_FAIR_USER_SCHED
 377                          * is defined, since we serialize alloc_uid() using
 378                          * uids_mutex. Hence no need to call
 379                          * sched_destroy_user() or remove_user_sysfs_dir().
 380                          */
 381                         key_put(new->uid_keyring);
 382                         key_put(new->session_keyring);
 383                         kmem_cache_free(uid_cachep, new);
 384                 } else {
 385                         uid_hash_insert(new, hashent);
 386                         up = new;
 387                 }
 388                 spin_unlock_irq(&uidhash_lock);
 389
 390         }
 391
 392         uids_mutex_unlock();
 393
 394         return up;
 395 }
 396
 397 void switch_uid(struct user_struct *new_user)
 398 {
 399         struct user_struct *old_user;
 400
 401         /* What if a process setreuid()'s and this brings the
 402          * new uid over his NPROC rlimit?  We can check this now
 403          * cheaply with the new uid cache, so if it matters
 404          * we should be checking for it.  -DaveM
 405          */
 406         old_user = current->user;
 407         atomic_inc(&new_user->processes);
 408         atomic_dec(&old_user->processes);
 409         switch_uid_keyring(new_user);
 410         current->user = new_user;
 411         sched_switch_user(current);
 412
 413         /*
 414          * We need to synchronize with __sigqueue_alloc()
 415          * doing a get_uid(p->user).. If that saw the old
 416          * user value, we need to wait until it has exited
 417          * its critical region before we can free the old
 418          * structure.
 419          */
 420         smp_mb();
 421         spin_unlock_wait(&current->sighand->siglock);
 422
 423         free_uid(old_user);
 424         suid_keys(current);
 425 }
 426
 427 void release_uids(struct user_namespace *ns)
 428 {
 429         int i;
 430         unsigned long flags;
 431         struct hlist_head *head;
 432         struct hlist_node *nd;
 433
 434         spin_lock_irqsave(&uidhash_lock, flags);
 435         /*
 436          * collapse the chains so that the user_struct-s will
 437          * be still alive, but not in hashes. subsequent free_uid()
 438          * will free them.
 439          */
 440         for (i = 0; i < UIDHASH_SZ; i++) {
 441                 head = ns->uidhash_table + i;
 442                 while (!hlist_empty(head)) {
 443                         nd = head->first;
 444                         hlist_del_init(nd);
 445                 }
 446         }
 447         spin_unlock_irqrestore(&uidhash_lock, flags);
 448
 449         free_uid(ns->root_user);
 450 }
 451
 452 static int __init uid_cache_init(void)
 453 {
 454         int n;
 455
 456         uid_cachep = kmem_cache_create("uid_cache", sizeof(struct user_struct),
 457                         0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
 458
 459         for(n = 0; n < UIDHASH_SZ; ++n)
 460                 INIT_HLIST_HEAD(init_user_ns.uidhash_table + n);
 461
 462         /* Insert the root user immediately (init already runs as root) */
 463         spin_lock_irq(&uidhash_lock);
 464         uid_hash_insert(&root_user, uidhashentry(&init_user_ns, 0));
 465         spin_unlock_irq(&uidhash_lock);
 466
 467         return 0;
 468 }
 469
 470 module_init(uid_cache_init);