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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/fld/fld_internal.h
34 * Subsystem Description:
35 * FLD is FID Location Database, which stores where (IE, on which MDT)
37 * The database is basically a record file, each record consists of a FID
38 * sequence range, MDT/OST index, and flags. The FLD for the whole FS
39 * is only stored on the sequence controller(MDT0) right now, but each target
40 * also has its local FLD, which only stores the local sequence.
42 * The FLD subsystem usually has two tasks:
43 * 1. maintain the database, i.e. when the sequence controller allocates
44 * new sequence ranges to some nodes, it will call the FLD API to insert the
45 * location information <sequence_range, node_index> in FLDB.
47 * 2. Handle requests from other nodes, i.e. if client needs to know where
48 * the FID is located, if it can not find the information in the local cache,
49 * it will send a FLD lookup RPC to the FLD service, and the FLD service will
50 * look up the FLDB entry and return the location information to client.
52 * Author: Yury Umanets <umka@clusterfs.com>
53 * Author: Tom WangDi <wangdi@clusterfs.com>
55 #ifndef __FLD_INTERNAL_H
56 #define __FLD_INTERNAL_H
59 #include <lustre/lustre_idl.h>
60 #include <libcfs/libcfs.h>
61 #include <lustre_fld.h>
68 typedef int (*fld_hash_func_t) (struct lu_client_fld *, __u64);
70 typedef struct lu_fld_target *
71 (*fld_scan_func_t) (struct lu_client_fld *, __u64);
75 fld_hash_func_t fh_hash_func;
76 fld_scan_func_t fh_scan_func;
79 struct fld_cache_entry {
80 struct list_head fce_lru;
81 struct list_head fce_list;
83 * fld cache entries are sorted on range->lsr_start field. */
84 struct lu_seq_range fce_range;
89 * Cache guard, protects fci_hash mostly because others immutable after
95 * Cache shrink threshold */
99 * Prefered number of cached entries */
103 * Current number of cached entries. Protected by \a fci_lock */
107 * LRU list fld entries. */
108 struct list_head fci_lru;
111 * sorted fld entries. */
112 struct list_head fci_entries_head;
115 * Cache statistics. */
116 struct fld_stats fci_stat;
119 * Cache name used for debug and messages. */
121 unsigned int fci_no_shrink:1;
125 /* 4M of FLD cache will not hurt client a lot. */
126 FLD_SERVER_CACHE_SIZE = (4 * 0x100000),
128 /* 1M of FLD cache will not hurt client a lot. */
129 FLD_CLIENT_CACHE_SIZE = (1 * 0x100000)
133 /* Cache threshold is 10 percent of size. */
134 FLD_SERVER_CACHE_THRESHOLD = 10,
136 /* Cache threshold is 10 percent of size. */
137 FLD_CLIENT_CACHE_THRESHOLD = 10
140 extern struct lu_fld_hash fld_hash[];
143 #ifdef CONFIG_PROC_FS
144 extern struct proc_dir_entry *fld_type_proc_dir;
145 extern struct lprocfs_vars fld_client_proc_list[];
148 # ifdef HAVE_SERVER_SUPPORT
149 struct fld_thread_info {
150 struct lu_seq_range fti_rec;
151 struct lu_seq_range fti_lrange;
152 struct lu_seq_range fti_irange;
155 extern struct lu_context_key fld_thread_key;
158 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
159 struct dt_device *dt, int type);
161 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
163 int fld_declare_index_create(const struct lu_env *env,
164 struct lu_server_fld *fld,
165 const struct lu_seq_range *new_range,
168 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
169 const struct lu_seq_range *new_range, struct thandle *th);
171 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
172 u64 seq, struct lu_seq_range *range);
174 int fld_name_to_index(const char *name, __u32 *index);
175 int fld_server_mod_init(void);
177 void fld_server_mod_exit(void);
179 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
180 struct lu_seq_range *range, void *data, int data_len);
181 #ifdef CONFIG_PROC_FS
182 extern const struct file_operations fld_proc_seq_fops;
183 extern struct lprocfs_vars fld_server_proc_list[];
186 # endif /* HAVE_SERVER_SUPPORT */
188 int fld_client_rpc(struct obd_export *exp,
189 struct lu_seq_range *range, __u32 fld_op,
190 struct ptlrpc_request **reqp);
192 struct fld_cache *fld_cache_init(const char *name,
193 int cache_size, int cache_threshold);
195 void fld_cache_fini(struct fld_cache *cache);
197 void fld_cache_flush(struct fld_cache *cache);
199 int fld_cache_insert(struct fld_cache *cache,
200 const struct lu_seq_range *range);
202 struct fld_cache_entry
203 *fld_cache_entry_create(const struct lu_seq_range *range);
205 int fld_cache_insert_nolock(struct fld_cache *cache,
206 struct fld_cache_entry *f_new);
207 void fld_cache_delete(struct fld_cache *cache,
208 const struct lu_seq_range *range);
209 void fld_cache_delete_nolock(struct fld_cache *cache,
210 const struct lu_seq_range *range);
211 int fld_cache_lookup(struct fld_cache *cache,
212 const u64 seq, struct lu_seq_range *range);
214 struct fld_cache_entry *
215 fld_cache_entry_lookup(struct fld_cache *cache,
216 const struct lu_seq_range *range);
218 void fld_cache_entry_delete(struct fld_cache *cache,
219 struct fld_cache_entry *node);
221 struct fld_cache_entry *
222 fld_cache_entry_lookup_nolock(struct fld_cache *cache,
223 const struct lu_seq_range *range);
225 static inline const char *
226 fld_target_name(const struct lu_fld_target *tar)
228 #ifdef HAVE_SERVER_SUPPORT
229 if (tar->ft_srv != NULL)
230 return tar->ft_srv->lsf_name;
233 return tar->ft_exp->exp_obd->obd_name;
236 #endif /* __FLD_INTERNAL_H */