summaryrefslogtreecommitdiffstats
path: root/libglusterfs/src/glusterfs/client_t.h
blob: a2c508e1d5caaf3e7ba481db3e2d95564262b9c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
  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

#include "glusterfs/glusterfs.h"
#include "glusterfs/locking.h" /* for gf_lock_t, not included by glusterfs.h */
#include "glusterfs/atomic.h"  /* for gf_atomic_t */

/* auth_data structure is required by RPC layer. But as it is also used in
 * client_t structure validation, comparision, it is critical that it is defined
 * in the larger scope of libglusterfs, instead of libgfrpc. With this change,
 * even RPC will use this structure */
#define GF_CLIENTT_AUTH_BYTES 400
typedef struct client_auth_data {
    int flavour;
    int datalen;
    char authdata[GF_CLIENTT_AUTH_BYTES];
} client_auth_data_t;

struct client_ctx {
    void *ctx_key;
    void *ctx_value;
};

typedef struct _client {
    struct {
        /* e.g. protocol/server stashes its ctx here */
        gf_lock_t lock;
        unsigned short count;
        struct client_ctx *ctx;
    } scratch_ctx;
    gf_atomic_t bind;
    gf_atomic_t count;
    xlator_t *bound_xl;
    xlator_t *this;
    int tbl_index;
    char *client_uid;
    char *client_name;
    struct {
        int flavour;
        size_t len;
        char *data;
        char *username;
        char *passwd;
    } auth;

    /* subdir_mount */
    char *subdir_mount;
    inode_t *subdir_inode;
    uuid_t subdir_gfid;
    int32_t opversion;
    /* Variable to save fd_count for detach brick */
    gf_atomic_t fd_cnt;
} client_t;

#define GF_CLIENTCTX_INITIAL_SIZE 8

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;
    client_t *local;
};
typedef struct clienttable clienttable_t;

#define GF_CLIENTTABLE_INITIAL_SIZE 128

/* 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

void
gf_client_put(client_t *client, gf_boolean_t *detached);

clienttable_t *
gf_clienttable_alloc(void);

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);

void *
client_ctx_set(client_t *client, void *key, void *value);

int
client_ctx_get(client_t *client, void *key, void **value);

int
client_ctx_del(client_t *client, void *key, void **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);

int
gf_client_disconnect(client_t *client);

client_t *
gf_client_get(xlator_t *this, client_auth_data_t *cred, char *client_uid,
              char *subdir_mount);

#endif /* _CLIENT_T_H */