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/
36 #include <linux/posix_acl.h>
37 #include <linux/kobject.h>
38 #include <linux/spinlock.h>
39 #include <linux/sysfs.h>
40 #include <linux/xarray.h>
42 #include <uapi/linux/lustre/lustre_idl.h>
43 #include <lustre_lib.h>
44 #include <libcfs/bitmap.h>
45 #ifdef HAVE_SERVER_SUPPORT
46 # include <lu_target.h>
47 # include <obd_target.h>
48 # include <lustre_quota.h>
51 #include <lustre_export.h>
52 #include <lustre_fid.h>
53 #include <lustre_fld.h>
54 #include <lustre_handles.h>
55 #include <lustre_intent.h>
58 #define MAX_OBD_DEVICES 8192
66 struct lov_oinfo { /* per-stripe data structure */
67 struct ost_id loi_oi; /* object ID/Sequence on the target OST */
68 int loi_ost_idx; /* OST stripe index in lov_tgt_desc->tgts */
69 int loi_ost_gen; /* generation of this loi_ost_idx */
71 unsigned long loi_kms_valid:1;
72 __u64 loi_kms; /* known minimum size */
73 struct ost_lvb loi_lvb;
74 struct osc_async_rc loi_ar;
77 void lov_fix_ea_for_replay(void *lovea);
79 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
82 oinfo->loi_kms_valid = 1;
88 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
90 /* obd info for a particular level (lov, osc). */
92 /* OBD_STATFS_* flags */
94 struct obd_device *oi_obd;
95 struct lu_tgt_desc *oi_tgt;
96 /* statfs data specific for every OSC, if needed at all. */
97 struct obd_statfs *oi_osfs;
98 /* An update callback which is called to update some data on upper
99 * level. E.g. it is used for update lsm->lsm_oinfo at every received
100 * request in osc level for enqueue requests. It is also possible to
101 * update some caller data from LOV layer if needed. */
102 obd_enqueue_update_f oi_cb_up;
106 const struct obd_ops *typ_dt_ops;
107 const struct md_ops *typ_md_ops;
108 struct proc_dir_entry *typ_procroot;
109 struct dentry *typ_debugfs_entry;
110 #ifdef HAVE_SERVER_SUPPORT
114 struct lu_device_type *typ_lu;
115 struct kobject typ_kobj;
117 #define typ_name typ_kobj.name
118 #define OBD_LU_TYPE_SETUP ((void *)0x01UL)
125 /* used for encryption: difference with offset in clear text page */
127 /* used for encryption: difference with count in clear text page */
132 struct timeout_item {
133 enum timeout_event ti_event;
137 struct list_head ti_obd_list;
138 struct list_head ti_chain;
141 #define OBD_MAX_RIF_DEFAULT 8
142 #define OBD_MAX_RIF_MAX 512
143 #define OSC_MAX_RIF_MAX 256
144 #define OSC_MAX_DIRTY_DEFAULT 2000 /* Arbitrary large value */
145 #define OSC_MAX_DIRTY_MB_MAX 2048 /* arbitrary, but < MAX_LONG bytes */
146 #define OSC_DEFAULT_RESENDS 10
148 /* possible values for lut_sync_lock_cancel */
149 enum tgt_sync_lock_cancel {
150 SYNC_LOCK_CANCEL_NEVER = 0,
151 SYNC_LOCK_CANCEL_BLOCKING = 1,
152 SYNC_LOCK_CANCEL_ALWAYS = 2,
156 * Limit reply buffer size for striping data to one x86_64 page. This
157 * value is chosen to fit the striping data for common use cases while
158 * staying well below the limit at which the buffer must be backed by
159 * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
162 #define OBD_MAX_DEFAULT_EA_SIZE 4096
165 * Lustre can handle larger xattrs internally, but we must respect the Linux
166 * VFS limitation or tools like tar cannot interact with Lustre volumes
169 #define OBD_MAX_EA_SIZE XATTR_SIZE_MAX
172 enum obd_cl_sem_lock_class {
181 struct rw_semaphore cl_sem;
182 struct obd_uuid cl_target_uuid;
183 struct obd_import *cl_import; /* ptlrpc connection state */
184 size_t cl_conn_count;
186 /* Cache maximum and default values for easize. This is
187 * strictly a performance optimization to minimize calls to
188 * obd_size_diskmd(). The default values are used to calculate the
189 * initial size of a request buffer. The ptlrpc layer will resize the
190 * buffer as needed to accommodate a larger reply from the
191 * server. The default values should be small enough to avoid wasted
192 * memory and excessive use of vmalloc(), yet large enough to avoid
193 * reallocating the buffer in the common use case. */
195 /* Default EA size for striping attributes. It is initialized at
196 * mount-time based on the default stripe width of the filesystem,
197 * then it tracks the largest observed EA size advertised by
198 * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
199 __u32 cl_default_mds_easize;
201 /* Maximum possible EA size computed at mount-time based on
202 * the number of OSTs in the filesystem. May be increased at
203 * run-time if a larger observed size is advertised by the MDT. */
204 __u32 cl_max_mds_easize;
206 /* Data-on-MDT specific value to set larger reply buffer for possible
207 * data read along with open/stat requests. By default it tries to use
208 * unused space in reply buffer.
209 * This value is used to ensure that reply buffer has at least as
210 * much free space as value indicates. That free space is gained from
211 * LOV EA buffer which is small for DoM files and on big systems can
212 * provide up to 32KB of extra space in reply buffer.
213 * Default value is 8K now.
215 __u32 cl_dom_min_inline_repsize;
217 unsigned int cl_checksum:1, /* 0 = disabled, 1 = enabled */
218 cl_checksum_dump:1, /* same */
219 cl_ocd_grant_param:1;
220 enum lustre_sec_part cl_sp_me;
221 enum lustre_sec_part cl_sp_to;
222 struct sptlrpc_flavor cl_flvr_mgc; /* fixed flavor of mgc->mgs */
224 /* the grant values are protected by loi_list_lock below */
225 unsigned long cl_dirty_pages; /* all _dirty_ in pages */
226 unsigned long cl_dirty_max_pages; /* allowed w/o rpc */
227 unsigned long cl_avail_grant; /* bytes of credit for ost */
228 unsigned long cl_lost_grant; /* lost credits (trunc) */
229 /* grant consumed for dirty pages */
230 unsigned long cl_dirty_grant;
232 /* since we allocate grant by blocks, we don't know how many grant will
233 * be used to add a page into cache. As a solution, we reserve maximum
234 * grant before trying to dirty a page and unreserve the rest.
235 * See osc_{reserve|unreserve}_grant for details. */
236 long cl_reserved_grant;
237 wait_queue_head_t cl_cache_waiters; /* waiting for cache/grant */
238 time64_t cl_next_shrink_grant; /* seconds */
239 struct list_head cl_grant_chain;
240 time64_t cl_grant_shrink_interval; /* seconds */
242 /* A chunk is an optimal size used by osc_extent to determine
243 * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
245 /* extent insertion metadata overhead to be accounted in grant,
247 unsigned int cl_grant_extent_tax;
248 /* maximum extent size, in number of pages */
249 unsigned int cl_max_extent_pages;
251 /* keep track of objects that have lois that contain pages which
252 * have been queued for async brw. this lock also protects the
253 * lists of osc_client_pages that hang off of the loi */
255 * ->cl_loi_list_lock protects consistency of
256 * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
257 * ->ap_completion() call-backs are executed under this lock. As we
258 * cannot guarantee that these call-backs never block on all platforms
259 * (as a matter of fact they do block on Mac OS X), type of
260 * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
261 * and blocking mutex on Mac OS X. (Alternative is to make this lock
262 * blocking everywhere, but we don't want to slow down fast-path of
263 * our main platform.)
265 * NB by Jinshan: though field names are still _loi_, but actually
266 * osc_object{}s are in the list.
268 spinlock_t cl_loi_list_lock;
269 struct list_head cl_loi_ready_list;
270 struct list_head cl_loi_hp_ready_list;
271 struct list_head cl_loi_write_list;
272 struct list_head cl_loi_read_list;
273 __u32 cl_r_in_flight;
274 __u32 cl_w_in_flight;
275 /* just a sum of the loi/lop pending numbers to be exported by /proc */
276 atomic_t cl_pending_w_pages;
277 atomic_t cl_pending_r_pages;
278 u32 cl_max_pages_per_rpc;
279 u32 cl_max_rpcs_in_flight;
280 u32 cl_max_short_io_bytes;
281 struct obd_histogram cl_read_rpc_hist;
282 struct obd_histogram cl_write_rpc_hist;
283 struct obd_histogram cl_read_page_hist;
284 struct obd_histogram cl_write_page_hist;
285 struct obd_histogram cl_read_offset_hist;
286 struct obd_histogram cl_write_offset_hist;
288 /** LRU for osc caching pages */
289 struct cl_client_cache *cl_cache;
290 /** member of cl_cache->ccc_lru */
291 struct list_head cl_lru_osc;
292 /** # of available LRU slots left in the per-OSC cache.
293 * Available LRU slots are shared by all OSCs of the same file system,
294 * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
295 atomic_long_t *cl_lru_left;
296 /** # of busy LRU pages. A page is considered busy if it's in writeback
297 * queue, or in transfer. Busy pages can't be discarded so they are not
299 atomic_long_t cl_lru_busy;
300 /** # of LRU pages in the cache for this client_obd */
301 atomic_long_t cl_lru_in_list;
302 /** # of threads are shrinking LRU cache. To avoid contention, it's not
303 * allowed to have multiple threads shrinking LRU cache. */
304 atomic_t cl_lru_shrinkers;
305 /** The time when this LRU cache was last used. */
306 time64_t cl_lru_last_used;
307 /** stats: how many reclaims have happened for this client_obd.
308 * reclaim and shrink - shrink is async, voluntarily rebalancing;
309 * reclaim is sync, initiated by IO thread when the LRU slots are
311 __u64 cl_lru_reclaim;
312 /** List of LRU pages for this client_obd */
313 struct list_head cl_lru_list;
314 /** Lock for LRU page list */
315 spinlock_t cl_lru_list_lock;
316 /** # of unstable pages in this client_obd.
317 * An unstable page is a page state that WRITE RPC has finished but
318 * the transaction has NOT yet committed. */
319 atomic_long_t cl_unstable_count;
320 /** Link to osc_shrinker_list */
321 struct list_head cl_shrink_list;
323 /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
324 atomic_t cl_destroy_in_flight;
325 wait_queue_head_t cl_destroy_waitq;
327 /* modify rpcs in flight
328 * currently used for metadata only */
329 spinlock_t cl_mod_rpcs_lock;
330 __u16 cl_max_mod_rpcs_in_flight;
331 __u16 cl_mod_rpcs_in_flight;
332 __u16 cl_close_rpcs_in_flight;
333 wait_queue_head_t cl_mod_rpcs_waitq;
334 unsigned long *cl_mod_tag_bitmap;
335 struct obd_histogram cl_mod_rpcs_hist;
338 struct mutex cl_mgc_mutex;
339 struct local_oid_storage *cl_mgc_los;
340 struct dt_object *cl_mgc_configs_dir;
341 struct obd_export *cl_mgc_mgsexp;
342 atomic_t cl_mgc_refcount;
343 /* in-flight control list and total RPCs counter */
344 struct list_head cl_flight_waiters;
345 __u32 cl_rpcs_in_flight;
347 /* supported checksum types that are worked out at connect time */
348 __u32 cl_supp_cksum_types;
349 /* checksum algorithm to be used */
350 enum cksum_types cl_cksum_type;
351 /* preferred checksum algorithm to be used */
352 enum cksum_types cl_preferred_cksum_type;
354 /* also protected by the poorly named _loi_list_lock lock above */
355 struct osc_async_rc cl_ar;
357 /* sequence manager */
358 struct lu_client_seq *cl_seq;
359 struct rw_semaphore cl_seq_rwsem;
361 atomic_t cl_resends; /* resend count */
363 /* ptlrpc work for writeback in ptlrpcd context */
364 void *cl_writeback_work;
366 struct mutex cl_quota_mutex;
367 /* hash tables for osc_quota_info */
368 struct cfs_hash *cl_quota_hash[LL_MAXQUOTAS];
369 /* the xid of the request updating the hash tables */
370 __u64 cl_quota_last_xid;
371 /* Links to the global list of registered changelog devices */
372 struct list_head cl_chg_dev_linkage;
374 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
381 struct echo_client_obd {
382 struct obd_export *ec_exp; /* the local connection to osc/lov */
384 struct list_head ec_objects;
385 struct list_head ec_locks;
389 /* allow statfs data caching for 1 second */
390 #define OBD_STATFS_CACHE_SECONDS 1
391 /* arbitrary maximum. larger would be useless, allows catching bogus input */
392 #define OBD_STATFS_CACHE_MAX_AGE 3600 /* seconds */
394 #define lov_tgt_desc lu_tgt_desc
396 struct lov_md_tgt_desc {
397 struct obd_device *lmtd_mdc;
402 struct lov_desc desc;
403 struct lov_tgt_desc **lov_tgts; /* sparse array */
404 struct lu_tgt_pool lov_packed; /* all OSTs in a packed
406 struct mutex lov_lock;
407 struct obd_connect_data lov_ocd;
408 atomic_t lov_refcount;
409 __u32 lov_death_row; /* tgts scheduled to be deleted */
410 __u32 lov_tgt_size; /* size of tgts array */
413 struct rhashtable lov_pools_hash_body; /* used for key access */
414 struct list_head lov_pool_list; /* used for sequential access */
415 struct proc_dir_entry *lov_pool_proc_entry;
416 enum lustre_sec_part lov_sp_me;
418 /* Cached LRU and unstable data from upper layer */
419 struct cl_client_cache *lov_cache;
421 struct rw_semaphore lov_notify_lock;
422 /* Data-on-MDT: MDC array */
423 struct lov_md_tgt_desc *lov_mdc_tgts;
425 struct kobject *lov_tgts_kobj;
428 #define lmv_tgt_desc lu_tgt_desc
431 struct lu_client_fld lmv_fld;
437 u32 lmv_statfs_start;
439 struct lu_tgt_descs lmv_mdt_descs;
441 struct obd_connect_data conn_data;
442 struct kobject *lmv_tgts_kobj;
445 __u32 lmv_qos_rr_index;
448 #define lmv_mdt_count lmv_mdt_descs.ltd_lmv_desc.ld_tgt_count
449 #define lmv_qos lmv_mdt_descs.ltd_qos
451 /* Minimum sector size is 512 */
452 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
454 struct niobuf_local {
455 __u64 lnb_file_offset;
456 __u32 lnb_page_offset;
460 struct page *lnb_page;
462 __u16 lnb_guards[MAX_GUARD_NUMBER];
463 __u16 lnb_guard_rpc:1;
464 __u16 lnb_guard_disk:1;
465 /* separate unlock for read path to allow shared access */
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;
601 /* corresponds to one of the obd's */
602 #define OBD_DEVICE_MAGIC 0XAB5CD6EF
605 struct obd_type *obd_type;
606 __u32 obd_magic; /* OBD_DEVICE_MAGIC */
607 int obd_minor; /* device number: lctl dl */
608 struct lu_device *obd_lu_dev;
610 /* common and UUID name of this device */
611 struct obd_uuid obd_uuid;
612 char obd_name[MAX_OBD_NAME];
614 /* bitfield modification is protected by obd_dev_lock */
616 obd_attached:1, /* finished attach */
617 obd_set_up:1, /* finished setup */
618 obd_recovering:1, /* there are recoverable clients */
619 obd_abort_recovery:1, /* recovery expired */
620 obd_abort_recov_mdt:1, /* only abort recovery between MDTs */
621 obd_version_recov:1, /* obd uses version checking */
622 obd_replayable:1, /* recovery enabled; inform clients */
623 obd_no_recov:1, /* fail instead of retry messages */
624 obd_stopping:1, /* started cleanup */
625 obd_starting:1, /* started setup */
626 obd_force:1, /* cleanup with > 0 obd refcount */
627 obd_fail:1, /* cleanup with failover */
628 obd_no_conn:1, /* deny new connections */
629 obd_inactive:1, /* device active/inactive
630 * (for /proc/status only!!) */
631 obd_no_ir:1, /* no imperative recovery. */
632 obd_process_conf:1, /* device is processing mgs config */
633 obd_checksum_dump:1, /* dump pages upon cksum error */
634 obd_dynamic_nids:1; /* Allow dynamic NIDs on device */
635 #ifdef HAVE_SERVER_SUPPORT
636 /* no committed-transno notification */
637 unsigned long obd_no_transno:1;
640 /* use separate field as it is set in interrupt to don't mess with
641 * protection of other bits using _bh lock */
642 unsigned long obd_recovery_expired:1;
643 /* uuid-export hash body */
644 struct rhashtable obd_uuid_hash;
645 /* nid-export hash body */
646 struct rhltable obd_nid_hash;
648 struct cfs_hash *obd_nid_stats_hash;
649 /* client_generation-export hash body */
650 struct cfs_hash *obd_gen_hash;
651 struct list_head obd_nid_stats;
652 struct list_head obd_exports;
653 struct list_head obd_unlinked_exports;
654 struct list_head obd_delayed_exports;
655 struct list_head obd_lwp_list;
656 atomic_t obd_refcount;
658 spinlock_t obd_nid_lock;
659 struct ldlm_namespace *obd_namespace;
660 struct ptlrpc_client obd_ldlm_client; /* XXX OST/MDS only */
661 /* a spinlock is OK for what we do now, may need a semaphore later */
662 spinlock_t obd_dev_lock; /* protect OBD bitfield above */
663 spinlock_t obd_osfs_lock;
664 struct obd_statfs obd_osfs; /* locked by obd_osfs_lock */
665 time64_t obd_osfs_age;
666 __u64 obd_last_committed;
667 struct mutex obd_dev_mutex;
668 struct lvfs_run_ctxt obd_lvfs_ctxt;
669 struct obd_llog_group obd_olg; /* default llog group */
670 struct obd_device *obd_observer;
671 struct rw_semaphore obd_observer_link_sem;
672 struct obd_notify_upcall obd_upcall;
673 struct obd_export *obd_self_export;
674 struct obd_export *obd_lwp_export;
675 /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
676 struct list_head obd_exports_timed;
677 time64_t obd_eviction_timer; /* for ping evictor */
679 atomic_t obd_max_recoverable_clients;
680 atomic_t obd_connected_clients;
681 int obd_stale_clients;
682 /* this lock protects all recovery list_heads, timer and
683 * obd_next_recovery_transno value */
684 spinlock_t obd_recovery_task_lock;
685 __u64 obd_next_recovery_transno;
686 int obd_replayed_requests;
687 int obd_requests_queued_for_recovery;
688 wait_queue_head_t obd_next_transno_waitq;
689 /* protected by obd_recovery_task_lock */
690 struct hrtimer obd_recovery_timer;
692 time64_t obd_recovery_start;
693 /* seconds, for lprocfs_status */
694 time64_t obd_recovery_end;
695 /* To tell timeouts from time stamps Lustre uses timeout_t
696 * instead of time64_t.
698 timeout_t obd_recovery_time_hard;
699 timeout_t obd_recovery_timeout;
700 int obd_recovery_ir_factor;
702 /* new recovery stuff from CMD2 */
703 int obd_replayed_locks;
704 atomic_t obd_req_replay_clients;
705 atomic_t obd_lock_replay_clients;
706 struct target_recovery_data obd_recovery_data;
708 /* all lists are protected by obd_recovery_task_lock */
709 struct list_head obd_req_replay_queue;
710 struct list_head obd_lock_replay_queue;
711 struct list_head obd_final_req_queue;
714 #ifdef HAVE_SERVER_SUPPORT
715 struct obd_device_target obt;
716 struct filter_obd filter;
718 struct echo_obd echo;
720 struct client_obd cli;
721 struct echo_client_obd echo_client;
726 /* Fields used by LProcFS */
727 struct lprocfs_stats *obd_stats;
729 struct lprocfs_stats *obd_md_stats;
731 struct dentry *obd_debugfs_entry;
732 struct proc_dir_entry *obd_proc_entry;
733 struct proc_dir_entry *obd_proc_exports_entry;
734 struct dentry *obd_svc_debugfs_entry;
735 struct lprocfs_stats *obd_svc_stats;
736 const struct attribute **obd_attrs;
737 struct lprocfs_vars *obd_vars;
738 struct ldebugfs_vars *obd_debugfs_vars;
739 atomic_t obd_evict_inprogress;
740 wait_queue_head_t obd_evict_inprogress_waitq;
741 struct list_head obd_evict_list; /* protected with pet_lock */
744 * LDLM pool part. Save last calculated SLV and Limit.
746 rwlock_t obd_pool_lock;
750 int obd_conn_inprogress;
753 * List of outstanding class_incref()'s fo this OBD. For debugging. */
754 struct lu_ref obd_reference;
756 struct kset obd_kset; /* sysfs object collection */
757 struct kobj_type obd_ktype;
758 struct completion obd_kobj_unregister;
761 int obd_uuid_add(struct obd_device *obd, struct obd_export *export);
762 void obd_uuid_del(struct obd_device *obd, struct obd_export *export);
763 #ifdef HAVE_SERVER_SUPPORT
764 struct obd_export *obd_uuid_lookup(struct obd_device *obd,
765 struct obd_uuid *uuid);
767 int obd_nid_export_for_each(struct obd_device *obd, lnet_nid_t nid,
768 int cb(struct obd_export *exp, void *data),
770 int obd_nid_add(struct obd_device *obd, struct obd_export *exp);
771 void obd_nid_del(struct obd_device *obd, struct obd_export *exp);
774 /* get/set_info keys */
775 #define KEY_ASYNC "async"
776 #define KEY_CHANGELOG_CLEAR "changelog_clear"
777 #define KEY_FID2PATH "fid2path"
778 #define KEY_CHECKSUM "checksum"
779 #define KEY_CLEAR_FS "clear_fs"
780 #define KEY_CONN_DATA "conn_data"
781 #define KEY_EVICT_BY_NID "evict_by_nid"
782 #define KEY_FIEMAP "fiemap"
783 #define KEY_FLUSH_CTX "flush_ctx"
784 #define KEY_GRANT_SHRINK "grant_shrink"
785 #define KEY_HSM_COPYTOOL_SEND "hsm_send"
786 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
787 #define KEY_INTERMDS "inter_mds"
788 #define KEY_LAST_ID "last_id"
789 #define KEY_LAST_FID "last_fid"
790 #define KEY_MAX_EASIZE "max_easize"
791 #define KEY_DEFAULT_EASIZE "default_easize"
792 #define KEY_MGSSEC "mgssec"
793 #define KEY_READ_ONLY "read-only"
794 #define KEY_REGISTER_TARGET "register_target"
795 #define KEY_SET_FS "set_fs"
796 #define KEY_TGT_COUNT "tgt_count"
797 /* KEY_SET_INFO in lustre_idl.h */
798 #define KEY_SPTLRPC_CONF "sptlrpc_conf"
800 #define KEY_CACHE_LRU_SHRINK "cache_lru_shrink"
801 #define KEY_OSP_CONNECTED "osp_connected"
803 /* Flags for op_xvalid */
805 OP_XVALID_CTIME_SET = BIT(0), /* 0x0001 */
806 OP_XVALID_BLOCKS = BIT(1), /* 0x0002 */
807 OP_XVALID_OWNEROVERRIDE = BIT(2), /* 0x0004 */
808 OP_XVALID_FLAGS = BIT(3), /* 0x0008 */
809 OP_XVALID_PROJID = BIT(4), /* 0x0010 */
810 OP_XVALID_LAZYSIZE = BIT(5), /* 0x0020 */
811 OP_XVALID_LAZYBLOCKS = BIT(6), /* 0x0040 */
816 static inline int it_to_lock_mode(struct lookup_intent *it)
818 /* CREAT needs to be tested before open (both could be set) */
819 if (it->it_op & IT_CREAT)
821 else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
823 else if (it->it_op & IT_LAYOUT)
824 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
825 else if (it->it_op & IT_READDIR)
827 else if (it->it_op & IT_GETXATTR)
830 LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
835 MF_MDC_CANCEL_FID1 = BIT(0),
836 MF_MDC_CANCEL_FID2 = BIT(1),
837 MF_MDC_CANCEL_FID3 = BIT(2),
838 MF_MDC_CANCEL_FID4 = BIT(3),
839 MF_GET_MDT_IDX = BIT(4),
840 MF_GETATTR_BY_FID = BIT(5),
844 CLI_SET_MEA = BIT(0),
845 CLI_RM_ENTRY = BIT(1),
848 CLI_MIGRATE = BIT(4),
849 CLI_DIRTY_DATA = BIT(5),
853 LUSTRE_OPC_MKDIR = 1,
861 * GETXATTR is not included as only a couple of fields in the reply body
862 * is filled, but not FID which is needed for common intent handling in
863 * mdc_finish_intent_lock()
865 static inline bool it_has_reply_body(const struct lookup_intent *it)
867 return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
871 struct lu_fid op_fid1; /* operation fid1 (usualy parent) */
872 struct lu_fid op_fid2; /* operation fid2 (usualy child) */
873 struct lu_fid op_fid3; /* 2 extra fids to find conflicting */
874 struct lu_fid op_fid4; /* to the operation locks. */
875 u32 op_mds; /* what mds server open will go to */
877 enum md_op_code op_code;
878 struct lustre_handle op_open_handle;
882 struct rw_semaphore *op_mea1_sem;
883 struct rw_semaphore *op_mea2_sem;
884 struct lmv_stripe_md *op_mea1;
885 struct lmv_stripe_md *op_mea2;
886 struct lmv_stripe_md *op_default_mea1; /* default LMV */
887 __u32 op_suppgids[2];
894 /* iattr fields and blocks. */
895 struct iattr op_attr;
896 enum op_xvalid op_xvalid; /* eXtra validity flags */
897 loff_t op_attr_blocks;
898 u64 op_valid; /* OBD_MD_* */
899 unsigned int op_attr_flags; /* LUSTRE_{SYNC,..}_FL */
901 enum md_op_flags op_flags;
903 /* Various operation flags. */
904 enum mds_op_bias op_bias;
906 /* used to transfer info between the stacks of MD client
907 * see enum op_cli_flags */
908 enum md_cli_flags op_cli_flags;
910 /* File object data version for HSM release, on client */
911 __u64 op_data_version;
912 struct lustre_handle op_lease_handle;
914 /* File security context, for creates/metadata ops */
915 const char *op_file_secctx_name;
916 __u32 op_file_secctx_name_size;
917 void *op_file_secctx;
918 __u32 op_file_secctx_size;
920 /* File encryption context, for creates/metadata ops */
921 void *op_file_encctx;
922 __u32 op_file_encctx_size;
926 /* Used by readdir */
927 unsigned int op_max_pages;
932 * used to access dir that is changing layout: if it's set, access
933 * dir by new layout, otherwise old layout.
934 * By default it's not set, because new files are created under new
935 * layout, if we can't find file with name under both old and new
936 * layout, we are sure file with name doesn't exist, but in reverse
937 * order there may be a race with creation by others.
940 /* used to access dir with bash hash */
941 __u32 op_stripe_index;
942 /* Archive ID for PCC attach */
947 int (*md_blocking_ast)(struct ldlm_lock *lock,
948 struct ldlm_lock_desc *desc,
949 void *data, int flag);
953 typedef int (*md_op_item_cb_t)(struct req_capsule *pill,
954 struct md_op_item *item,
964 enum md_opcode mop_opc;
965 struct md_op_data mop_data;
966 struct lookup_intent mop_it;
967 struct lustre_handle mop_lockh;
968 struct ldlm_enqueue_info mop_einfo;
969 md_op_item_cb_t mop_cb;
971 struct inode *mop_dir;
972 __u64 mop_lock_flags;
976 struct module *o_owner;
977 int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
978 void *karg, void __user *uarg);
979 int (*o_get_info)(const struct lu_env *env, struct obd_export *,
980 __u32 keylen, void *key, __u32 *vallen, void *val);
981 int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
982 __u32 keylen, void *key,
983 __u32 vallen, void *val,
984 struct ptlrpc_request_set *set);
985 int (*o_setup) (struct obd_device *obd, struct lustre_cfg *cfg);
986 int (*o_precleanup)(struct obd_device *obd);
987 int (*o_cleanup)(struct obd_device *obd);
988 int (*o_process_config)(struct obd_device *obd, size_t len, void *data);
989 int (*o_postrecov)(struct obd_device *obd);
990 int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
992 int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
993 /* connect to the target device with given connection
994 * data. @ocd->ocd_connect_flags is modified to reflect flags actually
995 * granted by the target, which are guaranteed to be a subset of flags
996 * asked for. If @ocd == NULL, use default parameters. */
997 int (*o_connect)(const struct lu_env *env,
998 struct obd_export **exp, struct obd_device *src,
999 struct obd_uuid *cluuid, struct obd_connect_data *ocd,
1001 int (*o_reconnect)(const struct lu_env *env,
1002 struct obd_export *exp, struct obd_device *src,
1003 struct obd_uuid *cluuid,
1004 struct obd_connect_data *ocd,
1006 int (*o_disconnect)(struct obd_export *exp);
1008 /* Initialize/finalize fids infrastructure. */
1009 int (*o_fid_init)(struct obd_device *obd,
1010 struct obd_export *exp, enum lu_cli_type type);
1011 int (*o_fid_fini)(struct obd_device *obd);
1013 /* Allocate new fid according to passed @hint. */
1014 int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
1015 struct lu_fid *fid, struct md_op_data *op_data);
1018 * Object with @fid is getting deleted, we may want to do something
1021 int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
1022 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
1023 int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
1024 time64_t max_age, struct ptlrpc_request_set *set);
1025 int (*o_create)(const struct lu_env *env, struct obd_export *exp,
1027 int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
1029 int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1031 int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1033 int (*o_preprw)(const struct lu_env *env, int cmd,
1034 struct obd_export *exp, struct obdo *oa, int objcount,
1035 struct obd_ioobj *obj, struct niobuf_remote *remote,
1036 int *nr_pages, struct niobuf_local *local);
1037 int (*o_commitrw)(const struct lu_env *env, int cmd,
1038 struct obd_export *exp, struct obdo *oa,
1039 int objcount, struct obd_ioobj *obj,
1040 struct niobuf_remote *remote, int pages,
1041 struct niobuf_local *local, int rc);
1042 int (*o_init_export)(struct obd_export *exp);
1043 int (*o_destroy_export)(struct obd_export *exp);
1045 int (*o_import_event)(struct obd_device *, struct obd_import *,
1046 enum obd_import_event);
1048 int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1049 enum obd_notify_event ev);
1051 int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1052 struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1055 int (*o_quotactl)(struct obd_device *, struct obd_export *,
1056 struct obd_quotactl *);
1059 int (*o_pool_new)(struct obd_device *obd, char *poolname);
1060 int (*o_pool_del)(struct obd_device *obd, char *poolname);
1061 int (*o_pool_add)(struct obd_device *obd, char *poolname,
1063 int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1067 /* lmv structures */
1069 struct mdt_body *body;
1070 struct lu_buf layout;
1072 struct lmv_stripe_md *lmv;
1073 struct lmv_foreign_md *lfm;
1075 struct lmv_stripe_md *default_lmv;
1076 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1077 struct posix_acl *posix_acl;
1081 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1082 static inline void lmd_clear_acl(struct lustre_md *md)
1084 if (md->posix_acl) {
1085 posix_acl_release(md->posix_acl);
1086 md->posix_acl = NULL;
1090 #define OBD_CONNECT_ACL_FLAGS \
1091 (OBD_CONNECT_ACL | OBD_CONNECT_UMASK | OBD_CONNECT_LARGE_ACL)
1093 static inline void lmd_clear_acl(struct lustre_md *md)
1097 #define OBD_CONNECT_ACL_FLAGS (0)
1100 struct md_open_data {
1101 struct obd_client_handle *mod_och;
1102 struct ptlrpc_request *mod_open_req;
1103 struct ptlrpc_request *mod_close_req;
1104 atomic_t mod_refcount;
1108 struct obd_client_handle {
1109 struct lustre_handle och_open_handle;
1110 struct lu_fid och_fid;
1111 struct md_open_data *och_mod;
1112 struct lustre_handle och_lease_handle; /* open lock for lease */
1117 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1119 struct lookup_intent;
1123 int (*m_close)(struct obd_export *, struct md_op_data *,
1124 struct md_open_data *, struct ptlrpc_request **);
1126 int (*m_create)(struct obd_export *, struct md_op_data *,
1127 const void *, size_t, umode_t, uid_t, gid_t,
1128 cfs_cap_t, __u64, struct ptlrpc_request **);
1130 int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1131 const union ldlm_policy_data *, struct md_op_data *,
1132 struct lustre_handle *, __u64);
1134 int (*m_getattr)(struct obd_export *, struct md_op_data *,
1135 struct ptlrpc_request **);
1137 int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1138 struct lookup_intent *,
1139 struct ptlrpc_request **,
1140 ldlm_blocking_callback, __u64);
1142 int (*m_link)(struct obd_export *, struct md_op_data *,
1143 struct ptlrpc_request **);
1145 int (*m_rename)(struct obd_export *, struct md_op_data *,
1146 const char *, size_t, const char *, size_t,
1147 struct ptlrpc_request **);
1149 int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1150 size_t , struct ptlrpc_request **);
1152 int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1153 struct ptlrpc_request **);
1155 int (*m_read_page)(struct obd_export *, struct md_op_data *,
1156 struct md_callback *cb_op, __u64 hash_offset,
1157 struct page **ppage);
1159 int (*m_unlink)(struct obd_export *, struct md_op_data *,
1160 struct ptlrpc_request **);
1162 int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1163 u64, const char *, const void *, size_t, unsigned int,
1164 u32, struct ptlrpc_request **);
1166 int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1167 u64, const char *, size_t, struct ptlrpc_request **);
1169 int (*m_intent_getattr_async)(struct obd_export *,
1170 struct md_op_item *);
1172 int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1173 struct lu_fid *, __u64 *bits);
1175 int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1177 int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1178 int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1180 int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1181 struct ptlrpc_request **);
1183 int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1185 int (*m_get_lustre_md)(struct obd_export *, struct req_capsule *,
1186 struct obd_export *, struct obd_export *,
1187 struct lustre_md *);
1189 int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1191 int (*m_merge_attr)(struct obd_export *,
1192 const struct lmv_stripe_md *lsm,
1193 struct cl_attr *attr, ldlm_blocking_callback);
1195 int (*m_set_open_replay_data)(struct obd_export *,
1196 struct obd_client_handle *,
1197 struct lookup_intent *);
1199 int (*m_clear_open_replay_data)(struct obd_export *,
1200 struct obd_client_handle *);
1202 int (*m_set_lock_data)(struct obd_export *,
1203 const struct lustre_handle *, void *, __u64 *);
1205 enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1206 const struct lu_fid *, enum ldlm_type,
1207 union ldlm_policy_data *, enum ldlm_mode,
1208 struct lustre_handle *);
1210 int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1211 union ldlm_policy_data *, enum ldlm_mode,
1212 enum ldlm_cancel_flags flags, void *opaque);
1214 int (*m_get_fid_from_lsm)(struct obd_export *,
1215 const struct lmv_stripe_md *,
1216 const char *name, int namelen,
1217 struct lu_fid *fid);
1218 int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1219 const union lmv_mds_md *lmv, size_t lmv_size);
1220 int (*m_rmfid)(struct obd_export *exp, struct fid_array *fa, int *rcs,
1221 struct ptlrpc_request_set *set);
1224 static inline struct md_open_data *obd_mod_alloc(void)
1226 struct md_open_data *mod;
1230 atomic_set(&mod->mod_refcount, 1);
1234 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1235 #define obd_mod_put(mod) \
1237 if (atomic_dec_and_test(&(mod)->mod_refcount)) { \
1238 if ((mod)->mod_open_req) \
1239 ptlrpc_req_finished((mod)->mod_open_req); \
1240 OBD_FREE_PTR(mod); \
1244 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1245 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1246 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1248 /* return 1 if client should be resend request */
1249 static inline int client_should_resend(int resend, struct client_obd *cli)
1251 return atomic_read(&cli->cl_resends) ?
1252 atomic_read(&cli->cl_resends) > resend : 1;
1256 * Return device name for this device
1258 * XXX: lu_device is declared before obd_device, while a pointer pointing
1259 * back to obd_device in lu_device, so this helper function defines here
1260 * instead of in lu_object.h
1262 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1264 return lu_dev->ld_obd->obd_name;
1267 static inline bool filename_is_volatile(const char *name, size_t namelen,
1273 if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1276 /* caller does not care of idx */
1280 /* volatile file, the MDT can be set from name */
1281 /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1282 /* if no MDT is specified, use std way */
1283 if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1285 /* test for no MDT idx case */
1286 if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1287 (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1291 /* we have an idx, read it */
1292 start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1293 *idx = simple_strtoul(start, &end, 16);
1295 * no digit, no trailing :, negative value
1297 if (((*idx == 0) && (end == start)) ||
1298 (*end != ':') || (*idx < 0))
1303 /* bad format of mdt idx, we cannot return an error
1304 * to caller so we use hash algo */
1305 CERROR("Bad volatile file name format: %s\n",
1306 name + LUSTRE_VOLATILE_HDR_LEN);
1310 static inline int cli_brw_size(struct obd_device *obd)
1312 LASSERT(obd != NULL);
1313 return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1317 * When RPC size or the max RPCs in flight is increased, the max dirty pages
1318 * of the client should be increased accordingly to avoid sending fragmented
1319 * RPCs over the network when the client runs out of the maximum dirty space
1320 * when so many RPCs are being generated.
1322 static inline void client_adjust_max_dirty(struct client_obd *cli)
1325 if (cli->cl_dirty_max_pages <= 0) {
1326 cli->cl_dirty_max_pages =
1327 (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1329 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1330 cli->cl_max_pages_per_rpc;
1332 if (dirty_max > cli->cl_dirty_max_pages)
1333 cli->cl_dirty_max_pages = dirty_max;
1336 if (cli->cl_dirty_max_pages > cfs_totalram_pages() / 8)
1337 cli->cl_dirty_max_pages = cfs_totalram_pages() / 8;
1339 /* This value is exported to userspace through the max_dirty_mb
1340 * parameter. So we round up the number of pages to make it a round
1342 cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1343 1 << (20 - PAGE_SHIFT));
1346 static inline struct inode *page2inode(struct page *page)
1348 if (page->mapping) {
1352 return page->mapping->host;
1358 #endif /* __OBD_H */