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 <libcfs/libcfs.h>
60 #include <lustre_fld.h>
67 typedef int (*fld_hash_func_t) (struct lu_client_fld *, __u64);
69 typedef struct lu_fld_target *
70 (*fld_scan_func_t) (struct lu_client_fld *, __u64);
74 fld_hash_func_t fh_hash_func;
75 fld_scan_func_t fh_scan_func;
78 struct fld_cache_entry {
79 struct list_head fce_lru;
80 struct list_head fce_list;
82 * fld cache entries are sorted on range->lsr_start field. */
83 struct lu_seq_range fce_range;
88 * Cache guard, protects fci_hash mostly because others immutable after
94 * Cache shrink threshold */
98 * Prefered number of cached entries */
102 * Current number of cached entries. Protected by \a fci_lock */
106 * LRU list fld entries. */
107 struct list_head fci_lru;
110 * sorted fld entries. */
111 struct list_head fci_entries_head;
114 * Cache statistics. */
115 struct fld_stats fci_stat;
118 * Cache name used for debug and messages. */
120 unsigned int fci_no_shrink:1;
124 /* 4M of FLD cache will not hurt client a lot. */
125 FLD_SERVER_CACHE_SIZE = (4 * 0x100000),
127 /* 1M of FLD cache will not hurt client a lot. */
128 FLD_CLIENT_CACHE_SIZE = (1 * 0x100000)
132 /* Cache threshold is 10 percent of size. */
133 FLD_SERVER_CACHE_THRESHOLD = 10,
135 /* Cache threshold is 10 percent of size. */
136 FLD_CLIENT_CACHE_THRESHOLD = 10
139 extern struct lu_fld_hash fld_hash[];
142 #ifdef CONFIG_PROC_FS
143 extern struct proc_dir_entry *fld_type_proc_dir;
144 extern struct lprocfs_vars fld_client_proc_list[];
147 # ifdef HAVE_SERVER_SUPPORT
148 struct fld_thread_info {
149 struct lu_seq_range fti_rec;
150 struct lu_seq_range fti_lrange;
151 struct lu_seq_range fti_irange;
154 extern struct lu_context_key fld_thread_key;
157 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
158 struct dt_device *dt, int type);
160 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
162 int fld_declare_index_create(const struct lu_env *env,
163 struct lu_server_fld *fld,
164 const struct lu_seq_range *new_range,
167 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
168 const struct lu_seq_range *new_range, struct thandle *th);
170 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
171 u64 seq, struct lu_seq_range *range);
173 int fld_name_to_index(const char *name, __u32 *index);
174 int fld_server_mod_init(void);
176 void fld_server_mod_exit(void);
178 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
179 struct lu_seq_range *range, void *data, int data_len);
180 #ifdef CONFIG_PROC_FS
181 extern const struct file_operations fld_proc_seq_fops;
182 extern struct lprocfs_vars fld_server_proc_list[];
185 # endif /* HAVE_SERVER_SUPPORT */
187 int fld_client_rpc(struct obd_export *exp,
188 struct lu_seq_range *range, __u32 fld_op,
189 struct ptlrpc_request **reqp);
191 struct fld_cache *fld_cache_init(const char *name,
192 int cache_size, int cache_threshold);
194 void fld_cache_fini(struct fld_cache *cache);
196 void fld_cache_flush(struct fld_cache *cache);
198 int fld_cache_insert(struct fld_cache *cache,
199 const struct lu_seq_range *range);
201 struct fld_cache_entry
202 *fld_cache_entry_create(const struct lu_seq_range *range);
204 int fld_cache_insert_nolock(struct fld_cache *cache,
205 struct fld_cache_entry *f_new);
206 void fld_cache_delete(struct fld_cache *cache,
207 const struct lu_seq_range *range);
208 void fld_cache_delete_nolock(struct fld_cache *cache,
209 const struct lu_seq_range *range);
210 int fld_cache_lookup(struct fld_cache *cache,
211 const u64 seq, struct lu_seq_range *range);
213 struct fld_cache_entry *
214 fld_cache_entry_lookup(struct fld_cache *cache,
215 const struct lu_seq_range *range);
217 void fld_cache_entry_delete(struct fld_cache *cache,
218 struct fld_cache_entry *node);
220 struct fld_cache_entry *
221 fld_cache_entry_lookup_nolock(struct fld_cache *cache,
222 const struct lu_seq_range *range);
224 static inline const char *
225 fld_target_name(const struct lu_fld_target *tar)
227 #ifdef HAVE_SERVER_SUPPORT
228 if (tar->ft_srv != NULL)
229 return tar->ft_srv->lsf_name;
232 return tar->ft_exp->exp_obd->obd_name;
235 #endif /* __FLD_INTERNAL_H */