summaryrefslogtreecommitdiffstats
path: root/cli/src/cli.h
blob: cd4db3dac2c89807864ec5ff03c6d372d620a333 (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
/*
   Copyright (c) 2006-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 __CLI_H__
#define __CLI_H__

#include "rpc-clnt.h"
#include <glusterfs/glusterfs.h>
#include "protocol-common.h"
#include <glusterfs/logging.h>
#include <glusterfs/quota-common-utils.h>

#include "cli1-xdr.h"
#include "gd-common-utils.h"

#if (HAVE_LIB_XML)
#include <libxml/encoding.h>
#include <libxml/xmlwriter.h>
#endif

#define DEFAULT_EVENT_POOL_SIZE 16384
#define CLI_GLUSTERD_PORT 24007
#define DEFAULT_CLI_LOG_FILE_DIRECTORY DATADIR "/log/glusterfs"
#define CLI_VOL_STATUS_BRICK_LEN 43
#define CLI_TAB_LENGTH 8
#define CLI_BRICK_STATUS_LINE_LEN 78

/* Geo-rep command positional arguments' index  */
#define GEO_REP_CMD_INDEX 1
#define GEO_REP_CMD_CONFIG_INDEX 4

enum argp_option_keys {
    ARGP_DEBUG_KEY = 133,
    ARGP_PORT_KEY = 'p',
};

extern int cli_default_conn_timeout;
extern int cli_ten_minutes_timeout;

typedef enum {
    COLD_BRICK_COUNT,
    COLD_TYPE,
    COLD_DIST_COUNT,
    COLD_REPLICA_COUNT,
    COLD_ARBITER_COUNT,
    COLD_DISPERSE_COUNT,
    COLD_REDUNDANCY_COUNT,
    HOT_BRICK_COUNT,
    HOT_TYPE,
    HOT_REPLICA_COUNT,
    MAX
} values;

#define GLUSTER_MODE_SCRIPT (1 << 0)
#define GLUSTER_MODE_ERR_FATAL (1 << 1)
#define GLUSTER_MODE_XML (1 << 2)
#define GLUSTER_MODE_WIGNORE (1 << 3)
#define GLUSTER_MODE_WIGNORE_PARTITION (1 << 4)
#define GLUSTER_MODE_GLFSHEAL_NOLOG (1 << 5)

#define GLUSTERD_GET_QUOTA_LIST_MOUNT_PATH(abspath, volname, path)             \
    do {                                                                       \
        snprintf(abspath, sizeof(abspath) - 1,                                 \
                 DEFAULT_VAR_RUN_DIRECTORY "/%s_quota_list%s", volname, path); \
    } while (0)

struct cli_state;
struct cli_cmd_word;
struct cli_cmd_tree;
struct cli_cmd;

extern char *cli_vol_status_str[];
extern char *cli_vol_task_status_str[];

typedef int(cli_cmd_cbk_t)(struct cli_state *state, struct cli_cmd_word *word,
                           const char **words, int wordcount);
typedef void(cli_cmd_reg_cbk_t)(struct cli_cmd *this);

typedef int(cli_cmd_match_t)(struct cli_cmd_word *word);
typedef int(cli_cmd_filler_t)(struct cli_cmd_word *word);

struct cli_cmd_word {
    struct cli_cmd_tree *tree;
    const char *word;
    cli_cmd_filler_t *filler;
    cli_cmd_match_t *match;
    cli_cmd_cbk_t *cbkfn;
    const char *desc;
    const char *pattern;
    int nextwords_cnt;
    struct cli_cmd_word **nextwords;
};

struct cli_cmd_tree {
    struct cli_state *state;
    struct cli_cmd_word root;
};

struct cli_state {
    int argc;
    char **argv;

    char debug;

    /* for events dispatching */
    glusterfs_ctx_t *ctx;

    /* registry of known commands */
    struct cli_cmd_tree tree;

    /* the thread which "executes" the command in non-interactive mode */
    /* also the thread which reads from stdin in non-readline mode */
    pthread_t input;

    /* terminal I/O */
    const char *prompt;
    int rl_enabled;
    int rl_async;
    int rl_processing;

    /* autocompletion state */
    char **matches;
    char **matchesp;

    char *remote_host;
    int remote_port;
    int mode;
    int await_connected;

    char *log_file;
    gf_loglevel_t log_level;

    char *glusterd_sock;
    char *address_family;
};

struct cli_local {
    struct {
        char *volname;
        int flags;
    } get_vol;

    dict_t *dict;
    const char **words;
    /* Marker for volume status all */
    gf_boolean_t all;
#if (HAVE_LIB_XML)
    xmlTextWriterPtr writer;
    xmlDocPtr doc;
    int vol_count;
#endif
    gf_lock_t lock;
    struct list_head dict_list;
};

struct cli_volume_status {
    int port;
    int rdma_port;
    int online;
    uint64_t block_size;
    uint64_t total_inodes;
    uint64_t free_inodes;
    char *brick;
    char *pid_str;
    char *free;
    char *total;
    char *fs_name;
    char *mount_options;
    char *device;
    char *inode_size;
};

struct snap_config_opt_vals_ {
    char *op_name;
    char *question;
};

typedef struct cli_volume_status cli_volume_status_t;

typedef struct cli_local cli_local_t;

typedef ssize_t (*cli_serialize_t)(struct iovec outmsg, void *args);

extern struct cli_state *global_state; /* use only in readline callback */

typedef const char *(*cli_selector_t)(void *wcon);

char *
get_struct_variable(int mem_num, gf_gsync_status_t *sts_val);

void *
cli_getunamb(const char *tok, void **choices, cli_selector_t sel);

int
cli_cmd_register(struct cli_cmd_tree *tree, struct cli_cmd *cmd);
int
cli_cmds_register(struct cli_state *state);

int
cli_input_init(struct cli_state *state);

int
cli_cmd_process(struct cli_state *state, int argc, char *argv[]);
int
cli_cmd_process_line(struct cli_state *state, const char *line);

int
cli_rl_enable(struct cli_state *state);
int
cli_rl_out(struct cli_state *state, const char *fmt, va_list ap);
int
cli_rl_err(struct cli_state *state, const char *fmt, va_list ap);

int
cli_usage_out(const char *usage);

int
_cli_out(const char *fmt, ...);
int
_cli_err(const char *fmt, ...);

#define cli_out(fmt...)                                                        \
    do {                                                                       \
        FMT_WARN(fmt);                                                         \
                                                                               \
        _cli_out(fmt);                                                         \
                                                                               \
    } while (0)

#define cli_err(fmt...)                                                        \
    do {                                                                       \
        FMT_WARN(fmt);                                                         \
                                                                               \
        _cli_err(fmt);                                                         \
                                                                               \
    } while (0)

#define usage()                                                                \
    do {                                                                       \
        cli_out(                                                               \
            " Usage: gluster [options] <help> <peer>"                          \
            " <pool> <volume>\n"                                               \
            " Options:\n"                                                      \
            " --help  Shows the help information\n"                            \
            " --version  Shows the version\n"                                  \
            " --print-logdir  Shows the log directory\n"                       \
            " --print-statedumpdir Shows the state dump directory\n");         \
                                                                               \
    } while (0)

int
cli_submit_request(struct rpc_clnt *rpc, void *req, call_frame_t *frame,
                   rpc_clnt_prog_t *prog, int procnum, struct iobref *iobref,
                   xlator_t *this, fop_cbk_fn_t cbkfn, xdrproc_t xdrproc);

int32_t
cli_cmd_volume_create_parse(struct cli_state *state, const char **words,
                            int wordcount, dict_t **options, char **bricks);

int32_t
cli_cmd_volume_reset_parse(const char **words, int wordcount, dict_t **opt);

int32_t
cli_cmd_gsync_set_parse(struct cli_state *state, const char **words,
                        int wordcount, dict_t **opt, char **errstr);

int32_t
cli_cmd_quota_parse(const char **words, int wordcount, dict_t **opt);

int32_t
cli_cmd_inode_quota_parse(const char **words, int wordcount, dict_t **opt);

int32_t
cli_cmd_bitrot_parse(const char **words, int wordcount, dict_t **opt);

int32_t
cli_cmd_volume_set_parse(struct cli_state *state, const char **words,
                         int wordcount, dict_t **options, char **op_errstr);

int32_t
cli_cmd_ganesha_parse(struct cli_state *state, const char **words,
                      int wordcount, dict_t **options, char **op_errstr);

int32_t
cli_cmd_get_state_parse(struct cli_state *state, const char **words,
                        int wordcount, dict_t **options, char **op_errstr);

int32_t
cli_cmd_volume_add_brick_parse(struct cli_state *state, const char **words,
                               int wordcount, dict_t **options, int *type);

int32_t
cli_cmd_volume_remove_brick_parse(struct cli_state *state, const char **words,
                                  int wordcount, dict_t **options,
                                  int *question, int *brick_count,
                                  int32_t *command);

int32_t
cli_cmd_volume_replace_brick_parse(const char **words, int wordcount,
                                   dict_t **options);

int32_t
cli_cmd_volume_reset_brick_parse(const char **words, int wordcount,
                                 dict_t **options);

int32_t
cli_cmd_log_rotate_parse(const char **words, int wordcount, dict_t **options);
int32_t
cli_cmd_log_locate_parse(const char **words, int wordcount, dict_t **options);
int32_t
cli_cmd_log_filename_parse(const char **words, int wordcount, dict_t **options);

int32_t
cli_cmd_volume_statedump_options_parse(const char **words, int wordcount,
                                       dict_t **options);
int32_t
cli_cmd_volume_clrlks_opts_parse(const char **words, int wordcount,
                                 dict_t **options);

cli_local_t *
cli_local_get();

void
cli_local_wipe(cli_local_t *local);

int32_t
cli_cmd_await_connected();

int32_t
cli_cmd_broadcast_connected();

int
cli_rpc_notify(struct rpc_clnt *rpc, void *mydata, rpc_clnt_event_t event,
               void *data);

int32_t
cli_cmd_volume_profile_parse(const char **words, int wordcount,
                             dict_t **options);
int32_t
cli_cmd_volume_top_parse(const char **words, int wordcount, dict_t **options);

int32_t
cli_cmd_log_level_parse(const char **words, int wordcount, dict_t **options);

int32_t
cli_cmd_volume_status_parse(const char **words, int wordcount,
                            dict_t **options);

int
cli_cmd_volume_heal_options_parse(const char **words, int wordcount,
                                  dict_t **options);

int
cli_cmd_volume_defrag_parse(const char **words, int wordcount,
                            dict_t **options);

int
cli_print_brick_status(cli_volume_status_t *status);

void
cli_print_detailed_status(cli_volume_status_t *status);

int
cli_get_detail_status(dict_t *dict, int i, cli_volume_status_t *status);

void
cli_print_line(int len);

int
cli_xml_output_str(char *op, char *str, int op_ret, int op_errno,
                   char *op_errstr);

int
cli_xml_output_dict(char *op, dict_t *dict, int op_ret, int op_errno,
                    char *op_errstr);

int
cli_xml_output_vol_top(dict_t *dict, int op_ret, int op_errno, char *op_errstr);

int
cli_xml_output_vol_profile(dict_t *dict, int op_ret, int op_errno,
                           char *op_errstr);

int
cli_xml_output_vol_status_begin(cli_local_t *local, int op_ret, int op_errno,
                                char *op_errstr);

int
cli_xml_output_vol_status_end(cli_local_t *local);

int
cli_xml_output_vol_status(cli_local_t *local, dict_t *dict);

int
cli_xml_output_vol_list(dict_t *dict, int op_ret, int op_errno,
                        char *op_errstr);

int
cli_xml_output_vol_info_begin(cli_local_t *local, int op_ret, int op_errno,
                              char *op_errstr);

int
cli_xml_output_vol_info_end(cli_local_t *local);

int
cli_xml_output_vol_info(cli_local_t *local, dict_t *dict);

int
cli_xml_output_vol_quota_limit_list_begin(cli_local_t *local, int op_ret,
                                          int op_errno, char *op_errstr);
int
cli_xml_output_vol_quota_limit_list_end(cli_local_t *local);

int
cli_quota_list_xml_error(cli_local_t *local, char *path, char *errstr);

int
cli_quota_xml_output(cli_local_t *local, char *path, int64_t hl_str,
                     char *sl_final, int64_t sl_num, int64_t used,
                     int64_t avail, char *sl, char *hl, gf_boolean_t limit_set);

int
cli_quota_object_xml_output(cli_local_t *local, char *path, char *sl_str,
                            int64_t sl_val, quota_limits_t *limits,
                            quota_meta_t *used_space, int64_t avail, char *sl,
                            char *hl, gf_boolean_t limit_set);

int
cli_xml_output_peer_status(dict_t *dict, int op_ret, int op_errno,
                           char *op_errstr);

int
cli_xml_output_vol_rebalance(gf_cli_defrag_type op, dict_t *dict, int op_ret,
                             int op_errno, char *op_errstr);

int
cli_xml_output_vol_remove_brick(gf_boolean_t status_op, dict_t *dict,
                                int op_ret, int op_errno, char *op_errstr,
                                const char *op);

int
cli_xml_output_vol_replace_brick(dict_t *dict, int op_ret, int op_errno,
                                 char *op_errstr);

int
cli_xml_output_vol_create(dict_t *dict, int op_ret, int op_errno,
                          char *op_errstr);

int
cli_xml_output_generic_volume(char *op, dict_t *dict, int op_ret, int op_errno,
                              char *op_errstr);

int
cli_xml_output_vol_gsync(dict_t *dict, int op_ret, int op_errno,
                         char *op_errstr);
int
cli_xml_output_vol_status_tasks_detail(cli_local_t *local, dict_t *dict);

int
cli_xml_snapshot_delete(cli_local_t *local, dict_t *dict, gf_cli_rsp *rsp);

int
cli_xml_snapshot_begin_composite_op(cli_local_t *local);

int
cli_xml_snapshot_end_composite_op(cli_local_t *local);

int
cli_xml_output_snap_delete_begin(cli_local_t *local, int op_ret, int op_errno,
                                 char *op_errstr);
int
cli_xml_output_snap_delete_end(cli_local_t *local);

int
cli_xml_output_snap_status_begin(cli_local_t *local, int op_ret, int op_errno,
                                 char *op_errstr);
int
cli_xml_output_snap_status_end(cli_local_t *local);
int
cli_xml_output_snapshot(int cmd_type, dict_t *dict, int op_ret, int op_errno,
                        char *op_errstr);
int
cli_xml_snapshot_status_single_snap(cli_local_t *local, dict_t *dict,
                                    char *key);
int32_t
cli_cmd_snapshot_parse(const char **words, int wordcount, dict_t **options,
                       struct cli_state *state);

int
cli_xml_output_vol_getopts(dict_t *dict, int op_ret, int op_errno,
                           char *op_errstr);

void
print_quota_list_header(int type);

void
print_quota_list_empty(char *path, int type);

int
gf_gsync_status_t_comparator(const void *p, const void *q);
#endif /* __CLI_H__ */