libglusterfs/client_t client_t implementation, phase 1

Implementation of client_t

The feature page for client_t is at
http://www.gluster.org/community/documentation/index.php/Planning34/client_t

In addition to adding libglusterfs/client_t.[ch] it also extracts/moves
the locktable functionality from xlators/protocol/server to libglusterfs,
where it is used; thus it may now be shared by other xlators too.

This patch is large as it is. Hooking up the state dump is left to do
in phase 2 of this patch set.

(N.B. this change/patch-set supercedes previous change 3689, which was
corrupted during a rebase. That change will be abandoned.)

BUG: 849630
Change-Id: I1433743190630a6d8119a72b81439c0c4c990340
Signed-off-by: Kaleb S. KEITHLEY <kkeithle@redhat.com>
Reviewed-on: http://review.gluster.org/3957
Tested-by: Gluster Build System <jenkins@build.gluster.com>
Reviewed-by: Amar Tumballi <amarts@redhat.com>

1 files changed, 168 insertions, 0 deletions

diff --git a/libglusterfs/src/client_t.h b/libglusterfs/src/client_t.h
new file mode 100644
index 000000000..7b3fcf0dd
--- /dev/null
+++ b/libglusterfs/src/client_t.h
@@ -0,0 +1,168 @@
+/*
+  Copyright (c) 2008-2012 Red Hat, Inc. <http://www.redhat.com>
+  This file is part of GlusterFS.
+
+  This file is licensed to you under your choice of the GNU Lesser
+  General Public License, version 3 or any later version (LGPLv3 or
+  later), or the GNU General Public License, version 2 (GPLv2), in all
+  cases as published by the Free Software Foundation.
+*/
+
+#ifndef _CLIENT_T_H
+#define _CLIENT_T_H
+
+#ifndef _CONFIG_H
+#define _CONFIG_H
+#include "config.h"
+#endif
+
+#include "glusterfs.h"
+#include "locking.h"  /* for gf_lock_t, not included by glusterfs.h */
+
+struct client_ctx {
+        union {
+                uint64_t  key;
+                void     *xl_key;
+        };
+        union {
+                uint64_t  value;
+                void     *ptr1;
+        };
+};
+
+struct _client_t {
+        struct {
+                /* ctx for .../xlators/protocol/server */
+                gf_lock_t            fdtable_lock;
+                fdtable_t           *fdtable;
+                char                *client_uid;
+                struct _gf_timer    *grace_timer;
+                uint32_t             lk_version;
+                struct {
+                        int          flavour;
+                        size_t       len;
+                        char        *data;
+                }            auth;
+        }            server_ctx;
+        struct {
+                /* ctx for .../xlators/features/locks */
+                gf_lock_t            ltable_lock;
+                struct _lock_table  *ltable;
+        }            locks_ctx;
+        struct {
+                /* e.g. hekafs uidmap can stash stuff here */
+                gf_lock_t            lock;
+                unsigned short       count;
+                struct client_ctx   *ctx;
+        }            scratch_ctx;
+        struct {
+                gf_lock_t            lock;
+                volatile int         bind;
+                volatile int         count;
+        }            ref;
+        xlator_t    *bound_xl;
+        xlator_t    *this;
+        int          tbl_index;
+};
+typedef struct _client_t client_t;
+
+
+struct client_table_entry {
+        client_t            *client;
+        int                  next_free;
+};
+typedef struct client_table_entry cliententry_t;
+
+
+struct _clienttable {
+        unsigned int         max_clients;
+        gf_lock_t            lock;
+        cliententry_t       *cliententries;
+        int                  first_free;
+};
+typedef struct _clienttable clienttable_t;
+
+#define GF_CLIENTTABLE_INITIAL_SIZE 32
+
+/* Signifies no more entries in the client table. */
+#define GF_CLIENTTABLE_END  -1
+
+/* This is used to invalidate
+ * the next_free value in an cliententry that has been allocated
+ */
+#define GF_CLIENTENTRY_ALLOCATED    -2
+
+
+
+client_t *
+gf_client_get (xlator_t *this, rpcsvc_auth_data_t *cred, char *client_uid);
+
+void
+gf_client_put (client_t *client, gf_boolean_t *detached);
+
+clienttable_t *
+gf_clienttable_alloc (void);
+
+
+void
+gf_client_clienttable_destroy (clienttable_t *clienttable);
+
+
+client_t *
+gf_client_ref (client_t *client);
+
+
+void
+gf_client_unref (client_t *client);
+
+int
+gf_client_dump_fdtable_to_dict (xlator_t *this, dict_t *dict);
+
+int
+gf_client_dump_fdtable (xlator_t *this);
+
+int
+gf_client_dump_inodes_to_dict (xlator_t *this, dict_t *dict);
+
+int
+gf_client_dump_inodes (xlator_t *this);
+
+int
+client_ctx_set (client_t *client, xlator_t *xlator, uint64_t value);
+
+
+int
+client_ctx_get (client_t *client, xlator_t *xlator, uint64_t *value);
+
+
+int
+client_ctx_del (client_t *client, xlator_t *xlator, uint64_t *value);
+
+
+int
+_client_ctx_set (client_t *client, xlator_t *xlator, uint64_t value);
+
+
+int
+_client_ctx_get (client_t *client, xlator_t *xlator, uint64_t *value);
+
+
+int
+_client_ctx_del (client_t *client, xlator_t *xlator, uint64_t *value);
+
+void
+client_ctx_dump (client_t *client, char *prefix);
+
+int
+gf_client_dump_fdtables_to_dict (xlator_t *this, dict_t *dict);
+
+int
+gf_client_dump_fdtables (xlator_t *this);
+
+int
+gf_client_dump_inodes_to_dict (xlator_t *this, dict_t *dict);
+
+int
+gf_client_dump_inodes (xlator_t *this);
+
+#endif /* _CLIENT_T_H */