1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/cmm/cmm_internal.h
38 * Lustre Cluster Metadata Manager (cmm)
40 * Author: Mike Pershin <tappro@clusterfs.com>
44 * Cluster Metadata Manager.
45 * Implementation of md interface to provide operation between MDS-es.
47 * CMM has two set of md methods, one is for local operation which uses MDD,
48 * second is for remote operations to call different MDS.
49 * When object is allocated then proper set of methods are set for it. *
52 #ifndef _CMM_INTERNAL_H
53 #define _CMM_INTERNAL_H
55 #if defined(__KERNEL__)
58 #include <lustre_fld.h>
59 #include <md_object.h>
60 #include <lustre_acl.h>
63 * md_device extention for CMM layer.
66 /** md_device instance */
67 struct md_device cmm_md_dev;
68 /** device flags, taken from enum cmm_flags */
70 /** underlaying device in MDS stack, usually MDD */
71 struct md_device *cmm_child;
72 /** FLD client to talk to FLD */
73 struct lu_client_fld *cmm_fld;
74 /** Number of this MDS server in cluster */
75 mdsno_t cmm_local_num;
76 /** Total number of other MDS */
78 /** linked list of all remove MDS clients */
79 cfs_list_t cmm_targets;
80 /** lock for cmm_device::cmm_targets operations */
81 cfs_spinlock_t cmm_tgt_guard;
82 /** /proc entry with CMM data */
83 cfs_proc_dir_entry_t *cmm_proc_entry;
85 struct lprocfs_stats *cmm_stats;
92 /** Device initialization complete. */
93 CMM_INITIALIZED = 1 << 0
97 * Wrapper for md_device::md_ops of underlaying device cmm_child.
99 static inline const struct md_device_operations *
100 cmm_child_ops(struct cmm_device *d)
102 return d->cmm_child->md_ops;
105 /** Wrapper to get cmm_device by contained md_device */
106 static inline struct cmm_device *md2cmm_dev(struct md_device *m)
108 return container_of0(m, struct cmm_device, cmm_md_dev);
111 /** Wrapper to get cmm_device by contained lu_device */
112 static inline struct cmm_device *lu2cmm_dev(struct lu_device *d)
114 return container_of0(d, struct cmm_device, cmm_md_dev.md_lu_dev);
117 /** Wrapper to get lu_device from cmm_device */
118 static inline struct lu_device *cmm2lu_dev(struct cmm_device *d)
120 return (&d->cmm_md_dev.md_lu_dev);
123 #ifdef HAVE_SPLIT_SUPPORT
126 * States of split operation.
128 enum cmm_split_state {
137 /** CMM container for md_object. */
139 struct md_object cmo_obj;
144 * CMM local operations.
151 /** cmm_object instance. */
152 struct cmm_object cmm_obj;
153 #ifdef HAVE_SPLIT_SUPPORT
154 /** split state of object (for dirs only) */
155 enum cmm_split_state clo_split;
162 * CMM remote operations.
169 /** cmm_object instance */
170 struct cmm_object cmm_obj;
171 /** mds number where object is placed */
177 CMM_SPLIT_PAGE_COUNT = 1
182 * This is storage for all variables used in CMM functions and it is needed as
185 struct cmm_thread_info {
186 struct md_attr cmi_ma;
187 struct lu_buf cmi_buf;
188 struct lu_fid cmi_fid; /* used for le/cpu conversions */
189 struct lu_rdpg cmi_rdpg;
190 /** pointers to pages for readpage. */
191 struct page *cmi_pages[CMM_SPLIT_PAGE_COUNT];
192 struct md_op_spec cmi_spec;
193 struct lmv_stripe_md cmi_lmv;
194 char cmi_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
195 /** Ops object filename */
196 struct lu_name cti_name;
200 * Wrapper to get cmm_device from cmm_object.
202 static inline struct cmm_device *cmm_obj2dev(struct cmm_object *c)
204 return (md2cmm_dev(md_obj2dev(&c->cmo_obj)));
208 * Get cmm_device from related lu_device.
210 static inline struct cmm_object *lu2cmm_obj(struct lu_object *o)
212 //LASSERT(lu_device_is_cmm(o->lo_dev));
213 return container_of0(o, struct cmm_object, cmo_obj.mo_lu);
217 * Get cmm object from corresponding md_object.
219 static inline struct cmm_object *md2cmm_obj(struct md_object *o)
221 return container_of0(o, struct cmm_object, cmo_obj);
225 * Get next lower-layer md_object from current cmm_object.
227 static inline struct md_object *cmm2child_obj(struct cmm_object *o)
229 return (o ? lu2md(lu_object_next(&o->cmo_obj.mo_lu)) : NULL);
233 * Extract lu_fid from corresponding cmm_object.
235 static inline struct lu_fid* cmm2fid(struct cmm_object *obj)
237 return &(obj->cmo_obj.mo_lu.lo_header->loh_fid);
240 struct cmm_thread_info *cmm_env_info(const struct lu_env *env);
241 struct lu_object *cmm_object_alloc(const struct lu_env *env,
242 const struct lu_object_header *hdr,
248 /** Get cml_object from lu_object. */
249 static inline struct cml_object *lu2cml_obj(struct lu_object *o)
251 return container_of0(o, struct cml_object, cmm_obj.cmo_obj.mo_lu);
253 /** Get cml_object from md_object. */
254 static inline struct cml_object *md2cml_obj(struct md_object *mo)
256 return container_of0(mo, struct cml_object, cmm_obj.cmo_obj);
258 /** Get cml_object from cmm_object */
259 static inline struct cml_object *cmm2cml_obj(struct cmm_object *co)
261 return container_of0(co, struct cml_object, cmm_obj);
265 int cmm_upcall(const struct lu_env *env, struct md_device *md,
266 enum md_upcall_event ev, void *data);
268 #ifdef HAVE_SPLIT_SUPPORT
270 * \defgroup split split
274 #define CMM_MD_SIZE(stripes) (sizeof(struct lmv_stripe_md) + \
275 (stripes) * sizeof(struct lu_fid))
277 /** Get and initialize lu_bug from cmm_thread_info. */
278 static inline struct lu_buf *cmm_buf_get(const struct lu_env *env,
279 void *area, ssize_t len)
283 buf = &cmm_env_info(env)->cmi_buf;
289 int cmm_split_check(const struct lu_env *env, struct md_object *mp,
291 int cmm_split_expect(const struct lu_env *env, struct md_object *mo,
292 struct md_attr *ma, int *split);
293 int cmm_split_dir(const struct lu_env *env, struct md_object *mo);
294 int cmm_split_access(const struct lu_env *env, struct md_object *mo,
299 int cmm_fld_lookup(struct cmm_device *cm, const struct lu_fid *fid,
300 mdsno_t *mds, const struct lu_env *env);
302 int cmm_procfs_init(struct cmm_device *cmm, const char *name);
303 int cmm_procfs_fini(struct cmm_device *cmm);
305 void cmm_lprocfs_time_start(const struct lu_env *env);
306 void cmm_lprocfs_time_end(const struct lu_env *env, struct cmm_device *cmm,
312 LPROC_CMM_SPLIT_CHECK,
319 #endif /* __KERNEL__ */
320 #endif /* _CMM_INTERNAL_H */