summaryrefslogtreecommitdiffstats
path: root/xlators/features/shard/src/shard.h
blob: 0dbb9399656fb79a513db023cf73fd087211e236 (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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*
  Copyright (c) 2015 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 __SHARD_H__
#define __SHARD_H__

#include <glusterfs/xlator.h>
#include <glusterfs/compat-errno.h>
#include "shard-messages.h"
#include <glusterfs/syncop.h>

#define GF_SHARD_DIR ".shard"
#define GF_SHARD_REMOVE_ME_DIR ".remove_me"
#define SHARD_MIN_BLOCK_SIZE (4 * GF_UNIT_MB)
#define SHARD_MAX_BLOCK_SIZE (4 * GF_UNIT_TB)
#define SHARD_XATTR_PREFIX "trusted.glusterfs.shard."
#define GF_XATTR_SHARD_BLOCK_SIZE "trusted.glusterfs.shard.block-size"
/**
 *  Bit masks for the valid flag, which is used while updating ctx
 **/
#define SHARD_MASK_BLOCK_SIZE (1 << 0)
#define SHARD_MASK_PROT (1 << 1)
#define SHARD_MASK_NLINK (1 << 2)
#define SHARD_MASK_UID (1 << 3)
#define SHARD_MASK_GID (1 << 4)
#define SHARD_MASK_SIZE (1 << 6)
#define SHARD_MASK_BLOCKS (1 << 7)
#define SHARD_MASK_TIMES (1 << 8)
#define SHARD_MASK_OTHERS (1 << 9)
#define SHARD_MASK_REFRESH_RESET (1 << 10)

#define SHARD_INODE_WRITE_MASK                                                 \
    (SHARD_MASK_SIZE | SHARD_MASK_BLOCKS | SHARD_MASK_TIMES)

#define SHARD_LOOKUP_MASK                                                      \
    (SHARD_MASK_PROT | SHARD_MASK_NLINK | SHARD_MASK_UID | SHARD_MASK_GID |    \
     SHARD_MASK_TIMES | SHARD_MASK_OTHERS)

#define SHARD_ALL_MASK                                                         \
    (SHARD_MASK_BLOCK_SIZE | SHARD_MASK_PROT | SHARD_MASK_NLINK |              \
     SHARD_MASK_UID | SHARD_MASK_GID | SHARD_MASK_SIZE | SHARD_MASK_BLOCKS |   \
     SHARD_MASK_TIMES | SHARD_MASK_OTHERS)

#define get_lowest_block(off, shard_size) ((off) / (shard_size))
#define get_highest_block(off, len, shard_size)                                \
    (((((off) + (len)) == 0) ? 0 : ((off) + (len)-1)) / (shard_size))

int
shard_unlock_inodelk(call_frame_t *frame, xlator_t *this);

int
shard_unlock_entrylk(call_frame_t *frame, xlator_t *this);

#define SHARD_ENTRY_FOP_CHECK(loc, op_errno, label)                            \
    do {                                                                       \
        if ((loc->name && !strcmp(GF_SHARD_DIR, loc->name)) &&                 \
            (((loc->parent) && __is_root_gfid(loc->parent->gfid)) ||           \
             __is_root_gfid(loc->pargfid))) {                                  \
            op_errno = EPERM;                                                  \
            goto label;                                                        \
        }                                                                      \
                                                                               \
        if ((loc->parent && __is_shard_dir(loc->parent->gfid)) ||              \
            __is_shard_dir(loc->pargfid)) {                                    \
            op_errno = EPERM;                                                  \
            goto label;                                                        \
        }                                                                      \
    } while (0)

#define SHARD_INODE_OP_CHECK(gfid, err, label)                                 \
    do {                                                                       \
        if (__is_shard_dir(gfid)) {                                            \
            err = EPERM;                                                       \
            goto label;                                                        \
        }                                                                      \
    } while (0)

#define SHARD_STACK_UNWIND(fop, frame, params...)                              \
    do {                                                                       \
        shard_local_t *__local = NULL;                                         \
        if (frame) {                                                           \
            __local = frame->local;                                            \
            if (__local && __local->int_inodelk.acquired_lock)                 \
                shard_unlock_inodelk(frame, frame->this);                      \
            if (__local && __local->int_entrylk.acquired_lock)                 \
                shard_unlock_entrylk(frame, frame->this);                      \
            frame->local = NULL;                                               \
        }                                                                      \
        STACK_UNWIND_STRICT(fop, frame, params);                               \
        if (__local) {                                                         \
            shard_local_wipe(__local);                                         \
            mem_put(__local);                                                  \
        }                                                                      \
    } while (0)

#define SHARD_STACK_DESTROY(frame)                                             \
    do {                                                                       \
        shard_local_t *__local = NULL;                                         \
        __local = frame->local;                                                \
        frame->local = NULL;                                                   \
        STACK_DESTROY(frame->root);                                            \
        if (__local) {                                                         \
            shard_local_wipe(__local);                                         \
            mem_put(__local);                                                  \
        }                                                                      \
    } while (0);

#define SHARD_INODE_CREATE_INIT(this, block_size, xattr_req, loc, size,        \
                                block_count, label)                            \
    do {                                                                       \
        int __ret = -1;                                                        \
        int64_t *__size_attr = NULL;                                           \
        uint64_t *__bs = 0;                                                    \
                                                                               \
        __bs = GF_MALLOC(sizeof(uint64_t), gf_shard_mt_uint64_t);              \
        if (!__bs)                                                             \
            goto label;                                                        \
        *__bs = hton64(block_size);                                            \
        __ret = dict_set_bin(xattr_req, GF_XATTR_SHARD_BLOCK_SIZE, __bs,       \
                             sizeof(*__bs));                                   \
        if (__ret) {                                                           \
            gf_msg(this->name, GF_LOG_WARNING, 0, SHARD_MSG_DICT_OP_FAILED,    \
                   "Failed to set key: %s "                                    \
                   "on path %s",                                               \
                   GF_XATTR_SHARD_BLOCK_SIZE, (loc)->path);                    \
            GF_FREE(__bs);                                                     \
            goto label;                                                        \
        }                                                                      \
                                                                               \
        __ret = shard_set_size_attrs(size, block_count, &__size_attr);         \
        if (__ret)                                                             \
            goto label;                                                        \
                                                                               \
        __ret = dict_set_bin(xattr_req, GF_XATTR_SHARD_FILE_SIZE, __size_attr, \
                             8 * 4);                                           \
        if (__ret) {                                                           \
            gf_msg(this->name, GF_LOG_WARNING, 0, SHARD_MSG_DICT_OP_FAILED,    \
                   "Failed to set key: %s "                                    \
                   "on path %s",                                               \
                   GF_XATTR_SHARD_FILE_SIZE, (loc)->path);                     \
            GF_FREE(__size_attr);                                              \
            goto label;                                                        \
        }                                                                      \
    } while (0)

