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