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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 /** \defgroup obd_export PortalRPC export definitions
39 /** \defgroup export export
44 #include <linux/rhashtable.h>
45 #include <linux/workqueue.h>
47 #include <uapi/linux/lustre/lustre_idl.h>
48 #include <uapi/linux/lustre/lustre_ver.h>
49 #include <lprocfs_status.h>
50 #include <lustre_dlm.h>
52 struct mds_client_data;
53 struct mdt_client_data;
54 struct mds_idmap_table;
55 struct mdt_idmap_table;
58 * Target-specific export data
60 struct tg_export_data {
61 /** Protects ted_lcd, ted_reply_* and ted_release_* fields below */
62 struct mutex ted_lcd_lock;
63 /** Per-client data for each export */
64 struct lsd_client_data *ted_lcd;
65 /** Offset of record in last_rcvd file */
67 /** Client index in last_rcvd file */
71 * ted_nodemap_lock is used to ensure that the nodemap is not destroyed
72 * between the time that ted_nodemap is checked for NULL, and a
73 * reference is taken. Modifications to ted_nodemap require that the
74 * active_config_lock and the nodemap(s)'s nm_member_list_lock be
75 * taken, as well as ted_nodemap_lock, so the export can be properly
76 * added to or removed from the nodemap's member list. When an export
77 * is added to a nodemap, a reference on that nodemap must be taken.
78 * That reference can be put only after ted_nodemap no longer refers to
81 spinlock_t ted_nodemap_lock;
82 struct lu_nodemap *ted_nodemap;
83 struct list_head ted_nodemap_member;
85 /** last version of nodemap config sent to client */
86 __u64 ted_nodemap_version;
88 /* Every reply data fields below are protected by ted_lcd_lock */
89 /** List of reply data */
90 struct list_head ted_reply_list;
92 /** Reply data with highest transno is retained */
93 struct tg_reply_data *ted_reply_last;
95 int ted_reply_max; /* high water mark */
99 long ted_dirty; /* in bytes */
100 long ted_grant; /* in bytes */
101 long ted_pending; /* bytes just being written */
102 __u8 ted_pagebits; /* log2 of client page size */
105 * File Modification Data (FMD) tracking
107 spinlock_t ted_fmd_lock; /* protects ted_fmd_list */
108 struct list_head ted_fmd_list; /* FIDs being modified */
109 int ted_fmd_count;/* items in ted_fmd_list */
113 * MDT-specific export data
115 struct mdt_export_data {
116 struct tg_export_data med_ted;
117 /** List of all files opened by client on this MDT */
118 struct list_head med_open_head;
119 spinlock_t med_open_lock; /* med_open_head, mfd_list */
122 struct ec_export_data { /* echo client */
123 struct list_head eced_locks;
126 /* In-memory access to client data from OST struct */
127 /** Filter (oss-side) specific import data */
128 struct filter_export_data {
129 struct tg_export_data fed_ted;
130 __u64 fed_lastid_gen;
131 /* count of SOFT_SYNC RPCs, which will be reset after
132 * ofd_soft_sync_limit number of RPCs, and trigger a sync.
134 atomic_t fed_soft_sync_count;
138 struct mgs_export_data {
139 struct list_head med_clients; /* mgc fs client via this exp */
140 spinlock_t med_lock; /* protect med_clients */
144 * per-NID statistics structure.
145 * It tracks access patterns to this export on a per-client-NID basis
149 struct hlist_node nid_hash;
150 struct list_head nid_list;
151 struct obd_device *nid_obd;
152 struct proc_dir_entry *nid_proc;
153 struct lprocfs_stats *nid_stats;
154 struct lprocfs_stats *nid_ldlm_stats;
155 /* for obd_nid_stats_hash exp_nid_stats */
156 atomic_t nid_exp_ref_count;
159 #define nidstat_getref(nidstat) \
160 atomic_inc(&(nidstat)->nid_exp_ref_count)
162 #define nidstat_putref(nidstat) \
164 atomic_dec(&(nidstat)->nid_exp_ref_count); \
165 LASSERTF(atomic_read(&(nidstat)->nid_exp_ref_count) >= 0, \
166 "stat %px nid_exp_ref_count < 0\n", nidstat); \
170 OBD_OPT_FORCE = 0x0001,
171 OBD_OPT_FAILOVER = 0x0002,
172 OBD_OPT_ABORT_RECOV = 0x0004,
176 * Export structure. Represents target-side of connection in portals.
177 * Also used in Lustre to connect between layers on the same node when
178 * there is no network-connection in-between.
179 * For every connected client there is an export structure on the server
180 * attached to the same obd device.
184 * Export handle, it's id is provided to client on connect
185 * Subsequent client RPCs contain this handle id to identify
186 * what export they are talking to.
188 struct portals_handle exp_handle;
190 * Set of counters below is to track where export references are
191 * kept. The exp_rpc_count is used for reconnect handling also,
192 * the cb_count and locks_count are for debug purposes only for now.
193 * The sum of them should be less than exp_handle.href by 3
195 atomic_t exp_rpc_count; /* RPC references */
196 atomic_t exp_cb_count; /* Commit callback references */
197 /** Number of queued replay requests to be processes */
198 atomic_t exp_replay_count;
199 atomic_t exp_locks_count; /** Lock references */
200 #if LUSTRE_TRACKS_LOCK_EXP_REFS
201 struct list_head exp_locks_list;
202 spinlock_t exp_locks_list_guard;
204 /** UUID of client connected to this export */
205 struct obd_uuid exp_client_uuid;
206 /** To link all exports on an obd device */
207 struct list_head exp_obd_chain;
208 /** work_struct for destruction of export */
209 struct work_struct exp_zombie_work;
210 /* Unlinked export list */
211 struct list_head exp_stale_list;
212 struct rhash_head exp_uuid_hash; /** uuid-export hash */
213 struct rhlist_head exp_nid_hash; /** nid-export hash */
214 struct hlist_node exp_gen_hash; /** last_rcvd clt gen hash */
216 * All exports eligible for ping evictor are linked into a list
217 * through this field in "most time since last request on this export"
219 * protected by obd_dev_lock
221 struct list_head exp_obd_chain_timed;
222 /** Obd device of this export */
223 struct obd_device *exp_obd;
225 * "reverse" import to send requests (e.g. from ldlm) back to client
226 * exp_lock protect its change
228 struct obd_import *exp_imp_reverse;
229 struct nid_stat *exp_nid_stats;
230 /** Active connetion */
231 struct ptlrpc_connection *exp_connection;
232 /** Connection count value from last successful reconnect rpc */
234 /** Hash list of all ldlm locks granted on this export */
235 struct cfs_hash *exp_lock_hash;
237 * Hash list for Posix lock deadlock detection, added with
238 * ldlm_lock::l_exp_flock_hash.
240 struct cfs_hash *exp_flock_hash;
241 struct list_head exp_outstanding_replies;
242 struct list_head exp_uncommitted_replies;
243 spinlock_t exp_uncommitted_replies_lock;
244 /** Last committed transno for this export */
245 __u64 exp_last_committed;
246 /** When was last request received */
247 time64_t exp_last_request_time;
248 /** On replay all requests waiting for replay are linked here */
249 struct list_head exp_req_replay_queue;
251 * protects exp_flags, exp_outstanding_replies and the change
255 /* Compatibility flags for this export embedded into exp_connect_data */
256 struct obd_connect_data exp_connect_data;
257 enum obd_option exp_flags;
258 unsigned long exp_failed:1,
262 /** VBR: export missed recovery */
264 /** VBR: failed version checking */
266 exp_req_replay_needed:1,
267 exp_lock_replay_needed:1,
271 /* if to swap nidtbl entries for 2.2 clients.
272 * Only used by the MGS to fix LU-1644.
275 /* export got final replay ping request */
277 /* local client with recovery disabled */
279 /* old client will set this to 1 (true).
280 * Newer clients 2.15 and beyond will have this
285 /* also protected by exp_lock */
286 enum lustre_sec_part exp_sp_peer;
287 struct sptlrpc_flavor exp_flvr; /* current */
288 struct sptlrpc_flavor exp_flvr_old[2]; /* about-to-expire */
289 time64_t exp_flvr_expire[2]; /* seconds */
291 /** protects exp_hp_rpcs */
292 spinlock_t exp_rpc_lock;
293 struct list_head exp_hp_rpcs; /* (potential) HP RPCs */
294 struct list_head exp_reg_rpcs; /* RPC being handled */
296 /** blocking dlm lock list, protected by exp_bl_list_lock */
297 struct list_head exp_bl_list;
298 spinlock_t exp_bl_list_lock;
300 /** Target specific data */
302 struct tg_export_data eu_target_data;
303 struct mdt_export_data eu_mdt_data;
304 struct filter_export_data eu_filter_data;
305 struct ec_export_data eu_ec_data;
306 struct mgs_export_data eu_mgs_data;
309 struct adaptive_timeout exp_bl_lock_at;
311 /** highest XID received by export client that has no
312 * unreceived lower-numbered XID
315 long *exp_used_slots;
316 struct lu_fid exp_root_fid; /* subdir mount fid */
319 #define exp_target_data u.eu_target_data
320 #define exp_mdt_data u.eu_mdt_data
321 #define exp_filter_data u.eu_filter_data
322 #define exp_ec_data u.eu_ec_data
324 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
326 return &exp->exp_connect_data.ocd_connect_flags;
329 static inline __u64 exp_connect_flags(struct obd_export *exp)
331 return *exp_connect_flags_ptr(exp);
334 static inline __u64 *exp_connect_flags2_ptr(struct obd_export *exp)
336 return &exp->exp_connect_data.ocd_connect_flags2;
339 static inline __u64 exp_connect_flags2(struct obd_export *exp)
341 if (exp_connect_flags(exp) & OBD_CONNECT_FLAGS2)
342 return *exp_connect_flags2_ptr(exp);
346 static inline int exp_max_brw_size(struct obd_export *exp)
348 LASSERT(exp != NULL);
349 if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
350 return exp->exp_connect_data.ocd_brw_size;
352 return ONE_MB_BRW_SIZE;
355 static inline int exp_connect_multibulk(struct obd_export *exp)
357 return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
360 static inline int exp_connect_cancelset(struct obd_export *exp)
362 LASSERT(exp != NULL);
363 return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
366 static inline int exp_connect_lru_resize(struct obd_export *exp)
368 LASSERT(exp != NULL);
369 return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
372 static inline int exp_connect_vbr(struct obd_export *exp)
374 LASSERT(exp != NULL);
375 LASSERT(exp->exp_connection);
376 return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
379 static inline int exp_connect_umask(struct obd_export *exp)
381 return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
384 static inline int imp_connect_lru_resize(struct obd_import *imp)
386 struct obd_connect_data *ocd;
388 LASSERT(imp != NULL);
389 ocd = &imp->imp_connect_data;
390 return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
393 static inline int exp_connect_layout(struct obd_export *exp)
395 return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
398 static inline bool exp_connect_lvb_type(struct obd_export *exp)
400 LASSERT(exp != NULL);
401 if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
407 static inline bool imp_connect_lvb_type(struct obd_import *imp)
409 struct obd_connect_data *ocd;
411 LASSERT(imp != NULL);
412 ocd = &imp->imp_connect_data;
413 if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
419 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
421 struct obd_connect_data *ocd;
423 LASSERT(imp != NULL);
424 ocd = &imp->imp_connect_data;
425 return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
428 static inline bool imp_connect_shortio(struct obd_import *imp)
430 struct obd_connect_data *ocd = &imp->imp_connect_data;
432 return ocd->ocd_connect_flags & OBD_CONNECT_SHORTIO;
435 static inline __u64 exp_connect_ibits(struct obd_export *exp)
437 struct obd_connect_data *ocd;
439 ocd = &exp->exp_connect_data;
440 return ocd->ocd_ibits_known;
443 static inline int exp_connect_large_acl(struct obd_export *exp)
445 return !!(exp_connect_flags(exp) & OBD_CONNECT_LARGE_ACL);
448 static inline int exp_connect_lockahead(struct obd_export *exp)
450 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LOCKAHEAD);
453 static inline int exp_connect_overstriping(struct obd_export *exp)
455 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_OVERSTRIPING);
458 static inline int exp_connect_flr(struct obd_export *exp)
460 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_FLR);
463 static inline int exp_connect_lock_convert(struct obd_export *exp)
465 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LOCK_CONVERT);
468 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
470 static inline int exp_connect_archive_id_array(struct obd_export *exp)
472 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_ARCHIVE_ID_ARRAY);
475 static inline int exp_connect_sepol(struct obd_export *exp)
477 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_SELINUX_POLICY);
480 static inline int exp_connect_encrypt(struct obd_export *exp)
482 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_ENCRYPT);
485 static inline int exp_connect_encrypt_fid2path(struct obd_export *exp)
487 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_ENCRYPT_FID2PATH);
490 static inline int exp_connect_lseek(struct obd_export *exp)
492 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LSEEK);
495 static inline int exp_connect_dom_lvb(struct obd_export *exp)
497 return !!(exp_connect_flags2(exp) & OBD_CONNECT2_DOM_LVB);
500 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 20, 53, 0)
501 /* Only needed for interop with older MDS and 2.16+ OSS for rolling upgrade.
502 * This is typically unsupported for long periods, especially between large
503 * large version differences, so assume this is always true in the future
504 * and the OBD_CONNECT2_REPLAY_CREATE flag can be removed/reused in 2.21+.
506 static inline bool exp_connect_replay_create(struct obd_export *exp)
508 return exp_connect_flags2(exp) & OBD_CONNECT2_REPLAY_CREATE;
511 static inline bool imp_connect_replay_create(struct obd_import *imp)
513 struct obd_connect_data *ocd = &imp->imp_connect_data;
515 return (ocd->ocd_connect_flags & OBD_CONNECT_FLAGS2) &&
516 (ocd->ocd_connect_flags2 & OBD_CONNECT2_REPLAY_CREATE);
519 #define exp_connect_replay_create(exp) true
520 #define imp_connect_replay_create(exp) true
523 static inline bool exp_connect_unaligned_dio(struct obd_export *exp)
525 return (exp_connect_flags2(exp) & OBD_CONNECT2_UNALIGNED_DIO);
529 /* archive_ids in array format */
530 KKUC_CT_DATA_ARRAY_MAGIC = 0x092013cea,
531 /* archive_ids in bitmap format */
532 KKUC_CT_DATA_BITMAP_MAGIC = 0x082018cea,
536 struct kkuc_ct_data {
538 __u32 kcd_nr_archives;
539 __u32 kcd_archives[0];
544 #endif /* __EXPORT_H */