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 struct mutex med_idmap_mutex;
81 struct lustre_idmap_table *med_idmap;
84 struct ec_export_data { /* echo client */
85 cfs_list_t eced_locks;
88 /* In-memory access to client data from OST struct */
89 /** Filter (oss-side) specific import data */
90 struct filter_export_data {
91 struct tg_export_data fed_ted;
92 spinlock_t fed_lock; /**< protects fed_mod_list */
94 long fed_dirty; /* in bytes */
95 long fed_grant; /* in bytes */
96 cfs_list_t fed_mod_list; /* files being modified */
97 long fed_pending; /* bytes just being written */
98 /* count of SOFT_SYNC RPCs, which will be reset after
99 * ofd_soft_sync_limit number of RPCs, and trigger a sync. */
100 atomic_t fed_soft_sync_count;
101 int fed_mod_count;/* items in fed_writing list */
103 __u8 fed_pagesize; /* log2 of client page size */
106 struct mgs_export_data {
107 cfs_list_t med_clients; /* mgc fs client via this exp */
108 spinlock_t med_lock; /* protect med_clients */
112 * per-NID statistics structure.
113 * It tracks access patterns to this export on a per-client-NID basis
117 cfs_hlist_node_t nid_hash;
119 struct obd_device *nid_obd;
120 struct proc_dir_entry *nid_proc;
121 struct lprocfs_stats *nid_stats;
122 struct lprocfs_stats *nid_ldlm_stats;
123 atomic_t nid_exp_ref_count; /* for obd_nid_stats_hash
127 #define nidstat_getref(nidstat) \
129 atomic_inc(&(nidstat)->nid_exp_ref_count); \
132 #define nidstat_putref(nidstat) \
134 atomic_dec(&(nidstat)->nid_exp_ref_count); \
135 LASSERTF(atomic_read(&(nidstat)->nid_exp_ref_count) >= 0, \
136 "stat %p nid_exp_ref_count < 0\n", nidstat); \
140 OBD_OPT_FORCE = 0x0001,
141 OBD_OPT_FAILOVER = 0x0002,
142 OBD_OPT_ABORT_RECOV = 0x0004,
146 * Export structure. Represents target-side of connection in portals.
147 * Also used in Lustre to connect between layers on the same node when
148 * there is no network-connection in-between.
149 * For every connected client there is an export structure on the server
150 * attached to the same obd device.
154 * Export handle, it's id is provided to client on connect
155 * Subsequent client RPCs contain this handle id to identify
156 * what export they are talking to.
158 struct portals_handle exp_handle;
159 atomic_t exp_refcount;
161 * Set of counters below is to track where export references are
162 * kept. The exp_rpc_count is used for reconnect handling also,
163 * the cb_count and locks_count are for debug purposes only for now.
164 * The sum of them should be less than exp_refcount by 3
166 atomic_t exp_rpc_count; /* RPC references */
167 atomic_t exp_cb_count; /* Commit callback references */
168 /** Number of queued replay requests to be processes */
169 atomic_t exp_replay_count;
170 atomic_t exp_locks_count; /** Lock references */
171 #if LUSTRE_TRACKS_LOCK_EXP_REFS
172 cfs_list_t exp_locks_list;
173 spinlock_t exp_locks_list_guard;
175 /** UUID of client connected to this export */
176 struct obd_uuid exp_client_uuid;
177 /** To link all exports on an obd device */
178 cfs_list_t exp_obd_chain;
179 cfs_hlist_node_t exp_uuid_hash; /** uuid-export hash*/
180 cfs_hlist_node_t exp_nid_hash; /** nid-export hash */
182 * All exports eligible for ping evictor are linked into a list
183 * through this field in "most time since last request on this export"
185 * protected by obd_dev_lock
187 cfs_list_t exp_obd_chain_timed;
188 /** Obd device of this export */
189 struct obd_device *exp_obd;
191 * "reverse" import to send requests (e.g. from ldlm) back to client
192 * exp_lock protect its change
194 struct obd_import *exp_imp_reverse;
195 struct nid_stat *exp_nid_stats;
196 /** Active connetion */
197 struct ptlrpc_connection *exp_connection;
198 /** Connection count value from last succesful reconnect rpc */
200 /** Hash list of all ldlm locks granted on this export */
201 cfs_hash_t *exp_lock_hash;
203 * Hash list for Posix lock deadlock detection, added with
204 * ldlm_lock::l_exp_flock_hash.
206 cfs_hash_t *exp_flock_hash;
207 cfs_list_t exp_outstanding_replies;
208 cfs_list_t exp_uncommitted_replies;
209 spinlock_t exp_uncommitted_replies_lock;
210 /** Last committed transno for this export */
211 __u64 exp_last_committed;
212 /** When was last request received */
213 cfs_time_t exp_last_request_time;
214 /** On replay all requests waiting for replay are linked here */
215 cfs_list_t exp_req_replay_queue;
217 * protects exp_flags, exp_outstanding_replies and the change
221 /** Compatibility flags for this export are embedded into
222 * exp_connect_data */
223 struct obd_connect_data exp_connect_data;
224 enum obd_option exp_flags;
225 unsigned long exp_failed:1,
229 /** VBR: export missed recovery */
231 /** VBR: failed version checking */
233 exp_req_replay_needed:1,
234 exp_lock_replay_needed:1,
239 exp_libclient:1, /* liblustre client? */
240 /* if to swap nidtbl entries for 2.2 clients.
241 * Only used by the MGS to fix LU-1644. */
243 /* also protected by exp_lock */
244 enum lustre_sec_part exp_sp_peer;
245 struct sptlrpc_flavor exp_flvr; /* current */
246 struct sptlrpc_flavor exp_flvr_old[2]; /* about-to-expire */
247 cfs_time_t exp_flvr_expire[2]; /* seconds */
249 /** protects exp_hp_rpcs */
250 spinlock_t exp_rpc_lock;
251 cfs_list_t exp_hp_rpcs; /* (potential) HP RPCs */
252 cfs_list_t exp_reg_rpcs; /* RPC being handled */
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;
267 struct nodemap *exp_nodemap;
270 #define exp_target_data u.eu_target_data
271 #define exp_mdt_data u.eu_mdt_data
272 #define exp_filter_data u.eu_filter_data
273 #define exp_ec_data u.eu_ec_data
275 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
277 return &exp->exp_connect_data.ocd_connect_flags;
280 static inline __u64 exp_connect_flags(struct obd_export *exp)
282 return *exp_connect_flags_ptr(exp);
285 static inline int exp_max_brw_size(struct obd_export *exp)
287 LASSERT(exp != NULL);
288 if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
289 return exp->exp_connect_data.ocd_brw_size;
291 return ONE_MB_BRW_SIZE;
294 static inline int exp_connect_multibulk(struct obd_export *exp)
296 return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
299 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
301 LASSERT(exp->exp_delayed);
302 return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
303 cfs_time_current_sec());
306 static inline int exp_connect_cancelset(struct obd_export *exp)
308 LASSERT(exp != NULL);
309 return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
312 static inline int exp_connect_lru_resize(struct obd_export *exp)
314 LASSERT(exp != NULL);
315 return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
318 static inline int exp_connect_rmtclient(struct obd_export *exp)
320 LASSERT(exp != NULL);
321 return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
324 static inline int client_is_remote(struct obd_export *exp)
326 struct obd_import *imp = class_exp2cliimp(exp);
328 return !!(imp->imp_connect_data.ocd_connect_flags &
329 OBD_CONNECT_RMT_CLIENT);
332 static inline int exp_connect_vbr(struct obd_export *exp)
334 LASSERT(exp != NULL);
335 LASSERT(exp->exp_connection);
336 return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
339 static inline int exp_connect_som(struct obd_export *exp)
341 LASSERT(exp != NULL);
342 return !!(exp_connect_flags(exp) & OBD_CONNECT_SOM);
345 static inline int exp_connect_umask(struct obd_export *exp)
347 return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
350 static inline int imp_connect_lru_resize(struct obd_import *imp)
352 struct obd_connect_data *ocd;
354 LASSERT(imp != NULL);
355 ocd = &imp->imp_connect_data;
356 return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
359 static inline int exp_connect_layout(struct obd_export *exp)
361 return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
364 static inline bool exp_connect_lvb_type(struct obd_export *exp)
366 LASSERT(exp != NULL);
367 if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
373 static inline bool imp_connect_lvb_type(struct obd_import *imp)
375 struct obd_connect_data *ocd;
377 LASSERT(imp != NULL);
378 ocd = &imp->imp_connect_data;
379 if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
385 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
387 struct obd_connect_data *ocd;
389 LASSERT(imp != NULL);
390 ocd = &imp->imp_connect_data;
391 return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
394 static inline __u64 exp_connect_ibits(struct obd_export *exp)
396 struct obd_connect_data *ocd;
398 ocd = &exp->exp_connect_data;
399 return ocd->ocd_ibits_known;
402 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
403 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
405 #define KKUC_CT_DATA_MAGIC 0x092013cea
406 struct kkuc_ct_data {
408 struct obd_uuid kcd_uuid;
414 #endif /* __EXPORT_H */