#define SHARD_MD_READ_FOP_INIT_REQ_DICT(this, dict, gfid, local, label)        \
    do {                                                                       \
        int __ret = -1;                                                        \
                                                                               \
        __ret = dict_set_uint64(dict, GF_XATTR_SHARD_FILE_SIZE, 8 * 4);        \
        if (__ret) {                                                           \
            local->op_ret = -1;                                                \
            local->op_errno = ENOMEM;                                          \
            gf_msg(this->name, GF_LOG_WARNING, 0, SHARD_MSG_DICT_OP_FAILED,    \
                   "Failed to set dict value:"                                 \
                   " key:%s for %s.",                                          \
                   GF_XATTR_SHARD_FILE_SIZE, uuid_utoa(gfid));                 \
            goto label;                                                        \
        }                                                                      \
    } while (0)

#define SHARD_SET_ROOT_FS_ID(frame, local)                                     \
    do {                                                                       \
        if (!local->is_set_fsid) {                                             \
            local->uid = frame->root->uid;                                     \
            local->gid = frame->root->gid;                                     \
            frame->root->uid = 0;                                              \
            frame->root->gid = 0;                                              \
            local->is_set_fsid = _gf_true;                                     \
        }                                                                      \
    } while (0)

#define SHARD_UNSET_ROOT_FS_ID(frame, local)                                   \
    do {                                                                       \
        if (local->is_set_fsid) {                                              \
            frame->root->uid = local->uid;                                     \
            frame->root->gid = local->gid;                                     \
            local->is_set_fsid = _gf_false;                                    \
        }                                                                      \
    } while (0)

#define SHARD_TIME_UPDATE(ctx_sec, ctx_nsec, new_sec, new_nsec)                \
    do {                                                                       \
        if (ctx_sec == new_sec)                                                \
            ctx_nsec = new_nsec = max(new_nsec, ctx_nsec);                     \
        else if (ctx_sec > new_sec) {                                          \
            new_sec = ctx_sec;                                                 \
            new_nsec = ctx_nsec;                                               \
        } else {                                                               \
            ctx_sec = new_sec;                                                 \
            ctx_nsec = new_nsec;                                               \
        }                                                                      \
    } while (0)

typedef enum {
    SHARD_FIRST_LOOKUP_PENDING = 0,
    SHARD_FIRST_LOOKUP_IN_PROGRESS,
    SHARD_FIRST_LOOKUP_DONE,
} shard_first_lookup_state_t;

