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) 2007, 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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
36 #include <linux/kobject.h>
37 #include <linux/spinlock.h>
38 #include <linux/sysfs.h>
40 #include <uapi/linux/lustre/lustre_idl.h>
41 #include <lustre_lib.h>
42 #include <libcfs/bitmap.h>
43 #ifdef HAVE_SERVER_SUPPORT
44 # include <lu_target.h>
45 # include <obd_target.h>
48 #include <lustre_export.h>
49 #include <lustre_fid.h>
50 #include <lustre_fld.h>
51 #include <lustre_handles.h>
52 #include <lustre_intent.h>
54 #include <lustre_quota.h>
56 #define MAX_OBD_DEVICES 8192
64 struct lov_oinfo { /* per-stripe data structure */
65 struct ost_id loi_oi; /* object ID/Sequence on the target OST */
66 int loi_ost_idx; /* OST stripe index in lov_tgt_desc->tgts */
67 int loi_ost_gen; /* generation of this loi_ost_idx */
69 unsigned long loi_kms_valid:1;
70 __u64 loi_kms; /* known minimum size */
71 struct ost_lvb loi_lvb;
72 struct osc_async_rc loi_ar;
75 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
78 oinfo->loi_kms_valid = 1;
84 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
86 /* obd info for a particular level (lov, osc). */
88 /* OBD_STATFS_* flags */
90 /* statfs data specific for every OSC, if needed at all. */
91 struct obd_statfs *oi_osfs;
92 /* An update callback which is called to update some data on upper
93 * level. E.g. it is used for update lsm->lsm_oinfo at every received
94 * request in osc level for enqueue requests. It is also possible to
95 * update some caller data from LOV layer if needed. */
96 obd_enqueue_update_f oi_cb_up;
100 struct list_head typ_chain;
101 struct obd_ops *typ_dt_ops;
102 struct md_ops *typ_md_ops;
103 struct proc_dir_entry *typ_procroot;
104 struct proc_dir_entry *typ_procsym;
105 struct dentry *typ_debugfs_entry;
106 #ifdef HAVE_SERVER_SUPPORT
111 struct lu_device_type *typ_lu;
112 spinlock_t obd_type_lock;
113 struct kobject *typ_kobj;
123 struct timeout_item {
124 enum timeout_event ti_event;
128 struct list_head ti_obd_list;
129 struct list_head ti_chain;
132 #define OBD_MAX_RIF_DEFAULT 8
133 #define OBD_MAX_RIF_MAX 512
134 #define OSC_MAX_RIF_MAX 256
135 #define OSC_MAX_DIRTY_DEFAULT 2000 /* Arbitrary large value */
136 #define OSC_MAX_DIRTY_MB_MAX 2048 /* arbitrary, but < MAX_LONG bytes */
137 #define OSC_DEFAULT_RESENDS 10
139 /* possible values for fo_sync_lock_cancel */
141 NEVER_SYNC_ON_CANCEL = 0,
142 BLOCKING_SYNC_ON_CANCEL = 1,
143 ALWAYS_SYNC_ON_CANCEL = 2,
144 NUM_SYNC_ON_CANCEL_STATES
148 * Limit reply buffer size for striping data to one x86_64 page. This
149 * value is chosen to fit the striping data for common use cases while
150 * staying well below the limit at which the buffer must be backed by
151 * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
154 #define OBD_MAX_DEFAULT_EA_SIZE 4096
156 enum obd_cl_sem_lock_class {
165 struct rw_semaphore cl_sem;
166 struct obd_uuid cl_target_uuid;
167 struct obd_import *cl_import; /* ptlrpc connection state */
168 size_t cl_conn_count;
170 /* Cache maximum and default values for easize. This is
171 * strictly a performance optimization to minimize calls to
172 * obd_size_diskmd(). The default values are used to calculate the
173 * initial size of a request buffer. The ptlrpc layer will resize the
174 * buffer as needed to accommodate a larger reply from the
175 * server. The default values should be small enough to avoid wasted
176 * memory and excessive use of vmalloc(), yet large enough to avoid
177 * reallocating the buffer in the common use case. */
179 /* Default EA size for striping attributes. It is initialized at
180 * mount-time based on the default stripe width of the filesystem,
181 * then it tracks the largest observed EA size advertised by
182 * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
183 __u32 cl_default_mds_easize;
185 /* Maximum possible EA size computed at mount-time based on
186 * the number of OSTs in the filesystem. May be increased at
187 * run-time if a larger observed size is advertised by the MDT. */
188 __u32 cl_max_mds_easize;
190 /* Data-on-MDT specific value to set larger reply buffer for possible
191 * data read along with open/stat requests. By default it tries to use
192 * unused space in reply buffer.
193 * This value is used to ensure that reply buffer has at least as
194 * much free space as value indicates. That free space is gained from
195 * LOV EA buffer which is small for DoM files and on big systems can
196 * provide up to 32KB of extra space in reply buffer.
197 * Default value is 8K now.
199 __u32 cl_dom_min_inline_repsize;
201 enum lustre_sec_part cl_sp_me;
202 enum lustre_sec_part cl_sp_to;
203 struct sptlrpc_flavor cl_flvr_mgc; /* fixed flavor of mgc->mgs */
205 /* the grant values are protected by loi_list_lock below */
206 unsigned long cl_dirty_pages; /* all _dirty_ in pages */
207 unsigned long cl_dirty_max_pages; /* allowed w/o rpc */
208 unsigned long cl_dirty_transit; /* dirty synchronous */
209 unsigned long cl_avail_grant; /* bytes of credit for ost */
210 unsigned long cl_lost_grant; /* lost credits (trunc) */
211 /* grant consumed for dirty pages */
212 unsigned long cl_dirty_grant;
214 /* since we allocate grant by blocks, we don't know how many grant will
215 * be used to add a page into cache. As a solution, we reserve maximum
216 * grant before trying to dirty a page and unreserve the rest.
217 * See osc_{reserve|unreserve}_grant for details. */
218 long cl_reserved_grant;
219 struct list_head cl_cache_waiters; /* waiting for cache/grant */
220 time64_t cl_next_shrink_grant; /* seconds */
221 struct list_head cl_grant_chain;
222 time64_t cl_grant_shrink_interval; /* seconds */
224 /* A chunk is an optimal size used by osc_extent to determine
225 * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
227 /* extent insertion metadata overhead to be accounted in grant,
229 unsigned int cl_grant_extent_tax;
230 /* maximum extent size, in number of pages */
231 unsigned int cl_max_extent_pages;
233 /* keep track of objects that have lois that contain pages which
234 * have been queued for async brw. this lock also protects the
235 * lists of osc_client_pages that hang off of the loi */
237 * ->cl_loi_list_lock protects consistency of
238 * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
239 * ->ap_completion() call-backs are executed under this lock. As we
240 * cannot guarantee that these call-backs never block on all platforms
241 * (as a matter of fact they do block on Mac OS X), type of
242 * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
243 * and blocking mutex on Mac OS X. (Alternative is to make this lock
244 * blocking everywhere, but we don't want to slow down fast-path of
245 * our main platform.)
247 * NB by Jinshan: though field names are still _loi_, but actually
248 * osc_object{}s are in the list.
250 spinlock_t cl_loi_list_lock;
251 struct list_head cl_loi_ready_list;
252 struct list_head cl_loi_hp_ready_list;
253 struct list_head cl_loi_write_list;
254 struct list_head cl_loi_read_list;
255 __u32 cl_r_in_flight;
256 __u32 cl_w_in_flight;
257 /* just a sum of the loi/lop pending numbers to be exported by /proc */
258 atomic_t cl_pending_w_pages;
259 atomic_t cl_pending_r_pages;
260 u32 cl_max_pages_per_rpc;
261 u32 cl_max_rpcs_in_flight;
262 u32 cl_max_short_io_bytes;
263 struct obd_histogram cl_read_rpc_hist;
264 struct obd_histogram cl_write_rpc_hist;
265 struct obd_histogram cl_read_page_hist;
266 struct obd_histogram cl_write_page_hist;
267 struct obd_histogram cl_read_offset_hist;
268 struct obd_histogram cl_write_offset_hist;
270 /** LRU for osc caching pages */
271 struct cl_client_cache *cl_cache;
272 /** member of cl_cache->ccc_lru */
273 struct list_head cl_lru_osc;
274 /** # of available LRU slots left in the per-OSC cache.
275 * Available LRU slots are shared by all OSCs of the same file system,
276 * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
277 atomic_long_t *cl_lru_left;
278 /** # of busy LRU pages. A page is considered busy if it's in writeback
279 * queue, or in transfer. Busy pages can't be discarded so they are not
281 atomic_long_t cl_lru_busy;
282 /** # of LRU pages in the cache for this client_obd */
283 atomic_long_t cl_lru_in_list;
284 /** # of threads are shrinking LRU cache. To avoid contention, it's not
285 * allowed to have multiple threads shrinking LRU cache. */
286 atomic_t cl_lru_shrinkers;
287 /** The time when this LRU cache was last used. */
288 time64_t cl_lru_last_used;
289 /** stats: how many reclaims have happened for this client_obd.
290 * reclaim and shrink - shrink is async, voluntarily rebalancing;
291 * reclaim is sync, initiated by IO thread when the LRU slots are
293 __u64 cl_lru_reclaim;
294 /** List of LRU pages for this client_obd */
295 struct list_head cl_lru_list;
296 /** Lock for LRU page list */
297 spinlock_t cl_lru_list_lock;
298 /** # of unstable pages in this client_obd.
299 * An unstable page is a page state that WRITE RPC has finished but
300 * the transaction has NOT yet committed. */
301 atomic_long_t cl_unstable_count;
302 /** Link to osc_shrinker_list */
303 struct list_head cl_shrink_list;
305 /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
306 atomic_t cl_destroy_in_flight;
307 wait_queue_head_t cl_destroy_waitq;
309 /* modify rpcs in flight
310 * currently used for metadata only */
311 spinlock_t cl_mod_rpcs_lock;
312 __u16 cl_max_mod_rpcs_in_flight;
313 __u16 cl_mod_rpcs_in_flight;
314 __u16 cl_close_rpcs_in_flight;
315 wait_queue_head_t cl_mod_rpcs_waitq;
316 unsigned long *cl_mod_tag_bitmap;
317 struct obd_histogram cl_mod_rpcs_hist;
320 struct mutex cl_mgc_mutex;
321 struct local_oid_storage *cl_mgc_los;
322 struct dt_object *cl_mgc_configs_dir;
323 struct obd_export *cl_mgc_mgsexp;
324 atomic_t cl_mgc_refcount;
325 /* in-flight control list and total RPCs counter */
326 struct list_head cl_flight_waiters;
327 __u32 cl_rpcs_in_flight;
329 /* checksumming for data sent over the network */
330 unsigned int cl_checksum:1, /* 0 = disabled, 1 = enabled */
331 cl_checksum_dump:1; /* same */
332 /* supported checksum types that are worked out at connect time */
333 __u32 cl_supp_cksum_types;
334 /* checksum algorithm to be used */
335 enum cksum_types cl_cksum_type;
337 /* also protected by the poorly named _loi_list_lock lock above */
338 struct osc_async_rc cl_ar;
340 /* sequence manager */
341 struct lu_client_seq *cl_seq;
342 struct rw_semaphore cl_seq_rwsem;
344 atomic_t cl_resends; /* resend count */
346 /* ptlrpc work for writeback in ptlrpcd context */
347 void *cl_writeback_work;
349 /* hash tables for osc_quota_info */
350 struct cfs_hash *cl_quota_hash[LL_MAXQUOTAS];
351 /* Links to the global list of registered changelog devices */
352 struct list_head cl_chg_dev_linkage;
354 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
361 struct echo_client_obd {
362 struct obd_export *ec_exp; /* the local connection to osc/lov */
364 struct list_head ec_objects;
365 struct list_head ec_locks;
369 /* Generic subset of OSTs */
371 __u32 *op_array; /* array of index of
373 unsigned int op_count; /* number of OSTs in the array */
374 unsigned int op_size; /* allocated size of lp_array */
375 struct rw_semaphore op_rw_sem; /* to protect ost_pool use */
378 /* allow statfs data caching for 1 second */
379 #define OBD_STATFS_CACHE_SECONDS 1
381 struct lov_tgt_desc {
382 struct list_head ltd_kill;
383 struct obd_uuid ltd_uuid;
384 struct obd_device *ltd_obd;
385 struct obd_export *ltd_exp;
387 __u32 ltd_index; /* index in lov_obd->tgts */
388 unsigned long ltd_active:1,/* is this target up for requests */
389 ltd_activate:1,/* should target be activated */
390 ltd_reap:1; /* should this target be deleted */
393 struct lov_md_tgt_desc {
394 struct obd_device *lmtd_mdc;
399 struct lov_desc desc;
400 struct lov_tgt_desc **lov_tgts; /* sparse array */
401 struct ost_pool lov_packed; /* all OSTs in a packed
403 struct mutex lov_lock;
404 struct obd_connect_data lov_ocd;
405 struct proc_dir_entry *targets_proc_entry;
406 atomic_t lov_refcount;
407 __u32 lov_death_row; /* tgts scheduled to be deleted */
408 __u32 lov_tgt_size; /* size of tgts array */
411 struct cfs_hash *lov_pools_hash_body; /* used for key access */
412 struct list_head lov_pool_list; /* used for sequential access */
413 struct proc_dir_entry *lov_pool_proc_entry;
414 enum lustre_sec_part lov_sp_me;
416 /* Cached LRU and unstable data from upper layer */
417 struct cl_client_cache *lov_cache;
419 struct rw_semaphore lov_notify_lock;
420 /* Data-on-MDT: MDC array */
421 struct lov_md_tgt_desc *lov_mdc_tgts;
423 struct kobject *lov_tgts_kobj;
426 struct lmv_tgt_desc {
427 struct obd_uuid ltd_uuid;
428 struct obd_device *ltd_obd;
429 struct obd_export *ltd_exp;
431 struct mutex ltd_fid_mutex;
432 unsigned long ltd_active:1; /* target up for requests */
436 struct lu_client_fld lmv_fld;
438 struct lmv_desc desc;
440 struct mutex lmv_init_mutex;
444 u32 lmv_statfs_start;
446 u32 tgts_size; /* size of tgts array */
447 struct lmv_tgt_desc **tgts;
449 struct obd_connect_data conn_data;
450 struct kobject *lmv_tgts_kobj;
453 /* Minimum sector size is 512 */
454 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
456 struct niobuf_local {
457 __u64 lnb_file_offset;
458 __u32 lnb_page_offset;
462 struct page *lnb_page;
464 __u16 lnb_guards[MAX_GUARD_NUMBER];
465 __u16 lnb_guard_rpc:1;
466 __u16 lnb_guard_disk:1;
469 struct tgt_thread_big_cache {
470 struct niobuf_local local[PTLRPC_MAX_BRW_PAGES];
473 #define LUSTRE_FLD_NAME "fld"
474 #define LUSTRE_SEQ_NAME "seq"
476 #define LUSTRE_MDD_NAME "mdd"
477 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
478 #define LUSTRE_OSD_ZFS_NAME "osd-zfs"
479 #define LUSTRE_VVP_NAME "vvp"
480 #define LUSTRE_LMV_NAME "lmv"
481 #define LUSTRE_SLP_NAME "slp"
482 #define LUSTRE_LOD_NAME "lod"
483 #define LUSTRE_OSP_NAME "osp"
484 #define LUSTRE_LWP_NAME "lwp"
486 /* obd device type names */
487 /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
488 #define LUSTRE_MDS_NAME "mds"
489 #define LUSTRE_MDT_NAME "mdt"
490 #define LUSTRE_MDC_NAME "mdc"
491 #define LUSTRE_OSS_NAME "ost" /* FIXME change name to oss */
492 #define LUSTRE_OST_NAME "obdfilter" /* FIXME change name to ost */
493 #define LUSTRE_OSC_NAME "osc"
494 #define LUSTRE_LOV_NAME "lov"
495 #define LUSTRE_MGS_NAME "mgs"
496 #define LUSTRE_MGC_NAME "mgc"
498 #define LUSTRE_ECHO_NAME "obdecho"
499 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
500 #define LUSTRE_QMT_NAME "qmt"
502 /* Constant obd names (post-rename) */
503 #define LUSTRE_MDS_OBDNAME "MDS"
504 #define LUSTRE_OSS_OBDNAME "OSS"
505 #define LUSTRE_MGS_OBDNAME "MGS"
506 #define LUSTRE_MGC_OBDNAME "MGC"
508 static inline int is_lwp_on_mdt(char *name)
512 ptr = strrchr(name, '-');
514 CERROR("%s is not a obdname\n", name);
518 /* LWP name on MDT is fsname-MDTxxxx-lwp-MDTxxxx */
520 if (strncmp(ptr + 1, "MDT", 3) != 0)
523 while (*(--ptr) != '-' && ptr != name);
528 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
534 static inline int is_lwp_on_ost(char *name)
538 ptr = strrchr(name, '-');
540 CERROR("%s is not a obdname\n", name);
544 /* LWP name on OST is fsname-MDTxxxx-lwp-OSTxxxx */
546 if (strncmp(ptr + 1, "OST", 3) != 0)
549 while (*(--ptr) != '-' && ptr != name);
554 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
561 * Events signalled through obd_notify() upcall-chain.
563 enum obd_notify_event {
564 /* Device connect start */
566 /* Device activated */
568 /* Device deactivated */
570 /* Connect data for import were changed */
572 /* Administratively deactivate/activate event */
573 OBD_NOTIFY_DEACTIVATE,
578 * Data structure used to pass obd_notify()-event to non-obd listeners (llite
579 * being main example).
581 struct obd_notify_upcall {
582 int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
583 enum obd_notify_event ev, void *owner);
584 /* Opaque datum supplied by upper layer listener */
588 struct target_recovery_data {
589 svc_handler_t trd_recovery_handler;
590 pid_t trd_processing_task;
591 struct completion trd_starting;
592 struct completion trd_finishing;
595 struct obd_llog_group {
596 struct llog_ctxt *olg_ctxts[LLOG_MAX_CTXTS];
597 wait_queue_head_t olg_waitq;
599 struct mutex olg_cat_processing;
602 /* corresponds to one of the obd's */
603 #define OBD_DEVICE_MAGIC 0XAB5CD6EF
606 struct obd_type *obd_type;
607 __u32 obd_magic; /* OBD_DEVICE_MAGIC */
608 int obd_minor; /* device number: lctl dl */
609 struct lu_device *obd_lu_dev;
611 /* common and UUID name of this device */
612 struct obd_uuid obd_uuid;
613 char obd_name[MAX_OBD_NAME];
615 /* bitfield modification is protected by obd_dev_lock */
617 obd_attached:1, /* finished attach */
618 obd_set_up:1, /* finished setup */
619 obd_recovering:1, /* there are recoverable clients */
620 obd_abort_recovery:1, /* recovery expired */
621 obd_version_recov:1, /* obd uses version checking */
622 obd_replayable:1, /* recovery enabled; inform clients */
623 obd_no_transno:1, /* no committed-transno notification */
624 obd_no_recov:1, /* fail instead of retry messages */
625 obd_stopping:1, /* started cleanup */
626 obd_starting:1, /* started setup */
627 obd_force:1, /* cleanup with > 0 obd refcount */
628 obd_fail:1, /* cleanup with failover */
629 obd_no_conn:1, /* deny new connections */
630 obd_inactive:1, /* device active/inactive
631 * (for /proc/status only!!) */
632 obd_no_ir:1, /* no imperative recovery. */
633 obd_process_conf:1, /* device is processing mgs config */
634 obd_checksum_dump:1; /* dump pages upon cksum error */
636 /* use separate field as it is set in interrupt to don't mess with
637 * protection of other bits using _bh lock */
638 unsigned long obd_recovery_expired:1;
639 /* uuid-export hash body */
640 struct cfs_hash *obd_uuid_hash;
641 /* nid-export hash body */
642 struct cfs_hash *obd_nid_hash;
644 struct cfs_hash *obd_nid_stats_hash;
645 /* client_generation-export hash body */
646 struct cfs_hash *obd_gen_hash;
647 struct list_head obd_nid_stats;
648 struct list_head obd_exports;
649 struct list_head obd_unlinked_exports;
650 struct list_head obd_delayed_exports;
651 struct list_head obd_lwp_list;
652 atomic_t obd_refcount;
654 spinlock_t obd_nid_lock;
655 struct ldlm_namespace *obd_namespace;
656 struct ptlrpc_client obd_ldlm_client; /* XXX OST/MDS only */
657 /* a spinlock is OK for what we do now, may need a semaphore later */
658 spinlock_t obd_dev_lock; /* protect OBD bitfield above */
659 spinlock_t obd_osfs_lock;
660 struct obd_statfs obd_osfs; /* locked by obd_osfs_lock */
661 time64_t obd_osfs_age;
662 __u64 obd_last_committed;
663 struct mutex obd_dev_mutex;
664 struct lvfs_run_ctxt obd_lvfs_ctxt;
665 struct obd_llog_group obd_olg; /* default llog group */
666 struct obd_device *obd_observer;
667 struct rw_semaphore obd_observer_link_sem;
668 struct obd_notify_upcall obd_upcall;
669 struct obd_export *obd_self_export;
670 struct obd_export *obd_lwp_export;
671 /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
672 struct list_head obd_exports_timed;
673 time64_t obd_eviction_timer; /* for ping evictor */
675 int obd_max_recoverable_clients;
676 atomic_t obd_connected_clients;
677 int obd_stale_clients;
678 /* this lock protects all recovery list_heads, timer and
679 * obd_next_recovery_transno value */
680 spinlock_t obd_recovery_task_lock;
681 __u64 obd_next_recovery_transno;
682 int obd_replayed_requests;
683 int obd_requests_queued_for_recovery;
684 wait_queue_head_t obd_next_transno_waitq;
685 /* protected by obd_recovery_task_lock */
686 struct timer_list obd_recovery_timer;
688 time64_t obd_recovery_start;
689 /* seconds, for lprocfs_status */
690 time64_t obd_recovery_end;
691 time64_t obd_recovery_time_hard;
692 time64_t obd_recovery_timeout;
693 int obd_recovery_ir_factor;
695 /* new recovery stuff from CMD2 */
696 int obd_replayed_locks;
697 atomic_t obd_req_replay_clients;
698 atomic_t obd_lock_replay_clients;
699 struct target_recovery_data obd_recovery_data;
701 /* all lists are protected by obd_recovery_task_lock */
702 struct list_head obd_req_replay_queue;
703 struct list_head obd_lock_replay_queue;
704 struct list_head obd_final_req_queue;
707 #ifdef HAVE_SERVER_SUPPORT
708 struct obd_device_target obt;
709 struct filter_obd filter;
711 struct echo_obd echo;
713 struct client_obd cli;
714 struct echo_client_obd echo_client;
719 /* Fields used by LProcFS */
720 struct lprocfs_stats *obd_stats;
722 struct lprocfs_stats *obd_md_stats;
724 struct dentry *obd_debugfs_entry;
725 struct proc_dir_entry *obd_proc_entry;
726 struct proc_dir_entry *obd_proc_exports_entry;
727 struct dentry *obd_svc_debugfs_entry;
728 struct lprocfs_stats *obd_svc_stats;
729 const struct attribute **obd_attrs;
730 struct lprocfs_vars *obd_vars;
731 atomic_t obd_evict_inprogress;
732 wait_queue_head_t obd_evict_inprogress_waitq;
733 struct list_head obd_evict_list; /* protected with pet_lock */
736 * LDLM pool part. Save last calculated SLV and Limit.
738 rwlock_t obd_pool_lock;
742 int obd_conn_inprogress;
745 * List of outstanding class_incref()'s fo this OBD. For debugging. */
746 struct lu_ref obd_reference;
748 struct kset obd_kset; /* sysfs object collection */
749 struct kobj_type obd_ktype;
750 struct completion obd_kobj_unregister;
753 /* get/set_info keys */
754 #define KEY_ASYNC "async"
755 #define KEY_CHANGELOG_CLEAR "changelog_clear"
756 #define KEY_FID2PATH "fid2path"
757 #define KEY_CHECKSUM "checksum"
758 #define KEY_CLEAR_FS "clear_fs"
759 #define KEY_CONN_DATA "conn_data"
760 #define KEY_EVICT_BY_NID "evict_by_nid"
761 #define KEY_FIEMAP "fiemap"
762 #define KEY_FLUSH_CTX "flush_ctx"
763 #define KEY_GRANT_SHRINK "grant_shrink"
764 #define KEY_HSM_COPYTOOL_SEND "hsm_send"
765 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
766 #define KEY_INTERMDS "inter_mds"
767 #define KEY_LAST_ID "last_id"
768 #define KEY_LAST_FID "last_fid"
769 #define KEY_MAX_EASIZE "max_easize"
770 #define KEY_DEFAULT_EASIZE "default_easize"
771 #define KEY_MGSSEC "mgssec"
772 #define KEY_READ_ONLY "read-only"
773 #define KEY_REGISTER_TARGET "register_target"
774 #define KEY_SET_FS "set_fs"
775 #define KEY_TGT_COUNT "tgt_count"
776 /* KEY_SET_INFO in lustre_idl.h */
777 #define KEY_SPTLRPC_CONF "sptlrpc_conf"
779 #define KEY_CACHE_SET "cache_set"
780 #define KEY_CACHE_LRU_SHRINK "cache_lru_shrink"
781 #define KEY_OSP_CONNECTED "osp_connected"
783 /* Flags for op_xvalid */
785 OP_XVALID_CTIME_SET = BIT(0), /* 0x0001 */
786 OP_XVALID_BLOCKS = BIT(1), /* 0x0002 */
787 OP_XVALID_OWNEROVERRIDE = BIT(2), /* 0x0004 */
788 OP_XVALID_FLAGS = BIT(3), /* 0x0008 */
789 OP_XVALID_PROJID = BIT(4), /* 0x0010 */
790 OP_XVALID_LAZYSIZE = BIT(5), /* 0x0020 */
791 OP_XVALID_LAZYBLOCKS = BIT(6), /* 0x0040 */
796 static inline int it_to_lock_mode(struct lookup_intent *it)
798 /* CREAT needs to be tested before open (both could be set) */
799 if (it->it_op & IT_CREAT)
801 else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
803 else if (it->it_op & IT_LAYOUT)
804 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
805 else if (it->it_op & IT_READDIR)
807 else if (it->it_op & IT_GETXATTR)
810 LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
815 MF_MDC_CANCEL_FID1 = 1 << 0,
816 MF_MDC_CANCEL_FID2 = 1 << 1,
817 MF_MDC_CANCEL_FID3 = 1 << 2,
818 MF_MDC_CANCEL_FID4 = 1 << 3,
819 MF_GET_MDT_IDX = 1 << 4,
823 CLI_SET_MEA = 1 << 0,
824 CLI_RM_ENTRY = 1 << 1,
827 CLI_MIGRATE = 1 << 4,
831 * GETXATTR is not included as only a couple of fields in the reply body
832 * is filled, but not FID which is needed for common intent handling in
833 * mdc_finish_intent_lock()
835 static inline bool it_has_reply_body(const struct lookup_intent *it)
837 return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
841 struct lu_fid op_fid1; /* operation fid1 (usualy parent) */
842 struct lu_fid op_fid2; /* operation fid2 (usualy child) */
843 struct lu_fid op_fid3; /* 2 extra fids to find conflicting */
844 struct lu_fid op_fid4; /* to the operation locks. */
845 u32 op_mds; /* what mds server open will go to */
847 struct lustre_handle op_open_handle;
851 struct rw_semaphore *op_mea1_sem;
852 struct rw_semaphore *op_mea2_sem;
853 struct lmv_stripe_md *op_mea1;
854 struct lmv_stripe_md *op_mea2;
855 __u32 op_suppgids[2];
862 /* iattr fields and blocks. */
863 struct iattr op_attr;
864 enum op_xvalid op_xvalid; /* eXtra validity flags */
865 loff_t op_attr_blocks;
866 u64 op_valid; /* OBD_MD_* */
867 unsigned int op_attr_flags; /* LUSTRE_{SYNC,..}_FL */
869 enum md_op_flags op_flags;
871 /* Various operation flags. */
872 enum mds_op_bias op_bias;
874 /* used to transfer info between the stacks of MD client
875 * see enum op_cli_flags */
876 enum md_cli_flags op_cli_flags;
878 /* File object data version for HSM release, on client */
879 __u64 op_data_version;
880 struct lustre_handle op_lease_handle;
882 /* File security context, for creates. */
883 const char *op_file_secctx_name;
884 void *op_file_secctx;
885 __u32 op_file_secctx_size;
887 /* default stripe offset */
888 __u32 op_default_stripe_offset;
892 /* Used by readdir */
893 unsigned int op_max_pages;
898 * used to access migrating dir: if it's set, assume migration is
899 * finished, use the new layout to access dir, otherwise use old layout.
900 * By default it's not set, because new files are created under new
901 * layout, if we can't find file with name under both old and new
902 * layout, we are sure file with name doesn't exist, but in reverse
903 * order there may be a race with creation by others.
905 bool op_post_migrate;
906 /* used to access dir with bash hash */
907 __u32 op_stripe_index;
911 int (*md_blocking_ast)(struct ldlm_lock *lock,
912 struct ldlm_lock_desc *desc,
913 void *data, int flag);
916 struct md_enqueue_info;
917 /* metadata stat-ahead */
918 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
919 struct md_enqueue_info *minfo,
922 struct md_enqueue_info {
923 struct md_op_data mi_data;
924 struct lookup_intent mi_it;
925 struct lustre_handle mi_lockh;
926 struct inode *mi_dir;
927 struct ldlm_enqueue_info mi_einfo;
928 md_enqueue_cb_t mi_cb;
933 struct module *o_owner;
934 int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
935 void *karg, void __user *uarg);
936 int (*o_get_info)(const struct lu_env *env, struct obd_export *,
937 __u32 keylen, void *key, __u32 *vallen, void *val);
938 int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
939 __u32 keylen, void *key,
940 __u32 vallen, void *val,
941 struct ptlrpc_request_set *set);
942 int (*o_setup) (struct obd_device *dev, struct lustre_cfg *cfg);
943 int (*o_precleanup)(struct obd_device *dev);
944 int (*o_cleanup)(struct obd_device *dev);
945 int (*o_process_config)(struct obd_device *dev, size_t len, void *data);
946 int (*o_postrecov)(struct obd_device *dev);
947 int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
949 int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
950 /* connect to the target device with given connection
951 * data. @ocd->ocd_connect_flags is modified to reflect flags actually
952 * granted by the target, which are guaranteed to be a subset of flags
953 * asked for. If @ocd == NULL, use default parameters. */
954 int (*o_connect)(const struct lu_env *env,
955 struct obd_export **exp, struct obd_device *src,
956 struct obd_uuid *cluuid, struct obd_connect_data *ocd,
958 int (*o_reconnect)(const struct lu_env *env,
959 struct obd_export *exp, struct obd_device *src,
960 struct obd_uuid *cluuid,
961 struct obd_connect_data *ocd,
963 int (*o_disconnect)(struct obd_export *exp);
965 /* Initialize/finalize fids infrastructure. */
966 int (*o_fid_init)(struct obd_device *obd,
967 struct obd_export *exp, enum lu_cli_type type);
968 int (*o_fid_fini)(struct obd_device *obd);
970 /* Allocate new fid according to passed @hint. */
971 int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
972 struct lu_fid *fid, struct md_op_data *op_data);
975 * Object with @fid is getting deleted, we may want to do something
978 int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
979 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
980 int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
981 time64_t max_age, struct ptlrpc_request_set *set);
982 int (*o_create)(const struct lu_env *env, struct obd_export *exp,
984 int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
986 int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
988 int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
990 int (*o_preprw)(const struct lu_env *env, int cmd,
991 struct obd_export *exp, struct obdo *oa, int objcount,
992 struct obd_ioobj *obj, struct niobuf_remote *remote,
993 int *nr_pages, struct niobuf_local *local);
994 int (*o_commitrw)(const struct lu_env *env, int cmd,
995 struct obd_export *exp, struct obdo *oa,
996 int objcount, struct obd_ioobj *obj,
997 struct niobuf_remote *remote, int pages,
998 struct niobuf_local *local, int rc);
999 int (*o_init_export)(struct obd_export *exp);
1000 int (*o_destroy_export)(struct obd_export *exp);
1002 int (*o_import_event)(struct obd_device *, struct obd_import *,
1003 enum obd_import_event);
1005 int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1006 enum obd_notify_event ev);
1008 int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1009 struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1012 int (*o_quotactl)(struct obd_device *, struct obd_export *,
1013 struct obd_quotactl *);
1015 int (*o_ping)(const struct lu_env *, struct obd_export *exp);
1018 int (*o_pool_new)(struct obd_device *obd, char *poolname);
1019 int (*o_pool_del)(struct obd_device *obd, char *poolname);
1020 int (*o_pool_add)(struct obd_device *obd, char *poolname,
1022 int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1026 /* lmv structures */
1028 struct mdt_body *body;
1029 struct lu_buf layout;
1030 struct lmv_stripe_md *lmv;
1031 #ifdef CONFIG_FS_POSIX_ACL
1032 struct posix_acl *posix_acl;
1036 struct md_open_data {
1037 struct obd_client_handle *mod_och;
1038 struct ptlrpc_request *mod_open_req;
1039 struct ptlrpc_request *mod_close_req;
1040 atomic_t mod_refcount;
1044 struct obd_client_handle {
1045 struct lustre_handle och_open_handle;
1046 struct lu_fid och_fid;
1047 struct md_open_data *och_mod;
1048 struct lustre_handle och_lease_handle; /* open lock for lease */
1053 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1055 struct lookup_intent;
1059 int (*m_close)(struct obd_export *, struct md_op_data *,
1060 struct md_open_data *, struct ptlrpc_request **);
1062 int (*m_create)(struct obd_export *, struct md_op_data *,
1063 const void *, size_t, umode_t, uid_t, gid_t,
1064 cfs_cap_t, __u64, struct ptlrpc_request **);
1066 int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1067 const union ldlm_policy_data *, struct md_op_data *,
1068 struct lustre_handle *, __u64);
1070 int (*m_getattr)(struct obd_export *, struct md_op_data *,
1071 struct ptlrpc_request **);
1073 int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1074 struct lookup_intent *,
1075 struct ptlrpc_request **,
1076 ldlm_blocking_callback, __u64);
1078 int (*m_link)(struct obd_export *, struct md_op_data *,
1079 struct ptlrpc_request **);
1081 int (*m_rename)(struct obd_export *, struct md_op_data *,
1082 const char *, size_t, const char *, size_t,
1083 struct ptlrpc_request **);
1085 int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1086 size_t , struct ptlrpc_request **);
1088 int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1089 struct ptlrpc_request **);
1091 int (*m_read_page)(struct obd_export *, struct md_op_data *,
1092 struct md_callback *cb_op, __u64 hash_offset,
1093 struct page **ppage);
1095 int (*m_unlink)(struct obd_export *, struct md_op_data *,
1096 struct ptlrpc_request **);
1098 int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1099 u64, const char *, const void *, size_t, unsigned int,
1100 u32, struct ptlrpc_request **);
1102 int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1103 u64, const char *, size_t, struct ptlrpc_request **);
1105 int (*m_intent_getattr_async)(struct obd_export *,
1106 struct md_enqueue_info *);
1108 int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1109 struct lu_fid *, __u64 *bits);
1111 int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1113 int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1114 int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1116 int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1117 struct ptlrpc_request **);
1119 int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1121 int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1122 struct obd_export *, struct obd_export *,
1123 struct lustre_md *);
1125 int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1127 int (*m_merge_attr)(struct obd_export *,
1128 const struct lmv_stripe_md *lsm,
1129 struct cl_attr *attr, ldlm_blocking_callback);
1131 int (*m_set_open_replay_data)(struct obd_export *,
1132 struct obd_client_handle *,
1133 struct lookup_intent *);
1135 int (*m_clear_open_replay_data)(struct obd_export *,
1136 struct obd_client_handle *);
1138 int (*m_set_lock_data)(struct obd_export *,
1139 const struct lustre_handle *, void *, __u64 *);
1141 enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1142 const struct lu_fid *, enum ldlm_type,
1143 union ldlm_policy_data *, enum ldlm_mode,
1144 struct lustre_handle *);
1146 int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1147 union ldlm_policy_data *, enum ldlm_mode,
1148 enum ldlm_cancel_flags flags, void *opaque);
1150 int (*m_get_fid_from_lsm)(struct obd_export *,
1151 const struct lmv_stripe_md *,
1152 const char *name, int namelen,
1153 struct lu_fid *fid);
1154 int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1155 const union lmv_mds_md *lmv, size_t lmv_size);
1158 static inline struct md_open_data *obd_mod_alloc(void)
1160 struct md_open_data *mod;
1164 atomic_set(&mod->mod_refcount, 1);
1168 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1169 #define obd_mod_put(mod) \
1171 if (atomic_dec_and_test(&(mod)->mod_refcount)) { \
1172 if ((mod)->mod_open_req) \
1173 ptlrpc_req_finished((mod)->mod_open_req); \
1174 OBD_FREE_PTR(mod); \
1178 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1179 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1180 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1182 /* return 1 if client should be resend request */
1183 static inline int client_should_resend(int resend, struct client_obd *cli)
1185 return atomic_read(&cli->cl_resends) ?
1186 atomic_read(&cli->cl_resends) > resend : 1;
1190 * Return device name for this device
1192 * XXX: lu_device is declared before obd_device, while a pointer pointing
1193 * back to obd_device in lu_device, so this helper function defines here
1194 * instead of in lu_object.h
1196 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1198 return lu_dev->ld_obd->obd_name;
1201 static inline bool filename_is_volatile(const char *name, size_t namelen,
1207 if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1210 /* caller does not care of idx */
1214 /* volatile file, the MDT can be set from name */
1215 /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1216 /* if no MDT is specified, use std way */
1217 if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1219 /* test for no MDT idx case */
1220 if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1221 (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1225 /* we have an idx, read it */
1226 start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1227 *idx = simple_strtoul(start, &end, 16);
1229 * no digit, no trailing :, negative value
1231 if (((*idx == 0) && (end == start)) ||
1232 (*end != ':') || (*idx < 0))
1237 /* bad format of mdt idx, we cannot return an error
1238 * to caller so we use hash algo */
1239 CERROR("Bad volatile file name format: %s\n",
1240 name + LUSTRE_VOLATILE_HDR_LEN);
1244 static inline int cli_brw_size(struct obd_device *obd)
1246 LASSERT(obd != NULL);
1247 return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1251 * When RPC size or the max RPCs in flight is increased, the max dirty pages
1252 * of the client should be increased accordingly to avoid sending fragmented
1253 * RPCs over the network when the client runs out of the maximum dirty space
1254 * when so many RPCs are being generated.
1256 static inline void client_adjust_max_dirty(struct client_obd *cli)
1259 if (cli->cl_dirty_max_pages <= 0) {
1260 cli->cl_dirty_max_pages =
1261 (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1263 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1264 cli->cl_max_pages_per_rpc;
1266 if (dirty_max > cli->cl_dirty_max_pages)
1267 cli->cl_dirty_max_pages = dirty_max;
1270 if (cli->cl_dirty_max_pages > totalram_pages / 8)
1271 cli->cl_dirty_max_pages = totalram_pages / 8;
1273 /* This value is exported to userspace through the max_dirty_mb
1274 * parameter. So we round up the number of pages to make it a round
1276 cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1277 1 << (20 - PAGE_SHIFT));
1280 #endif /* __OBD_H */