lustre/mgs/mgs_internal.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _MGS_INTERNAL_H
  38 #define _MGS_INTERNAL_H
  39
  40 #include <libcfs/libcfs.h>
  41 #include <lustre_log.h>
  42 #include <lustre_export.h>
  43 #include <dt_object.h>
  44
  45 #define MGSSELF_NAME    "_mgs"
  46
  47 #define MGS_SERVICE_WATCHDOG_FACTOR 2
  48
  49 /* -- imperative recovery control data structures -- */
  50 /**
  51  * restarting targets.
  52  */
  53 struct mgs_nidtbl;
  54 struct mgs_nidtbl_target {
  55         cfs_list_t              mnt_list;
  56         struct mgs_nidtbl      *mnt_fs;
  57         u64                     mnt_version;
  58         int                     mnt_type; /* OST or MDT */
  59         cfs_time_t              mnt_last_active;
  60         struct mgs_target_info  mnt_mti;
  61 };
  62
  63 enum {
  64         IR_FULL = 0,
  65         IR_STARTUP,
  66         IR_DISABLED,
  67         IR_PARTIAL
  68 };
  69
  70 #define IR_STRINGS { "full", "startup", "disabled", "partial" }
  71
  72 /**
  73  */
  74 struct fs_db;
  75
  76 /**
  77  * maintain fs client nodes of mgs.
  78  */
  79 struct mgs_fsc {
  80         struct fs_db      *mfc_fsdb;
  81         /**
  82          * Where the fs client comes from.
  83          */
  84         struct obd_export *mfc_export;
  85         /**
  86          * list of fs clients from the same export,
  87          * protected by mgs_export_data->med_lock
  88          */
  89         cfs_list_t         mfc_export_list;
  90         /**
  91          * list of fs clients in the same fsdb, protected by fsdb->fsdb_mutex
  92          */
  93         cfs_list_t        mfc_fsdb_list;
  94         unsigned          mfc_ir_capable:1;
  95 };
  96
  97 struct mgs_nidtbl {
  98         struct fs_db *mn_fsdb;
  99         struct file  *mn_version_file;
 100         struct mutex    mn_lock;
 101         u64           mn_version;
 102         int           mn_nr_targets;
 103         cfs_list_t    mn_targets;
 104 };
 105
 106 struct mgs_tgt_srpc_conf {
 107         struct mgs_tgt_srpc_conf  *mtsc_next;
 108         char                      *mtsc_tgt;
 109         struct sptlrpc_rule_set    mtsc_rset;
 110 };
 111
 112 #define INDEX_MAP_SIZE  8192     /* covers indicies to FFFF */
 113
 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
 121 struct fs_db {
 122         char              fsdb_name[9];
 123         cfs_list_t        fsdb_list;           /* list of databases */
 124         struct mutex      fsdb_mutex;
 125         void             *fsdb_ost_index_map;  /* bitmap of used indicies */
 126         void             *fsdb_mdt_index_map;  /* bitmap of used indicies */
 127         int               fsdb_mdt_count;
 128         char             *fsdb_clilov;       /* COMPAT_146 client lov name */
 129         char             *fsdb_clilmv;
 130         unsigned long     fsdb_flags;
 131         __u32             fsdb_gen;
 132
 133         /* in-memory copy of the srpc rules, guarded by fsdb_lock */
 134         struct sptlrpc_rule_set   fsdb_srpc_gen;
 135         struct mgs_tgt_srpc_conf *fsdb_srpc_tgt;
 136
 137         /* list of fs clients, mgs_fsc. protected by mgs_mutex */
 138         cfs_list_t           fsdb_clients;
 139         int                  fsdb_nonir_clients;
 140         int                  fsdb_ir_state;
 141
 142         /* Target NIDs Table */
 143         struct mgs_nidtbl    fsdb_nidtbl;
 144
 145         /* async thread to notify clients */
 146         struct mgs_device   *fsdb_mgs;
 147         cfs_waitq_t          fsdb_notify_waitq;
 148         struct completion       fsdb_notify_comp;
 149         cfs_time_t           fsdb_notify_start;
 150         cfs_atomic_t         fsdb_notify_phase;
 151         volatile int         fsdb_notify_async:1,
 152                              fsdb_notify_stop:1;
 153         /* statistic data */
 154         unsigned int         fsdb_notify_total;
 155         unsigned int         fsdb_notify_max;
 156         unsigned int         fsdb_notify_count;
 157 };
 158
 159 struct mgs_device {
 160         struct dt_device                 mgs_dt_dev;
 161         struct ptlrpc_service           *mgs_service;
 162         struct dt_device                *mgs_bottom;
 163         struct obd_export               *mgs_bottom_exp;
 164         struct dt_object                *mgs_configs_dir;
 165         struct dt_object                *mgs_nidtbl_dir;
 166         cfs_list_t                       mgs_fs_db_list;
 167         spinlock_t                       mgs_lock; /* covers mgs_fs_db_list */
 168         cfs_proc_dir_entry_t            *mgs_proc_live;
 169         cfs_proc_dir_entry_t            *mgs_proc_mntdev;
 170         cfs_time_t                       mgs_start_time;
 171         struct obd_device               *mgs_obd;
 172         struct local_oid_storage        *mgs_los;
 173         struct mutex                     mgs_mutex;
 174 };
 175
 176 /* this is a top object */
 177 struct mgs_object {
 178         struct lu_object_header mgo_header;
 179         struct dt_object        mgo_obj;
 180         int                     mgo_no_attrs;
 181         int                     mgo_reserved;
 182 };
 183
 184 int mgs_init_fsdb_list(struct mgs_device *mgs);
 185 int mgs_cleanup_fsdb_list(struct mgs_device *mgs);
 186 int mgs_find_or_make_fsdb(const struct lu_env *env, struct mgs_device *mgs, char *name,
 187                           struct fs_db **dbh);
 188 struct fs_db *mgs_find_fsdb(struct mgs_device *mgs, char *fsname);
 189 int mgs_get_fsdb_srpc_from_llog(const struct lu_env *env, struct mgs_device *mgs, struct fs_db *fsdb);
 190 int mgs_check_index(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti);
 191 int mgs_check_failnid(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti);
 192 int mgs_write_log_target(const struct lu_env *env, struct mgs_device *mgs, struct mgs_target_info *mti,
 193                          struct fs_db *fsdb);
 194 int mgs_erase_log(const struct lu_env *env, struct mgs_device *mgs,
 195                   char *name);
 196 int mgs_erase_logs(const struct lu_env *env, struct mgs_device *mgs,
 197                    char *fsname);
 198 int mgs_setparam(const struct lu_env *env, struct mgs_device *mgs,
 199                  struct lustre_cfg *lcfg, char *fsname);
 200 int mgs_list_logs(const struct lu_env *env, struct mgs_device *mgs,
 201                   struct obd_ioctl_data *data);
 202 int mgs_pool_cmd(const struct lu_env *env, struct mgs_device *mgs,
 203                  enum lcfg_command_type cmd, char *poolname, char *fsname,
 204                  char *ostname);
 205
 206 /* mgs_handler.c */
 207 int  mgs_get_lock(struct obd_device *obd, struct ldlm_res_id *res,
 208                   struct lustre_handle *lockh);
 209 int  mgs_put_lock(struct lustre_handle *lockh);
 210 void mgs_revoke_lock(struct mgs_device *mgs, struct fs_db *fsdb, int type);
 211
 212 /* mgs_nids.c */
 213 int  mgs_ir_update(const struct lu_env *env, struct mgs_device *mgs,
 214                    struct mgs_target_info *mti);
 215 int mgs_ir_init_fs(const struct lu_env *env, struct mgs_device *mgs,
 216                    struct fs_db *fsdb);
 217 void mgs_ir_fini_fs(struct mgs_device *mgs, struct fs_db *fsdb);
 218 void mgs_ir_notify_complete(struct fs_db *fsdb);
 219 int  mgs_get_ir_logs(struct ptlrpc_request *req);
 220 int  lprocfs_wr_ir_state(struct file *file, const char *buffer,
 221                            unsigned long count, void *data);
 222 int  lprocfs_rd_ir_state(struct seq_file *seq, void *data);
 223 int  lprocfs_wr_ir_timeout(struct file *file, const char *buffer,
 224                            unsigned long count, void *data);
 225 int  lprocfs_rd_ir_timeout(char *page, char **start, off_t off, int count,
 226                            int *eof, void *data);
 227 void mgs_fsc_cleanup(struct obd_export *exp);
 228 void mgs_fsc_cleanup_by_fsdb(struct fs_db *fsdb);
 229 int  mgs_fsc_attach(const struct lu_env *env, struct obd_export *exp,
 230                     char *fsname);
 231
 232 /* mgs_fs.c */
 233 int mgs_export_stats_init(struct obd_device *obd, struct obd_export *exp,
 234                           void *localdata);
 235 int mgs_client_free(struct obd_export *exp);
 236 int mgs_fs_setup(const struct lu_env *env, struct mgs_device *m);
 237 int mgs_fs_cleanup(const struct lu_env *env, struct mgs_device *m);
 238
 239 #define strsuf(buf, suffix) (strcmp((buf)+strlen(buf)-strlen(suffix), (suffix)))
 240 #ifdef LPROCFS
 241 int lproc_mgs_setup(struct mgs_device *mgs, char *osd_name);
 242 int lproc_mgs_cleanup(struct mgs_device *mgs);
 243 int lproc_mgs_add_live(struct mgs_device *mgs, struct fs_db *fsdb);
 244 int lproc_mgs_del_live(struct mgs_device *mgs, struct fs_db *fsdb);
 245 void lprocfs_mgs_init_vars(struct lprocfs_static_vars *lvars);
 246 #else
 247 static inline int lproc_mgs_setup(struct mgs_device *mgs)
 248 {return 0;}
 249 static inline int lproc_mgs_cleanup(struct mgs_device *mgs)
 250 {return 0;}
 251 static inline int lproc_mgs_add_live(struct mgs_device *mgs, struct fs_db *fsdb)
 252 {return 0;}
 253 static inline int lproc_mgs_del_live(struct mgs_device *mgs, struct fs_db *fsdb)
 254 {return 0;}
 255 static void lprocfs_mgs_init_vars(struct lprocfs_static_vars *lvars)
 256 {
 257         memset(lvars, 0, sizeof(*lvars));
 258 }
 259 #endif
 260
 261 /* mgs/lproc_mgs.c */
 262 enum {
 263         LPROC_MGS_CONNECT = 0,
 264         LPROC_MGS_DISCONNECT,
 265         LPROC_MGS_EXCEPTION,
 266         LPROC_MGS_TARGET_REG,
 267         LPROC_MGS_TARGET_DEL,
 268         LPROC_MGS_LAST
 269 };
 270 void mgs_counter_incr(struct obd_export *exp, int opcode);
 271 void mgs_stats_counter_init(struct lprocfs_stats *stats);
 272
 273 struct temp_comp {
 274         struct mgs_target_info  *comp_tmti;
 275         struct mgs_target_info  *comp_mti;
 276         struct fs_db            *comp_fsdb;
 277         struct obd_device       *comp_obd;
 278 };
 279
 280 struct mgs_thread_info {
 281         struct lustre_cfg_bufs  mgi_bufs;
 282         char                    mgi_fsname[MTI_NAME_MAXLEN];
 283         struct cfg_marker       mgi_marker;
 284         struct temp_comp        mgi_comp;
 285 };
 286
 287 extern struct lu_context_key mgs_thread_key;
 288
 289 static inline struct mgs_thread_info *mgs_env_info(const struct lu_env *env)
 290 {
 291         struct mgs_thread_info *info;
 292
 293         info = lu_context_key_get(&env->le_ctx, &mgs_thread_key);
 294         LASSERT(info != NULL);
 295         return info;
 296 }
 297
 298 extern const struct lu_device_operations mgs_lu_ops;
 299
 300 static inline int lu_device_is_mgs(struct lu_device *d)
 301 {
 302         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mgs_lu_ops);
 303 }
 304
 305 static inline struct mgs_device* lu2mgs_dev(struct lu_device *d)
 306 {
 307         LASSERT(lu_device_is_mgs(d));
 308         return container_of0(d, struct mgs_device, mgs_dt_dev.dd_lu_dev);
 309 }
 310
 311 static inline struct mgs_device *exp2mgs_dev(struct obd_export *exp)
 312 {
 313         return lu2mgs_dev(exp->exp_obd->obd_lu_dev);
 314 }
 315
 316 static inline struct lu_device *mgs2lu_dev(struct mgs_device *d)
 317 {
 318         return (&d->mgs_dt_dev.dd_lu_dev);
 319 }
 320
 321 static inline struct mgs_device *dt2mgs_dev(struct dt_device *d)
 322 {
 323         LASSERT(lu_device_is_mgs(&d->dd_lu_dev));
 324         return container_of0(d, struct mgs_device, mgs_dt_dev);
 325 }
 326
 327 static inline struct mgs_object *lu2mgs_obj(struct lu_object *o)
 328 {
 329         LASSERT(ergo(o != NULL, lu_device_is_mgs(o->lo_dev)));
 330         return container_of0(o, struct mgs_object, mgo_obj.do_lu);
 331 }
 332
 333 static inline struct lu_object *mgs2lu_obj(struct mgs_object *obj)
 334 {
 335         return &obj->mgo_obj.do_lu;
 336 }
 337
 338 static inline struct mgs_object *mgs_obj(const struct lu_object *o)
 339 {
 340         LASSERT(lu_device_is_mgs(o->lo_dev));
 341         return container_of0(o, struct mgs_object, mgo_obj.do_lu);
 342 }
 343
 344 static inline struct mgs_object *dt2mgs_obj(const struct dt_object *d)
 345 {
 346         return mgs_obj(&d->do_lu);
 347 }
 348
 349 static inline struct dt_object* mgs_object_child(struct mgs_object *o)
 350 {
 351         return container_of0(lu_object_next(mgs2lu_obj(o)),
 352                              struct dt_object, do_lu);
 353 }
 354
 355 static inline struct dt_object *dt_object_child(struct dt_object *o)
 356 {
 357         return container_of0(lu_object_next(&(o)->do_lu),
 358                              struct dt_object, do_lu);
 359 }
 360 struct mgs_direntry {
 361         cfs_list_t  list;
 362         char       *name;
 363         int         len;
 364 };
 365
 366 static inline void mgs_direntry_free(struct mgs_direntry *de)
 367 {
 368         if (de) {
 369                 LASSERT(de->len);
 370                 OBD_FREE(de->name, de->len);
 371                 OBD_FREE_PTR(de);
 372         }
 373 }
 374
 375 static inline struct mgs_direntry *mgs_direntry_alloc(int len)
 376 {
 377         struct mgs_direntry *de;
 378
 379         OBD_ALLOC_PTR(de);
 380         if (de == NULL)
 381                 return NULL;
 382
 383         OBD_ALLOC(de->name, len);
 384         if (de->name == NULL) {
 385                 OBD_FREE_PTR(de);
 386                 return NULL;
 387         }
 388
 389         de->len = len;
 390
 391         return de;
 392 }
 393
 394 /* mgs_llog.c */
 395 int class_dentry_readdir(const struct lu_env *env, struct mgs_device *mgs,
 396                          cfs_list_t *list);
 397
 398 #endif /* _MGS_INTERNAL_H */