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
  17 /*
  18  * UID task count cache, to get fast user lookup in "alloc_uid"
  19  * when changing user ID's (ie setuid() and friends).
  20  */
  21 #define UIDHASH_BITS            8
  22 #define UIDHASH_SZ              (1 << UIDHASH_BITS)
  23 #define UIDHASH_MASK            (UIDHASH_SZ - 1)
  24 #define __uidhashfn(xid,uid)    ((((uid) >> UIDHASH_BITS) + ((uid)^(xid))) & UIDHASH_MASK)
  25 #define uidhashentry(xid,uid)   (uidhash_table + __uidhashfn((xid),(uid)))
  26
  27 static kmem_cache_t *uid_cachep;
  28 static struct list_head uidhash_table[UIDHASH_SZ];
  29 static DEFINE_SPINLOCK(uidhash_lock);
  30
  31 struct user_struct root_user = {
  32         .__count        = ATOMIC_INIT(1),
  33         .processes      = ATOMIC_INIT(1),
  34         .files          = ATOMIC_INIT(0),
  35         .sigpending     = ATOMIC_INIT(0),
  36         .mq_bytes       = 0,
  37         .locked_shm     = 0,
  38 #ifdef CONFIG_KEYS
  39         .uid_keyring    = &root_user_keyring,
  40         .session_keyring = &root_session_keyring,
  41 #endif
  42 };
  43
  44 /*
  45  * These routines must be called with the uidhash spinlock held!
  46  */
  47 static inline void uid_hash_insert(struct user_struct *up, struct list_head *hashent)
  48 {
  49         list_add(&up->uidhash_list, hashent);
  50 }
  51
  52 static inline void uid_hash_remove(struct user_struct *up)
  53 {
  54         list_del(&up->uidhash_list);
  55 }
  56
  57 static inline struct user_struct *uid_hash_find(xid_t xid, uid_t uid, struct list_head *hashent)
  58 {
  59         struct list_head *up;
  60
  61         list_for_each(up, hashent) {
  62                 struct user_struct *user;
  63
  64                 user = list_entry(up, struct user_struct, uidhash_list);
  65
  66                 if(user->uid == uid && user->xid == xid) {
  67                         atomic_inc(&user->__count);
  68                         return user;
  69                 }
  70         }
  71
  72         return NULL;
  73 }
  74
  75 /*
  76  * Locate the user_struct for the passed UID.  If found, take a ref on it.  The
  77  * caller must undo that ref with free_uid().
  78  *
  79  * If the user_struct could not be found, return NULL.
  80  */
  81 struct user_struct *find_user(xid_t xid, uid_t uid)
  82 {
  83         struct user_struct *ret;
  84
  85         spin_lock(&uidhash_lock);
  86         ret = uid_hash_find(xid, uid, uidhashentry(xid, uid));
  87         spin_unlock(&uidhash_lock);
  88         return ret;
  89 }
  90
  91 void free_uid(struct user_struct *up)
  92 {
  93         if (up && atomic_dec_and_lock(&up->__count, &uidhash_lock)) {
  94                 uid_hash_remove(up);
  95                 key_put(up->uid_keyring);
  96                 key_put(up->session_keyring);
  97                 kmem_cache_free(uid_cachep, up);
  98                 spin_unlock(&uidhash_lock);
  99         }
 100 }
 101
 102 struct user_struct * alloc_uid(xid_t xid, uid_t uid)
 103 {
 104         struct list_head *hashent = uidhashentry(xid, uid);
 105         struct user_struct *up;
 106
 107         spin_lock(&uidhash_lock);
 108         up = uid_hash_find(xid, uid, hashent);
 109         spin_unlock(&uidhash_lock);
 110
 111         if (!up) {
 112                 struct user_struct *new;
 113
 114                 new = kmem_cache_alloc(uid_cachep, SLAB_KERNEL);
 115                 if (!new)
 116                         return NULL;
 117                 new->uid = uid;
 118                 new->xid = xid;
 119                 atomic_set(&new->__count, 1);
 120                 atomic_set(&new->processes, 0);
 121                 atomic_set(&new->files, 0);
 122                 atomic_set(&new->sigpending, 0);
 123
 124                 new->mq_bytes = 0;
 125                 new->locked_shm = 0;
 126
 127                 if (alloc_uid_keyring(new) < 0) {
 128                         kmem_cache_free(uid_cachep, new);
 129                         return NULL;
 130                 }
 131
 132                 /*
 133                  * Before adding this, check whether we raced
 134                  * on adding the same user already..
 135                  */
 136                 spin_lock(&uidhash_lock);
 137                 up = uid_hash_find(xid, uid, hashent);
 138                 if (up) {
 139                         key_put(new->uid_keyring);
 140                         key_put(new->session_keyring);
 141                         kmem_cache_free(uid_cachep, new);
 142                 } else {
 143                         uid_hash_insert(new, hashent);
 144                         up = new;
 145                 }
 146                 spin_unlock(&uidhash_lock);
 147
 148         }
 149         return up;
 150 }
 151
 152 void switch_uid(struct user_struct *new_user)
 153 {
 154         struct user_struct *old_user;
 155
 156         /* What if a process setreuid()'s and this brings the
 157          * new uid over his NPROC rlimit?  We can check this now
 158          * cheaply with the new uid cache, so if it matters
 159          * we should be checking for it.  -DaveM
 160          */
 161         old_user = current->user;
 162         atomic_inc(&new_user->processes);
 163         atomic_dec(&old_user->processes);
 164         switch_uid_keyring(new_user);
 165         current->user = new_user;
 166         free_uid(old_user);
 167         suid_keys(current);
 168 }
 169
 170
 171 static int __init uid_cache_init(void)
 172 {
 173         int n;
 174
 175         uid_cachep = kmem_cache_create("uid_cache", sizeof(struct user_struct),
 176                         0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
 177
 178         for(n = 0; n < UIDHASH_SZ; ++n)
 179                 INIT_LIST_HEAD(uidhash_table + n);
 180
 181         /* Insert the root user immediately (init already runs as root) */
 182         spin_lock(&uidhash_lock);
 183         uid_hash_insert(&root_user, uidhashentry(0,0));
 184         spin_unlock(&uidhash_lock);
 185
 186         return 0;
 187 }
 188
 189 module_init(uid_cache_init);