Whamcloud - gitweb
LU-9611 lod: allow -1 for default stripe count/offset
[fs/lustre-release.git] / lustre / include / lustre_fld.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2015, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef __LINUX_FLD_H
34 #define __LINUX_FLD_H
35
36 /** \defgroup fld fld
37  *
38  * @{
39  */
40
41 #include <lustre/lustre_idl.h>
42 #include <libcfs/libcfs.h>
43 #include <seq_range.h>
44
45 struct lu_env;
46 struct lu_client_fld;
47 struct lu_server_fld;
48 struct lu_fld_hash;
49 struct fld_cache;
50 struct thandle;
51 struct dt_device;
52 struct dt_object;
53
54 /*
55  * FLD (Fid Location Database) interface.
56  */
57 enum {
58         LUSTRE_CLI_FLD_HASH_DHT = 0,
59         LUSTRE_CLI_FLD_HASH_RRB
60 };
61
62 struct lu_fld_target {
63         struct list_head        ft_chain;
64         struct obd_export      *ft_exp;
65         struct lu_server_fld   *ft_srv;
66         __u64                   ft_idx;
67 };
68
69 struct lu_server_fld {
70         /**
71          * Fld dir proc entry. */
72         struct proc_dir_entry   *lsf_proc_dir;
73
74         /**
75          * /fld file object device */
76         struct dt_object        *lsf_obj;
77
78         /**
79          * super sequence controller export, needed to forward fld
80          * lookup  request. */
81         struct obd_export       *lsf_control_exp;
82
83         /**
84          * Client FLD cache. */
85         struct fld_cache        *lsf_cache;
86
87         /**
88          * Protect index modifications */
89         struct mutex            lsf_lock;
90
91         /**
92          * Fld service name in form "fld-srv-lustre-MDTXXX" */
93         char                     lsf_name[80];
94
95         int (*lsf_seq_lookup)(const struct lu_env *env,
96                               struct lu_server_fld *fld, u64 seq,
97                               struct lu_seq_range *range);
98
99         /**
100          * Just reformatted or upgraded, and this flag is being
101          * used to check whether the local FLDB is needs to be
102          * synced with global FLDB(in MDT0), and it is only needed
103          * if the MDT is upgraded from < 2.6 to 2.6, i.e. when the
104          * local FLDB is being invited */
105         unsigned int             lsf_new:1;
106
107 };
108
109 struct lu_client_fld {
110         /**
111          * Client side proc entry. */
112         struct proc_dir_entry   *lcf_proc_dir;
113
114         /**
115          * List of exports client FLD knows about. */
116         struct list_head        lcf_targets;
117
118         /**
119          * Current hash to be used to chose an export. */
120         struct lu_fld_hash      *lcf_hash;
121
122         /**
123          * Exports count. */
124         int                      lcf_count;
125
126         /**
127          * Lock protecting exports list and fld_hash. */
128         spinlock_t               lcf_lock;
129
130         /**
131          * Client FLD cache. */
132         struct fld_cache        *lcf_cache;
133
134         /**
135          * Client fld proc entry name. */
136         char                     lcf_name[80];
137 };
138
139 /* Server methods */
140 int fld_server_init(const struct lu_env *env, struct lu_server_fld *fld,
141                     struct dt_device *dt, const char *prefix, int type);
142
143 void fld_server_fini(const struct lu_env *env, struct lu_server_fld *fld);
144
145 int fld_declare_server_create(const struct lu_env *env,
146                               struct lu_server_fld *fld,
147                               const struct lu_seq_range *range,
148                               struct thandle *th);
149
150 int fld_server_create(const struct lu_env *env,
151                       struct lu_server_fld *fld,
152                       const struct lu_seq_range *add_range,
153                       struct thandle *th);
154
155 int fld_insert_entry(const struct lu_env *env,
156                      struct lu_server_fld *fld,
157                      const struct lu_seq_range *range);
158
159 int fld_server_lookup(const struct lu_env *env, struct lu_server_fld *fld,
160                       u64 seq, struct lu_seq_range *range);
161
162 int fld_local_lookup(const struct lu_env *env, struct lu_server_fld *fld,
163                      u64 seq, struct lu_seq_range *range);
164
165 int fld_update_from_controller(const struct lu_env *env,
166                                struct lu_server_fld *fld);
167
168 /* Client methods */
169 int fld_client_init(struct lu_client_fld *fld,
170                     const char *prefix, int hash);
171
172 void fld_client_fini(struct lu_client_fld *fld);
173
174 void fld_client_flush(struct lu_client_fld *fld);
175
176 int fld_client_lookup(struct lu_client_fld *fld, u64 seq, u32 *mds,
177                       __u32 flags, const struct lu_env *env);
178
179 int fld_client_create(struct lu_client_fld *fld,
180                       struct lu_seq_range *range,
181                       const struct lu_env *env);
182
183 int fld_client_delete(struct lu_client_fld *fld, u64 seq,
184                       const struct lu_env *env);
185
186 int fld_client_add_target(struct lu_client_fld *fld,
187                           struct lu_fld_target *tar);
188
189 int fld_client_del_target(struct lu_client_fld *fld,
190                           __u64 idx);
191
192 void fld_client_proc_fini(struct lu_client_fld *fld);
193
194 /** @} fld */
195
196 #endif