[PATCH] keys: Discard key spinlock and use RCU for key payload

The attached patch changes the key implementation in a number of ways:

 (1) It removes the spinlock from the key structure.

 (2) The key flags are now accessed using atomic bitops instead of
     write-locking the key spinlock and using C bitwise operators.

     The three instantiation flags are dealt with with the construction
     semaphore held during the request_key/instantiate/negate sequence, thus
     rendering the spinlock superfluous.

     The key flags are also now bit numbers not bit masks.

 (3) The key payload is now accessed using RCU. This permits the recursive
     keyring search algorithm to be simplified greatly since no locks need be
     taken other than the usual RCU preemption disablement. Searching now does
     not require any locks or semaphores to be held; merely that the starting
     keyring be pinned.

 (4) The keyring payload now includes an RCU head so that it can be disposed
     of by call_rcu(). This requires that the payload be copied on unlink to
     prevent introducing races in copy-down vs search-up.

 (5) The user key payload is now a structure with the data following it. It
     includes an RCU head like the keyring payload and for the same reason. It
     also contains a data length because the data length in the key may be
     changed on another CPU whilst an RCU protected read is in progress on the
     payload. This would then see the supposed RCU payload and the on-key data
     length getting out of sync.

     I'm tempted to drop the key's datalen entirely, except that it's used in
     conjunction with quota management and so is a little tricky to get rid
     of.

 (6) Update the keys documentation.

Signed-Off-By: David Howells <dhowells@redhat.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

2 files changed, 19 insertions, 12 deletions

diff --git a/include/linux/key-ui.h b/include/linux/key-ui.h
index 60cc7b762e78..159ca8d54e9a 100644
--- a/include/linux/key-ui.h
+++ b/include/linux/key-ui.h
@@ -31,8 +31,10 @@ extern spinlock_t key_serial_lock;
  * subscribed
  */
 struct keyring_list {
-        unsigned        maxkeys;        /* max keys this list can hold */
-        unsigned        nkeys;          /* number of keys currently held */
+        struct rcu_head rcu;            /* RCU deletion hook */
+        unsigned short  maxkeys;        /* max keys this list can hold */
+        unsigned short  nkeys;          /* number of keys currently held */
+        unsigned short  delkey;         /* key to be unlinked by RCU */
         struct key      *keys[0];
 };
 
diff --git a/include/linux/key.h b/include/linux/key.h
index 6aa46d0e812f..2c24ffaca86f 100644
--- a/include/linux/key.h
+++ b/include/linux/key.h
@@ -18,7 +18,7 @@
 #include <linux/types.h>
 #include <linux/list.h>
 #include <linux/rbtree.h>
-#include <linux/spinlock.h>
+#include <linux/rcupdate.h>
 #include <asm/atomic.h>
 
 #ifdef __KERNEL__
@@ -78,7 +78,6 @@ struct key {
         key_serial_t            serial;         /* key serial number */
         struct rb_node          serial_node;
         struct key_type         *type;          /* type of key */
-        rwlock_t                lock;           /* examination vs change lock */
         struct rw_semaphore     sem;            /* change vs change sem */
         struct key_user         *user;          /* owner of this key */
         time_t                  expiry;         /* time at which key expires (or 0) */
@@ -86,14 +85,10 @@ struct key {
         gid_t                   gid;
         key_perm_t              perm;           /* access permissions */
         unsigned short          quotalen;       /* length added to quota */
-        unsigned short          datalen;        /* payload data length */
-        unsigned short          flags;          /* status flags (change with lock writelocked) */
-#define KEY_FLAG_INSTANTIATED   0x00000001      /* set if key has been instantiated */
-#define KEY_FLAG_DEAD           0x00000002      /* set if key type has been deleted */
-#define KEY_FLAG_REVOKED        0x00000004      /* set if key had been revoked */
-#define KEY_FLAG_IN_QUOTA       0x00000008      /* set if key consumes quota */
-#define KEY_FLAG_USER_CONSTRUCT 0x00000010      /* set if key is being constructed in userspace */
-#define KEY_FLAG_NEGATIVE       0x00000020      /* set if key is negative */
+        unsigned short          datalen;        /* payload data length
+                                                 * - may not match RCU dereferenced payload
+                                                 * - payload should contain own length
+                                                 */
 
 #ifdef KEY_DEBUGGING
         unsigned                magic;
@@ -101,6 +96,14 @@ struct key {
 #define KEY_DEBUG_MAGIC_X       0xf8e9dacbu
 #endif
 
+        unsigned long           flags;          /* status flags (change with bitops) */
+#define KEY_FLAG_INSTANTIATED   0       /* set if key has been instantiated */
+#define KEY_FLAG_DEAD           1       /* set if key type has been deleted */
+#define KEY_FLAG_REVOKED        2       /* set if key had been revoked */
+#define KEY_FLAG_IN_QUOTA       3       /* set if key consumes quota */
+#define KEY_FLAG_USER_CONSTRUCT 4       /* set if key is being constructed in userspace */
+#define KEY_FLAG_NEGATIVE       5       /* set if key is negative */
+
         /* the description string
          * - this is used to match a key against search criteria
          * - this should be a printable string
@@ -250,6 +253,8 @@ extern int keyring_add_key(struct key *keyring,
 
 extern struct key *key_lookup(key_serial_t id);
 
+extern void keyring_replace_payload(struct key *key, void *replacement);
+
 #define key_serial(key) ((key) ? (key)->serial : 0)
 
 /*