Whamcloud - gitweb
LU-6540 test: fix no %s specifier for the file
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef __LINUX_FLD_H
38 #define __LINUX_FLD_H
39
40 /** \defgroup fld fld
41  *
42  * @{
43  */
44
45 #include <lustre/lustre_idl.h>
46 #include <libcfs/libcfs.h>
47
48 struct lu_env;
49 struct lu_client_fld;
50 struct lu_server_fld;
51 struct lu_fld_hash;
52 struct fld_cache;
53 struct thandle;
54 struct dt_device;
55 struct dt_object;
56
57 /*
58  * FLD (Fid Location Database) interface.
59  */
60 enum {
61         LUSTRE_CLI_FLD_HASH_DHT = 0,
62         LUSTRE_CLI_FLD_HASH_RRB
63 };
64
65 struct lu_fld_target {
66         struct list_head        ft_chain;
67         struct obd_export      *ft_exp;
68         struct lu_server_fld   *ft_srv;
69         __u64                   ft_idx;
70 };
71
72 struct lu_server_fld {
73         /**
74          * Fld dir proc entry. */
75         struct proc_dir_entry   *lsf_proc_dir;
76
77         /**
78          * /fld file object device */
79         struct dt_object        *lsf_obj;
80
81         /**
82          * super sequence controller export, needed to forward fld
83          * lookup  request. */
84         struct obd_export       *lsf_control_exp;
85
86         /**
87          * Client FLD cache. */
88         struct fld_cache        *lsf_cache;
89
90         /**
91          * Protect index modifications */
92         struct mutex            lsf_lock;
93
94         /**
95          * Fld service name in form "fld-srv-lustre-MDTXXX" */
96         char                     lsf_name[80];
97
98         int (*lsf_seq_lookup)(const struct lu_env *env,
99                               struct lu_server_fld *fld, u64 seq,
100                               struct lu_seq_range *range);
101
102         /**
103          * Just reformatted or upgraded, and this flag is being
104          * used to check whether the local FLDB is needs to be
105          * synced with global FLDB(in MDT0), and it is only needed
106          * if the MDT is upgraded from < 2.6 to 2.6, i.e. when the
107          * local FLDB is being invited */
108         unsigned int             lsf_new:1;
109
110 };
111
112 struct lu_client_fld {
113         /**
114          * Client side proc entry. */
115         struct proc_dir_entry   *lcf_proc_dir;
116
117         /**
118          * List of exports client FLD knows about. */
119         struct list_head        lcf_targets;
120
121         /**
122          * Current hash to be used to chose an export. */
123         struct lu_fld_hash      *lcf_hash;
124
125         /**
126          * Exports count. */
127         int                      lcf_count;
128
129         /**
130          * Lock protecting exports list and fld_hash. */
131         spinlock_t               lcf_lock;
132
133         /**
134          * Client FLD cache. */
135         struct fld_cache        *lcf_cache;
136
137         /**
138          * Client fld proc entry name. */
139         char                     lcf_name[80];
140
141         int                      lcf_flags;
142 };
143
144 /* Server methods */
145 int fld_server_init(const struct lu_env *env, struct lu_server_fld *fld,
146                     struct dt_device *dt, const char *prefix, int type);
147
148 void fld_server_fini(const struct lu_env *env, struct lu_server_fld *fld);
149
150 int fld_declare_server_create(const struct lu_env *env,
151                               struct lu_server_fld *fld,
152                               const struct lu_seq_range *range,
153                               struct thandle *th);
154
155 int fld_server_create(const struct lu_env *env,
156                       struct lu_server_fld *fld,
157                       const struct lu_seq_range *add_range,
158                       struct thandle *th);
159
160 int fld_insert_entry(const struct lu_env *env,
161                      struct lu_server_fld *fld,
162                      const struct lu_seq_range *range);
163
164 int fld_server_lookup(const struct lu_env *env, struct lu_server_fld *fld,
165                       u64 seq, struct lu_seq_range *range);
166
167 int fld_local_lookup(const struct lu_env *env, struct lu_server_fld *fld,
168                      u64 seq, struct lu_seq_range *range);
169
170 int fld_update_from_controller(const struct lu_env *env,
171                                struct lu_server_fld *fld);
172
173 /* Client methods */
174 int fld_client_init(struct lu_client_fld *fld,
175                     const char *prefix, int hash);
176
177 void fld_client_fini(struct lu_client_fld *fld);
178
179 void fld_client_flush(struct lu_client_fld *fld);
180
181 int fld_client_lookup(struct lu_client_fld *fld, u64 seq, u32 *mds,
182                       __u32 flags, const struct lu_env *env);
183
184 int fld_client_create(struct lu_client_fld *fld,
185                       struct lu_seq_range *range,
186                       const struct lu_env *env);
187
188 int fld_client_delete(struct lu_client_fld *fld, u64 seq,
189                       const struct lu_env *env);
190
191 int fld_client_add_target(struct lu_client_fld *fld,
192                           struct lu_fld_target *tar);
193
194 int fld_client_del_target(struct lu_client_fld *fld,
195                           __u64 idx);
196
197 void fld_client_proc_fini(struct lu_client_fld *fld);
198
199 /** @} fld */
200
201 #endif