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 #ifdef HAVE_SERVER_SUPPORT
45 # include <lu_target.h>
46 # include <obd_target.h>
47 # include <lustre_quota.h>
50 #include <lustre_export.h>
51 #include <lustre_fid.h>
52 #include <lustre_fld.h>
53 #include <lustre_handles.h>
54 #include <lustre_intent.h>
57 #define MAX_OBD_DEVICES 8192
65 struct lov_oinfo { /* per-stripe data structure */
66 struct ost_id loi_oi; /* object ID/Sequence on the target OST */
67 int loi_ost_idx; /* OST stripe index in lov_tgt_desc->tgts */
68 int loi_ost_gen; /* generation of this loi_ost_idx */
70 unsigned long loi_kms_valid:1;
71 __u64 loi_kms; /* known minimum size */
72 struct ost_lvb loi_lvb;
73 struct osc_async_rc loi_ar;
76 void lov_fix_ea_for_replay(void *lovea);
78 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
81 oinfo->loi_kms_valid = 1;
87 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
89 /* obd info for a particular level (lov, osc). */
91 /* OBD_STATFS_* flags */
93 struct obd_device *oi_obd;
94 struct lu_tgt_desc *oi_tgt;
95 /* statfs data specific for every OSC, if needed at all. */
96 struct obd_statfs *oi_osfs;
97 /* An update callback which is called to update some data on upper
98 * level. E.g. it is used for update lsm->lsm_oinfo at every received
99 * request in osc level for enqueue requests. It is also possible to
100 * update some caller data from LOV layer if needed. */
101 obd_enqueue_update_f oi_cb_up;
105 const struct obd_ops *typ_dt_ops;
106 const struct md_ops *typ_md_ops;
107 struct proc_dir_entry *typ_procroot;
108 struct dentry *typ_debugfs_entry;
109 #ifdef HAVE_SERVER_SUPPORT
113 struct lu_device_type *typ_lu;
114 struct kobject typ_kobj;
116 #define typ_name typ_kobj.name
117 #define OBD_LU_TYPE_SETUP ((void *)0x01UL)
124 /* used for encryption: difference with offset in clear text page */
126 /* used for encryption: difference with count in clear text page */
131 struct timeout_item {
132 enum timeout_event ti_event;
136 struct list_head ti_obd_list;
137 struct list_head ti_chain;
140 #define OBD_MAX_RIF_DEFAULT 8
141 #define OBD_MAX_RIF_MAX 512
142 #define OSC_MAX_RIF_MAX 256
143 #define OSC_MAX_DIRTY_DEFAULT 2000 /* Arbitrary large value */
144 #define OSC_MAX_DIRTY_MB_MAX 2048 /* arbitrary, but < MAX_LONG bytes */
145 #define OSC_DEFAULT_RESENDS 10
147 /* possible values for lut_sync_lock_cancel */
148 enum tgt_sync_lock_cancel {
149 SYNC_LOCK_CANCEL_NEVER = 0,
150 SYNC_LOCK_CANCEL_BLOCKING = 1,
151 SYNC_LOCK_CANCEL_ALWAYS = 2,
155 * Limit reply buffer size for striping data to one x86_64 page. This
156 * value is chosen to fit the striping data for common use cases while
157 * staying well below the limit at which the buffer must be backed by
158 * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
161 #define OBD_MAX_DEFAULT_EA_SIZE 4096
164 * Lustre can handle larger xattrs internally, but we must respect the Linux
165 * VFS limitation or tools like tar cannot interact with Lustre volumes
168 #define OBD_MAX_EA_SIZE XATTR_SIZE_MAX
171 enum obd_cl_sem_lock_class {
179 struct rw_semaphore cl_sem;
180 struct obd_uuid cl_target_uuid;
181 struct obd_import *cl_import; /* ptlrpc connection state */
182 size_t cl_conn_count;
184 /* Cache maximum and default values for easize. This is
185 * strictly a performance optimization to minimize calls to
186 * obd_size_diskmd(). The default values are used to calculate the
187 * initial size of a request buffer. The ptlrpc layer will resize the
188 * buffer as needed to accommodate a larger reply from the
189 * server. The default values should be small enough to avoid wasted
190 * memory and excessive use of vmalloc(), yet large enough to avoid
191 * reallocating the buffer in the common use case. */
193 /* Default EA size for striping attributes. It is initialized at
194 * mount-time based on the default stripe width of the filesystem,
195 * then it tracks the largest observed EA size advertised by
196 * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
197 __u32 cl_default_mds_easize;
199 /* Maximum possible EA size computed at mount-time based on
200 * the number of OSTs in the filesystem. May be increased at
201 * run-time if a larger observed size is advertised by the MDT. */
202 __u32 cl_max_mds_easize;
204 /* Data-on-MDT specific value to set larger reply buffer for possible
205 * data read along with open/stat requests. By default it tries to use
206 * unused space in reply buffer.
207 * This value is used to ensure that reply buffer has at least as
208 * much free space as value indicates. That free space is gained from
209 * LOV EA buffer which is small for DoM files and on big systems can
210 * provide up to 32KB of extra space in reply buffer.
211 * Default value is 8K now.
213 __u32 cl_dom_min_inline_repsize;
215 unsigned int cl_checksum:1, /* 0 = disabled, 1 = enabled */
216 cl_checksum_dump:1, /* same */
217 cl_ocd_grant_param:1,
218 cl_lsom_update:1; /* send LSOM updates */
219 enum lustre_sec_part cl_sp_me;
220 enum lustre_sec_part cl_sp_to;
221 struct sptlrpc_flavor cl_flvr_mgc; /* fixed flavor of mgc->mgs */
223 /* the grant values are protected by loi_list_lock below */
224 unsigned long cl_dirty_pages; /* all _dirty_ in pages */
225 unsigned long cl_dirty_max_pages; /* allowed w/o rpc */
226 unsigned long cl_avail_grant; /* bytes of credit for ost */
227 unsigned long cl_lost_grant; /* lost credits (trunc) */
228 /* grant consumed for dirty pages */
229 unsigned long cl_dirty_grant;
231 /* since we allocate grant by blocks, we don't know how many grant will
232 * be used to add a page into cache. As a solution, we reserve maximum
233 * grant before trying to dirty a page and unreserve the rest.
234 * See osc_{reserve|unreserve}_grant for details. */
235 long cl_reserved_grant;
236 wait_queue_head_t cl_cache_waiters; /* waiting for cache/grant */
237 time64_t cl_next_shrink_grant; /* seconds */
238 struct list_head cl_grant_chain;
239 time64_t cl_grant_shrink_interval; /* seconds */
241 int cl_root_squash; /* if root squash enabled*/
243 /* A chunk is an optimal size used by osc_extent to determine
244 * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
246 /* extent insertion metadata overhead to be accounted in grant,
248 unsigned int cl_grant_extent_tax;
249 /* maximum extent size, in number of pages */
250 unsigned int cl_max_extent_pages;
252 /* keep track of objects that have lois that contain pages which
253 * have been queued for async brw. this lock also protects the
254 * lists of osc_client_pages that hang off of the loi */
256 * ->cl_loi_list_lock protects consistency of
257 * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
258 * ->ap_completion() call-backs are executed under this lock. As we
259 * cannot guarantee that these call-backs never block on all platforms
260 * (as a matter of fact they do block on Mac OS X), type of
261 * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
262 * and blocking mutex on Mac OS X. (Alternative is to make this lock
263 * blocking everywhere, but we don't want to slow down fast-path of
264 * our main platform.)
266 * NB by Jinshan: though field names are still _loi_, but actually
267 * osc_object{}s are in the list.
269 spinlock_t cl_loi_list_lock;
270 struct list_head cl_loi_ready_list;
271 struct list_head cl_loi_hp_ready_list;
272 struct list_head cl_loi_write_list;
273 struct list_head cl_loi_read_list;
274 __u32 cl_r_in_flight;
275 __u32 cl_w_in_flight;
276 /* just a sum of the loi/lop pending numbers to be exported by /proc */
277 atomic_t cl_pending_w_pages;
278 atomic_t cl_pending_r_pages;
279 u32 cl_max_pages_per_rpc;
280 u32 cl_max_rpcs_in_flight;
281 u32 cl_max_short_io_bytes;
282 ktime_t cl_stats_init;
283 struct obd_histogram cl_read_rpc_hist;
284 struct obd_histogram cl_write_rpc_hist;
285 struct obd_histogram cl_read_page_hist;
286 struct obd_histogram cl_write_page_hist;
287 struct obd_histogram cl_read_offset_hist;
288 struct obd_histogram cl_write_offset_hist;
290 /** LRU for osc caching pages */
291 struct cl_client_cache *cl_cache;
292 /** member of cl_cache->ccc_lru */
293 struct list_head cl_lru_osc;
294 /** # of available LRU slots left in the per-OSC cache.
295 * Available LRU slots are shared by all OSCs of the same file system,
296 * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
297 atomic_long_t *cl_lru_left;
298 /** # of busy LRU pages. A page is considered busy if it's in writeback
299 * queue, or in transfer. Busy pages can't be discarded so they are not
301 atomic_long_t cl_lru_busy;
302 /** # of LRU pages in the cache for this client_obd */
303 atomic_long_t cl_lru_in_list;
304 /** # of threads are shrinking LRU cache. To avoid contention, it's not
305 * allowed to have multiple threads shrinking LRU cache. */
306 atomic_t cl_lru_shrinkers;
307 /** The time when this LRU cache was last used. */
308 time64_t cl_lru_last_used;
309 /** stats: how many reclaims have happened for this client_obd.
310 * reclaim and shrink - shrink is async, voluntarily rebalancing;
311 * reclaim is sync, initiated by IO thread when the LRU slots are
313 __u64 cl_lru_reclaim;
314 /** List of LRU pages for this client_obd */
315 struct list_head cl_lru_list;
316 /** Lock for LRU page list */
317 spinlock_t cl_lru_list_lock;
318 /** # of unstable pages in this client_obd.
319 * An unstable page is a page state that WRITE RPC has finished but
320 * the transaction has NOT yet committed. */
321 atomic_long_t cl_unstable_count;
322 /** Link to osc_shrinker_list */
323 struct list_head cl_shrink_list;
325 /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
326 atomic_t cl_destroy_in_flight;
327 wait_queue_head_t cl_destroy_waitq;
329 /* modify rpcs in flight
330 * currently used for metadata only */
331 spinlock_t cl_mod_rpcs_lock;
332 __u16 cl_max_mod_rpcs_in_flight;
333 __u16 cl_mod_rpcs_in_flight;
334 __u16 cl_close_rpcs_in_flight;
335 wait_queue_head_t cl_mod_rpcs_waitq;
336 unsigned long *cl_mod_tag_bitmap;
337 ktime_t cl_mod_rpcs_init;
338 struct obd_histogram cl_mod_rpcs_hist;
341 struct mutex cl_mgc_mutex;
342 struct local_oid_storage *cl_mgc_los;
343 struct dt_object *cl_mgc_configs_dir;
344 struct obd_export *cl_mgc_mgsexp;
345 atomic_t cl_mgc_refcount;
346 /* in-flight control list and total RPCs counter */
347 struct list_head cl_flight_waiters;
348 __u32 cl_rpcs_in_flight;
350 /* supported checksum types that are worked out at connect time */
351 __u32 cl_supp_cksum_types;
352 /* checksum algorithm to be used */
353 enum cksum_types cl_cksum_type;
354 /* preferred checksum algorithm to be used */
355 enum cksum_types cl_preferred_cksum_type;
357 /* also protected by the poorly named _loi_list_lock lock above */
358 struct osc_async_rc cl_ar;
360 /* sequence manager */
361 struct lu_client_seq *cl_seq;
362 struct rw_semaphore cl_seq_rwsem;
364 atomic_t cl_resends; /* resend count */
366 /* ptlrpc work for writeback in ptlrpcd context */
367 void *cl_writeback_work;
369 struct mutex cl_quota_mutex;
370 /* hash tables for osc_quota_info */
371 struct cfs_hash *cl_quota_hash[LL_MAXQUOTAS];
372 /* the xid of the request updating the hash tables */
373 __u64 cl_quota_last_xid;
374 /* Links to the global list of registered changelog devices */
375 struct list_head cl_chg_dev_linkage;
377 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
384 struct echo_client_obd {
385 struct obd_export *ec_exp; /* the local connection to osc/lov */
387 struct list_head ec_objects;
388 struct list_head ec_locks;
392 /* allow statfs data caching for 1 second */
393 #define OBD_STATFS_CACHE_SECONDS 1
394 /* arbitrary maximum. larger would be useless, allows catching bogus input */
395 #define OBD_STATFS_CACHE_MAX_AGE 3600 /* seconds */
397 #define lov_tgt_desc lu_tgt_desc
399 struct lov_md_tgt_desc {
400 struct obd_device *lmtd_mdc;
405 struct lov_desc desc;
406 struct lov_tgt_desc **lov_tgts; /* sparse array */
407 struct lu_tgt_pool lov_packed; /* all OSTs in a packed
409 struct mutex lov_lock;
410 struct obd_connect_data lov_ocd;
411 atomic_t lov_refcount;
412 __u32 lov_death_row; /* tgts scheduled to be deleted */
413 __u32 lov_tgt_size; /* size of tgts array */
416 struct rhashtable lov_pools_hash_body; /* used for key access */
417 struct list_head lov_pool_list; /* used for sequential access */
418 struct proc_dir_entry *lov_pool_proc_entry;
419 enum lustre_sec_part lov_sp_me;
421 /* Cached LRU and unstable data from upper layer */
422 struct cl_client_cache *lov_cache;
424 struct rw_semaphore lov_notify_lock;
425 /* Data-on-MDT: MDC array */
426 struct lov_md_tgt_desc *lov_mdc_tgts;
428 struct kobject *lov_tgts_kobj;
431 #define lmv_tgt_desc lu_tgt_desc
434 struct lu_client_fld lmv_fld;
440 u32 lmv_statfs_start;
442 struct lu_tgt_descs lmv_mdt_descs;
444 struct obd_connect_data conn_data;
445 struct kobject *lmv_tgts_kobj;
448 __u32 lmv_qos_rr_index;
451 #define lmv_mdt_count lmv_mdt_descs.ltd_lmv_desc.ld_tgt_count
452 #define lmv_qos lmv_mdt_descs.ltd_qos
454 /* Minimum sector size is 512 */
455 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
457 struct niobuf_local {
458 __u64 lnb_file_offset;
459 __u32 lnb_page_offset;
463 struct page *lnb_page;
465 __u16 lnb_guards[MAX_GUARD_NUMBER];
466 __u16 lnb_guard_rpc:1;
467 __u16 lnb_guard_disk:1;
468 /* separate unlock for read path to allow shared access */
472 struct tgt_thread_big_cache {
473 struct niobuf_local local[PTLRPC_MAX_BRW_PAGES];
476 #define LUSTRE_FLD_NAME "fld"
477 #define LUSTRE_SEQ_NAME "seq"
479 #define LUSTRE_MDD_NAME "mdd"
480 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
481 #define LUSTRE_OSD_ZFS_NAME "osd-zfs"
482 #define LUSTRE_VVP_NAME "vvp"
483 #define LUSTRE_LMV_NAME "lmv"
484 #define LUSTRE_SLP_NAME "slp"
485 #define LUSTRE_LOD_NAME "lod"
486 #define LUSTRE_OSP_NAME "osp"
487 #define LUSTRE_LWP_NAME "lwp"
489 /* obd device type names */
490 /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
491 #define LUSTRE_MDS_NAME "mds"
492 #define LUSTRE_MDT_NAME "mdt"
493 #define LUSTRE_MDC_NAME "mdc"
494 #define LUSTRE_OSS_NAME "ost" /* FIXME change name to oss */
495 #define LUSTRE_OST_NAME "obdfilter" /* FIXME change name to ost */
496 #define LUSTRE_OSC_NAME "osc"
497 #define LUSTRE_LOV_NAME "lov"
498 #define LUSTRE_MGS_NAME "mgs"
499 #define LUSTRE_MGC_NAME "mgc"
501 #define LUSTRE_ECHO_NAME "obdecho"
502 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
503 #define LUSTRE_QMT_NAME "qmt"
505 /* Constant obd names (post-rename) */
506 #define LUSTRE_MDS_OBDNAME "MDS"
507 #define LUSTRE_OSS_OBDNAME "OSS"
508 #define LUSTRE_MGS_OBDNAME "MGS"
509 #define LUSTRE_MGC_OBDNAME "MGC"
511 static inline int is_lwp_on_mdt(char *name)
515 ptr = strrchr(name, '-');
517 CERROR("%s is not a obdname\n", name);
521 /* LWP name on MDT is fsname-MDTxxxx-lwp-MDTxxxx */
523 if (strncmp(ptr + 1, "MDT", 3) != 0)
526 while (*(--ptr) != '-' && ptr != name);
531 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
537 static inline int is_lwp_on_ost(char *name)
541 ptr = strrchr(name, '-');
543 CERROR("%s is not a obdname\n", name);
547 /* LWP name on OST is fsname-MDTxxxx-lwp-OSTxxxx */
549 if (strncmp(ptr + 1, "OST", 3) != 0)
552 while (*(--ptr) != '-' && ptr != name);
557 if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
564 * Events signalled through obd_notify() upcall-chain.
566 enum obd_notify_event {
567 /* Device connect start */
569 /* Device activated */
571 /* Device deactivated */
573 /* Connect data for import were changed */
575 /* Administratively deactivate/activate event */
576 OBD_NOTIFY_DEACTIVATE,
581 * Data structure used to pass obd_notify()-event to non-obd listeners (llite
582 * being main example).
584 struct obd_notify_upcall {
585 int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
586 enum obd_notify_event ev, void *owner);
587 /* Opaque datum supplied by upper layer listener */
591 struct target_recovery_data {
592 svc_handler_t trd_recovery_handler;
593 pid_t trd_processing_task;
594 struct completion trd_starting;
595 struct completion trd_finishing;
598 struct obd_llog_group {
599 struct llog_ctxt *olg_ctxts[LLOG_MAX_CTXTS];
600 wait_queue_head_t olg_waitq;
604 /* corresponds to one of the obd's */
605 #define OBD_DEVICE_MAGIC 0XAB5CD6EF
608 struct obd_type *obd_type;
609 __u32 obd_magic; /* OBD_DEVICE_MAGIC */
610 int obd_minor; /* device number: lctl dl */
611 struct lu_device *obd_lu_dev;
613 /* common and UUID name of this device */
614 struct obd_uuid obd_uuid;
615 char obd_name[MAX_OBD_NAME];
617 /* bitfield modification is protected by obd_dev_lock */
619 obd_attached:1, /* finished attach */
620 obd_set_up:1, /* finished setup */
621 obd_recovering:1, /* there are recoverable clients */
622 obd_abort_recovery:1, /* recovery expired */
623 obd_abort_recov_mdt:1, /* only abort recovery between MDTs */
624 obd_version_recov:1, /* obd uses version checking */
625 obd_replayable:1, /* recovery enabled; inform clients */
626 obd_no_recov:1, /* fail instead of retry messages */
627 obd_stopping:1, /* started cleanup */
628 obd_starting:1, /* started setup */
629 obd_force:1, /* cleanup with > 0 obd refcount */
630 obd_fail:1, /* cleanup with failover */
631 obd_no_conn:1, /* deny new connections */
632 obd_inactive:1, /* device active/inactive
633 * (for /proc/status only!!) */
634 obd_no_ir:1, /* no imperative recovery. */
635 obd_process_conf:1, /* device is processing mgs config */
636 obd_checksum_dump:1, /* dump pages upon cksum error */
637 obd_dynamic_nids:1, /* Allow dynamic NIDs on device */
638 obd_read_only:1; /* device is read-only */
639 #ifdef HAVE_SERVER_SUPPORT
640 /* no committed-transno notification */
641 unsigned long obd_no_transno:1;
644 /* use separate field as it is set in interrupt to don't mess with
645 * protection of other bits using _bh lock */
646 unsigned long obd_recovery_expired:1;
647 /* uuid-export hash body */
648 struct rhashtable obd_uuid_hash;
649 /* nid-export hash body */
650 struct rhltable obd_nid_hash;
652 struct cfs_hash *obd_nid_stats_hash;
653 /* client_generation-export hash body */
654 struct cfs_hash *obd_gen_hash;
655 struct list_head obd_nid_stats;
656 struct list_head obd_exports;
657 struct list_head obd_unlinked_exports;
658 struct list_head obd_delayed_exports;
659 struct list_head obd_lwp_list;
660 atomic_t obd_refcount;
662 int obd_grant_check_threshold;
663 spinlock_t obd_nid_lock;
664 struct ldlm_namespace *obd_namespace;
665 struct ptlrpc_client obd_ldlm_client; /* XXX OST/MDS only */
666 /* a spinlock is OK for what we do now, may need a semaphore later */
667 spinlock_t obd_dev_lock; /* protect OBD bitfield above */
668 spinlock_t obd_osfs_lock;
669 struct obd_statfs obd_osfs; /* locked by obd_osfs_lock */
670 time64_t obd_osfs_age;
671 __u64 obd_last_committed;
672 struct mutex obd_dev_mutex;
673 struct lvfs_run_ctxt obd_lvfs_ctxt;
674 struct obd_llog_group obd_olg; /* default llog group */
675 struct obd_device *obd_observer;
676 struct rw_semaphore obd_observer_link_sem;
677 struct obd_notify_upcall obd_upcall;
678 struct obd_export *obd_self_export;
679 struct obd_export *obd_lwp_export;
680 /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
681 struct list_head obd_exports_timed;
682 time64_t obd_eviction_timer; /* for ping evictor */
684 atomic_t obd_max_recoverable_clients;
685 atomic_t obd_connected_clients;
686 int obd_stale_clients;
687 /* this lock protects all recovery list_heads, timer and
688 * obd_next_recovery_transno value */
689 spinlock_t obd_recovery_task_lock;
690 __u64 obd_next_recovery_transno;
691 int obd_replayed_requests;
692 int obd_requests_queued_for_recovery;
693 wait_queue_head_t obd_next_transno_waitq;
694 /* protected by obd_recovery_task_lock */
695 struct hrtimer obd_recovery_timer;
697 time64_t obd_recovery_start;
698 /* seconds, for lprocfs_status */
699 time64_t obd_recovery_end;
700 /* To tell timeouts from time stamps Lustre uses timeout_t
701 * instead of time64_t.
703 timeout_t obd_recovery_time_hard;
704 timeout_t obd_recovery_timeout;
705 int obd_recovery_ir_factor;
707 /* new recovery stuff from CMD2 */
708 int obd_replayed_locks;
709 atomic_t obd_req_replay_clients;
710 atomic_t obd_lock_replay_clients;
711 struct target_recovery_data obd_recovery_data;
713 /* all lists are protected by obd_recovery_task_lock */
714 struct list_head obd_req_replay_queue;
715 struct list_head obd_lock_replay_queue;
716 struct list_head obd_final_req_queue;
719 #ifdef HAVE_SERVER_SUPPORT
720 struct obd_device_target obt;
721 struct filter_obd filter;
723 struct echo_obd echo;
725 struct client_obd cli;
726 struct echo_client_obd echo_client;
731 /* Fields used by LProcFS */
732 struct lprocfs_stats *obd_stats;
734 struct lprocfs_stats *obd_md_stats;
736 struct dentry *obd_debugfs_entry;
737 struct proc_dir_entry *obd_proc_entry;
738 struct proc_dir_entry *obd_proc_exports_entry;
739 struct dentry *obd_svc_debugfs_entry;
740 struct lprocfs_stats *obd_svc_stats;
741 const struct attribute **obd_attrs;
742 struct lprocfs_vars *obd_vars;
743 struct ldebugfs_vars *obd_debugfs_vars;
744 atomic_t obd_evict_inprogress;
745 wait_queue_head_t obd_evict_inprogress_waitq;
746 struct list_head obd_evict_list; /* protected with pet_lock */
749 * LDLM pool part. Save last calculated SLV and Limit.
751 rwlock_t obd_pool_lock;
755 int obd_conn_inprogress;
758 * List of outstanding class_incref()'s fo this OBD. For debugging. */
759 struct lu_ref obd_reference;
761 struct kset obd_kset; /* sysfs object collection */
762 struct kobj_type obd_ktype;
763 struct completion obd_kobj_unregister;
766 int obd_uuid_add(struct obd_device *obd, struct obd_export *export);
767 void obd_uuid_del(struct obd_device *obd, struct obd_export *export);
768 #ifdef HAVE_SERVER_SUPPORT
769 struct obd_export *obd_uuid_lookup(struct obd_device *obd,
770 struct obd_uuid *uuid);
772 int obd_nid_export_for_each(struct obd_device *obd, struct lnet_nid *nid,
773 int cb(struct obd_export *exp, void *data),
775 int obd_nid_add(struct obd_device *obd, struct obd_export *exp);
776 void obd_nid_del(struct obd_device *obd, struct obd_export *exp);
779 /* get/set_info keys */
780 #define KEY_ASYNC "async"
781 #define KEY_CHANGELOG_CLEAR "changelog_clear"
782 #define KEY_FID2PATH "fid2path"
783 #define KEY_CHECKSUM "checksum"
784 #define KEY_CLEAR_FS "clear_fs"
785 #define KEY_CONN_DATA "conn_data"
786 #define KEY_EVICT_BY_NID "evict_by_nid"
787 #define KEY_FIEMAP "fiemap"
788 #define KEY_FLUSH_CTX "flush_ctx"
789 #define KEY_GRANT_SHRINK "grant_shrink"
790 #define KEY_HSM_COPYTOOL_SEND "hsm_send"
791 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
792 #define KEY_INTERMDS "inter_mds"
793 #define KEY_LAST_ID "last_id"
794 #define KEY_LAST_FID "last_fid"
795 #define KEY_MAX_EASIZE "max_easize"
796 #define KEY_DEFAULT_EASIZE "default_easize"
797 #define KEY_MGSSEC "mgssec"
798 #define KEY_READ_ONLY "read-only"
799 #define KEY_REGISTER_TARGET "register_target"
800 #define KEY_SET_FS "set_fs"
801 #define KEY_TGT_COUNT "tgt_count"
802 /* KEY_SET_INFO in lustre_idl.h */
803 #define KEY_SPTLRPC_CONF "sptlrpc_conf"
805 #define KEY_CACHE_LRU_SHRINK "cache_lru_shrink"
806 #define KEY_OSP_CONNECTED "osp_connected"
808 /* Flags for op_xvalid */
810 OP_XVALID_CTIME_SET = BIT(0), /* 0x0001 */
811 OP_XVALID_BLOCKS = BIT(1), /* 0x0002 */
812 OP_XVALID_OWNEROVERRIDE = BIT(2), /* 0x0004 */
813 OP_XVALID_FLAGS = BIT(3), /* 0x0008 */
814 OP_XVALID_PROJID = BIT(4), /* 0x0010 */
815 OP_XVALID_LAZYSIZE = BIT(5), /* 0x0020 */
816 OP_XVALID_LAZYBLOCKS = BIT(6), /* 0x0040 */
821 static inline int it_to_lock_mode(struct lookup_intent *it)
823 /* CREAT needs to be tested before open (both could be set) */
824 if (it->it_op & IT_CREAT)
826 else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
828 else if (it->it_op & IT_LAYOUT)
829 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
830 else if (it->it_op & IT_READDIR)
832 else if (it->it_op & IT_GETXATTR)
835 LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
840 MF_MDC_CANCEL_FID1 = BIT(0),
841 MF_MDC_CANCEL_FID2 = BIT(1),
842 MF_MDC_CANCEL_FID3 = BIT(2),
843 MF_MDC_CANCEL_FID4 = BIT(3),
844 MF_GET_MDT_IDX = BIT(4),
845 MF_GETATTR_BY_FID = BIT(5),
846 MF_QOS_MKDIR = BIT(6),
847 MF_RR_MKDIR = BIT(7),
848 MF_OPNAME_KMALLOCED = BIT(8),
852 CLI_SET_MEA = BIT(0),
853 CLI_RM_ENTRY = BIT(1),
856 CLI_MIGRATE = BIT(4),
857 CLI_DIRTY_DATA = BIT(5),
858 CLI_NO_SLOT = BIT(6),
862 LUSTRE_OPC_MKDIR = 1,
872 * GETXATTR is not included as only a couple of fields in the reply body
873 * is filled, but not FID which is needed for common intent handling in
874 * mdc_finish_intent_lock()
876 static inline bool it_has_reply_body(const struct lookup_intent *it)
878 return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
882 struct lu_fid op_fid1; /* operation fid1 (usualy parent) */
883 struct lu_fid op_fid2; /* operation fid2 (usualy child) */
884 struct lu_fid op_fid3; /* 2 extra fids to find conflicting */
885 struct lu_fid op_fid4; /* to the operation locks. */
886 u32 op_mds; /* what mds server open will go to */
888 enum md_op_code op_code;
889 struct lustre_handle op_open_handle;
893 struct rw_semaphore *op_mea1_sem;
894 struct rw_semaphore *op_mea2_sem;
895 struct lmv_stripe_md *op_mea1;
896 struct lmv_stripe_md *op_mea2;
897 struct lmv_stripe_md *op_default_mea1; /* default LMV */
898 __u32 op_suppgids[2];
905 /* iattr fields and blocks. */
906 struct iattr op_attr;
907 enum op_xvalid op_xvalid; /* eXtra validity flags */
908 loff_t op_attr_blocks;
909 u64 op_valid; /* OBD_MD_* */
910 unsigned int op_attr_flags; /* LUSTRE_{SYNC,..}_FL */
912 enum md_op_flags op_flags;
914 /* Various operation flags. */
915 enum mds_op_bias op_bias;
917 /* used to transfer info between the stacks of MD client
918 * see enum op_cli_flags */
919 enum md_cli_flags op_cli_flags;
921 /* File object data version for HSM release, on client */
922 __u64 op_data_version;
923 struct lustre_handle op_lease_handle;
925 /* File security context, for creates/metadata ops */
926 const char *op_file_secctx_name;
927 __u32 op_file_secctx_name_size;
928 void *op_file_secctx;
929 __u32 op_file_secctx_size;
931 /* File encryption context, for creates/metadata ops */
932 void *op_file_encctx;
933 __u32 op_file_encctx_size;
938 /* Used by readdir */
939 unsigned int op_max_pages;
941 unsigned short op_dir_depth;
947 * used to access dir that is changing layout: if it's set, access
948 * dir by new layout, otherwise old layout.
949 * By default it's not set, because new files are created under new
950 * layout, if we can't find file with name under both old and new
951 * layout, we are sure file with name doesn't exist, but in reverse
952 * order there may be a race with creation by others.
955 /* used to access dir with bash hash */
956 __u32 op_stripe_index;
957 /* Archive ID for PCC attach */
961 struct md_readdir_info {
962 int (*mr_blocking_ast)(struct ldlm_lock *lock,
963 struct ldlm_lock_desc *desc,
964 void *data, int flag);
965 /* if striped directory is partially read, the result is stored here */
966 int mr_partial_readdir_rc;
970 typedef int (*md_op_item_cb_t)(struct req_capsule *pill,
971 struct md_op_item *item,
975 struct md_op_data mop_data;
976 struct lookup_intent mop_it;
977 struct lustre_handle mop_lockh;
978 struct ldlm_enqueue_info mop_einfo;
979 md_op_item_cb_t mop_cb;
981 struct inode *mop_dir;
985 struct module *o_owner;
986 int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
987 void *karg, void __user *uarg);
988 int (*o_get_info)(const struct lu_env *env, struct obd_export *,
989 __u32 keylen, void *key, __u32 *vallen, void *val);
990 int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
991 __u32 keylen, void *key,
992 __u32 vallen, void *val,
993 struct ptlrpc_request_set *set);
994 int (*o_setup) (struct obd_device *obd, struct lustre_cfg *cfg);
995 int (*o_precleanup)(struct obd_device *obd);
996 int (*o_cleanup)(struct obd_device *obd);
997 int (*o_process_config)(struct obd_device *obd, size_t len, void *data);
998 int (*o_postrecov)(struct obd_device *obd);
999 int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
1001 int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
1002 /* connect to the target device with given connection
1003 * data. @ocd->ocd_connect_flags is modified to reflect flags actually
1004 * granted by the target, which are guaranteed to be a subset of flags
1005 * asked for. If @ocd == NULL, use default parameters. */
1006 int (*o_connect)(const struct lu_env *env,
1007 struct obd_export **exp, struct obd_device *src,
1008 struct obd_uuid *cluuid, struct obd_connect_data *ocd,
1010 int (*o_reconnect)(const struct lu_env *env,
1011 struct obd_export *exp, struct obd_device *src,
1012 struct obd_uuid *cluuid,
1013 struct obd_connect_data *ocd,
1015 int (*o_disconnect)(struct obd_export *exp);
1017 /* Initialize/finalize fids infrastructure. */
1018 int (*o_fid_init)(struct obd_device *obd,
1019 struct obd_export *exp, enum lu_cli_type type);
1020 int (*o_fid_fini)(struct obd_device *obd);
1022 /* Allocate new fid according to passed @hint. */
1023 int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
1024 struct lu_fid *fid, struct md_op_data *op_data);
1027 * Object with @fid is getting deleted, we may want to do something
1030 int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
1031 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
1032 int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
1033 time64_t max_age, struct ptlrpc_request_set *set);
1034 int (*o_create)(const struct lu_env *env, struct obd_export *exp,
1036 int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
1038 int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1040 int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1042 int (*o_preprw)(const struct lu_env *env, int cmd,
1043 struct obd_export *exp, struct obdo *oa, int objcount,
1044 struct obd_ioobj *obj, struct niobuf_remote *remote,
1045 int *nr_pages, struct niobuf_local *local);
1046 int (*o_commitrw)(const struct lu_env *env, int cmd,
1047 struct obd_export *exp, struct obdo *oa,
1048 int objcount, struct obd_ioobj *obj,
1049 struct niobuf_remote *remote, int pages,
1050 struct niobuf_local *local, int rc, int nob,
1052 int (*o_init_export)(struct obd_export *exp);
1053 int (*o_destroy_export)(struct obd_export *exp);
1055 int (*o_import_event)(struct obd_device *, struct obd_import *,
1056 enum obd_import_event);
1058 int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1059 enum obd_notify_event ev);
1061 int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1062 struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1065 int (*o_quotactl)(struct obd_device *, struct obd_export *,
1066 struct obd_quotactl *);
1069 int (*o_pool_new)(struct obd_device *obd, char *poolname);
1070 int (*o_pool_del)(struct obd_device *obd, char *poolname);
1071 int (*o_pool_add)(struct obd_device *obd, char *poolname,
1073 int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1077 /* lmv structures */
1079 struct mdt_body *body;
1080 struct lu_buf layout;
1082 struct lmv_stripe_md *lmv;
1083 struct lmv_foreign_md *lfm;
1085 struct lmv_stripe_md *default_lmv;
1086 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1087 struct posix_acl *posix_acl;
1091 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1092 static inline void lmd_clear_acl(struct lustre_md *md)
1094 if (md->posix_acl) {
1095 posix_acl_release(md->posix_acl);
1096 md->posix_acl = NULL;
1100 #define OBD_CONNECT_ACL_FLAGS \
1101 (OBD_CONNECT_ACL | OBD_CONNECT_UMASK | OBD_CONNECT_LARGE_ACL)
1103 static inline void lmd_clear_acl(struct lustre_md *md)
1107 #define OBD_CONNECT_ACL_FLAGS (0)
1110 struct md_open_data {
1111 struct obd_client_handle *mod_och;
1112 struct ptlrpc_request *mod_open_req;
1113 struct ptlrpc_request *mod_close_req;
1114 atomic_t mod_refcount;
1118 struct obd_client_handle {
1119 struct lustre_handle och_open_handle;
1120 struct lu_fid och_fid;
1121 struct md_open_data *och_mod;
1122 struct lustre_handle och_lease_handle; /* open lock for lease */
1127 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1129 struct lookup_intent;
1133 int (*m_close)(struct obd_export *, struct md_op_data *,
1134 struct md_open_data *, struct ptlrpc_request **);
1136 int (*m_create)(struct obd_export *, struct md_op_data *,
1137 const void *, size_t, umode_t, uid_t, gid_t,
1138 kernel_cap_t, __u64, struct ptlrpc_request **);
1140 int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1141 const union ldlm_policy_data *, struct md_op_data *,
1142 struct lustre_handle *, __u64);
1144 int (*m_getattr)(struct obd_export *, struct md_op_data *,
1145 struct ptlrpc_request **);
1147 int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1148 struct lookup_intent *,
1149 struct ptlrpc_request **,
1150 ldlm_blocking_callback, __u64);
1152 int (*m_link)(struct obd_export *, struct md_op_data *,
1153 struct ptlrpc_request **);
1155 int (*m_rename)(struct obd_export *, struct md_op_data *,
1156 const char *, size_t, const char *, size_t,
1157 struct ptlrpc_request **);
1159 int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1160 size_t , struct ptlrpc_request **);
1162 int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1163 struct ptlrpc_request **);
1165 int (*m_read_page)(struct obd_export *, struct md_op_data *,
1166 struct md_readdir_info *mrinfo, __u64 hash_offset,
1167 struct page **ppage);
1169 int (*m_unlink)(struct obd_export *, struct md_op_data *,
1170 struct ptlrpc_request **);
1172 int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1173 u64, const char *, const void *, size_t, unsigned int,
1174 u32, struct ptlrpc_request **);
1176 int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1177 u64, const char *, size_t, struct ptlrpc_request **);
1179 int (*m_intent_getattr_async)(struct obd_export *,
1180 struct md_op_item *);
1182 int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1183 struct lu_fid *, __u64 *bits);
1185 int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1187 int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1188 int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1190 int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1191 struct ptlrpc_request **);
1193 int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1195 int (*m_get_lustre_md)(struct obd_export *, struct req_capsule *,
1196 struct obd_export *, struct obd_export *,
1197 struct lustre_md *);
1199 int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1201 int (*m_merge_attr)(struct obd_export *,
1202 const struct lmv_stripe_md *lsm,
1203 struct cl_attr *attr, ldlm_blocking_callback);
1205 int (*m_set_open_replay_data)(struct obd_export *,
1206 struct obd_client_handle *,
1207 struct lookup_intent *);
1209 int (*m_clear_open_replay_data)(struct obd_export *,
1210 struct obd_client_handle *);
1212 int (*m_set_lock_data)(struct obd_export *,
1213 const struct lustre_handle *, void *, __u64 *);
1215 enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1216 const struct lu_fid *, enum ldlm_type,
1217 union ldlm_policy_data *, enum ldlm_mode,
1218 struct lustre_handle *);
1220 int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1221 union ldlm_policy_data *, enum ldlm_mode,
1222 enum ldlm_cancel_flags flags, void *opaque);
1224 int (*m_get_fid_from_lsm)(struct obd_export *,
1225 const struct lmv_stripe_md *,
1226 const char *name, int namelen,
1227 struct lu_fid *fid);
1228 int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1229 const union lmv_mds_md *lmv, size_t lmv_size);
1230 int (*m_rmfid)(struct obd_export *exp, struct fid_array *fa, int *rcs,
1231 struct ptlrpc_request_set *set);
1234 static inline struct md_open_data *obd_mod_alloc(void)
1236 struct md_open_data *mod;
1240 atomic_set(&mod->mod_refcount, 1);
1244 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1245 #define obd_mod_put(mod) \
1247 if (atomic_dec_and_test(&(mod)->mod_refcount)) { \
1248 if ((mod)->mod_open_req) \
1249 ptlrpc_req_finished((mod)->mod_open_req); \
1250 OBD_FREE_PTR(mod); \
1254 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1255 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1256 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1258 /* return 1 if client should be resend request */
1259 static inline int client_should_resend(int resend, struct client_obd *cli)
1261 return atomic_read(&cli->cl_resends) ?
1262 atomic_read(&cli->cl_resends) > resend : 1;
1266 * Return device name for this device
1268 * XXX: lu_device is declared before obd_device, while a pointer pointing
1269 * back to obd_device in lu_device, so this helper function defines here
1270 * instead of in lu_object.h
1272 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1274 return lu_dev->ld_obd->obd_name;
1277 static inline bool filename_is_volatile(const char *name, size_t namelen,
1283 if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1286 /* caller does not care of idx */
1290 /* volatile file, the MDT can be set from name */
1291 /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1292 /* if no MDT is specified, use std way */
1293 if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1295 /* test for no MDT idx case */
1296 if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1297 (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1301 /* we have an idx, read it */
1302 start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1303 *idx = simple_strtoul(start, &end, 16);
1305 * no digit, no trailing :, negative value
1307 if (((*idx == 0) && (end == start)) ||
1308 (*end != ':') || (*idx < 0))
1313 /* bad format of mdt idx, we cannot return an error
1314 * to caller so we use hash algo */
1315 CERROR("Bad volatile file name format: %s\n",
1316 name + LUSTRE_VOLATILE_HDR_LEN);
1320 static inline int cli_brw_size(struct obd_device *obd)
1322 LASSERT(obd != NULL);
1323 return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1327 * When RPC size or the max RPCs in flight is increased, the max dirty pages
1328 * of the client should be increased accordingly to avoid sending fragmented
1329 * RPCs over the network when the client runs out of the maximum dirty space
1330 * when so many RPCs are being generated.
1332 static inline void client_adjust_max_dirty(struct client_obd *cli)
1335 if (cli->cl_dirty_max_pages <= 0) {
1336 cli->cl_dirty_max_pages =
1337 (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1339 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1340 cli->cl_max_pages_per_rpc;
1342 if (dirty_max > cli->cl_dirty_max_pages)
1343 cli->cl_dirty_max_pages = dirty_max;
1346 if (cli->cl_dirty_max_pages > cfs_totalram_pages() / 8)
1347 cli->cl_dirty_max_pages = cfs_totalram_pages() / 8;
1349 /* This value is exported to userspace through the max_dirty_mb
1350 * parameter. So we round up the number of pages to make it a round
1352 cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1353 1 << (20 - PAGE_SHIFT));
1356 /* Must be used for page cache pages only,
1357 * not safe otherwise (e.g. direct IO pages)
1359 static inline struct inode *page2inode(struct page *page)
1361 if (page->mapping) {
1365 return page->mapping->host;
1371 #endif /* __OBD_H */