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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup obd_export PortalRPC export definitions
44 /** \defgroup export export
49 #include <lprocfs_status.h>
50 #include <lustre/lustre_idl.h>
51 #include <lustre_dlm.h>
53 struct mds_client_data;
54 struct mdt_client_data;
55 struct mds_idmap_table;
56 struct mdt_idmap_table;
59 * Target-specific export data
61 struct tg_export_data {
62 /** Protects led_lcd below */
63 struct mutex 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 */
68 /** Client index in last_rcvd file */
73 * MDT-specific export data
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 spinlock_t med_open_lock; /* med_open_head, mfd_list */
80 /** Bitmask of all ibit locks this MDT understands */
81 __u64 med_ibits_known;
82 struct mutex med_idmap_mutex;
83 struct lustre_idmap_table *med_idmap;
86 struct ec_export_data { /* echo client */
87 cfs_list_t eced_locks;
90 /* In-memory access to client data from OST struct */
91 /** Filter (oss-side) specific import data */
92 struct filter_export_data {
93 struct tg_export_data fed_ted;
94 spinlock_t fed_lock; /**< protects fed_mod_list */
95 long fed_dirty; /* in bytes */
96 long fed_grant; /* in bytes */
97 cfs_list_t fed_mod_list; /* files being modified */
98 int fed_mod_count;/* items in fed_writing list */
99 long fed_pending; /* bytes just being written */
101 __u8 fed_pagesize; /* log2 of client page size */
104 struct mgs_export_data {
105 cfs_list_t med_clients; /* mgc fs client via this exp */
106 spinlock_t med_lock; /* protect med_clients */
110 * per-NID statistics structure.
111 * It tracks access patterns to this export on a per-client-NID basis
115 cfs_hlist_node_t nid_hash;
117 struct obd_device *nid_obd;
118 struct proc_dir_entry *nid_proc;
119 struct lprocfs_stats *nid_stats;
120 struct lprocfs_stats *nid_ldlm_stats;
121 cfs_atomic_t nid_exp_ref_count; /* for obd_nid_stats_hash
125 #define nidstat_getref(nidstat) \
127 cfs_atomic_inc(&(nidstat)->nid_exp_ref_count); \
130 #define nidstat_putref(nidstat) \
132 cfs_atomic_dec(&(nidstat)->nid_exp_ref_count); \
133 LASSERTF(cfs_atomic_read(&(nidstat)->nid_exp_ref_count) >= 0, \
134 "stat %p nid_exp_ref_count < 0\n", nidstat); \
138 OBD_OPT_FORCE = 0x0001,
139 OBD_OPT_FAILOVER = 0x0002,
140 OBD_OPT_ABORT_RECOV = 0x0004,
144 * Export structure. Represents target-side of connection in portals.
145 * Also used in Lustre to connect between layers on the same node when
146 * there is no network-connection in-between.
147 * For every connected client there is an export structure on the server
148 * attached to the same obd device.
152 * Export handle, it's id is provided to client on connect
153 * Subsequent client RPCs contain this handle id to identify
154 * what export they are talking to.
156 struct portals_handle exp_handle;
157 cfs_atomic_t exp_refcount;
159 * Set of counters below is to track where export references are
160 * kept. The exp_rpc_count is used for reconnect handling also,
161 * the cb_count and locks_count are for debug purposes only for now.
162 * The sum of them should be less than exp_refcount by 3
164 cfs_atomic_t exp_rpc_count; /* RPC references */
165 cfs_atomic_t exp_cb_count; /* Commit callback references */
166 /** Number of queued replay requests to be processes */
167 cfs_atomic_t exp_replay_count;
168 cfs_atomic_t exp_locks_count; /** Lock references */
169 #if LUSTRE_TRACKS_LOCK_EXP_REFS
170 cfs_list_t exp_locks_list;
171 spinlock_t exp_locks_list_guard;
173 /** UUID of client connected to this export */
174 struct obd_uuid exp_client_uuid;
175 /** To link all exports on an obd device */
176 cfs_list_t exp_obd_chain;
177 cfs_hlist_node_t exp_uuid_hash; /** uuid-export hash*/
178 cfs_hlist_node_t exp_nid_hash; /** nid-export hash */
180 * All exports eligible for ping evictor are linked into a list
181 * through this field in "most time since last request on this export"
183 * protected by obd_dev_lock
185 cfs_list_t exp_obd_chain_timed;
186 /** Obd device of this export */
187 struct obd_device *exp_obd;
189 * "reverse" import to send requests (e.g. from ldlm) back to client
190 * exp_lock protect its change
192 struct obd_import *exp_imp_reverse;
193 struct nid_stat *exp_nid_stats;
194 struct lprocfs_stats *exp_md_stats;
195 /** Active connetion */
196 struct ptlrpc_connection *exp_connection;
197 /** Connection count value from last succesful reconnect rpc */
199 /** Hash list of all ldlm locks granted on this export */
200 cfs_hash_t *exp_lock_hash;
202 * Hash list for Posix lock deadlock detection, added with
203 * ldlm_lock::l_exp_flock_hash.
205 cfs_hash_t *exp_flock_hash;
206 cfs_list_t exp_outstanding_replies;
207 cfs_list_t exp_uncommitted_replies;
208 spinlock_t exp_uncommitted_replies_lock;
209 /** Last committed transno for this export */
210 __u64 exp_last_committed;
211 /** When was last request received */
212 cfs_time_t exp_last_request_time;
213 /** On replay all requests waiting for replay are linked here */
214 cfs_list_t exp_req_replay_queue;
216 * protects exp_flags, exp_outstanding_replies and the change
220 /** Compatibility flags for this export are embedded into
221 * exp_connect_data */
222 struct obd_connect_data exp_connect_data;
223 enum obd_option exp_flags;
224 unsigned long exp_failed:1,
228 /** VBR: export missed recovery */
230 /** VBR: failed version checking */
232 exp_req_replay_needed:1,
233 exp_lock_replay_needed:1,
237 exp_libclient:1, /* liblustre client? */
238 /* client timed out and tried to reconnect,
239 * but couldn't because of active rpcs */
240 exp_abort_active_req:1,
241 /* if to swap nidtbl entries for 2.2 clients.
242 * Only used by the MGS to fix LU-1644. */
244 /* also protected by exp_lock */
245 enum lustre_sec_part exp_sp_peer;
246 struct sptlrpc_flavor exp_flvr; /* current */
247 struct sptlrpc_flavor exp_flvr_old[2]; /* about-to-expire */
248 cfs_time_t exp_flvr_expire[2]; /* seconds */
250 /** protects exp_hp_rpcs */
251 spinlock_t exp_rpc_lock;
252 cfs_list_t exp_hp_rpcs; /* (potential) HP RPCs */
254 /** blocking dlm lock list, protected by exp_bl_list_lock */
255 cfs_list_t exp_bl_list;
256 spinlock_t exp_bl_list_lock;
258 /** Target specific data */
260 struct tg_export_data eu_target_data;
261 struct mdt_export_data eu_mdt_data;
262 struct filter_export_data eu_filter_data;
263 struct ec_export_data eu_ec_data;
264 struct mgs_export_data eu_mgs_data;
268 #define exp_target_data u.eu_target_data
269 #define exp_mdt_data u.eu_mdt_data
270 #define exp_filter_data u.eu_filter_data
271 #define exp_ec_data u.eu_ec_data
273 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
275 return &exp->exp_connect_data.ocd_connect_flags;
278 static inline __u64 exp_connect_flags(struct obd_export *exp)
280 return *exp_connect_flags_ptr(exp);
283 static inline int exp_max_brw_size(struct obd_export *exp)
285 LASSERT(exp != NULL);
286 if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
287 return exp->exp_connect_data.ocd_brw_size;
289 return ONE_MB_BRW_SIZE;
292 static inline int exp_connect_multibulk(struct obd_export *exp)
294 return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
297 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
299 LASSERT(exp->exp_delayed);
300 return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
301 cfs_time_current_sec());
304 static inline int exp_connect_cancelset(struct obd_export *exp)
306 LASSERT(exp != NULL);
307 return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
310 static inline int exp_connect_lru_resize(struct obd_export *exp)
312 LASSERT(exp != NULL);
313 return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
316 static inline int exp_connect_rmtclient(struct obd_export *exp)
318 LASSERT(exp != NULL);
319 return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
322 static inline int client_is_remote(struct obd_export *exp)
324 struct obd_import *imp = class_exp2cliimp(exp);
326 return !!(imp->imp_connect_data.ocd_connect_flags &
327 OBD_CONNECT_RMT_CLIENT);
330 static inline int exp_connect_vbr(struct obd_export *exp)
332 LASSERT(exp != NULL);
333 LASSERT(exp->exp_connection);
334 return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
337 static inline int exp_connect_som(struct obd_export *exp)
339 LASSERT(exp != NULL);
340 return !!(exp_connect_flags(exp) & OBD_CONNECT_SOM);
343 static inline int exp_connect_umask(struct obd_export *exp)
345 return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
348 static inline int imp_connect_lru_resize(struct obd_import *imp)
350 struct obd_connect_data *ocd;
352 LASSERT(imp != NULL);
353 ocd = &imp->imp_connect_data;
354 return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
357 static inline int exp_connect_layout(struct obd_export *exp)
359 return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
362 static inline bool exp_connect_lvb_type(struct obd_export *exp)
364 LASSERT(exp != NULL);
365 if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
371 static inline bool imp_connect_lvb_type(struct obd_import *imp)
373 struct obd_connect_data *ocd;
375 LASSERT(imp != NULL);
376 ocd = &imp->imp_connect_data;
377 if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
383 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
384 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
388 #endif /* __EXPORT_H */