summaryrefslogtreecommitdiffstats
path: root/extras/create_new_xlator/new-xlator-tmpl.c
blob: 9bb9aa6e4bc46ae53b65bc3166de90263eebc5df (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
#pragma fragment CBK_TEMPLATE
int32_t @FOP_PREFIX @_ @NAME
    @_cbk(call_frame_t *frame, void *cookie, xlator_t *this, int32_t op_ret,
          int32_t op_errno, @UNWIND_PARAMS @)
{
    STACK_UNWIND_STRICT(@NAME @, frame, op_ret, op_errno, @UNWIND_ARGS @);
    return 0;
}

#pragma fragment COMMENT
If you are generating the leaf xlators, remove the STACK_WIND and replace the
    @ERROR_ARGS @to @UNWIND_ARGS @ if necessary

#pragma fragment FOP_TEMPLATE
        int32_t @FOP_PREFIX @_ @NAME
    @(call_frame_t *frame, xlator_t *this, @WIND_PARAMS @)
{
    STACK_WIND(frame, @FOP_PREFIX @_ @NAME @_cbk, FIRST_CHILD(this),
               FIRST_CHILD(this)->fops->@NAME @, @WIND_ARGS @);
    return 0;
err:
    STACK_UNWIND_STRICT(@NAME @, frame, -1, errno, @ERROR_ARGS @);
    return 0;
}

#pragma fragment FUNC_TEMPLATE
@RET_TYPE @ @FOP_PREFIX @_ @NAME @(@FUNC_PARAMS @)
{
    return @RET_VAR @;
}

#pragma fragment CP
/*
 *   Copyright (c) @CURRENT_YEAR@ 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.
 */

#pragma fragment INCLUDE_IN_SRC_FILE
#include "@XL_NAME@.h"

#pragma fragment XLATOR_METHODS

static int32_t @FOP_PREFIX @_init(xlator_t *this)
{
    return 0;
}

static void @FOP_PREFIX @_fini(xlator_t *this)
{
    return;
}

static int32_t @FOP_PREFIX @_reconfigure(xlator_t *this, dict_t *dict)
{
    return 0;
}

static int @FOP_PREFIX @_notify(xlator_t *this, int event, void *data, ...)
{
    return default_notify(this, event, data);
}

static int32_t @FOP_PREFIX @_mem_acct_init(xlator_t *this)
{
    int ret = -1;

    ret = xlator_mem_acct_init(this, gf_ @FOP_PREFIX @_mt_end + 1);
    return ret;
}

static int32_t @FOP_PREFIX @_dump_metrics(xlator_t *this, int fd)
{
    return 0;
}

struct volume_options @FOP_PREFIX @_options[] = {
    /*{ .key  = {""},
      .type = GF_OPTION_TYPE_BOOL,
      .default_value = "",
      .op_version = {GD_OP_VERSION_},
      .flags = OPT_FLAG_SETTABLE | OPT_FLAG_DOC | OPT_FLAG_CLIENT_OPT,
      .tags = {""},
      .description = "",
      .category = GF_EXPERIMENTAL,
    },
    { .key = {NULL} },
    */
};

xlator_api_t xlator_api = {
    .init = @FOP_PREFIX @_init,
    .fini = @FOP_PREFIX @_fini,
    .notify = @FOP_PREFIX @_notify,
    .reconfigure = @FOP_PREFIX @_reconfigure,
    .mem_acct_init = @FOP_PREFIX @_mem_acct_init,
    .dump_metrics = @FOP_PREFIX @_dump_metrics,
    .op_version = {GD_OP_VERSION_},
    .dumpops = &@FOP_PREFIX @_dumpops,
    .fops = &@FOP_PREFIX @_fops,
    .cbks = &@FOP_PREFIX @_cbks,
    .options = @FOP_PREFIX @_options,
    .identifier = "@XL_NAME@",
    .category = GF_EXPERIMENTAL,
};
#pragma fragment HEADER_FMT
#ifndef __ @HFL_NAME @_H__
#define __ @HFL_NAME @_H__

#include "@XL_NAME@-mem-types.h"
#include "@XL_NAME@-messages.h"
#include <glusterfs/glusterfs.h>
#include <glusterfs/xlator.h>
#include <glusterfs/defaults.h>

#endif /* __@HFL_NAME@_H__ */

#pragma fragment MEM_HEADER_FMT
#ifndef __ @HFL_NAME @_H__
#define __ @HFL_NAME @_H__

#include <glusterfs/mem-types.h>

enum gf_mdc_mem_types_ {
    gf_ @FOP_PREFIX @_mt_ = gf_common_mt_end + 1,
    gf_ @FOP_PREFIX @_mt_end
};

#endif /* __@HFL_NAME@_H__ */

#pragma fragment MSG_HEADER_FMT
#ifndef __ @HFL_NAME @_H__
#define __ @HFL_NAME @_H__

#include <glusterfs/glfs-message-id.h>

/* To add new message IDs, append new identifiers at the end of the list.
 *
 * Never remove a message ID. If it's not used anymore, you can rename it or
 * leave it as it is, but not delete it. This is to prevent reutilization of
 * IDs by other messages.
 *
 * The component name must match one of the entries defined in
 * glfs-message-id.h.
 */

GLFS_MSGID(@FOP_PREFIX @, @FOP_PREFIX @_MSG_NO_MEMORY);

#endif /* __@HFL_NAME@_H__ */