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 struct list_head typ_chain;
103 struct obd_ops *typ_dt_ops;
104 struct md_ops *typ_md_ops;
105 struct proc_dir_entry *typ_procroot;
106 struct proc_dir_entry *typ_procsym;
107 struct dentry *typ_debugfs_entry;
108 #ifdef HAVE_SERVER_SUPPORT
113 struct lu_device_type *typ_lu;
114 spinlock_t obd_type_lock;
115 struct kobject typ_kobj;
125 struct timeout_item {
126 enum timeout_event ti_event;
130 struct list_head ti_obd_list;
131 struct list_head ti_chain;
134 #define OBD_MAX_RIF_DEFAULT 8
135 #define OBD_MAX_RIF_MAX 512
136 #define OSC_MAX_RIF_MAX 256
137 #define OSC_MAX_DIRTY_DEFAULT 2000 /* Arbitrary large value */
138 #define OSC_MAX_DIRTY_MB_MAX 2048 /* arbitrary, but < MAX_LONG bytes */
139 #define OSC_DEFAULT_RESENDS 10
141 /* possible values for fo_sync_lock_cancel */
143 NEVER_SYNC_ON_CANCEL = 0,
144 BLOCKING_SYNC_ON_CANCEL = 1,
145 ALWAYS_SYNC_ON_CANCEL = 2,
146 NUM_SYNC_ON_CANCEL_STATES
150 * Limit reply buffer size for striping data to one x86_64 page. This
151 * value is chosen to fit the striping data for common use cases while
152 * staying well below the limit at which the buffer must be backed by
153 * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
156 #define OBD_MAX_DEFAULT_EA_SIZE 4096
159 * Lustre can handle larger xattrs internally, but we must respect the Linux
160 * VFS limitation or tools like tar cannot interact with Lustre volumes
163 #define OBD_MAX_EA_SIZE XATTR_SIZE_MAX
166 enum obd_cl_sem_lock_class {
175 struct rw_semaphore cl_sem;
176 struct obd_uuid cl_target_uuid;
177 struct obd_import *cl_import; /* ptlrpc connection state */
178 size_t cl_conn_count;
180 /* Cache maximum and default values for easize. This is
181 * strictly a performance optimization to minimize calls to
182 * obd_size_diskmd(). The default values are used to calculate the
183 * initial size of a request buffer. The ptlrpc layer will resize the
184 * buffer as needed to accommodate a larger reply from the
185 * server. The default values should be small enough to avoid wasted
186 * memory and excessive use of vmalloc(), yet large enough to avoid
187 * reallocating the buffer in the common use case. */
189 /* Default EA size for striping attributes. It is initialized at
190 * mount-time based on the default stripe width of the filesystem,
191 * then it tracks the largest observed EA size advertised by
192 * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
193 __u32 cl_default_mds_easize;
195 /* Maximum possible EA size computed at mount-time based on
196 * the number of OSTs in the filesystem. May be increased at
197 * run-time if a larger observed size is advertised by the MDT. */
198 __u32 cl_max_mds_easize;
200 /* Data-on-MDT specific value to set larger reply buffer for possible
201 * data read along with open/stat requests. By default it tries to use
202 * unused space in reply buffer.
203 * This value is used to ensure that reply buffer has at least as
204 * much free space as value indicates. That free space is gained from
205 * LOV EA buffer which is small for DoM files and on big systems can
206 * provide up to 32KB of extra space in reply buffer.
207 * Default value is 8K now.
209 __u32 cl_dom_min_inline_repsize;
211 enum lustre_sec_part cl_sp_me;
212 enum lustre_sec_part cl_sp_to;
213 struct sptlrpc_flavor cl_flvr_mgc; /* fixed flavor of mgc->mgs */
215 /* the grant values are protected by loi_list_lock below */
216 unsigned long cl_dirty_pages; /* all _dirty_ in pages */
217 unsigned long cl_dirty_max_pages; /* allowed w/o rpc */
218 unsigned long cl_dirty_transit; /* dirty synchronous */
219 unsigned long cl_avail_grant; /* bytes of credit for ost */
220 unsigned long cl_lost_grant; /* lost credits (trunc) */
221 /* grant consumed for dirty pages */
222 unsigned long cl_dirty_grant;
224 /* since we allocate grant by blocks, we don't know how many grant will
225 * be used to add a page into cache. As a solution, we reserve maximum
226 * grant before trying to dirty a page and unreserve the rest.
227 * See osc_{reserve|unreserve}_grant for details. */
228 long cl_reserved_grant;
229 struct list_head cl_cache_waiters; /* waiting for cache/grant */
230 time64_t cl_next_shrink_grant; /* seconds */
231 struct list_head cl_grant_chain;
232 time64_t cl_grant_shrink_interval; /* seconds */
234 /* A chunk is an optimal size used by osc_extent to determine
235 * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
237 /* extent insertion metadata overhead to be accounted in grant,
239 unsigned int cl_grant_extent_tax;
240 /* maximum extent size, in number of pages */
241 unsigned int cl_max_extent_pages;
243 /* keep track of objects that have lois that contain pages which
244 * have been queued for async brw. this lock also protects the
245 * lists of osc_client_pages that hang off of the loi */
247 * ->cl_loi_list_lock protects consistency of
248 * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
249 * ->ap_completion() call-backs are executed under this lock. As we
250 * cannot guarantee that these call-backs never block on all platforms
251 * (as a matter of fact they do block on Mac OS X), type of
252 * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
253 * and blocking mutex on Mac OS X. (Alternative is to make this lock
254 * blocking everywhere, but we don't want to slow down fast-path of
255 * our main platform.)
257 * NB by Jinshan: though field names are still _loi_, but actually
258 * osc_object{}s are in the list.
260 spinlock_t cl_loi_list_lock;
261 struct list_head cl_loi_ready_list;
262 struct list_head cl_loi_hp_ready_list;
263 struct list_head cl_loi_write_list;
264 struct list_head cl_loi_read_list;
265 __u32 cl_r_in_flight;
266 __u32 cl_w_in_flight;
267 /* just a sum of the loi/lop pending numbers to be exported by /proc */
268 atomic_t cl_pending_w_pages;
269 atomic_t cl_pending_r_pages;
270 u32 cl_max_pages_per_rpc;
271 u32 cl_max_rpcs_in_flight;
272 u32 cl_max_short_io_bytes;
273 struct obd_histogram cl_read_rpc_hist;
274 struct obd_histogram cl_write_rpc_hist;
275 struct obd_histogram cl_read_page_hist;
276 struct obd_histogram cl_write_page_hist;
277 struct obd_histogram cl_read_offset_hist;
278 struct obd_histogram cl_write_offset_hist;
280 /** LRU for osc caching pages */
281 struct cl_client_cache *cl_cache;
282 /** member of cl_cache->ccc_lru */
283 struct list_head cl_lru_osc;
284 /** # of available LRU slots left in the per-OSC cache.
285 * Available LRU slots are shared by all OSCs of the same file system,
286 * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
287 atomic_long_t *cl_lru_left;
288 /** # of busy LRU pages. A page is considered busy if it's in writeback
289 * queue, or in transfer. Busy pages can't be discarded so they are not
291 atomic_long_t cl_lru_busy;
292 /** # of LRU pages in the cache for this client_obd */
293 atomic_long_t cl_lru_in_list;
294 /** # of threads are shrinking LRU cache. To avoid contention, it's not
295 * allowed to have multiple threads shrinking LRU cache. */
296 atomic_t cl_lru_shrinkers;
297 /** The time when this LRU cache was last used. */
298 time64_t cl_lru_last_used;
299 /** stats: how many reclaims have happened for this client_obd.
300 * reclaim and shrink - shrink is async, voluntarily rebalancing;
301 * reclaim is sync, initiated by IO thread when the LRU slots are
303 __u64 cl_lru_reclaim;
304 /** List of LRU pages for this client_obd */
305 struct list_head cl_lru_list;
306 /** Lock for LRU page list */
307 spinlock_t cl_lru_list_lock;
308 /** # of unstable pages in this client_obd.
309 * An unstable page is a page state that WRITE RPC has finished but
310 * the transaction has NOT yet committed. */
311 atomic_long_t cl_unstable_count;
312 /** Link to osc_shrinker_list */
313 struct list_head cl_shrink_list;
315 /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
316 atomic_t cl_destroy_in_flight;
317 wait_queue_head_t cl_destroy_waitq;
319 /* modify rpcs in flight
320 * currently used for metadata only */
321 spinlock_t cl_mod_rpcs_lock;
322 __u16 cl_max_mod_rpcs_in_flight;
323 __u16 cl_mod_rpcs_in_flight;
324 __u16 cl_close_rpcs_in_flight;
325 wait_queue_head_t cl_mod_rpcs_waitq;
326 unsigned long *cl_mod_tag_bitmap;
327 struct obd_histogram cl_mod_rpcs_hist;
330 struct mutex cl_mgc_mutex;
331 struct local_oid_storage *cl_mgc_los;
332 struct dt_object *cl_mgc_configs_dir;
333 struct obd_export *cl_mgc_mgsexp;
334 atomic_t cl_mgc_refcount;
335 /* in-flight control list and total RPCs counter */
336 struct list_head cl_flight_waiters;
337 __u32 cl_rpcs_in_flight;
339 /* checksumming for data sent over the network */
340 unsigned int cl_checksum:1, /* 0 = disabled, 1 = enabled */
341 cl_checksum_dump:1; /* same */
342 /* supported checksum types that are worked out at connect time */
343 __u32 cl_supp_cksum_types;
344 /* checksum algorithm to be used */
345 enum cksum_types cl_cksum_type;
347 /* also protected by the poorly named _loi_list_lock lock above */
348 struct osc_async_rc cl_ar;
350 /* sequence manager */
351 struct lu_client_seq *cl_seq;
352 struct rw_semaphore cl_seq_rwsem;
354 atomic_t cl_resends; /* resend count */
356 /* ptlrpc work for writeback in ptlrpcd context */
357 void *cl_writeback_work;
359 struct mutex cl_quota_mutex;
360 /* hash tables for osc_quota_info */
361 struct cfs_hash *cl_quota_hash[LL_MAXQUOTAS];
362 /* the xid of the request updating the hash tables */
363 __u64 cl_quota_last_xid;
364 /* Links to the global list of registered changelog devices */
365 struct list_head cl_chg_dev_linkage;
367 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
374 struct echo_client_obd {
375 struct obd_export *ec_exp; /* the local connection to osc/lov */
377 struct list_head ec_objects;
378 struct list_head ec_locks;
382 /* allow statfs data caching for 1 second */
383 #define OBD_STATFS_CACHE_SECONDS 1
385 #define lov_tgt_desc lu_tgt_desc
387 struct lov_md_tgt_desc {
388 struct obd_device *lmtd_mdc;
393 struct lov_desc desc;
394 struct lov_tgt_desc **lov_tgts; /* sparse array */
395 struct ost_pool lov_packed; /* all OSTs in a packed
397 struct mutex lov_lock;
398 struct obd_connect_data lov_ocd;
399 struct proc_dir_entry *targets_proc_entry;
400 atomic_t lov_refcount;
401 __u32 lov_death_row; /* tgts scheduled to be deleted */
402 __u32 lov_tgt_size; /* size of tgts array */
405 struct cfs_hash *lov_pools_hash_body; /* used for key access */
406 struct list_head lov_pool_list; /* used for sequential access */
407 struct proc_dir_entry *lov_pool_proc_entry;
408 enum lustre_sec_part lov_sp_me;
410 /* Cached LRU and unstable data from upper layer */
411 struct cl_client_cache *lov_cache;
413 struct rw_semaphore lov_notify_lock;
414 /* Data-on-MDT: MDC array */
415 struct lov_md_tgt_desc *lov_mdc_tgts;
417 struct kobject *lov_tgts_kobj;
420 #define lmv_tgt_desc lu_tgt_desc
423 struct lu_client_fld lmv_fld;
425 struct lmv_desc desc;
427 struct mutex lmv_init_mutex;
431 u32 lmv_statfs_start;
433 u32 tgts_size; /* size of tgts array */
434 struct lmv_tgt_desc **tgts;
436 struct obd_connect_data conn_data;
437 struct kobject *lmv_tgts_kobj;
440 struct lu_qos lmv_qos;
441 __u32 lmv_qos_rr_index;
444 /* Minimum sector size is 512 */
445 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
447 struct niobuf_local {
448 __u64 lnb_file_offset;
449 __u32 lnb_page_offset;
453 struct page *lnb_page;
455 __u16 lnb_guards[MAX_GUARD_NUMBER];
456 __u16 lnb_guard_rpc:1;
457 __u16 lnb_guard_disk:1;
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;
590 struct mutex olg_cat_processing;
593 /* corresponds to one of the obd's */
594 #define OBD_DEVICE_MAGIC 0XAB5CD6EF
597 struct obd_type *obd_type;
598 __u32 obd_magic; /* OBD_DEVICE_MAGIC */
599 int obd_minor; /* device number: lctl dl */
600 struct lu_device *obd_lu_dev;
602 /* common and UUID name of this device */
603 struct obd_uuid obd_uuid;
604 char obd_name[MAX_OBD_NAME];
606 /* bitfield modification is protected by obd_dev_lock */
608 obd_attached:1, /* finished attach */
609 obd_set_up:1, /* finished setup */
610 obd_recovering:1, /* there are recoverable clients */
611 obd_abort_recovery:1, /* recovery expired */
612 obd_version_recov:1, /* obd uses version checking */
613 obd_replayable:1, /* recovery enabled; inform clients */
614 obd_no_transno:1, /* no committed-transno notification */
615 obd_no_recov:1, /* fail instead of retry messages */
616 obd_stopping:1, /* started cleanup */
617 obd_starting:1, /* started setup */
618 obd_force:1, /* cleanup with > 0 obd refcount */
619 obd_fail:1, /* cleanup with failover */
620 obd_no_conn:1, /* deny new connections */
621 obd_inactive:1, /* device active/inactive
622 * (for /proc/status only!!) */
623 obd_no_ir:1, /* no imperative recovery. */
624 obd_process_conf:1, /* device is processing mgs config */
625 obd_checksum_dump:1; /* dump pages upon cksum error */
627 /* use separate field as it is set in interrupt to don't mess with
628 * protection of other bits using _bh lock */
629 unsigned long obd_recovery_expired:1;
630 /* uuid-export hash body */
631 struct cfs_hash *obd_uuid_hash;
632 /* nid-export hash body */
633 struct cfs_hash *obd_nid_hash;
635 struct cfs_hash *obd_nid_stats_hash;
636 /* client_generation-export hash body */
637 struct cfs_hash *obd_gen_hash;
638 struct list_head obd_nid_stats;
639 struct list_head obd_exports;
640 struct list_head obd_unlinked_exports;
641 struct list_head obd_delayed_exports;
642 struct list_head obd_lwp_list;
643 atomic_t obd_refcount;
645 spinlock_t obd_nid_lock;
646 struct ldlm_namespace *obd_namespace;
647 struct ptlrpc_client obd_ldlm_client; /* XXX OST/MDS only */
648 /* a spinlock is OK for what we do now, may need a semaphore later */
649 spinlock_t obd_dev_lock; /* protect OBD bitfield above */
650 spinlock_t obd_osfs_lock;
651 struct obd_statfs obd_osfs; /* locked by obd_osfs_lock */
652 time64_t obd_osfs_age;
653 __u64 obd_last_committed;
654 struct mutex obd_dev_mutex;
655 struct lvfs_run_ctxt obd_lvfs_ctxt;
656 struct obd_llog_group obd_olg; /* default llog group */
657 struct obd_device *obd_observer;
658 struct rw_semaphore obd_observer_link_sem;
659 struct obd_notify_upcall obd_upcall;
660 struct obd_export *obd_self_export;
661 struct obd_export *obd_lwp_export;
662 /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
663 struct list_head obd_exports_timed;
664 time64_t obd_eviction_timer; /* for ping evictor */
666 int obd_max_recoverable_clients;
667 atomic_t obd_connected_clients;
668 int obd_stale_clients;
669 /* this lock protects all recovery list_heads, timer and
670 * obd_next_recovery_transno value */
671 spinlock_t obd_recovery_task_lock;
672 __u64 obd_next_recovery_transno;
673 int obd_replayed_requests;
674 int obd_requests_queued_for_recovery;
675 wait_queue_head_t obd_next_transno_waitq;
676 /* protected by obd_recovery_task_lock */
677 struct hrtimer obd_recovery_timer;
679 time64_t obd_recovery_start;
680 /* seconds, for lprocfs_status */
681 time64_t obd_recovery_end;
682 time64_t obd_recovery_time_hard;
683 time64_t obd_recovery_timeout;
684 int obd_recovery_ir_factor;
686 /* new recovery stuff from CMD2 */
687 int obd_replayed_locks;
688 atomic_t obd_req_replay_clients;
689 atomic_t obd_lock_replay_clients;
690 struct target_recovery_data obd_recovery_data;
692 /* all lists are protected by obd_recovery_task_lock */
693 struct list_head obd_req_replay_queue;
694 struct list_head obd_lock_replay_queue;
695 struct list_head obd_final_req_queue;
698 #ifdef HAVE_SERVER_SUPPORT
699 struct obd_device_target obt;
700 struct filter_obd filter;
702 struct echo_obd echo;
704 struct client_obd cli;
705 struct echo_client_obd echo_client;
710 /* Fields used by LProcFS */
711 struct lprocfs_stats *obd_stats;
713 struct lprocfs_stats *obd_md_stats;
715 struct dentry *obd_debugfs_entry;
716 struct proc_dir_entry *obd_proc_entry;
717 struct proc_dir_entry *obd_proc_exports_entry;
718 struct dentry *obd_svc_debugfs_entry;
719 struct lprocfs_stats *obd_svc_stats;
720 const struct attribute **obd_attrs;
721 struct lprocfs_vars *obd_vars;
722 atomic_t obd_evict_inprogress;
723 wait_queue_head_t obd_evict_inprogress_waitq;
724 struct list_head obd_evict_list; /* protected with pet_lock */
727 * LDLM pool part. Save last calculated SLV and Limit.
729 rwlock_t obd_pool_lock;
733 int obd_conn_inprogress;
736 * List of outstanding class_incref()'s fo this OBD. For debugging. */
737 struct lu_ref obd_reference;
739 struct kset obd_kset; /* sysfs object collection */
740 struct kobj_type obd_ktype;
741 struct completion obd_kobj_unregister;
744 /* get/set_info keys */
745 #define KEY_ASYNC "async"
746 #define KEY_CHANGELOG_CLEAR "changelog_clear"
747 #define KEY_FID2PATH "fid2path"
748 #define KEY_CHECKSUM "checksum"
749 #define KEY_CLEAR_FS "clear_fs"
750 #define KEY_CONN_DATA "conn_data"
751 #define KEY_EVICT_BY_NID "evict_by_nid"
752 #define KEY_FIEMAP "fiemap"
753 #define KEY_FLUSH_CTX "flush_ctx"
754 #define KEY_GRANT_SHRINK "grant_shrink"
755 #define KEY_HSM_COPYTOOL_SEND "hsm_send"
756 #define KEY_INIT_RECOV_BACKUP "init_recov_bk"
757 #define KEY_INTERMDS "inter_mds"
758 #define KEY_LAST_ID "last_id"
759 #define KEY_LAST_FID "last_fid"
760 #define KEY_MAX_EASIZE "max_easize"
761 #define KEY_DEFAULT_EASIZE "default_easize"
762 #define KEY_MGSSEC "mgssec"
763 #define KEY_READ_ONLY "read-only"
764 #define KEY_REGISTER_TARGET "register_target"
765 #define KEY_SET_FS "set_fs"
766 #define KEY_TGT_COUNT "tgt_count"
767 /* KEY_SET_INFO in lustre_idl.h */
768 #define KEY_SPTLRPC_CONF "sptlrpc_conf"
770 #define KEY_CACHE_LRU_SHRINK "cache_lru_shrink"
771 #define KEY_OSP_CONNECTED "osp_connected"
773 /* Flags for op_xvalid */
775 OP_XVALID_CTIME_SET = BIT(0), /* 0x0001 */
776 OP_XVALID_BLOCKS = BIT(1), /* 0x0002 */
777 OP_XVALID_OWNEROVERRIDE = BIT(2), /* 0x0004 */
778 OP_XVALID_FLAGS = BIT(3), /* 0x0008 */
779 OP_XVALID_PROJID = BIT(4), /* 0x0010 */
780 OP_XVALID_LAZYSIZE = BIT(5), /* 0x0020 */
781 OP_XVALID_LAZYBLOCKS = BIT(6), /* 0x0040 */
786 static inline int it_to_lock_mode(struct lookup_intent *it)
788 /* CREAT needs to be tested before open (both could be set) */
789 if (it->it_op & IT_CREAT)
791 else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
793 else if (it->it_op & IT_LAYOUT)
794 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
795 else if (it->it_op & IT_READDIR)
797 else if (it->it_op & IT_GETXATTR)
800 LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
805 MF_MDC_CANCEL_FID1 = 1 << 0,
806 MF_MDC_CANCEL_FID2 = 1 << 1,
807 MF_MDC_CANCEL_FID3 = 1 << 2,
808 MF_MDC_CANCEL_FID4 = 1 << 3,
809 MF_GET_MDT_IDX = 1 << 4,
813 CLI_SET_MEA = 1 << 0,
814 CLI_RM_ENTRY = 1 << 1,
817 CLI_MIGRATE = 1 << 4,
821 LUSTRE_OPC_MKDIR = 0,
822 LUSTRE_OPC_SYMLINK = 1,
823 LUSTRE_OPC_MKNOD = 2,
824 LUSTRE_OPC_CREATE = 3,
829 * GETXATTR is not included as only a couple of fields in the reply body
830 * is filled, but not FID which is needed for common intent handling in
831 * mdc_finish_intent_lock()
833 static inline bool it_has_reply_body(const struct lookup_intent *it)
835 return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
839 struct lu_fid op_fid1; /* operation fid1 (usualy parent) */
840 struct lu_fid op_fid2; /* operation fid2 (usualy child) */
841 struct lu_fid op_fid3; /* 2 extra fids to find conflicting */
842 struct lu_fid op_fid4; /* to the operation locks. */
843 u32 op_mds; /* what mds server open will go to */
845 enum md_op_code op_code;
846 struct lustre_handle op_open_handle;
850 struct rw_semaphore *op_mea1_sem;
851 struct rw_semaphore *op_mea2_sem;
852 struct lmv_stripe_md *op_mea1;
853 struct lmv_stripe_md *op_mea2;
854 struct lmv_stripe_md *op_default_mea1; /* default LMV */
855 __u32 op_suppgids[2];
862 /* iattr fields and blocks. */
863 struct iattr op_attr;
864 enum op_xvalid op_xvalid; /* eXtra validity flags */
865 loff_t op_attr_blocks;
866 u64 op_valid; /* OBD_MD_* */
867 unsigned int op_attr_flags; /* LUSTRE_{SYNC,..}_FL */
869 enum md_op_flags op_flags;
871 /* Various operation flags. */
872 enum mds_op_bias op_bias;
874 /* used to transfer info between the stacks of MD client
875 * see enum op_cli_flags */
876 enum md_cli_flags op_cli_flags;
878 /* File object data version for HSM release, on client */
879 __u64 op_data_version;
880 struct lustre_handle op_lease_handle;
882 /* File security context, for creates/metadata ops */
883 const char *op_file_secctx_name;
884 __u32 op_file_secctx_name_size;
885 void *op_file_secctx;
886 __u32 op_file_secctx_size;
890 /* Used by readdir */
891 unsigned int op_max_pages;
896 * used to access migrating dir: if it's set, assume migration is
897 * finished, use the new layout to access dir, otherwise use old layout.
898 * By default it's not set, because new files are created under new
899 * layout, if we can't find file with name under both old and new
900 * layout, we are sure file with name doesn't exist, but in reverse
901 * order there may be a race with creation by others.
903 bool op_post_migrate;
904 /* used to access dir with bash hash */
905 __u32 op_stripe_index;
906 /* Archive ID for PCC attach */
911 int (*md_blocking_ast)(struct ldlm_lock *lock,
912 struct ldlm_lock_desc *desc,
913 void *data, int flag);
916 struct md_enqueue_info;
917 /* metadata stat-ahead */
918 typedef int (* md_enqueue_cb_t)(struct ptlrpc_request *req,
919 struct md_enqueue_info *minfo,
922 struct md_enqueue_info {
923 struct md_op_data mi_data;
924 struct lookup_intent mi_it;
925 struct lustre_handle mi_lockh;
926 struct inode *mi_dir;
927 struct ldlm_enqueue_info mi_einfo;
928 md_enqueue_cb_t mi_cb;
933 struct module *o_owner;
934 int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
935 void *karg, void __user *uarg);
936 int (*o_get_info)(const struct lu_env *env, struct obd_export *,
937 __u32 keylen, void *key, __u32 *vallen, void *val);
938 int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
939 __u32 keylen, void *key,
940 __u32 vallen, void *val,
941 struct ptlrpc_request_set *set);
942 int (*o_setup) (struct obd_device *dev, struct lustre_cfg *cfg);
943 int (*o_precleanup)(struct obd_device *dev);
944 int (*o_cleanup)(struct obd_device *dev);
945 int (*o_process_config)(struct obd_device *dev, size_t len, void *data);
946 int (*o_postrecov)(struct obd_device *dev);
947 int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
949 int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
950 /* connect to the target device with given connection
951 * data. @ocd->ocd_connect_flags is modified to reflect flags actually
952 * granted by the target, which are guaranteed to be a subset of flags
953 * asked for. If @ocd == NULL, use default parameters. */
954 int (*o_connect)(const struct lu_env *env,
955 struct obd_export **exp, struct obd_device *src,
956 struct obd_uuid *cluuid, struct obd_connect_data *ocd,
958 int (*o_reconnect)(const struct lu_env *env,
959 struct obd_export *exp, struct obd_device *src,
960 struct obd_uuid *cluuid,
961 struct obd_connect_data *ocd,
963 int (*o_disconnect)(struct obd_export *exp);
965 /* Initialize/finalize fids infrastructure. */
966 int (*o_fid_init)(struct obd_device *obd,
967 struct obd_export *exp, enum lu_cli_type type);
968 int (*o_fid_fini)(struct obd_device *obd);
970 /* Allocate new fid according to passed @hint. */
971 int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
972 struct lu_fid *fid, struct md_op_data *op_data);
975 * Object with @fid is getting deleted, we may want to do something
978 int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
979 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
980 int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
981 time64_t max_age, struct ptlrpc_request_set *set);
982 int (*o_create)(const struct lu_env *env, struct obd_export *exp,
984 int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
986 int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
988 int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
990 int (*o_preprw)(const struct lu_env *env, int cmd,
991 struct obd_export *exp, struct obdo *oa, int objcount,
992 struct obd_ioobj *obj, struct niobuf_remote *remote,
993 int *nr_pages, struct niobuf_local *local);
994 int (*o_commitrw)(const struct lu_env *env, int cmd,
995 struct obd_export *exp, struct obdo *oa,
996 int objcount, struct obd_ioobj *obj,
997 struct niobuf_remote *remote, int pages,
998 struct niobuf_local *local, int rc);
999 int (*o_init_export)(struct obd_export *exp);
1000 int (*o_destroy_export)(struct obd_export *exp);
1002 int (*o_import_event)(struct obd_device *, struct obd_import *,
1003 enum obd_import_event);
1005 int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1006 enum obd_notify_event ev);
1008 int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1009 struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1012 int (*o_quotactl)(struct obd_device *, struct obd_export *,
1013 struct obd_quotactl *);
1016 int (*o_pool_new)(struct obd_device *obd, char *poolname);
1017 int (*o_pool_del)(struct obd_device *obd, char *poolname);
1018 int (*o_pool_add)(struct obd_device *obd, char *poolname,
1020 int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1024 /* lmv structures */
1026 struct mdt_body *body;
1027 struct lu_buf layout;
1029 struct lmv_stripe_md *lmv;
1030 struct lmv_foreign_md *lfm;
1032 struct lmv_stripe_md *default_lmv;
1033 #ifdef CONFIG_FS_POSIX_ACL
1034 struct posix_acl *posix_acl;
1038 struct md_open_data {
1039 struct obd_client_handle *mod_och;
1040 struct ptlrpc_request *mod_open_req;
1041 struct ptlrpc_request *mod_close_req;
1042 atomic_t mod_refcount;
1046 struct obd_client_handle {
1047 struct lustre_handle och_open_handle;
1048 struct lu_fid och_fid;
1049 struct md_open_data *och_mod;
1050 struct lustre_handle och_lease_handle; /* open lock for lease */
1055 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1057 struct lookup_intent;
1061 int (*m_close)(struct obd_export *, struct md_op_data *,
1062 struct md_open_data *, struct ptlrpc_request **);
1064 int (*m_create)(struct obd_export *, struct md_op_data *,
1065 const void *, size_t, umode_t, uid_t, gid_t,
1066 cfs_cap_t, __u64, struct ptlrpc_request **);
1068 int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1069 const union ldlm_policy_data *, struct md_op_data *,
1070 struct lustre_handle *, __u64);
1072 int (*m_getattr)(struct obd_export *, struct md_op_data *,
1073 struct ptlrpc_request **);
1075 int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1076 struct lookup_intent *,
1077 struct ptlrpc_request **,
1078 ldlm_blocking_callback, __u64);
1080 int (*m_link)(struct obd_export *, struct md_op_data *,
1081 struct ptlrpc_request **);
1083 int (*m_rename)(struct obd_export *, struct md_op_data *,
1084 const char *, size_t, const char *, size_t,
1085 struct ptlrpc_request **);
1087 int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1088 size_t , struct ptlrpc_request **);
1090 int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1091 struct ptlrpc_request **);
1093 int (*m_read_page)(struct obd_export *, struct md_op_data *,
1094 struct md_callback *cb_op, __u64 hash_offset,
1095 struct page **ppage);
1097 int (*m_unlink)(struct obd_export *, struct md_op_data *,
1098 struct ptlrpc_request **);
1100 int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1101 u64, const char *, const void *, size_t, unsigned int,
1102 u32, struct ptlrpc_request **);
1104 int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1105 u64, const char *, size_t, struct ptlrpc_request **);
1107 int (*m_intent_getattr_async)(struct obd_export *,
1108 struct md_enqueue_info *);
1110 int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1111 struct lu_fid *, __u64 *bits);
1113 int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1115 int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1116 int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1118 int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1119 struct ptlrpc_request **);
1121 int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1123 int (*m_get_lustre_md)(struct obd_export *, struct ptlrpc_request *,
1124 struct obd_export *, struct obd_export *,
1125 struct lustre_md *);
1127 int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1129 int (*m_merge_attr)(struct obd_export *,
1130 const struct lmv_stripe_md *lsm,
1131 struct cl_attr *attr, ldlm_blocking_callback);
1133 int (*m_set_open_replay_data)(struct obd_export *,
1134 struct obd_client_handle *,
1135 struct lookup_intent *);
1137 int (*m_clear_open_replay_data)(struct obd_export *,
1138 struct obd_client_handle *);
1140 int (*m_set_lock_data)(struct obd_export *,
1141 const struct lustre_handle *, void *, __u64 *);
1143 enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1144 const struct lu_fid *, enum ldlm_type,
1145 union ldlm_policy_data *, enum ldlm_mode,
1146 struct lustre_handle *);
1148 int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1149 union ldlm_policy_data *, enum ldlm_mode,
1150 enum ldlm_cancel_flags flags, void *opaque);
1152 int (*m_get_fid_from_lsm)(struct obd_export *,
1153 const struct lmv_stripe_md *,
1154 const char *name, int namelen,
1155 struct lu_fid *fid);
1156 int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1157 const union lmv_mds_md *lmv, size_t lmv_size);
1160 static inline struct md_open_data *obd_mod_alloc(void)
1162 struct md_open_data *mod;
1166 atomic_set(&mod->mod_refcount, 1);
1170 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1171 #define obd_mod_put(mod) \
1173 if (atomic_dec_and_test(&(mod)->mod_refcount)) { \
1174 if ((mod)->mod_open_req) \
1175 ptlrpc_req_finished((mod)->mod_open_req); \
1176 OBD_FREE_PTR(mod); \
1180 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1181 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1182 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1184 /* return 1 if client should be resend request */
1185 static inline int client_should_resend(int resend, struct client_obd *cli)
1187 return atomic_read(&cli->cl_resends) ?
1188 atomic_read(&cli->cl_resends) > resend : 1;
1192 * Return device name for this device
1194 * XXX: lu_device is declared before obd_device, while a pointer pointing
1195 * back to obd_device in lu_device, so this helper function defines here
1196 * instead of in lu_object.h
1198 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1200 return lu_dev->ld_obd->obd_name;
1203 static inline bool filename_is_volatile(const char *name, size_t namelen,
1209 if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1212 /* caller does not care of idx */
1216 /* volatile file, the MDT can be set from name */
1217 /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1218 /* if no MDT is specified, use std way */
1219 if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1221 /* test for no MDT idx case */
1222 if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1223 (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1227 /* we have an idx, read it */
1228 start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1229 *idx = simple_strtoul(start, &end, 16);
1231 * no digit, no trailing :, negative value
1233 if (((*idx == 0) && (end == start)) ||
1234 (*end != ':') || (*idx < 0))
1239 /* bad format of mdt idx, we cannot return an error
1240 * to caller so we use hash algo */
1241 CERROR("Bad volatile file name format: %s\n",
1242 name + LUSTRE_VOLATILE_HDR_LEN);
1246 static inline int cli_brw_size(struct obd_device *obd)
1248 LASSERT(obd != NULL);
1249 return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1253 * When RPC size or the max RPCs in flight is increased, the max dirty pages
1254 * of the client should be increased accordingly to avoid sending fragmented
1255 * RPCs over the network when the client runs out of the maximum dirty space
1256 * when so many RPCs are being generated.
1258 static inline void client_adjust_max_dirty(struct client_obd *cli)
1261 if (cli->cl_dirty_max_pages <= 0) {
1262 cli->cl_dirty_max_pages =
1263 (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1265 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1266 cli->cl_max_pages_per_rpc;
1268 if (dirty_max > cli->cl_dirty_max_pages)
1269 cli->cl_dirty_max_pages = dirty_max;
1272 if (cli->cl_dirty_max_pages > totalram_pages / 8)
1273 cli->cl_dirty_max_pages = totalram_pages / 8;
1275 /* This value is exported to userspace through the max_dirty_mb
1276 * parameter. So we round up the number of pages to make it a round
1278 cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1279 1 << (20 - PAGE_SHIFT));
1282 #endif /* __OBD_H */