/* rm = "remove me" */

typedef struct shard_priv {
    uint64_t block_size;
    uuid_t dot_shard_gfid;
    uuid_t dot_shard_rm_gfid;
    inode_t *dot_shard_inode;
    inode_t *dot_shard_rm_inode;
    gf_lock_t lock;
    int inode_count;
    struct list_head ilist_head;
    uint32_t deletion_rate;
    shard_first_lookup_state_t first_lookup;
    uint64_t lru_limit;
} shard_priv_t;

typedef struct {
    loc_t loc;
    char *domain;
    struct gf_flock flock;
    gf_boolean_t acquired_lock;
} shard_inodelk_t;

typedef struct {
    loc_t loc;
    char *domain;
    char *basename;
    entrylk_cmd cmd;
    entrylk_type type;
    gf_boolean_t acquired_lock;
} shard_entrylk_t;

typedef int32_t (*shard_post_fop_handler_t)(call_frame_t *frame,
                                            xlator_t *this);
typedef int32_t (*shard_post_resolve_fop_handler_t)(call_frame_t *frame,
                                                    xlator_t *this);
typedef int32_t (*shard_post_lookup_shards_fop_handler_t)(call_frame_t *frame,
                                                          xlator_t *this);

typedef int32_t (*shard_post_mknod_fop_handler_t)(call_frame_t *frame,
                                                  xlator_t *this);

typedef int32_t (*shard_post_update_size_fop_handler_t)(call_frame_t *frame,
                                                        xlator_t *this);

typedef struct shard_local {
    int op_ret;
    int op_errno;
    int first_block;
    int last_block;
    int num_blocks;
    int call_count;
    int eexist_count;
    int create_count;
    int xflag;
    int count;
    uint32_t flags;
    uint32_t uid;
    uint32_t gid;
    uint64_t block_size;
    uint64_t dst_block_size;
    int32_t datasync;
    off_t offset;
    size_t total_size;
    size_t written_size;
    size_t hole_size;
    size_t req_size;
    size_t readdir_size;
    int64_t delta_size;
    int delta_blocks;
    loc_t loc;
    loc_t dot_shard_loc;
    loc_t dot_shard_rm_loc;
    loc_t loc2;
    loc_t tmp_loc;
    fd_t *fd;
    dict_t *xattr_req;
    dict_t *xattr_rsp;
    inode_t **inode_list;
    glusterfs_fop_t fop;
    struct iatt prebuf;
    struct iatt postbuf;
    struct iatt preoldparent;
    struct iatt postoldparent;
    struct iatt prenewparent;
    struct iatt postnewparent;
    struct iovec *vector;
    struct iobref *iobref;
    struct iobuf *iobuf;
    gf_dirent_t entries_head;
    gf_boolean_t is_set_fsid;
    gf_boolean_t list_inited;
    shard_post_fop_handler_t handler;
    shard_post_lookup_shards_fop_handler_t pls_fop_handler;
    shard_post_resolve_fop_handler_t post_res_handler;
    shard_post_mknod_fop_handler_t post_mknod_handler;
    shard_post_update_size_fop_handler_t post_update_size_handler;
    shard_inodelk_t int_inodelk;
    shard_entrylk_t int_entrylk;
    inode_t *resolver_base_inode;
    gf_boolean_t first_lookup_done;
    syncbarrier_t barrier;
    gf_boolean_t lookup_shards_barriered;
    gf_boolean_t unlink_shards_barriered;
    gf_boolean_t resolve_not;
    loc_t newloc;
    call_frame_t *main_frame;
    call_frame_t *inodelk_frame;
    call_frame_t *entrylk_frame;
    uint32_t deletion_rate;
    gf_boolean_t cleanup_required;
    uuid_t base_gfid;
} shard_local_t;

typedef struct shard_inode_ctx {
    uint64_t block_size; /* The block size with which this inode is
                            sharded */
    struct iatt stat;
    gf_boolean_t refresh;
    /* The following members of inode ctx will be applicable only to the
     * individual shards' ctx and never the base file ctx.
     */
    struct list_head ilist;
    uuid_t base_gfid;
    int block_num;
    gf_boolean_t refreshed;
    struct list_head to_fsync_list;
    int fsync_needed;
    inode_t *inode;
    int fsync_count;
    inode_t *base_inode;
} shard_inode_ctx_t;

typedef enum {
    SHARD_INTERNAL_DIR_DOT_SHARD = 1,
    SHARD_INTERNAL_DIR_DOT_SHARD_REMOVE_ME,
} shard_internal_dir_type_t;

#endif /* __SHARD_H__ */