Whamcloud - gitweb
6bd4bdfa51f53123d8345efd9b60e0a2a8dcdbf6
[fs/lustre-release.git] / lustre / include / lustre_export.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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36 /** \defgroup obd_export PortalRPC export definitions
37  *
38  * @{
39  */
40
41 #ifndef __EXPORT_H
42 #define __EXPORT_H
43
44 /** \defgroup export export
45  *
46  * @{
47  */
48
49 #include <lprocfs_status.h>
50 #include <lustre/lustre_idl.h>
51 #include <lustre_dlm.h>
52
53 struct mds_client_data;
54 struct mdt_client_data;
55 struct mds_idmap_table;
56 struct mdt_idmap_table;
57
58 /**
59  * Target-specific export data
60  */
61 struct tg_export_data {
62         /** Protects led_lcd below */
63         cfs_mutex_t             ted_lcd_lock;
64         /** Per-client data for each export */
65         struct lsd_client_data *ted_lcd;
66         /** Offset of record in last_rcvd file */
67         loff_t                  ted_lr_off;
68         /** Client index in last_rcvd file */
69         int                     ted_lr_idx;
70 };
71
72 /**
73  * MDT-specific export data
74  */
75 struct mdt_export_data {
76         struct tg_export_data   med_ted;
77         /** List of all files opened by client on this MDT */
78         cfs_list_t              med_open_head;
79         cfs_spinlock_t          med_open_lock; /* lock med_open_head, mfd_list*/
80         /** Bitmask of all ibit locks this MDT understands */
81         __u64                   med_ibits_known;
82         cfs_mutex_t             med_idmap_mutex;
83         struct lustre_idmap_table *med_idmap;
84 };
85
86 struct osc_creator {
87         cfs_spinlock_t          oscc_lock;
88         cfs_list_t              oscc_wait_create_list;
89         struct obd_device      *oscc_obd;
90         obd_id                  oscc_last_id;//last available pre-created object
91         obd_id                  oscc_next_id;// what object id to give out next
92         int                     oscc_grow_count;
93         /**
94          * Limit oscc_grow_count value, can be changed via proc fs
95          */
96         int                     oscc_max_grow_count;
97         struct obdo             oscc_oa;
98         int                     oscc_flags;
99         cfs_waitq_t             oscc_waitq; /* creating procs wait on this */
100 };
101
102 struct ec_export_data { /* echo client */
103         cfs_list_t eced_locks;
104 };
105
106 /* In-memory access to client data from OST struct */
107 /** Filter (oss-side) specific import data */
108 struct filter_export_data {
109         struct tg_export_data      fed_ted;
110         cfs_spinlock_t             fed_lock;     /**< protects fed_mod_list */
111         long                       fed_dirty;    /* in bytes */
112         long                       fed_grant;    /* in bytes */
113         cfs_list_t                 fed_mod_list; /* files being modified */
114         int                        fed_mod_count;/* items in fed_writing list */
115         long                       fed_pending;  /* bytes just being written */
116         __u32                      fed_group;
117         __u8                       fed_pagesize; /* log2 of client page size */
118 };
119
120 struct mgs_export_data {
121         cfs_list_t                 med_clients; /* mgc fs client via this exp */
122         cfs_spinlock_t             med_lock;    /* protect med_clients */
123 };
124
125 /**
126  * per-NID statistics structure.
127  * It tracks access patterns to this export on a per-client-NID basis
128  */
129 typedef struct nid_stat {
130         lnet_nid_t               nid;
131         cfs_hlist_node_t         nid_hash;
132         cfs_list_t               nid_list;
133         struct obd_device       *nid_obd;
134         struct proc_dir_entry   *nid_proc;
135         struct lprocfs_stats    *nid_stats;
136         struct lprocfs_stats    *nid_ldlm_stats;
137         struct brw_stats        *nid_brw_stats;
138         cfs_atomic_t             nid_exp_ref_count; /* for obd_nid_stats_hash
139                                                            exp_nid_stats */
140 }nid_stat_t;
141
142 #define nidstat_getref(nidstat)                                                \
143 do {                                                                           \
144         cfs_atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
145 } while(0)
146
147 #define nidstat_putref(nidstat)                                                \
148 do {                                                                           \
149         cfs_atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
150         LASSERTF(cfs_atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
151                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
152 } while(0)
153
154 enum obd_option {
155         OBD_OPT_FORCE =         0x0001,
156         OBD_OPT_FAILOVER =      0x0002,
157         OBD_OPT_ABORT_RECOV =   0x0004,
158 };
159
160 /**
161  * Export structure. Represents target-side of connection in portals.
162  * Also used in Lustre to connect between layers on the same node when
163  * there is no network-connection in-between.
164  * For every connected client there is an export structure on the server
165  * attached to the same obd device.
166  */
167 struct obd_export {
168         /**
169          * Export handle, it's id is provided to client on connect
170          * Subsequent client RPCs contain this handle id to identify
171          * what export they are talking to.
172          */
173         struct portals_handle     exp_handle;
174         cfs_atomic_t              exp_refcount;
175         /**
176          * Set of counters below is to track where export references are
177          * kept. The exp_rpc_count is used for reconnect handling also,
178          * the cb_count and locks_count are for debug purposes only for now.
179          * The sum of them should be less than exp_refcount by 3
180          */
181         cfs_atomic_t              exp_rpc_count; /* RPC references */
182         cfs_atomic_t              exp_cb_count; /* Commit callback references */
183         /** Number of queued replay requests to be processes */
184         cfs_atomic_t              exp_replay_count;
185         cfs_atomic_t              exp_locks_count; /** Lock references */
186 #if LUSTRE_TRACKS_LOCK_EXP_REFS
187         cfs_list_t                exp_locks_list;
188         cfs_spinlock_t            exp_locks_list_guard;
189 #endif
190         /** UUID of client connected to this export */
191         struct obd_uuid           exp_client_uuid;
192         /** To link all exports on an obd device */
193         cfs_list_t                exp_obd_chain;
194         cfs_hlist_node_t          exp_uuid_hash; /** uuid-export hash*/
195         cfs_hlist_node_t          exp_nid_hash; /** nid-export hash */
196         /**
197          * All exports eligible for ping evictor are linked into a list
198          * through this field in "most time since last request on this export"
199          * order
200          * protected by obd_dev_lock
201          */
202         cfs_list_t                exp_obd_chain_timed;
203         /** Obd device of this export */
204         struct obd_device        *exp_obd;
205         /** "reverse" import to send requests (e.g. from ldlm) back to client */
206         struct obd_import        *exp_imp_reverse;
207         struct nid_stat          *exp_nid_stats;
208         struct lprocfs_stats     *exp_md_stats;
209         /** Active connetion */
210         struct ptlrpc_connection *exp_connection;
211         /** Connection count value from last succesful reconnect rpc */
212         __u32                     exp_conn_cnt;
213         /** Hash list of all ldlm locks granted on this export */
214         cfs_hash_t               *exp_lock_hash;
215         /** Lock protecting access to exp_flock_wait_list */
216         cfs_rwlock_t              exp_flock_wait_lock;
217         /**
218          * Wait queue for Posix lock deadlock detection, added with
219          * ldlm_lock::l_flock_waitq.
220          */
221         cfs_list_t                exp_flock_wait_list;
222         cfs_list_t                exp_outstanding_replies;
223         cfs_list_t                exp_uncommitted_replies;
224         cfs_spinlock_t            exp_uncommitted_replies_lock;
225         /** Last committed transno for this export */
226         __u64                     exp_last_committed;
227         /** When was last request received */
228         cfs_time_t                exp_last_request_time;
229         /** On replay all requests waiting for replay are linked here */
230         cfs_list_t                exp_req_replay_queue;
231         /** protects exp_flags and exp_outstanding_replies */
232         cfs_spinlock_t            exp_lock;
233         /** Compatibility flags for this export */
234         __u64                     exp_connect_flags;
235         enum obd_option           exp_flags;
236         unsigned long             exp_failed:1,
237                                   exp_in_recovery:1,
238                                   exp_disconnected:1,
239                                   exp_connecting:1,
240                                   /** VBR: export missed recovery */
241                                   exp_delayed:1,
242                                   /** VBR: failed version checking */
243                                   exp_vbr_failed:1,
244                                   exp_req_replay_needed:1,
245                                   exp_lock_replay_needed:1,
246                                   exp_need_sync:1,
247                                   exp_flvr_changed:1,
248                                   exp_flvr_adapt:1,
249                                   exp_libclient:1, /* liblustre client? */
250                                   /* client timed out and tried to reconnect,
251                                    * but couldn't because of active rpcs */
252                                   exp_abort_active_req:1;
253         /* also protected by exp_lock */
254         enum lustre_sec_part      exp_sp_peer;
255         struct sptlrpc_flavor     exp_flvr;             /* current */
256         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
257         cfs_time_t                exp_flvr_expire[2];   /* seconds */
258
259         /** protects exp_hp_rpcs */
260         cfs_spinlock_t            exp_rpc_lock;
261         cfs_list_t                exp_hp_rpcs;  /* (potential) HP RPCs */
262
263         /** blocking dlm lock list, protected by exp_bl_list_lock */
264         cfs_list_t                exp_bl_list;
265         cfs_spinlock_t            exp_bl_list_lock;
266
267         /** Target specific data */
268         union {
269                 struct tg_export_data     eu_target_data;
270                 struct mdt_export_data    eu_mdt_data;
271                 struct filter_export_data eu_filter_data;
272                 struct ec_export_data     eu_ec_data;
273                 struct mgs_export_data    eu_mgs_data;
274         } u;
275 };
276
277 #define exp_target_data u.eu_target_data
278 #define exp_mdt_data    u.eu_mdt_data
279 #define exp_filter_data u.eu_filter_data
280 #define exp_ec_data     u.eu_ec_data
281
282 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
283 {
284         LASSERT(exp->exp_delayed);
285         return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
286                                cfs_time_current_sec());
287 }
288
289 static inline int exp_connect_cancelset(struct obd_export *exp)
290 {
291         LASSERT(exp != NULL);
292         return !!(exp->exp_connect_flags & OBD_CONNECT_CANCELSET);
293 }
294
295 static inline int exp_connect_lru_resize(struct obd_export *exp)
296 {
297         LASSERT(exp != NULL);
298         return !!(exp->exp_connect_flags & OBD_CONNECT_LRU_RESIZE);
299 }
300
301 static inline int exp_connect_rmtclient(struct obd_export *exp)
302 {
303         LASSERT(exp != NULL);
304         return !!(exp->exp_connect_flags & OBD_CONNECT_RMT_CLIENT);
305 }
306
307 static inline int client_is_remote(struct obd_export *exp)
308 {
309         struct obd_import *imp = class_exp2cliimp(exp);
310
311         return !!(imp->imp_connect_data.ocd_connect_flags &
312                   OBD_CONNECT_RMT_CLIENT);
313 }
314
315 static inline int exp_connect_vbr(struct obd_export *exp)
316 {
317         LASSERT(exp != NULL);
318         LASSERT(exp->exp_connection);
319         return !!(exp->exp_connect_flags & OBD_CONNECT_VBR);
320 }
321
322 static inline int exp_connect_som(struct obd_export *exp)
323 {
324         LASSERT(exp != NULL);
325         return !!(exp->exp_connect_flags & OBD_CONNECT_SOM);
326 }
327
328 static inline int imp_connect_lru_resize(struct obd_import *imp)
329 {
330         struct obd_connect_data *ocd;
331
332         LASSERT(imp != NULL);
333         ocd = &imp->imp_connect_data;
334         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
335 }
336
337 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
338 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
339
340 /** @} export */
341
342 #endif /* __EXPORT_H */
343 /** @} obd_export */