Whamcloud - gitweb
53b8fc33bb99bbd32f37da98424af16c083da8a1
[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.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) 2012, 2015, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/fld/fld_internal.h
33  *
34  * Subsystem Description:
35  * FLD is FID Location Database, which stores where (IE, on which MDT)
36  * FIDs are located.
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.
41  *
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.
46  *
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.
51  *
52  * Author: Yury Umanets <umka@clusterfs.com>
53  * Author: Tom WangDi <wangdi@clusterfs.com>
54  */
55 #ifndef __FLD_INTERNAL_H
56 #define __FLD_INTERNAL_H
57
58 #include <obd.h>
59 #include <libcfs/libcfs.h>
60 #include <lustre_fld.h>
61
62 struct fld_stats {
63         __u64   fst_count;
64         __u64   fst_cache;
65 };
66
67 struct lu_fld_hash {
68         const char              *fh_name;
69         int                     (*fh_hash_func)(struct lu_client_fld *fld,
70                                                 __u64 seq);
71         struct lu_fld_target *  (*fh_scan_func)(struct lu_client_fld *fld,
72                                                 __u64 seq);
73 };
74
75 struct fld_cache_entry {
76         struct list_head        fce_lru;
77         struct list_head        fce_list;
78         /**
79          * fld cache entries are sorted on range->lsr_start field. */
80         struct lu_seq_range     fce_range;
81 };
82
83 struct fld_cache {
84         /**
85          * Cache guard, protects fci_hash mostly because others immutable after
86          * init is finished.
87          */
88         rwlock_t                 fci_lock;
89
90         /**
91          * Cache shrink threshold */
92         int                      fci_threshold;
93
94         /**
95          * Prefered number of cached entries */
96         int                      fci_cache_size;
97
98         /**
99          * Current number of cached entries. Protected by \a fci_lock */
100         int                      fci_cache_count;
101
102         /**
103          * LRU list fld entries. */
104         struct list_head        fci_lru;
105
106         /**
107          * sorted fld entries. */
108         struct list_head        fci_entries_head;
109
110         /**
111          * Cache statistics.
112          */
113         struct fld_stats        fci_stat;
114
115         /**
116          * Cache name used for debug and messages.
117          */
118         char                    fci_name[LUSTRE_MDT_MAXNAMELEN];
119 };
120
121 enum {
122         /* 4M of FLD cache will not hurt client a lot. */
123         FLD_SERVER_CACHE_SIZE      = (4 * 0x100000),
124
125         /* 1M of FLD cache will not hurt client a lot. */
126         FLD_CLIENT_CACHE_SIZE      = (1 * 0x100000)
127 };
128
129 enum {
130         /* Cache threshold is 10 percent of size. */
131         FLD_SERVER_CACHE_THRESHOLD = 10,
132
133         /* Cache threshold is 10 percent of size. */
134         FLD_CLIENT_CACHE_THRESHOLD = 10
135 };
136
137 extern struct lu_fld_hash fld_hash[];
138
139 # ifdef HAVE_SERVER_SUPPORT
140 struct fld_thread_info {
141         struct lu_seq_range fti_rec;
142         struct lu_seq_range fti_lrange;
143         struct lu_seq_range fti_irange;
144 };
145
146 extern struct lu_context_key fld_thread_key;
147
148 struct dt_device;
149 int fld_index_init(const struct lu_env *env, struct lu_server_fld *fld,
150                    struct dt_device *dt, int type);
151
152 void fld_index_fini(const struct lu_env *env, struct lu_server_fld *fld);
153
154 int fld_declare_index_create(const struct lu_env *env,
155                              struct lu_server_fld *fld,
156                              const struct lu_seq_range *new_range,
157                              struct thandle *th);
158
159 int fld_index_create(const struct lu_env *env, struct lu_server_fld *fld,
160                      const struct lu_seq_range *new_range, struct thandle *th);
161
162 int fld_index_lookup(const struct lu_env *env, struct lu_server_fld *fld,
163                      u64 seq, struct lu_seq_range *range);
164
165 int fld_name_to_index(const char *name, __u32 *index);
166
167 int fld_server_mod_init(void);
168 void fld_server_mod_exit(void);
169
170 int fld_server_read(const struct lu_env *env, struct lu_server_fld *fld,
171                     struct lu_seq_range *range, void *data, int data_len);
172
173 extern const struct file_operations fld_debugfs_seq_fops;
174 extern struct dentry *fld_debugfs_dir;
175
176 # endif /* HAVE_SERVER_SUPPORT */
177
178 int fld_client_rpc(struct obd_export *exp,
179                    struct lu_seq_range *range, __u32 fld_op,
180                    struct ptlrpc_request **reqp);
181
182 extern struct ldebugfs_vars fld_client_debugfs_list[];
183
184 struct fld_cache *fld_cache_init(const char *name,
185                                  int cache_size, int cache_threshold);
186
187 void fld_cache_fini(struct fld_cache *cache);
188
189 void fld_cache_flush(struct fld_cache *cache);
190
191 int fld_cache_insert(struct fld_cache *cache,
192                      const struct lu_seq_range *range);
193
194 struct fld_cache_entry
195 *fld_cache_entry_create(const struct lu_seq_range *range);
196
197 int fld_cache_insert_nolock(struct fld_cache *cache,
198                             struct fld_cache_entry *f_new);
199 void fld_cache_delete_nolock(struct fld_cache *cache,
200                              const struct lu_seq_range *range);
201 int fld_cache_lookup(struct fld_cache *cache,
202                      const u64 seq, struct lu_seq_range *range);
203
204 static inline const char *
205 fld_target_name(const struct lu_fld_target *tar)
206 {
207 #ifdef HAVE_SERVER_SUPPORT
208         if (tar->ft_srv != NULL)
209                 return tar->ft_srv->lsf_name;
210 #endif
211
212         return tar->ft_exp->exp_obd->obd_name;
213 }
214
215 #endif /* __FLD_INTERNAL_H */