Whamcloud - gitweb
LU-14628 ptlrpc: remove might_sleep() in sptlrpc_gc_del_sec()
[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  */
31
32 #ifndef __LINUX_FLD_H
33 #define __LINUX_FLD_H
34
35 /** \defgroup fld fld
36  *
37  * @{
38  */
39
40 #include <uapi/linux/lustre/lustre_idl.h>
41 #include <libcfs/libcfs.h>
42 #include <seq_range.h>
43 #include <lustre_fid.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 debugfs entry.
72          */
73         struct dentry           *lsf_debugfs_entry;
74
75         /**
76          * /fld file object device */
77         struct dt_object        *lsf_obj;
78
79         /**
80          * super sequence controller export, needed to forward fld
81          * lookup  request. */
82         struct obd_export       *lsf_control_exp;
83
84         /**
85          * Client FLD cache. */
86         struct fld_cache        *lsf_cache;
87
88         /**
89          * Protect index modifications */
90         struct mutex            lsf_lock;
91
92         /**
93          * Fld service name in form "fld-srv-lustre-MDTXXX"
94          */
95         char                    lsf_name[LUSTRE_MDT_MAXNAMELEN];
96
97         int (*lsf_seq_lookup)(const struct lu_env *env,
98                               struct lu_server_fld *fld, u64 seq,
99                               struct lu_seq_range *range);
100
101         /**
102          * Just reformatted or upgraded, and this flag is being
103          * used to check whether the local FLDB is needs to be
104          * synced with global FLDB(in MDT0), and it is only needed
105          * if the MDT is upgraded from < 2.6 to 2.6, i.e. when the
106          * local FLDB is being invited */
107         unsigned int             lsf_new:1;
108
109 };
110
111 struct lu_client_fld {
112         /**
113          * Client side debugfs entry.
114          */
115         struct dentry           *lcf_debugfs_entry;
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 debugfs entry name.
139          */
140         char                    lcf_name[LUSTRE_MDT_MAXNAMELEN];
141 };
142
143 /* Server methods */
144 int fld_server_init(const struct lu_env *env, struct lu_server_fld *fld,
145                     struct dt_device *dt, const char *prefix, int type);
146
147 void fld_server_fini(const struct lu_env *env, struct lu_server_fld *fld);
148
149 int fld_declare_server_create(const struct lu_env *env,
150                               struct lu_server_fld *fld,
151                               const struct lu_seq_range *range,
152                               struct thandle *th);
153
154 int fld_server_create(const struct lu_env *env,
155                       struct lu_server_fld *fld,
156                       const struct lu_seq_range *add_range,
157                       struct thandle *th);
158
159 int fld_insert_entry(const struct lu_env *env,
160                      struct lu_server_fld *fld,
161                      const struct lu_seq_range *range);
162
163 int fld_server_lookup(const struct lu_env *env, struct lu_server_fld *fld,
164                       u64 seq, struct lu_seq_range *range);
165
166 int fld_local_lookup(const struct lu_env *env, struct lu_server_fld *fld,
167                      u64 seq, struct lu_seq_range *range);
168
169 int fld_update_from_controller(const struct lu_env *env,
170                                struct lu_server_fld *fld);
171
172 /* Client methods */
173 int fld_client_init(struct lu_client_fld *fld,
174                     const char *prefix, int hash);
175
176 void fld_client_fini(struct lu_client_fld *fld);
177
178 void fld_client_flush(struct lu_client_fld *fld);
179
180 int fld_client_lookup(struct lu_client_fld *fld, u64 seq, u32 *mds,
181                       __u32 flags, const struct lu_env *env);
182
183 int fld_client_create(struct lu_client_fld *fld,
184                       struct lu_seq_range *range,
185                       const struct lu_env *env);
186
187 int fld_client_delete(struct lu_client_fld *fld, u64 seq,
188                       const struct lu_env *env);
189
190 int fld_client_add_target(struct lu_client_fld *fld,
191                           struct lu_fld_target *tar);
192
193 int fld_client_del_target(struct lu_client_fld *fld,
194                           __u64 idx);
195
196 void fld_client_debugfs_fini(struct lu_client_fld *fld);
197
198 /** @} fld */
199
200 #endif