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 struct obd_device *oi_obd;
91 struct lu_tgt_desc *oi_tgt;
92 /* statfs data specific for every OSC, if needed at all. */
93 struct obd_statfs *oi_osfs;
94 /* An update callback which is called to update some data on upper
95 * level. E.g. it is used for update lsm->lsm_oinfo at every received
96 * request in osc level for enqueue requests. It is also possible to
97 * update some caller data from LOV layer if needed. */
98 obd_enqueue_update_f oi_cb_up;
102 const struct obd_ops *typ_dt_ops;
103 const struct md_ops *typ_md_ops;
104 struct proc_dir_entry *typ_procroot;
105 struct dentry *typ_debugfs_entry;
106 #ifdef HAVE_SERVER_SUPPORT
110 struct lu_device_type *typ_lu;
111 struct kobject typ_kobj;
113 #define typ_name typ_kobj.name
122 struct timeout_item {
123 enum timeout_event ti_event;
127 struct list_head ti_obd_list;
128 struct list_head ti_chain;
131 #define OBD_MAX_RIF_DEFAULT 8
132 #define OBD_MAX_RIF_MAX 512
133 #define OSC_MAX_RIF_MAX 256
134 #define OSC_MAX_DIRTY_DEFAULT 2000 /* Arbitrary large value */
135 #define OSC_MAX_DIRTY_MB_MAX 2048 /* arbitrary, but < MAX_LONG bytes */
136 #define OSC_DEFAULT_RESENDS 10
138 /* possible values for lut_sync_lock_cancel */
139 enum tgt_sync_lock_cancel {
140 SYNC_LOCK_CANCEL_NEVER = 0,
141 SYNC_LOCK_CANCEL_BLOCKING = 1,
142 SYNC_LOCK_CANCEL_ALWAYS = 2,
146 * Limit reply buffer size for striping data to one x86_64 page. This
147 * value is chosen to fit the striping data for common use cases while
148 * staying well below the limit at which the buffer must be backed by
149 * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
152 #define OBD_MAX_DEFAULT_EA_SIZE 4096
155 * Lustre can handle larger xattrs internally, but we must respect the Linux
156 * VFS limitation or tools like tar cannot interact with Lustre volumes
159 #define OBD_MAX_EA_SIZE XATTR_SIZE_MAX
162 enum obd_cl_sem_lock_class {
171 struct rw_semaphore cl_sem;
172 struct obd_uuid cl_target_uuid;
173 struct obd_import *cl_import; /* ptlrpc connection state */
174 size_t cl_conn_count;
176 /* Cache maximum and default values for easize. This is
177 * strictly a performance optimization to minimize calls to
178 * obd_size_diskmd(). The default values are used to calculate the
179 * initial size of a request buffer. The ptlrpc layer will resize the
180 * buffer as needed to accommodate a larger reply from the
181 * server. The default values should be small enough to avoid wasted
182 * memory and excessive use of vmalloc(), yet large enough to avoid
183 * reallocating the buffer in the common use case. */
185 /* Default EA size for striping attributes. It is initialized at
186 * mount-time based on the default stripe width of the filesystem,
187 * then it tracks the largest observed EA size advertised by
188 * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
189 __u32 cl_default_mds_easize;
191 /* Maximum possible EA size computed at mount-time based on
192 * the number of OSTs in the filesystem. May be increased at
193 * run-time if a larger observed size is advertised by the MDT. */
194 __u32 cl_max_mds_easize;
196 /* Data-on-MDT specific value to set larger reply buffer for possible
197 * data read along with open/stat requests. By default it tries to use
198 * unused space in reply buffer.
199 * This value is used to ensure that reply buffer has at least as
200 * much free space as value indicates. That free space is gained from
201 * LOV EA buffer which is small for DoM files and on big systems can
202 * provide up to 32KB of extra space in reply buffer.
203 * Default value is 8K now.
205 __u32 cl_dom_min_inline_repsize;
207 enum lustre_sec_part cl_sp_me;
208 enum lustre_sec_part cl_sp_to;
209 struct sptlrpc_flavor cl_flvr_mgc; /* fixed flavor of mgc->mgs */
211 /* the grant values are protected by loi_list_lock below */
212 unsigned long cl_dirty_pages; /* all _dirty_ in pages */
213 unsigned long cl_dirty_max_pages; /* allowed w/o rpc */
214 unsigned long cl_avail_grant; /* bytes of credit for ost */
215 unsigned long cl_lost_grant; /* lost credits (trunc) */
216 /* grant consumed for dirty pages */
217 unsigned long cl_dirty_grant;
219 /* since we allocate grant by blocks, we don't know how many grant will
220 * be used to add a page into cache. As a solution, we reserve maximum
221 * grant before trying to dirty a page and unreserve the rest.
222 * See osc_{reserve|unreserve}_grant for details. */
223 long cl_reserved_grant;
224 wait_queue_head_t cl_cache_waiters; /* waiting for cache/grant */
225 time64_t cl_next_shrink_grant; /* seconds */
226 struct list_head cl_grant_chain;
227 time64_t cl_grant_shrink_interval; /* seconds */
229 /* A chunk is an optimal size used by osc_extent to determine
230 * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
232 /* extent insertion metadata overhead to be accounted in grant,
234 unsigned int cl_grant_extent_tax;
235 /* maximum extent size, in number of pages */
236 unsigned int cl_max_extent_pages;
238 /* keep track of objects that have lois that contain pages which
239 * have been queued for async brw. this lock also protects the
240 * lists of osc_client_pages that hang off of the loi */
242 * ->cl_loi_list_lock protects consistency of
243 * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
244 * ->ap_completion() call-backs are executed under this lock. As we
245 * cannot guarantee that these call-backs never block on all platforms
246 * (as a matter of fact they do block on Mac OS X), type of
247 * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
248 * and blocking mutex on Mac OS X. (Alternative is to make this lock
249 * blocking everywhere, but we don't want to slow down fast-path of
250 * our main platform.)
252 * NB by Jinshan: though field names are still _loi_, but actually
253 * osc_object{}s are in the list.
255 spinlock_t cl_loi_list_lock;
256 struct list_head cl_loi_ready_list;
257 struct list_head cl_loi_hp_ready_list;
258 struct list_head cl_loi_write_list;
259 struct list_head cl_loi_read_list;
260 __u32 cl_r_in_flight;
261 __u32 cl_w_in_flight;
262 /* just a sum of the loi/lop pending numbers to be exported by /proc */
263 atomic_t cl_pending_w_pages;
264 atomic_t cl_pending_r_pages;
265 u32 cl_max_pages_per_rpc;
266 u32 cl_max_rpcs_in_flight;
267 u32 cl_max_short_io_bytes;
268 struct obd_histogram cl_read_rpc_hist;
269 struct obd_histogram cl_write_rpc_hist;
270 struct obd_histogram cl_read_page_hist;
271 struct obd_histogram cl_write_page_hist;
272 struct obd_histogram cl_read_offset_hist;
273 struct obd_histogram cl_write_offset_hist;
275 /** LRU for osc caching pages */
276 struct cl_client_cache *cl_cache;
277 /** member of cl_cache->ccc_lru */
278 struct list_head cl_lru_osc;
279 /** # of available LRU slots left in the per-OSC cache.
280 * Available LRU slots are shared by all OSCs of the same file system,
281 * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
282 atomic_long_t *cl_lru_left;
283 /** # of busy LRU pages. A page is considered busy if it's in writeback
284 * queue, or in transfer. Busy pages can't be discarded so they are not
286 atomic_long_t cl_lru_busy;
287 /** # of LRU pages in the cache for this client_obd */
288 atomic_long_t cl_lru_in_list;
289 /** # of threads are shrinking LRU cache. To avoid contention, it's not
290 * allowed to have multiple threads shrinking LRU cache. */
291 atomic_t cl_lru_shrinkers;
292 /** The time when this LRU cache was last used. */
293 time64_t cl_lru_last_used;
294 /** stats: how many reclaims have happened for this client_obd.
295 * reclaim and shrink - shrink is async, voluntarily rebalancing;
296 * reclaim is sync, initiated by IO thread when the LRU slots are
298 __u64 cl_lru_reclaim;
299 /** List of LRU pages for this client_obd */
300 struct list_head cl_lru_list;
301 /** Lock for LRU page list */
302 spinlock_t cl_lru_list_lock;
303 /** # of unstable pages in this client_obd.
304 * An unstable page is a page state that WRITE RPC has finished but
305 * the transaction has NOT yet committed. */
306 atomic_long_t cl_unstable_count;
307 /** Link to osc_shrinker_list */
308 struct list_head cl_shrink_list;
310 /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
311 atomic_t cl_destroy_in_flight;
312 wait_queue_head_t cl_destroy_waitq;
314 /* modify rpcs in flight
315 * currently used for metadata only */
316 spinlock_t cl_mod_rpcs_lock;
317 __u16 cl_max_mod_rpcs_in_flight;
318 __u16 cl_mod_rpcs_in_flight;
319 __u16 cl_close_rpcs_in_flight;
320 wait_queue_head_t cl_mod_rpcs_waitq;
321 unsigned long *cl_mod_tag_bitmap;
322 struct obd_histogram cl_mod_rpcs_hist;
325 struct mutex cl_mgc_mutex;
326 struct local_oid_storage *cl_mgc_los;
327 struct dt_object *cl_mgc_configs_dir;
328 struct obd_export *cl_mgc_mgsexp;
329 atomic_t cl_mgc_refcount;
330 /* in-flight control list and total RPCs counter */
331 struct list_head cl_flight_waiters;
332 __u32 cl_rpcs_in_flight;
334 /* checksumming for data sent over the network */
335 unsigned int cl_checksum:1, /* 0 = disabled, 1 = enabled */
336 cl_checksum_dump:1; /* same */
337 /* supported checksum types that are worked out at connect time */
338 __u32 cl_supp_cksum_types;
339 /* checksum algorithm to be used */
340 enum cksum_types cl_cksum_type;
341 /* preferred checksum algorithm to be used */
342 enum cksum_types cl_preferred_cksum_type;
344 /* also protected by the poorly named _loi_list_lock lock above */
345 struct osc_async_rc cl_ar;
347 /* sequence manager */
348 struct lu_client_seq *cl_seq;
349 struct rw_semaphore cl_seq_rwsem;
351 atomic_t cl_resends; /* resend count */
353 /* ptlrpc work for writeback in ptlrpcd context */
354 void *cl_writeback_work;
356 struct mutex cl_quota_mutex;
357 /* hash tables for osc_quota_info */
358 struct cfs_hash *cl_quota_hash[LL_MAXQUOTAS];
359 /* the xid of the request updating the hash tables */
360 __u64 cl_quota_last_xid;
361 /* Links to the global list of registered changelog devices */
362 struct list_head cl_chg_dev_linkage;
364 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
371 struct echo_client_obd {
372 struct obd_export *ec_exp; /* the local connection to osc/lov */
374 struct list_head ec_objects;
375 struct list_head ec_locks;
379 /* allow statfs data caching for 1 second */
380 #define OBD_STATFS_CACHE_SECONDS 1
381 /* arbitrary maximum. larger would be useless, allows catching bogus input */
382 #define OBD_STATFS_CACHE_MAX_AGE 3600 /* seconds */
384 #define lov_tgt_desc lu_tgt_desc
386 struct lov_md_tgt_desc {
387 struct obd_device *lmtd_mdc;
392 struct lov_desc desc;
393 struct lov_tgt_desc **lov_tgts; /* sparse array */
394 struct lu_tgt_pool lov_packed; /* all OSTs in a packed
396 struct mutex lov_lock;
397 struct obd_connect_data lov_ocd;
398 struct proc_dir_entry *targets_proc_entry;
399 atomic_t lov_refcount;
400 __u32 lov_death_row; /* tgts scheduled to be deleted */
401 __u32 lov_tgt_size; /* size of tgts array */
404 struct rhashtable lov_pools_hash_body; /* used for key access */
405 struct list_head lov_pool_list; /* used for sequential access */
406 struct proc_dir_entry *lov_pool_proc_entry;
407 enum lustre_sec_part lov_sp_me;
409 /* Cached LRU and unstable data from upper layer */
410 struct cl_client_cache *lov_cache;
412 struct rw_semaphore lov_notify_lock;
413 /* Data-on-MDT: MDC array */
414 struct lov_md_tgt_desc *lov_mdc_tgts;
416 struct kobject *lov_tgts_kobj;
419 #define lmv_tgt_desc lu_tgt_desc
422 struct lu_client_fld lmv_fld;
428 u32 lmv_statfs_start;
430 struct lu_tgt_descs lmv_mdt_descs;
432 struct obd_connect_data conn_data;
433 struct kobject *lmv_tgts_kobj;
436 __u32 lmv_qos_rr_index;
439 #define lmv_mdt_count lmv_mdt_descs.ltd_lmv_desc.ld_tgt_count
440 #define lmv_qos lmv_mdt_descs.ltd_qos
442 /* Minimum sector size is 512 */
443 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
445 struct niobuf_local {
446 __u64 lnb_file_offset;
447 __u32 lnb_page_offset;
451 struct page *lnb_page;
453 __u16 lnb_guards[MAX_GUARD_NUMBER];
454 __u16 lnb_guard_rpc:1;
455 __u16 lnb_guard_disk:1;
456 /* separate unlock for read path to allow shared access */
460 struct tgt_thread_big_cache {
461 struct niobuf_local local[PTLRPC_MAX_BRW_PAGES];
464 #define LUSTRE_FLD_NAME "fld"
465 #define LUSTRE_SEQ_NAME "seq"
467 #define LUSTRE_MDD_NAME "mdd"
468 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
469 #define LUSTRE_OSD_ZFS_NAME "osd-zfs"
470 #define LUSTRE_VVP_NAME "vvp"
471 #define LUSTRE_LMV_NAME "lmv"
472 #define LUSTRE_SLP_NAME "slp"
473 #define LUSTRE_LOD_NAME "lod"
474 #define LUSTRE_OSP_NAME "osp"
475 #define LUSTRE_LWP_NAME "lwp"
477 /* obd device type names */
478 /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
479 #define LUSTRE_MDS_NAME "mds"
480 #define LUSTRE_MDT_NAME "mdt"
481 #define LUSTRE_MDC_NAME "mdc"
482 #define LUSTRE_OSS_NAME "ost" /* FIXME change name to oss */
483 #define LUSTRE_OST_NAME "obdfilter" /* FIXME change name to ost */
484 #define LUSTRE_OSC_NAME "osc"
485 #define LUSTRE_LOV_NAME "lov"
486 #define LUSTRE_MGS_NAME "mgs"
487 #define LUSTRE_MGC_NAME "mgc"
489 #define LUSTRE_ECHO_NAME "obdecho"
490 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
491 #define LUSTRE_QMT_NAME "qmt"
493 /* Constant obd names (post-rename) */
494 #define LUSTRE_MDS_OBDNAME "MDS"
495 #define LUSTRE_OSS_OBDNAME "OSS"
496 #define LUSTRE_MGS_OBDNAME "MGS"
497 #define LUSTRE_MGC_OBDNAME "MGC"
499 static inline int is_lwp_on_mdt(char *name)
503 ptr = strrchr(name, '-');
505 CERROR("%s is not a obdname\n", name);
509 /* LWP name on MDT is fsname-MDTxxxx-lwp-MDTxxxx */
511 if (strncmp(ptr + 1, "MDT", 3) != 0)
514 while (*(--ptr) != '-' && ptr != name);
519 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
525 static inline int is_lwp_on_ost(char *name)
529 ptr = strrchr(name, '-');
531 CERROR("%s is not a obdname\n", name);
535 /* LWP name on OST is fsname-MDTxxxx-lwp-OSTxxxx */
537 if (strncmp(ptr + 1, "OST", 3) != 0)
540 while (*(--ptr) != '-' && ptr != name);
545 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
552 * Events signalled through obd_notify() upcall-chain.
554 enum obd_notify_event {
555 /* Device connect start */
557 /* Device activated */
559 /* Device deactivated */
561 /* Connect data for import were changed */
563 /* Administratively deactivate/activate event */
564 OBD_NOTIFY_DEACTIVATE,
569 * Data structure used to pass obd_notify()-event to non-obd listeners (llite
570 * being main example).
572 struct obd_notify_upcall {
573 int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
574 enum obd_notify_event ev, void *owner);
575 /* Opaque datum supplied by upper layer listener */
579 struct target_recovery_data {
580 svc_handler_t trd_recovery_handler;
581 pid_t trd_processing_task;
582 struct completion trd_starting;
583 struct completion trd_finishing;
586 struct obd_llog_group {
587 struct llog_ctxt *olg_ctxts[LLOG_MAX_CTXTS];
588 wait_queue_head_t olg_waitq;
592 /* corresponds to one of the obd's */
593 #define OBD_DEVICE_MAGIC 0XAB5CD6EF
596 struct obd_type *obd_type;
597 __u32 obd_magic; /* OBD_DEVICE_MAGIC */
598 int obd_minor; /* device number: lctl dl */
599 struct lu_device *obd_lu_dev;
601 /* common and UUID name of this device */
602 struct obd_uuid obd_uuid;
603 char obd_name[MAX_OBD_NAME];
605 /* bitfield modification is protected by obd_dev_lock */
607 obd_attached:1, /* finished attach */
608 obd_set_up:1, /* finished setup */
609 obd_recovering:1, /* there are recoverable clients */
610 obd_abort_recovery:1, /* recovery expired */
611 obd_version_recov:1, /* obd uses version checking */
612 obd_replayable:1, /* recovery enabled; inform clients */
613 obd_no_recov:1, /* fail instead of retry messages */
614 obd_stopping:1, /* started cleanup */
615 obd_starting:1, /* started setup */
616 obd_force:1, /* cleanup with > 0 obd refcount */
617 obd_fail:1, /* cleanup with failover */
618 obd_no_conn:1, /* deny new connections */
619 obd_inactive:1, /* device active/inactive
620 * (for /proc/status only!!) */
621 obd_no_ir:1, /* no imperative recovery. */
622 obd_process_conf:1, /* device is processing mgs config */
623 obd_checksum_dump:1; /* dump pages upon cksum error */
624 #ifdef HAVE_SERVER_SUPPORT
625 /* no committed-transno notification */
626 unsigned long obd_no_transno:1;
629 /* use separate field as it is set in interrupt to don't mess with
630 * protection of other bits using _bh lock */
631 unsigned long obd_recovery_expired:1;
632 /* uuid-export hash body */
633 struct rhashtable obd_uuid_hash;
634 /* nid-export hash body */
635 struct cfs_hash *obd_nid_hash;
637 struct cfs_hash *obd_nid_stats_hash;
638 /* client_generation-export hash body */
639 struct cfs_hash *obd_gen_hash;
640 struct list_head obd_nid_stats;
641 struct list_head obd_exports;
642 struct list_head obd_unlinked_exports;
643 struct list_head obd_delayed_exports;
644 struct list_head obd_lwp_list;
645 atomic_t obd_refcount;
647 spinlock_t obd_nid_lock;
648 struct ldlm_namespace *obd_namespace;
649 struct ptlrpc_client obd_ldlm_client; /* XXX OST/MDS only */
650 /* a spinlock is OK for what we do now, may need a semaphore later */
651 spinlock_t obd_dev_lock; /* protect OBD bitfield above */
652 spinlock_t obd_osfs_lock;
653 struct obd_statfs obd_osfs; /* locked by obd_osfs_lock */
654 time64_t obd_osfs_age;
655 __u64 obd_last_committed;
656 struct mutex obd_dev_mutex;
657 struct lvfs_run_ctxt obd_lvfs_ctxt;
658 struct obd_llog_group obd_olg; /* default llog group */
659 struct obd_device *obd_observer;
660 struct rw_semaphore obd_observer_link_sem;
661 struct obd_notify_upcall obd_upcall;
662 struct obd_export *obd_self_export;
663 struct obd_export *obd_lwp_export;
664 /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
665 struct list_head obd_exports_timed;
666 time64_t obd_eviction_timer; /* for ping evictor */
668 atomic_t obd_max_recoverable_clients;
669 atomic_t obd_connected_clients;
670 int obd_stale_clients;
671 /* this lock protects all recovery list_heads, timer and
672 * obd_next_recovery_transno value */
673 spinlock_t obd_recovery_task_lock;
674 __u64 obd_next_recovery_transno;
675 int obd_replayed_requests;
676 int obd_requests_queued_for_recovery;
677 wait_queue_head_t obd_next_transno_waitq;
678 /* protected by obd_recovery_task_lock */
679 struct hrtimer obd_recovery_timer;
681 time64_t obd_recovery_start;
682 /* seconds, for lprocfs_status */
683 time64_t obd_recovery_end;
684 /* To tell timeouts from time stamps Lustre uses time_t
685 * instead of time64_t.
687 time_t obd_recovery_time_hard;
688 time_t obd_recovery_timeout;
689 int obd_recovery_ir_factor;
691 /* new recovery stuff from CMD2 */
692 int obd_replayed_locks;
693 atomic_t obd_req_replay_clients;
694 atomic_t obd_lock_replay_clients;
695 struct target_recovery_data obd_recovery_data;
697 /* all lists are protected by obd_recovery_task_lock */
698 struct list_head obd_req_replay_queue;
699 struct list_head obd_lock_replay_queue;
700 struct list_head obd_final_req_queue;
703 #ifdef HAVE_SERVER_SUPPORT
704 struct obd_device_target obt;
705 struct filter_obd filter;
707 struct echo_obd echo;
709 struct client_obd cli;
710 struct echo_client_obd echo_client;
715 /* Fields used by LProcFS */
716 struct lprocfs_stats *obd_stats;
718 struct lprocfs_stats *obd_md_stats;
720 struct dentry *obd_debugfs_entry;
721 struct proc_dir_entry *obd_proc_entry;
722 struct proc_dir_entry *obd_proc_exports_entry;
723 struct dentry *obd_svc_debugfs_entry;
724 struct lprocfs_stats *obd_svc_stats;
725 const struct attribute **obd_attrs;
726 struct lprocfs_vars *obd_vars;
727 atomic_t obd_evict_inprogress;
728 wait_queue_head_t obd_evict_inprogress_waitq;
729 struct list_head obd_evict_list; /* protected with pet_lock */
732 * LDLM pool part. Save last calculated SLV and Limit.
734 rwlock_t obd_pool_lock;
738 int obd_conn_inprogress;
741 * List of outstanding class_incref()'s fo this OBD. For debugging. */
742 struct lu_ref obd_reference;
744 struct kset obd_kset; /* sysfs object collection */
745 struct kobj_type obd_ktype;
746 struct completion obd_kobj_unregister;
749 int obd_uuid_add(struct obd_device *obd, struct obd_export *export);
750 void obd_uuid_del(struct obd_device *obd, struct obd_export *export);
751 #ifdef HAVE_SERVER_SUPPORT
752 struct obd_export *obd_uuid_lookup(struct obd_device *obd,
753 struct obd_uuid *uuid);
756 /* get/set_info keys */
757 #define KEY_ASYNC "async"
758 #define KEY_CHANGELOG_CLEAR "changelog_clear"
759 #define KEY_FID2PATH "fid2path"
760 #define KEY_CHECKSUM "checksum"
761 #define KEY_CLEAR_FS "clear_fs"
762 #define KEY_CONN_DATA "conn_data"
763 #define KEY_EVICT_BY_NID "evict_by_nid"
764 #define KEY_FIEMAP "fiemap"
765 #define KEY_FLUSH_CTX "flush_ctx"
766 #define KEY_GRANT_SHRINK "grant_shrink"
767 #define KEY_HSM_COPYTOOL_SEND "hsm_send"
768 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
769 #define KEY_INTERMDS "inter_mds"
770 #define KEY_LAST_ID "last_id"
771 #define KEY_LAST_FID "last_fid"
772 #define KEY_MAX_EASIZE "max_easize"
773 #define KEY_DEFAULT_EASIZE "default_easize"
774 #define KEY_MGSSEC "mgssec"
775 #define KEY_READ_ONLY "read-only"
776 #define KEY_REGISTER_TARGET "register_target"
777 #define KEY_SET_FS "set_fs"
778 #define KEY_TGT_COUNT "tgt_count"
779 /* KEY_SET_INFO in lustre_idl.h */
780 #define KEY_SPTLRPC_CONF "sptlrpc_conf"
782 #define KEY_CACHE_LRU_SHRINK "cache_lru_shrink"
783 #define KEY_OSP_CONNECTED "osp_connected"
785 /* Flags for op_xvalid */
787 OP_XVALID_CTIME_SET = BIT(0), /* 0x0001 */
788 OP_XVALID_BLOCKS = BIT(1), /* 0x0002 */
789 OP_XVALID_OWNEROVERRIDE = BIT(2), /* 0x0004 */
790 OP_XVALID_FLAGS = BIT(3), /* 0x0008 */
791 OP_XVALID_PROJID = BIT(4), /* 0x0010 */
792 OP_XVALID_LAZYSIZE = BIT(5), /* 0x0020 */
793 OP_XVALID_LAZYBLOCKS = BIT(6), /* 0x0040 */
798 static inline int it_to_lock_mode(struct lookup_intent *it)
800 /* CREAT needs to be tested before open (both could be set) */
801 if (it->it_op & IT_CREAT)
803 else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
805 else if (it->it_op & IT_LAYOUT)
806 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
807 else if (it->it_op & IT_READDIR)
809 else if (it->it_op & IT_GETXATTR)
812 LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
817 MF_MDC_CANCEL_FID1 = 1 << 0,
818 MF_MDC_CANCEL_FID2 = 1 << 1,
819 MF_MDC_CANCEL_FID3 = 1 << 2,
820 MF_MDC_CANCEL_FID4 = 1 << 3,
821 MF_GET_MDT_IDX = 1 << 4,
825 CLI_SET_MEA = 1 << 0,
826 CLI_RM_ENTRY = 1 << 1,
829 CLI_MIGRATE = 1 << 4,
830 CLI_DIRTY_DATA = 1 << 5,
834 LUSTRE_OPC_MKDIR = 0,
835 LUSTRE_OPC_SYMLINK = 1,
836 LUSTRE_OPC_MKNOD = 2,
837 LUSTRE_OPC_CREATE = 3,
842 * GETXATTR is not included as only a couple of fields in the reply body
843 * is filled, but not FID which is needed for common intent handling in
844 * mdc_finish_intent_lock()
846 static inline bool it_has_reply_body(const struct lookup_intent *it)
848 return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
852 struct lu_fid op_fid1; /* operation fid1 (usualy parent) */
853 struct lu_fid op_fid2; /* operation fid2 (usualy child) */
854 struct lu_fid op_fid3; /* 2 extra fids to find conflicting */
855 struct lu_fid op_fid4; /* to the operation locks. */
856 u32 op_mds; /* what mds server open will go to */
858 enum md_op_code op_code;
859 struct lustre_handle op_open_handle;
863 struct rw_semaphore *op_mea1_sem;
864 struct rw_semaphore *op_mea2_sem;
865 struct lmv_stripe_md *op_mea1;
866 struct lmv_stripe_md *op_mea2;
867 struct lmv_stripe_md *op_default_mea1; /* default LMV */
868 __u32 op_suppgids[2];
875 /* iattr fields and blocks. */
876 struct iattr op_attr;
877 enum op_xvalid op_xvalid; /* eXtra validity flags */
878 loff_t op_attr_blocks;
879 u64 op_valid; /* OBD_MD_* */
880 unsigned int op_attr_flags; /* LUSTRE_{SYNC,..}_FL */
882 enum md_op_flags op_flags;
884 /* Various operation flags. */
885 enum mds_op_bias op_bias;
887 /* used to transfer info between the stacks of MD client
888 * see enum op_cli_flags */
889 enum md_cli_flags op_cli_flags;
891 /* File object data version for HSM release, on client */
892 __u64 op_data_version;
893 struct lustre_handle op_lease_handle;
895 /* File security context, for creates/metadata ops */
896 const char *op_file_secctx_name;
897 __u32 op_file_secctx_name_size;
898 void *op_file_secctx;
899 __u32 op_file_secctx_size;
903 /* Used by readdir */
904 unsigned int op_max_pages;
909 * used to access dir that is changing layout: if it's set, access
910 * dir by new layout, otherwise old layout.
911 * By default it's not set, because new files are created under new
912 * layout, if we can't find file with name under both old and new
913 * layout, we are sure file with name doesn't exist, but in reverse
914 * order there may be a race with creation by others.
917 /* used to access dir with bash hash */
918 __u32 op_stripe_index;
919 /* Archive ID for PCC attach */
924 int (*md_blocking_ast)(struct ldlm_lock *lock,
925 struct ldlm_lock_desc *desc,
926 void *data, int flag);
929 struct md_enqueue_info;
930 /* metadata stat-ahead */
931 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
932 struct md_enqueue_info *minfo,
935 struct md_enqueue_info {
936 struct md_op_data mi_data;
937 struct lookup_intent mi_it;
938 struct lustre_handle mi_lockh;
939 struct inode *mi_dir;
940 struct ldlm_enqueue_info mi_einfo;
941 md_enqueue_cb_t mi_cb;
946 struct module *o_owner;
947 int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
948 void *karg, void __user *uarg);
949 int (*o_get_info)(const struct lu_env *env, struct obd_export *,
950 __u32 keylen, void *key, __u32 *vallen, void *val);
951 int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
952 __u32 keylen, void *key,
953 __u32 vallen, void *val,
954 struct ptlrpc_request_set *set);
955 int (*o_setup) (struct obd_device *obd, struct lustre_cfg *cfg);
956 int (*o_precleanup)(struct obd_device *obd);
957 int (*o_cleanup)(struct obd_device *obd);
958 int (*o_process_config)(struct obd_device *obd, size_t len, void *data);
959 int (*o_postrecov)(struct obd_device *obd);
960 int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
962 int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
963 /* connect to the target device with given connection
964 * data. @ocd->ocd_connect_flags is modified to reflect flags actually
965 * granted by the target, which are guaranteed to be a subset of flags
966 * asked for. If @ocd == NULL, use default parameters. */
967 int (*o_connect)(const struct lu_env *env,
968 struct obd_export **exp, struct obd_device *src,
969 struct obd_uuid *cluuid, struct obd_connect_data *ocd,
971 int (*o_reconnect)(const struct lu_env *env,
972 struct obd_export *exp, struct obd_device *src,
973 struct obd_uuid *cluuid,
974 struct obd_connect_data *ocd,
976 int (*o_disconnect)(struct obd_export *exp);
978 /* Initialize/finalize fids infrastructure. */
979 int (*o_fid_init)(struct obd_device *obd,
980 struct obd_export *exp, enum lu_cli_type type);
981 int (*o_fid_fini)(struct obd_device *obd);
983 /* Allocate new fid according to passed @hint. */
984 int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
985 struct lu_fid *fid, struct md_op_data *op_data);
988 * Object with @fid is getting deleted, we may want to do something
991 int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
992 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
993 int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
994 time64_t max_age, struct ptlrpc_request_set *set);
995 int (*o_create)(const struct lu_env *env, struct obd_export *exp,
997 int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
999 int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1001 int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1003 int (*o_preprw)(const struct lu_env *env, int cmd,
1004 struct obd_export *exp, struct obdo *oa, int objcount,
1005 struct obd_ioobj *obj, struct niobuf_remote *remote,
1006 int *nr_pages, struct niobuf_local *local);
1007 int (*o_commitrw)(const struct lu_env *env, int cmd,
1008 struct obd_export *exp, struct obdo *oa,
1009 int objcount, struct obd_ioobj *obj,
1010 struct niobuf_remote *remote, int pages,
1011 struct niobuf_local *local, int rc);
1012 int (*o_init_export)(struct obd_export *exp);
1013 int (*o_destroy_export)(struct obd_export *exp);
1015 int (*o_import_event)(struct obd_device *, struct obd_import *,
1016 enum obd_import_event);
1018 int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1019 enum obd_notify_event ev);
1021 int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1022 struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1025 int (*o_quotactl)(struct obd_device *, struct obd_export *,
1026 struct obd_quotactl *);
1029 int (*o_pool_new)(struct obd_device *obd, char *poolname);
1030 int (*o_pool_del)(struct obd_device *obd, char *poolname);
1031 int (*o_pool_add)(struct obd_device *obd, char *poolname,
1033 int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1037 /* lmv structures */
1039 struct mdt_body *body;
1040 struct lu_buf layout;
1042 struct lmv_stripe_md *lmv;
1043 struct lmv_foreign_md *lfm;
1045 struct lmv_stripe_md *default_lmv;
1046 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1047 struct posix_acl *posix_acl;
1051 struct md_open_data {
1052 struct obd_client_handle *mod_och;
1053 struct ptlrpc_request *mod_open_req;
1054 struct ptlrpc_request *mod_close_req;
1055 atomic_t mod_refcount;
1059 struct obd_client_handle {
1060 struct lustre_handle och_open_handle;
1061 struct lu_fid och_fid;
1062 struct md_open_data *och_mod;
1063 struct lustre_handle och_lease_handle; /* open lock for lease */
1068 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1070 struct lookup_intent;
1074 int (*m_close)(struct obd_export *, struct md_op_data *,
1075 struct md_open_data *, struct ptlrpc_request **);
1077 int (*m_create)(struct obd_export *, struct md_op_data *,
1078 const void *, size_t, umode_t, uid_t, gid_t,
1079 cfs_cap_t, __u64, struct ptlrpc_request **);
1081 int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1082 const union ldlm_policy_data *, struct md_op_data *,
1083 struct lustre_handle *, __u64);
1085 int (*m_getattr)(struct obd_export *, struct md_op_data *,
1086 struct ptlrpc_request **);
1088 int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1089 struct lookup_intent *,
1090 struct ptlrpc_request **,
1091 ldlm_blocking_callback, __u64);
1093 int (*m_link)(struct obd_export *, struct md_op_data *,
1094 struct ptlrpc_request **);
1096 int (*m_rename)(struct obd_export *, struct md_op_data *,
1097 const char *, size_t, const char *, size_t,
1098 struct ptlrpc_request **);
1100 int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1101 size_t , struct ptlrpc_request **);
1103 int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1104 struct ptlrpc_request **);
1106 int (*m_read_page)(struct obd_export *, struct md_op_data *,
1107 struct md_callback *cb_op, __u64 hash_offset,
1108 struct page **ppage);
1110 int (*m_unlink)(struct obd_export *, struct md_op_data *,
1111 struct ptlrpc_request **);
1113 int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1114 u64, const char *, const void *, size_t, unsigned int,
1115 u32, struct ptlrpc_request **);
1117 int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1118 u64, const char *, size_t, struct ptlrpc_request **);
1120 int (*m_intent_getattr_async)(struct obd_export *,
1121 struct md_enqueue_info *);
1123 int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1124 struct lu_fid *, __u64 *bits);
1126 int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1128 int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1129 int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1131 int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1132 struct ptlrpc_request **);
1134 int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1136 int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1137 struct obd_export *, struct obd_export *,
1138 struct lustre_md *);
1140 int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1142 int (*m_merge_attr)(struct obd_export *,
1143 const struct lmv_stripe_md *lsm,
1144 struct cl_attr *attr, ldlm_blocking_callback);
1146 int (*m_set_open_replay_data)(struct obd_export *,
1147 struct obd_client_handle *,
1148 struct lookup_intent *);
1150 int (*m_clear_open_replay_data)(struct obd_export *,
1151 struct obd_client_handle *);
1153 int (*m_set_lock_data)(struct obd_export *,
1154 const struct lustre_handle *, void *, __u64 *);
1156 enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1157 const struct lu_fid *, enum ldlm_type,
1158 union ldlm_policy_data *, enum ldlm_mode,
1159 struct lustre_handle *);
1161 int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1162 union ldlm_policy_data *, enum ldlm_mode,
1163 enum ldlm_cancel_flags flags, void *opaque);
1165 int (*m_get_fid_from_lsm)(struct obd_export *,
1166 const struct lmv_stripe_md *,
1167 const char *name, int namelen,
1168 struct lu_fid *fid);
1169 int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1170 const union lmv_mds_md *lmv, size_t lmv_size);
1171 int (*m_rmfid)(struct obd_export *exp, struct fid_array *fa, int *rcs,
1172 struct ptlrpc_request_set *set);
1175 static inline struct md_open_data *obd_mod_alloc(void)
1177 struct md_open_data *mod;
1181 atomic_set(&mod->mod_refcount, 1);
1185 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1186 #define obd_mod_put(mod) \
1188 if (atomic_dec_and_test(&(mod)->mod_refcount)) { \
1189 if ((mod)->mod_open_req) \
1190 ptlrpc_req_finished((mod)->mod_open_req); \
1191 OBD_FREE_PTR(mod); \
1195 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1196 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1197 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1199 /* return 1 if client should be resend request */
1200 static inline int client_should_resend(int resend, struct client_obd *cli)
1202 return atomic_read(&cli->cl_resends) ?
1203 atomic_read(&cli->cl_resends) > resend : 1;
1207 * Return device name for this device
1209 * XXX: lu_device is declared before obd_device, while a pointer pointing
1210 * back to obd_device in lu_device, so this helper function defines here
1211 * instead of in lu_object.h
1213 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1215 return lu_dev->ld_obd->obd_name;
1218 static inline bool filename_is_volatile(const char *name, size_t namelen,
1224 if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1227 /* caller does not care of idx */
1231 /* volatile file, the MDT can be set from name */
1232 /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1233 /* if no MDT is specified, use std way */
1234 if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1236 /* test for no MDT idx case */
1237 if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1238 (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1242 /* we have an idx, read it */
1243 start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1244 *idx = simple_strtoul(start, &end, 16);
1246 * no digit, no trailing :, negative value
1248 if (((*idx == 0) && (end == start)) ||
1249 (*end != ':') || (*idx < 0))
1254 /* bad format of mdt idx, we cannot return an error
1255 * to caller so we use hash algo */
1256 CERROR("Bad volatile file name format: %s\n",
1257 name + LUSTRE_VOLATILE_HDR_LEN);
1261 static inline int cli_brw_size(struct obd_device *obd)
1263 LASSERT(obd != NULL);
1264 return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1268 * When RPC size or the max RPCs in flight is increased, the max dirty pages
1269 * of the client should be increased accordingly to avoid sending fragmented
1270 * RPCs over the network when the client runs out of the maximum dirty space
1271 * when so many RPCs are being generated.
1273 static inline void client_adjust_max_dirty(struct client_obd *cli)
1276 if (cli->cl_dirty_max_pages <= 0) {
1277 cli->cl_dirty_max_pages =
1278 (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1280 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1281 cli->cl_max_pages_per_rpc;
1283 if (dirty_max > cli->cl_dirty_max_pages)
1284 cli->cl_dirty_max_pages = dirty_max;
1287 if (cli->cl_dirty_max_pages > cfs_totalram_pages() / 8)
1288 cli->cl_dirty_max_pages = cfs_totalram_pages() / 8;
1290 /* This value is exported to userspace through the max_dirty_mb
1291 * parameter. So we round up the number of pages to make it a round
1293 cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1294 1 << (20 - PAGE_SHIFT));
1297 #endif /* __OBD_H */