summaryrefslogtreecommitdiffstats
path: root/libglusterfs/src/syncop-utils.c
blob: 029f10b058efb7c6441927615cc9c98da99b8c62 (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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
/*
  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.
*/

#include "syncop.h"
#include "syncop-utils.h"
#include "common-utils.h"
#include "libglusterfs-messages.h"

struct syncop_dir_scan_data {
        xlator_t *subvol;
        loc_t *parent;
        void *data;
        gf_dirent_t *q;
        gf_dirent_t *entry;
        pthread_cond_t *cond;
        pthread_mutex_t *mut;
        syncop_dir_scan_fn_t fn;
        uint32_t *jobs_running;
        uint32_t *qlen;
        int32_t  *retval;
};

int
syncop_dirfd (xlator_t *subvol, loc_t *loc, fd_t **fd, int pid)
{
        int  ret    = 0;
        fd_t *dirfd = NULL;

        if (!fd)
                return -EINVAL;

        dirfd = fd_create (loc->inode, pid);
        if (!dirfd) {
                gf_msg (subvol->name, GF_LOG_ERROR, errno,
                        LG_MSG_FD_CREATE_FAILED, "fd_create of %s",
                        uuid_utoa (loc->gfid));
                ret = -errno;
                goto out;
        }

        ret = syncop_opendir (subvol, loc, dirfd, NULL, NULL);
        if (ret) {
        /*
         * On Linux, if the brick was not updated, opendir will
         * fail. We therefore use backward compatible code
         * that violate the standards by reusing offsets
         * in seekdir() from different DIR *, but it works on Linux.
         *
         * On other systems it never worked, hence we do not need
         * to provide backward-compatibility.
         */
#ifdef GF_LINUX_HOST_OS
                fd_unref (dirfd);
                dirfd = fd_anonymous (loc->inode);
                if (!dirfd) {
                        gf_msg (subvol->name, GF_LOG_ERROR, errno,
                                LG_MSG_FD_ANONYMOUS_FAILED, "fd_anonymous of "
                                "%s", uuid_utoa (loc->gfid));
                        ret = -errno;
                        goto out;
                }
                ret = 0;
#else /* GF_LINUX_HOST_OS */
                fd_unref (dirfd);
                gf_msg (subvol->name, GF_LOG_ERROR, errno,
                        LG_MSG_DIR_OP_FAILED, "opendir of %s",
                        uuid_utoa (loc->gfid));
                goto out;
#endif /* GF_LINUX_HOST_OS */
        } else {
                fd_bind (dirfd);
        }
out:
        if (ret == 0)
                *fd = dirfd;
        return ret;
}

int
syncop_ftw (xlator_t *subvol, loc_t *loc, int pid, void *data,
            int (*fn) (xlator_t *subvol, gf_dirent_t *entry, loc_t *parent,
                       void *data))
{
        loc_t       child_loc = {0, };
        fd_t        *fd       = NULL;
        uint64_t    offset    = 0;
        gf_dirent_t *entry    = NULL;
        int         ret       = 0;
        gf_dirent_t entries;

        ret = syncop_dirfd (subvol, loc, &fd, pid);
        if (ret)
                goto out;

        INIT_LIST_HEAD (&entries.list);

        while ((ret = syncop_readdirp (subvol, fd, 131072, offset, &entries,
                                       NULL, NULL))) {
                if (ret < 0)
                        break;

                if (ret > 0) {
                        /* If the entries are only '.', and '..' then ret
                         * value will be non-zero. so set it to zero here. */
                        ret = 0;
                }
                list_for_each_entry (entry, &entries.list, list) {
                        offset = entry->d_off;

                        if (!strcmp (entry->d_name, ".") ||
                            !strcmp (entry->d_name, ".."))
                                continue;

                        gf_link_inode_from_dirent (NULL, fd->inode, entry);

                        ret = fn (subvol, entry, loc, data);
                        if (ret)
                                break;

                        if (entry->d_stat.ia_type == IA_IFDIR) {
                                child_loc.inode = inode_ref (entry->inode);
                                gf_uuid_copy (child_loc.gfid, entry->inode->gfid);
                                ret = syncop_ftw (subvol, &child_loc,
                                                  pid, data, fn);
                                loc_wipe (&child_loc);
                                if (ret)
                                        break;
                        }
                }

                gf_dirent_free (&entries);
                if (ret)
                        break;
        }

out:
        if (fd)
                fd_unref (fd);
        return ret;
}

/**
 * Syncop_ftw_throttle can be used in a configurable way to control
 * the speed at which crawling is done. It takes 2 more arguments
 * compared to syncop_ftw.
 * After @count entries are finished in a directory (to be
 * precise, @count files) sleep for @sleep_time seconds.
 * If either @count or @sleep_time is <=0, then it behaves similar to
 * syncop_ftw.
 */
int
syncop_ftw_throttle (xlator_t *subvol, loc_t *loc, int pid, void *data,
                     int (*fn) (xlator_t *subvol, gf_dirent_t *entry,
                                loc_t *parent, void *data),
                     int count, int sleep_time)
{
        loc_t       child_loc = {0, };
        fd_t        *fd       = NULL;
        uint64_t    offset    = 0;
        gf_dirent_t *entry    = NULL;
        int         ret       = 0;
        gf_dirent_t entries;
        int         tmp       = 0;

        if (sleep_time <= 0) {
                ret = syncop_ftw (subvol, loc, pid, data, fn);
                goto out;
        }

        ret = syncop_dirfd (subvol, loc, &fd, pid);
        if (ret)
                goto out;

        INIT_LIST_HEAD (&entries.list);

        while ((ret = syncop_readdirp (subvol, fd, 131072, offset, &entries,
                                       NULL, NULL))) {
                if (ret < 0)
                        break;

                if (ret > 0) {
                        /* If the entries are only '.', and '..' then ret
                         * value will be non-zero. so set it to zero here. */
                        ret = 0;
                }

                tmp = 0;

                list_for_each_entry (entry, &entries.list, list) {
                        offset = entry->d_off;

                        if (!strcmp (entry->d_name, ".") ||
                            !strcmp (entry->d_name, ".."))
                                continue;

                        if (++tmp >= count) {
                                tmp = 0;
                                sleep (sleep_time);
                        }

                        gf_link_inode_from_dirent (NULL, fd->inode, entry);

                        ret = fn (subvol, entry, loc, data);
                        if (ret)
                                continue;

                        if (entry->d_stat.ia_type == IA_IFDIR) {
                                child_loc.inode = inode_ref (entry->inode);
                                gf_uuid_copy (child_loc.gfid, entry->inode->gfid);
                                ret = syncop_ftw_throttle (subvol, &child_loc,
                                                           pid, data, fn, count,
                                                           sleep_time);
                                loc_wipe (&child_loc);
                                if (ret)
                                        continue;
                        }
                }

                gf_dirent_free (&entries);
                if (ret)
                        break;
        }

out:
        if (fd)
                fd_unref (fd);
        return ret;
}

static void
_scan_data_destroy (struct syncop_dir_scan_data *data)
{
        GF_FREE (data);
}

static int
_dir_scan_job_fn_cbk (int ret, call_frame_t *frame, void *opaque)
{
        struct syncop_dir_scan_data *scan_data = opaque;

        _scan_data_destroy (scan_data);
        return 0;
}

static int
_dir_scan_job_fn (void *data)
{
        struct syncop_dir_scan_data *scan_data = data;
        gf_dirent_t                 *entry     = NULL;
        int                         ret        = 0;

        entry = scan_data->entry;
        scan_data->entry = NULL;
        do {
                ret = scan_data->fn (scan_data->subvol, entry,
                                     scan_data->parent,
                                     scan_data->data);
                gf_dirent_entry_free (entry);
                entry = NULL;
                pthread_mutex_lock (scan_data->mut);
                {
                        if (ret || list_empty (&scan_data->q->list)) {
                                (*scan_data->jobs_running)--;
                                *scan_data->retval |= ret;
                                pthread_cond_broadcast (scan_data->cond);
                        } else {
                                entry = list_first_entry (&scan_data->q->list,
                                                  typeof (*scan_data->q), list);
                                list_del_init (&entry->list);
                                (*scan_data->qlen)--;
                        }
                }
                pthread_mutex_unlock (scan_data->mut);
        } while (entry);

        return ret;
}

static int
_run_dir_scan_task (call_frame_t *frame, xlator_t *subvol, loc_t *parent,
                    gf_dirent_t *q, gf_dirent_t *entry, int *retval,
                    pthread_mutex_t *mut, pthread_cond_t *cond,
                    uint32_t *jobs_running, uint32_t *qlen,
                    syncop_dir_scan_fn_t fn, void *data)
{
        int     ret = 0;
        struct syncop_dir_scan_data *scan_data = NULL;


        scan_data = GF_CALLOC (1, sizeof (struct syncop_dir_scan_data),
                               gf_common_mt_scan_data);
        if (!scan_data) {
                ret = -ENOMEM;
                goto out;
        }

        scan_data->subvol       = subvol;
        scan_data->parent       = parent;
        scan_data->data         = data;
        scan_data->mut          = mut;
        scan_data->cond         = cond;
        scan_data->fn           = fn;
        scan_data->jobs_running = jobs_running;
        scan_data->entry        = entry;
        scan_data->q            = q;
        scan_data->qlen         = qlen;
        scan_data->retval       = retval;

        ret = synctask_new (subvol->ctx->env, _dir_scan_job_fn,
                            _dir_scan_job_fn_cbk, frame, scan_data);
out:
        if (ret < 0) {
                gf_dirent_entry_free (entry);
                _scan_data_destroy (scan_data);
                pthread_mutex_lock (mut);
                {
                        *jobs_running = *jobs_running - 1;
                }
                pthread_mutex_unlock (mut);
                /*No need to cond-broadcast*/
        }
        return ret;
}

int
syncop_mt_dir_scan (call_frame_t *frame, xlator_t *subvol, loc_t *loc, int pid,
                    void *data, syncop_dir_scan_fn_t fn, dict_t *xdata,
                    uint32_t max_jobs, uint32_t max_qlen)
{
        fd_t        *fd    = NULL;
        uint64_t    offset = 0;
        gf_dirent_t *last = NULL;
        int         ret    = 0;
        int         retval = 0;
        gf_dirent_t q;
        gf_dirent_t *entry = NULL;
        gf_dirent_t *tmp = NULL;
        uint32_t    jobs_running = 0;
        uint32_t    qlen = 0;
        pthread_cond_t cond;
        pthread_mutex_t mut;
        gf_boolean_t cond_init = _gf_false;
        gf_boolean_t mut_init = _gf_false;
        gf_dirent_t entries;

        /*For this functionality to be implemented in general, we need
         * synccond_t infra which doesn't block the executing thread. Until then
         * return failures inside synctask if they use this.*/
        if (synctask_get())
                return -ENOTSUP;

        if (max_jobs == 0)
                return -EINVAL;

        /*Code becomes simpler this way. cond_wait just on qlength.
         * Little bit of cheating*/
        if (max_qlen == 0)
                max_qlen = 1;

        ret = syncop_dirfd (subvol, loc, &fd, pid);
        if (ret)
                goto out;

        INIT_LIST_HEAD (&entries.list);
        INIT_LIST_HEAD (&q.list);
        ret = pthread_mutex_init (&mut, NULL);
        if (ret)
                goto out;
        mut_init = _gf_true;

        ret = pthread_cond_init (&cond, NULL);
        if (ret)
                goto out;
        cond_init = _gf_true;

        while ((ret = syncop_readdir (subvol, fd, 131072, offset, &entries,
                                      xdata, NULL))) {
                if (ret < 0)
                        break;

                if (ret > 0) {
                        /* If the entries are only '.', and '..' then ret
                         * value will be non-zero. so set it to zero here. */
                        ret = 0;
                }

                last = list_last_entry (&entries.list, typeof (*last), list);
                offset = last->d_off;

                list_for_each_entry_safe (entry, tmp, &entries.list, list) {
                        list_del_init (&entry->list);
                        if (!strcmp (entry->d_name, ".") ||
                            !strcmp (entry->d_name, "..")) {
                                gf_dirent_entry_free (entry);
                                continue;
                        }

                        if (entry->d_type == IA_IFDIR) {
                                ret = fn (subvol, entry, loc, data);
                                gf_dirent_entry_free (entry);
                                if (ret)
                                        break;
                                continue;
                        }

                        pthread_mutex_lock (&mut);
                        {
                                while (qlen == max_qlen)
                                        pthread_cond_wait (&cond, &mut);
                                if (max_jobs == jobs_running) {
                                        list_add_tail (&entry->list, &q.list);
                                        qlen++;
                                        entry = NULL;
                                } else {
                                        jobs_running++;
                                }
                        }
                        pthread_mutex_unlock (&mut);
                        if (retval) /*Any jobs failed?*/
                                break;

                        if (!entry)
                                continue;

                        ret = _run_dir_scan_task (frame, subvol, loc, &q, entry,
                                                  &retval, &mut, &cond,
                                                &jobs_running, &qlen, fn, data);
                        if (ret)
                                break;
                }
        }

out:
        if (fd)
                fd_unref (fd);
        if (mut_init && cond_init) {
                pthread_mutex_lock (&mut);
                {
                        while (jobs_running)
                                pthread_cond_wait (&cond, &mut);
                }
                pthread_mutex_unlock (&mut);
                gf_dirent_free (&q);
                gf_dirent_free (&entries);
        }

        if (mut_init)
                pthread_mutex_destroy (&mut);
        if (cond_init)
                pthread_cond_destroy (&cond);
        return ret|retval;
}

int
syncop_dir_scan (xlator_t *subvol, loc_t *loc, int pid, void *data,
                 int (*fn) (xlator_t *subvol, gf_dirent_t *entry, loc_t *parent,
                            void *data))
{
        fd_t        *fd    = NULL;
        uint64_t    offset = 0;
        gf_dirent_t *entry = NULL;
        int         ret    = 0;
        gf_dirent_t entries;

        ret = syncop_dirfd (subvol, loc, &fd, pid);
        if (ret)
                goto out;

        INIT_LIST_HEAD (&entries.list);

        while ((ret = syncop_readdir (subvol, fd, 131072, offset, &entries,
                                      NULL, NULL))) {
                if (ret < 0)
                        break;

                if (ret > 0) {
                        /* If the entries are only '.', and '..' then ret
                         * value will be non-zero. so set it to zero here. */
                        ret = 0;
                }

                list_for_each_entry (entry, &entries.list, list) {
                        offset = entry->d_off;

                        if (!strcmp (entry->d_name, ".") ||
                            !strcmp (entry->d_name, ".."))
                                continue;

                        ret = fn (subvol, entry, loc, data);
                        if (ret)
                                break;
                }
                gf_dirent_free (&entries);
                if (ret)
                        break;
        }

out:
        if (fd)
                fd_unref (fd);
        return ret;
}

int
syncop_is_subvol_local (xlator_t *this, loc_t *loc, gf_boolean_t *is_local)
{
        char *pathinfo = NULL;
        dict_t *xattr = NULL;
        int ret = 0;

        if (!this || !this->type || !is_local)
                return -EINVAL;

        if (strcmp (this->type, "protocol/client") != 0)
                return -EINVAL;

        *is_local = _gf_false;

        ret = syncop_getxattr (this, loc, &xattr, GF_XATTR_PATHINFO_KEY, NULL,
                               NULL);
        if (ret < 0) {
                ret = -1;
                goto out;
        }

        if (!xattr) {
                ret = -EINVAL;
                goto out;
        }

        ret = dict_get_str (xattr, GF_XATTR_PATHINFO_KEY, &pathinfo);
        if (ret)
                goto out;

        ret = glusterfs_is_local_pathinfo (pathinfo, is_local);

        gf_msg_debug (this->name, 0, "subvol %s is %slocal",
                this->name, *is_local ? "" : "not ");

out:
        if (xattr)
                dict_unref (xattr);

        return ret;
}

int
syncop_gfid_to_path (inode_table_t *itable, xlator_t *subvol, uuid_t gfid,
                     char **path_p)
{
        int      ret   = 0;
        char    *path  = NULL;
        loc_t    loc   = {0,};
        dict_t  *xattr = NULL;

        gf_uuid_copy (loc.gfid, gfid);
        loc.inode = inode_new (itable);

        ret = syncop_getxattr (subvol, &loc, &xattr, GFID_TO_PATH_KEY, NULL,
                               NULL);
        if (ret < 0)
                goto out;

        ret = dict_get_str (xattr, GFID_TO_PATH_KEY, &path);
        if (ret || !path) {
                ret = -EINVAL;
                goto out;
        }

        if (path_p) {
                *path_p = gf_strdup (path);
                if (!*path_p) {
                        ret = -ENOMEM;
                        goto out;
                }
        }

        ret = 0;

out:
        if (xattr)
                dict_unref (xattr);
        loc_wipe (&loc);

        return ret;
}