summaryrefslogtreecommitdiffstats
path: root/xlators/playground/template/src/template.c
blob: 4a9e8d2e6f32f4eea72fc01ed3bb7683c2fbb42b (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
/*
   Copyright (c) 2006-2018 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 "template.h"
#include "statedump.h"

static int32_t
template_mem_acct_init(xlator_t *this)
{
    int ret = -1;

    GF_VALIDATE_OR_GOTO("template", this, out);

    ret = xlator_mem_acct_init(this, gf_template_mt_end + 1);

    if (ret != 0) {
        gf_msg(this->name, GF_LOG_ERROR, ENOMEM, TEMPLATE_MSG_NO_MEMORY,
               "Memory accounting init failed");
        goto out;
    }

    ret = 0;
out:
    return ret;
}

static int32_t
template_priv_to_dict(xlator_t *this, dict_t *dict, char *brickname)
{
    int ret = 0;
    template_private_t *priv = NULL;

    priv = this->private;
    ret = dict_set_uint64(dict, "template.dummy", priv->dummy);
    if (ret)
        gf_msg_debug(this->name, ENOMEM, "dict_set of dummy key failed");

    return 0;
}

static int32_t
template_priv(xlator_t *this)
{
    template_private_t *priv = NULL;

    priv = this->private;
    gf_proc_dump_write("template.dummy", "%lu", priv->dummy);

    return 0;
}

static int32_t
template_dump_metrics(xlator_t *this, int fd)
{
    template_private_t *priv = NULL;

    priv = this->private;
    /* NOTE: currently this is adding private variable, which can
       be constant here. But in reality, things which are changing
       can be added here, so we get to plot them on graph. */
    dprintf(fd, "%s.private.dummy %d\n", this->name, priv->dummy);

    return 0;
}

static int32_t
template_init(xlator_t *this)
{
    int ret = -1;
    template_private_t *priv = NULL;

    if (!this->children || this->children->next) {
        gf_msg(this->name, GF_LOG_ERROR, EINVAL, TEMPLATE_MSG_NO_GRAPH,
               "not configured with exactly one child. exiting");
        goto out;
    }

    if (!this->parents) {
        gf_msg(this->name, GF_LOG_ERROR, EINVAL, TEMPLATE_MSG_NO_GRAPH,
               "dangling volume. check volfile ");
        goto out;
    }

    priv = GF_CALLOC(1, sizeof(template_private_t), gf_template_mt_private_t);
    if (!priv) {
        gf_msg(this->name, GF_LOG_ERROR, ENOMEM, TEMPLATE_MSG_NO_MEMORY,
               "priv allocation failed");
        goto out;
    }

    GF_OPTION_INIT("dummy", priv->dummy, int32, out);

    this->private = priv;
    priv = NULL;
    ret = 0;

out:
    if (priv)
        GF_FREE(priv);

    return ret;
}

static int
template_reconfigure(xlator_t *this, dict_t *options)
{
    int ret = -1;
    template_private_t *priv = NULL;

    priv = this->private;

    GF_OPTION_RECONF("dummy", priv->dummy, options, int32, out);

    ret = 0;
out:
    return ret;
}

static void
template_fini(xlator_t *this)
{
    template_private_t *priv = NULL;

    priv = this->private;
    this->private = NULL;

    GF_FREE(priv);
}

static int
template_notify(xlator_t *this, int32_t event, void *data, ...)
{
    switch (event) {
        default:
            default_notify(this, event, data);
            gf_msg_debug(this->name, 0, "event %d received", event);
    }

    return 0;
}

struct xlator_fops template_fops = {};

struct xlator_cbks template_cbks = {};

struct xlator_dumpops template_dumpops = {
    .priv = template_priv,
    .priv_to_dict = template_priv_to_dict,
};

struct volume_options template_options[] = {
    {
        .key = {"dummy"},
        .type = GF_OPTION_TYPE_INT,
        .min = 1,
        .max = 1024,
        .default_value = "1",
        .description = "a dummy option to show how to set the option",
        .op_version = {GD_OP_VERSION_5_0},
        .flags = OPT_FLAG_SETTABLE | OPT_FLAG_DOC,
        .level = OPT_STATUS_EXPERIMENTAL,
        .tags = {"development", "experimental", "template"},
    },
    {.key = {NULL}},
};

xlator_api_t xlator_api = {
    .init = template_init,
    .fini = template_fini,
    .notify = template_notify,
    .reconfigure = template_reconfigure,
    .mem_acct_init = template_mem_acct_init,
    .dump_metrics = template_dump_metrics,
    .op_version = {GD_OP_VERSION_5_0},
    .dumpops = &template_dumpops,
    .fops = &template_fops,
    .cbks = &template_cbks,
    .options = template_options,
    .identifier = "template",
};