4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/fld/fld_internal.h
38 * Subsystem Description:
39 * FLD is FID Location Database, which stores where (IE, on which MDT)
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.
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.
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.
56 * Author: Yury Umanets <umka@clusterfs.com>
57 * Author: Tom WangDi <wangdi@clusterfs.com>
59 #ifndef __FLD_INTERNAL_H
60 #define __FLD_INTERNAL_H
63 #include <lustre/lustre_idl.h>
64 #include <libcfs/libcfs.h>
65 #include <lustre_fld.h>
68 LUSTRE_FLD_INIT = 1 << 0,
69 LUSTRE_FLD_RUN = 1 << 1
77 typedef int (*fld_hash_func_t) (struct lu_client_fld *, __u64);
79 typedef struct lu_fld_target *
80 (*fld_scan_func_t) (struct lu_client_fld *, __u64);
84 fld_hash_func_t fh_hash_func;
85 fld_scan_func_t fh_scan_func;
88 struct fld_cache_entry {
89 struct list_head fce_lru;
90 struct list_head fce_list;
92 * fld cache entries are sorted on range->lsr_start field. */
93 struct lu_seq_range fce_range;
98 * Cache guard, protects fci_hash mostly because others immutable after
104 * Cache shrink threshold */
108 * Prefered number of cached entries */
112 * Current number of cached entries. Protected by \a fci_lock */
116 * LRU list fld entries. */
117 struct list_head fci_lru;
120 * sorted fld entries. */
121 struct list_head fci_entries_head;
124 * Cache statistics. */
125 struct fld_stats fci_stat;
128 * Cache name used for debug and messages. */
130 unsigned int fci_no_shrink:1;
134 /* 4M of FLD cache will not hurt client a lot. */
135 FLD_SERVER_CACHE_SIZE = (4 * 0x100000),
137 /* 1M of FLD cache will not hurt client a lot. */
138 FLD_CLIENT_CACHE_SIZE = (1 * 0x100000)
142 /* Cache threshold is 10 percent of size. */
143 FLD_SERVER_CACHE_THRESHOLD = 10,
145 /* Cache threshold is 10 percent of size. */
146 FLD_CLIENT_CACHE_THRESHOLD = 10
149 extern struct lu_fld_hash fld_hash[];
153 extern struct proc_dir_entry *fld_type_proc_dir;
154 extern struct lprocfs_seq_vars fld_client_proc_list[];
157 # ifdef HAVE_SERVER_SUPPORT
158 struct fld_thread_info {
159 struct lu_seq_range fti_rec;
160 struct lu_seq_range fti_lrange;
161 struct lu_seq_range fti_irange;
164 extern struct lu_context_key fld_thread_key;
167 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
168 struct dt_device *dt, int type);
170 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
172 int fld_declare_index_create(const struct lu_env *env,
173 struct lu_server_fld *fld,
174 const struct lu_seq_range *new_range,
177 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
178 const struct lu_seq_range *new_range, struct thandle *th);
180 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
181 u64 seq, struct lu_seq_range *range);
183 int fld_name_to_index(const char *name, __u32 *index);
184 int fld_server_mod_init(void);
186 void fld_server_mod_exit(void);
188 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
189 struct lu_seq_range *range, void *data, int data_len);
191 extern const struct file_operations fld_proc_seq_fops;
192 extern struct lprocfs_seq_vars fld_server_proc_list[];
195 # endif /* HAVE_SERVER_SUPPORT */
197 int fld_client_rpc(struct obd_export *exp,
198 struct lu_seq_range *range, __u32 fld_op,
199 struct ptlrpc_request **reqp);
201 struct fld_cache *fld_cache_init(const char *name,
202 int cache_size, int cache_threshold);
204 void fld_cache_fini(struct fld_cache *cache);
206 void fld_cache_flush(struct fld_cache *cache);
208 int fld_cache_insert(struct fld_cache *cache,
209 const struct lu_seq_range *range);
211 struct fld_cache_entry
212 *fld_cache_entry_create(const struct lu_seq_range *range);
214 int fld_cache_insert_nolock(struct fld_cache *cache,
215 struct fld_cache_entry *f_new);
216 void fld_cache_delete(struct fld_cache *cache,
217 const struct lu_seq_range *range);
218 void fld_cache_delete_nolock(struct fld_cache *cache,
219 const struct lu_seq_range *range);
220 int fld_cache_lookup(struct fld_cache *cache,
221 const u64 seq, struct lu_seq_range *range);
223 struct fld_cache_entry *
224 fld_cache_entry_lookup(struct fld_cache *cache,
225 const struct lu_seq_range *range);
227 void fld_cache_entry_delete(struct fld_cache *cache,
228 struct fld_cache_entry *node);
230 struct fld_cache_entry *
231 fld_cache_entry_lookup_nolock(struct fld_cache *cache,
232 const struct lu_seq_range *range);
234 static inline const char *
235 fld_target_name(const struct lu_fld_target *tar)
237 #ifdef HAVE_SERVER_SUPPORT
238 if (tar->ft_srv != NULL)
239 return tar->ft_srv->lsf_name;
242 return tar->ft_exp->exp_obd->obd_name;
245 #endif /* __FLD_INTERNAL_H */