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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _MGS_INTERNAL_H
38 #define _MGS_INTERNAL_H
40 #include <libcfs/libcfs.h>
41 #include <lustre_log.h>
42 #include <lustre_export.h>
43 #include <dt_object.h>
45 #define MGSSELF_NAME "_mgs"
47 #define MGS_SERVICE_WATCHDOG_FACTOR 2
49 /* -- imperative recovery control data structures -- */
54 struct mgs_nidtbl_target {
56 struct mgs_nidtbl *mnt_fs;
58 int mnt_type; /* OST or MDT */
59 cfs_time_t mnt_last_active;
60 struct mgs_target_info mnt_mti;
70 #define IR_STRINGS { "full", "startup", "disabled", "partial" }
77 * maintain fs client nodes of mgs.
80 struct fs_db *mfc_fsdb;
82 * Where the fs client comes from.
84 struct obd_export *mfc_export;
86 * list of fs clients from the same export,
87 * protected by mgs_export_data->med_lock
89 cfs_list_t mfc_export_list;
91 * list of fs clients in the same fsdb, protected by fsdb->fsdb_mutex
93 cfs_list_t mfc_fsdb_list;
94 unsigned mfc_ir_capable:1;
98 struct fs_db *mn_fsdb;
99 struct file *mn_version_file;
100 struct mutex mn_lock;
103 cfs_list_t mn_targets;
106 struct mgs_tgt_srpc_conf {
107 struct mgs_tgt_srpc_conf *mtsc_next;
109 struct sptlrpc_rule_set mtsc_rset;
112 #define INDEX_MAP_SIZE 8192 /* covers indicies to FFFF */
114 #define FSDB_LOG_EMPTY (0) /* missing client log */
115 #define FSDB_OLDLOG14 (1) /* log starts in old (1.4) style */
116 #define FSDB_REVOKING_LOCK (2) /* DLM lock is being revoked */
117 #define FSDB_MGS_SELF (3) /* for '_mgs', used by sptlrpc */
118 #define FSDB_OSCNAME18 (4) /* old 1.8 style OSC naming */
119 #define FSDB_UDESC (5) /* sptlrpc user desc, will be obsolete */
120 #define FSDB_REVOKING_PARAMS (6) /* DLM lock is being revoked */
124 cfs_list_t fsdb_list; /* list of databases */
125 struct mutex fsdb_mutex;
126 void *fsdb_ost_index_map; /* bitmap of used indicies */
127 void *fsdb_mdt_index_map; /* bitmap of used indicies */
129 char *fsdb_clilov; /* COMPAT_146 client lov name */
131 unsigned long fsdb_flags;
134 /* in-memory copy of the srpc rules, guarded by fsdb_lock */
135 struct sptlrpc_rule_set fsdb_srpc_gen;
136 struct mgs_tgt_srpc_conf *fsdb_srpc_tgt;
138 /* list of fs clients, mgs_fsc. protected by mgs_mutex */
139 cfs_list_t fsdb_clients;
140 int fsdb_nonir_clients;
143 /* Target NIDs Table */
144 struct mgs_nidtbl fsdb_nidtbl;
146 /* async thread to notify clients */
147 struct mgs_device *fsdb_mgs;
148 cfs_waitq_t fsdb_notify_waitq;
149 struct completion fsdb_notify_comp;
150 cfs_time_t fsdb_notify_start;
151 cfs_atomic_t fsdb_notify_phase;
152 volatile unsigned int fsdb_notify_async:1,
155 unsigned int fsdb_notify_total;
156 unsigned int fsdb_notify_max;
157 unsigned int fsdb_notify_count;
161 struct dt_device mgs_dt_dev;
162 struct ptlrpc_service *mgs_service;
163 struct dt_device *mgs_bottom;
164 struct obd_export *mgs_bottom_exp;
165 struct dt_object *mgs_configs_dir;
166 struct dt_object *mgs_nidtbl_dir;
167 cfs_list_t mgs_fs_db_list;
168 spinlock_t mgs_lock; /* covers mgs_fs_db_list */
169 cfs_proc_dir_entry_t *mgs_proc_live;
170 cfs_proc_dir_entry_t *mgs_proc_osd;
171 cfs_proc_dir_entry_t *mgs_proc_fstype;
172 cfs_proc_dir_entry_t *mgs_proc_mntdev;
173 cfs_time_t mgs_start_time;
174 struct obd_device *mgs_obd;
175 struct local_oid_storage *mgs_los;
176 struct mutex mgs_mutex;
177 struct lu_target mgs_lut;
180 /* this is a top object */
182 struct lu_object_header mgo_header;
183 struct dt_object mgo_obj;
188 int mgs_init_fsdb_list(struct mgs_device *mgs);
189 int mgs_cleanup_fsdb_list(struct mgs_device *mgs);
190 int mgs_find_or_make_fsdb(const struct lu_env *env, struct mgs_device *mgs, char *name,
192 struct fs_db *mgs_find_fsdb(struct mgs_device *mgs, char *fsname);
193 int mgs_get_fsdb_srpc_from_llog(const struct lu_env *env, struct mgs_device *mgs, struct fs_db *fsdb);
194 int mgs_check_index(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti);
195 int mgs_check_failnid(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti);
196 int mgs_write_log_target(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti,
198 int mgs_replace_nids(const struct lu_env *env, struct mgs_device *mgs, char *devname, char *nids);
199 int mgs_erase_log(const struct lu_env *env, struct mgs_device *mgs,
201 int mgs_erase_logs(const struct lu_env *env, struct mgs_device *mgs,
203 int mgs_setparam(const struct lu_env *env, struct mgs_device *mgs,
204 struct lustre_cfg *lcfg, char *fsname);
205 int mgs_list_logs(const struct lu_env *env, struct mgs_device *mgs,
206 struct obd_ioctl_data *data);
207 int mgs_pool_cmd(const struct lu_env *env, struct mgs_device *mgs,
208 enum lcfg_command_type cmd, char *poolname, char *fsname,
212 int mgs_get_lock(struct obd_device *obd, struct ldlm_res_id *res,
213 struct lustre_handle *lockh);
214 int mgs_put_lock(struct lustre_handle *lockh);
215 void mgs_revoke_lock(struct mgs_device *mgs, struct fs_db *fsdb, int type);
218 int mgs_ir_update(const struct lu_env *env, struct mgs_device *mgs,
219 struct mgs_target_info *mti);
220 int mgs_ir_init_fs(const struct lu_env *env, struct mgs_device *mgs,
222 void mgs_ir_fini_fs(struct mgs_device *mgs, struct fs_db *fsdb);
223 void mgs_ir_notify_complete(struct fs_db *fsdb);
224 int mgs_get_ir_logs(struct ptlrpc_request *req);
225 int lprocfs_wr_ir_state(struct file *file, const char *buffer,
226 unsigned long count, void *data);
227 int lprocfs_rd_ir_state(struct seq_file *seq, void *data);
228 int lprocfs_wr_ir_timeout(struct file *file, const char *buffer,
229 unsigned long count, void *data);
230 int lprocfs_rd_ir_timeout(char *page, char **start, off_t off, int count,
231 int *eof, void *data);
232 void mgs_fsc_cleanup(struct obd_export *exp);
233 void mgs_fsc_cleanup_by_fsdb(struct fs_db *fsdb);
234 int mgs_fsc_attach(const struct lu_env *env, struct obd_export *exp,
238 int mgs_export_stats_init(struct obd_device *obd, struct obd_export *exp,
240 int mgs_client_free(struct obd_export *exp);
241 int mgs_fs_setup(const struct lu_env *env, struct mgs_device *m);
242 int mgs_fs_cleanup(const struct lu_env *env, struct mgs_device *m);
245 int lproc_mgs_setup(struct mgs_device *mgs, const char *osd_name);
246 void lproc_mgs_cleanup(struct mgs_device *mgs);
247 int lproc_mgs_add_live(struct mgs_device *mgs, struct fs_db *fsdb);
248 int lproc_mgs_del_live(struct mgs_device *mgs, struct fs_db *fsdb);
249 void lprocfs_mgs_init_vars(struct lprocfs_static_vars *lvars);
251 static inline int lproc_mgs_setup(struct mgs_device *mgs, const char *osd_name)
253 static inline void lproc_mgs_cleanup(struct mgs_device *mgs)
255 static inline int lproc_mgs_add_live(struct mgs_device *mgs, struct fs_db *fsdb)
257 static inline int lproc_mgs_del_live(struct mgs_device *mgs, struct fs_db *fsdb)
259 static void lprocfs_mgs_init_vars(struct lprocfs_static_vars *lvars)
261 memset(lvars, 0, sizeof(*lvars));
265 /* mgs/lproc_mgs.c */
267 LPROC_MGS_CONNECT = 0,
268 LPROC_MGS_DISCONNECT,
270 LPROC_MGS_TARGET_REG,
271 LPROC_MGS_TARGET_DEL,
274 void mgs_counter_incr(struct obd_export *exp, int opcode);
275 void mgs_stats_counter_init(struct lprocfs_stats *stats);
278 struct mgs_target_info *comp_tmti;
279 struct mgs_target_info *comp_mti;
280 struct fs_db *comp_fsdb;
281 struct obd_device *comp_obd;
284 struct mgs_thread_info {
285 struct lustre_cfg_bufs mgi_bufs;
286 char mgi_fsname[MTI_NAME_MAXLEN];
287 struct cfg_marker mgi_marker;
288 struct temp_comp mgi_comp;
291 extern struct lu_context_key mgs_thread_key;
293 static inline struct mgs_thread_info *mgs_env_info(const struct lu_env *env)
295 struct mgs_thread_info *info;
298 info = lu_context_key_get(&env->le_ctx, &mgs_thread_key);
300 rc = lu_env_refill((struct lu_env *)env);
303 info = lu_context_key_get(&env->le_ctx, &mgs_thread_key);
305 LASSERT(info != NULL);
309 extern const struct lu_device_operations mgs_lu_ops;
311 static inline int lu_device_is_mgs(struct lu_device *d)
313 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mgs_lu_ops);
316 static inline struct mgs_device* lu2mgs_dev(struct lu_device *d)
318 LASSERT(lu_device_is_mgs(d));
319 return container_of0(d, struct mgs_device, mgs_dt_dev.dd_lu_dev);
322 static inline struct mgs_device *exp2mgs_dev(struct obd_export *exp)
324 return lu2mgs_dev(exp->exp_obd->obd_lu_dev);
327 static inline struct lu_device *mgs2lu_dev(struct mgs_device *d)
329 return (&d->mgs_dt_dev.dd_lu_dev);
332 static inline struct mgs_device *dt2mgs_dev(struct dt_device *d)
334 LASSERT(lu_device_is_mgs(&d->dd_lu_dev));
335 return container_of0(d, struct mgs_device, mgs_dt_dev);
338 static inline struct mgs_object *lu2mgs_obj(struct lu_object *o)
340 LASSERT(ergo(o != NULL, lu_device_is_mgs(o->lo_dev)));
341 return container_of0(o, struct mgs_object, mgo_obj.do_lu);
344 static inline struct lu_object *mgs2lu_obj(struct mgs_object *obj)
346 return &obj->mgo_obj.do_lu;
349 static inline struct mgs_object *mgs_obj(const struct lu_object *o)
351 LASSERT(lu_device_is_mgs(o->lo_dev));
352 return container_of0(o, struct mgs_object, mgo_obj.do_lu);
355 static inline struct mgs_object *dt2mgs_obj(const struct dt_object *d)
357 return mgs_obj(&d->do_lu);
360 static inline struct dt_object* mgs_object_child(struct mgs_object *o)
362 return container_of0(lu_object_next(mgs2lu_obj(o)),
363 struct dt_object, do_lu);
366 static inline struct dt_object *dt_object_child(struct dt_object *o)
368 return container_of0(lu_object_next(&(o)->do_lu),
369 struct dt_object, do_lu);
371 struct mgs_direntry {
377 static inline void mgs_direntry_free(struct mgs_direntry *de)
381 OBD_FREE(de->name, de->len);
386 static inline struct mgs_direntry *mgs_direntry_alloc(int len)
388 struct mgs_direntry *de;
394 OBD_ALLOC(de->name, len);
395 if (de->name == NULL) {
406 int class_dentry_readdir(const struct lu_env *env, struct mgs_device *mgs,
409 #endif /* _MGS_INTERNAL_H */