Whamcloud - gitweb
LU-8468 kernel: kernel update RHEL7.2 [3.10.0-327.28.2.el7]
[fs/lustre-release.git] / lustre / fld / fld_internal.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) 2012, 2015, 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  * lustre/fld/fld_internal.h
37  *
38  * Subsystem Description:
39  * FLD is FID Location Database, which stores where (IE, on which MDT)
40  * FIDs are located.
41  * The database is basically a record file, each record consists of a FID
42  * sequence range, MDT/OST index, and flags. The FLD for the whole FS
43  * is only stored on the sequence controller(MDT0) right now, but each target
44  * also has its local FLD, which only stores the local sequence.
45  *
46  * The FLD subsystem usually has two tasks:
47  * 1. maintain the database, i.e. when the sequence controller allocates
48  * new sequence ranges to some nodes, it will call the FLD API to insert the
49  * location information <sequence_range, node_index> in FLDB.
50  *
51  * 2. Handle requests from other nodes, i.e. if client needs to know where
52  * the FID is located, if it can not find the information in the local cache,
53  * it will send a FLD lookup RPC to the FLD service, and the FLD service will
54  * look up the FLDB entry and return the location information to client.
55  *
56  * Author: Yury Umanets <umka@clusterfs.com>
57  * Author: Tom WangDi <wangdi@clusterfs.com>
58  */
59 #ifndef __FLD_INTERNAL_H
60 #define __FLD_INTERNAL_H
61
62 #include <obd.h>
63 #include <lustre/lustre_idl.h>
64 #include <libcfs/libcfs.h>
65 #include <lustre_fld.h>
66
67 struct fld_stats {
68         __u64   fst_count;
69         __u64   fst_cache;
70 };
71
72 typedef int (*fld_hash_func_t) (struct lu_client_fld *, __u64);
73
74 typedef struct lu_fld_target *
75 (*fld_scan_func_t) (struct lu_client_fld *, __u64);
76
77 struct lu_fld_hash {
78         const char              *fh_name;
79         fld_hash_func_t          fh_hash_func;
80         fld_scan_func_t          fh_scan_func;
81 };
82
83 struct fld_cache_entry {
84         struct list_head        fce_lru;
85         struct list_head        fce_list;
86         /**
87          * fld cache entries are sorted on range->lsr_start field. */
88         struct lu_seq_range     fce_range;
89 };
90
91 struct fld_cache {
92         /**
93          * Cache guard, protects fci_hash mostly because others immutable after
94          * init is finished.
95          */
96         rwlock_t                 fci_lock;
97
98         /**
99          * Cache shrink threshold */
100         int                      fci_threshold;
101
102         /**
103          * Prefered number of cached entries */
104         int                      fci_cache_size;
105
106         /**
107          * Current number of cached entries. Protected by \a fci_lock */
108         int                      fci_cache_count;
109
110         /**
111          * LRU list fld entries. */
112         struct list_head        fci_lru;
113
114         /**
115          * sorted fld entries. */
116         struct list_head        fci_entries_head;
117
118         /**
119          * Cache statistics. */
120         struct fld_stats         fci_stat;
121
122         /**
123          * Cache name used for debug and messages. */
124         char                     fci_name[80];
125         unsigned int             fci_no_shrink:1;
126 };
127
128 enum {
129         /* 4M of FLD cache will not hurt client a lot. */
130         FLD_SERVER_CACHE_SIZE      = (4 * 0x100000),
131
132         /* 1M of FLD cache will not hurt client a lot. */
133         FLD_CLIENT_CACHE_SIZE      = (1 * 0x100000)
134 };
135
136 enum {
137         /* Cache threshold is 10 percent of size. */
138         FLD_SERVER_CACHE_THRESHOLD = 10,
139
140         /* Cache threshold is 10 percent of size. */
141         FLD_CLIENT_CACHE_THRESHOLD = 10
142 };
143
144 extern struct lu_fld_hash fld_hash[];
145
146
147 #ifdef CONFIG_PROC_FS
148 extern struct proc_dir_entry *fld_type_proc_dir;
149 extern struct lprocfs_vars fld_client_proc_list[];
150 #endif
151
152 # ifdef HAVE_SERVER_SUPPORT
153 struct fld_thread_info {
154         struct lu_seq_range fti_rec;
155         struct lu_seq_range fti_lrange;
156         struct lu_seq_range fti_irange;
157 };
158
159 extern struct lu_context_key fld_thread_key;
160
161 struct dt_device;
162 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
163                    struct dt_device *dt, int type);
164
165 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
166
167 int fld_declare_index_create(const struct lu_env *env,
168                              struct lu_server_fld *fld,
169                              const struct lu_seq_range *new_range,
170                              struct thandle *th);
171
172 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
173                      const struct lu_seq_range *new_range, struct thandle *th);
174
175 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
176                      u64 seq, struct lu_seq_range *range);
177
178 int fld_name_to_index(const char *name, __u32 *index);
179 int fld_server_mod_init(void);
180
181 void fld_server_mod_exit(void);
182
183 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
184                     struct lu_seq_range *range, void *data, int data_len);
185 #ifdef CONFIG_PROC_FS
186 extern const struct file_operations fld_proc_seq_fops;
187 extern struct lprocfs_vars fld_server_proc_list[];
188 #endif
189
190 # endif /* HAVE_SERVER_SUPPORT */
191
192 int fld_client_rpc(struct obd_export *exp,
193                    struct lu_seq_range *range, __u32 fld_op,
194                    struct ptlrpc_request **reqp);
195
196 struct fld_cache *fld_cache_init(const char *name,
197                                  int cache_size, int cache_threshold);
198
199 void fld_cache_fini(struct fld_cache *cache);
200
201 void fld_cache_flush(struct fld_cache *cache);
202
203 int fld_cache_insert(struct fld_cache *cache,
204                      const struct lu_seq_range *range);
205
206 struct fld_cache_entry
207 *fld_cache_entry_create(const struct lu_seq_range *range);
208
209 int fld_cache_insert_nolock(struct fld_cache *cache,
210                             struct fld_cache_entry *f_new);
211 void fld_cache_delete(struct fld_cache *cache,
212                       const struct lu_seq_range *range);
213 void fld_cache_delete_nolock(struct fld_cache *cache,
214                              const struct lu_seq_range *range);
215 int fld_cache_lookup(struct fld_cache *cache,
216                      const u64 seq, struct lu_seq_range *range);
217
218 struct fld_cache_entry *
219 fld_cache_entry_lookup(struct fld_cache *cache,
220                        const struct lu_seq_range *range);
221
222 void fld_cache_entry_delete(struct fld_cache *cache,
223                             struct fld_cache_entry *node);
224
225 struct fld_cache_entry *
226 fld_cache_entry_lookup_nolock(struct fld_cache *cache,
227                               const struct lu_seq_range *range);
228
229 static inline const char *
230 fld_target_name(const struct lu_fld_target *tar)
231 {
232 #ifdef HAVE_SERVER_SUPPORT
233         if (tar->ft_srv != NULL)
234                 return tar->ft_srv->lsf_name;
235 #endif
236
237         return tar->ft_exp->exp_obd->obd_name;
238 }
239
240 #endif /* __FLD_INTERNAL_H */