lustre/ofd/ofd_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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, 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 _OFD_INTERNAL_H
  38 #define _OFD_INTERNAL_H
  39
  40 #include <obd.h>
  41 #include <obd_class.h>
  42 #include <dt_object.h>
  43 #include <lustre_fid.h>
  44 #include <lustre_capa.h>
  45
  46 #define OFD_INIT_OBJID  0
  47 #define OFD_ROCOMPAT_SUPP (0)
  48 #define OFD_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
  49                            OBD_INCOMPAT_COMMON_LR)
  50 #define OFD_MAX_GROUPS  256
  51
  52 enum {
  53         LPROC_OFD_READ_BYTES = 0,
  54         LPROC_OFD_WRITE_BYTES = 1,
  55         LPROC_OFD_LAST,
  56 };
  57
  58 struct ofd_device {
  59         struct dt_device         ofd_dt_dev;
  60         struct dt_device        *ofd_osd;
  61         struct dt_device_param   ofd_dt_conf;
  62         /* DLM name-space for meta-data locks maintained by this server */
  63         struct ldlm_namespace   *ofd_namespace;
  64
  65         /* last_rcvd file */
  66         struct lu_target         ofd_lut;
  67         struct dt_object        *ofd_last_group_file;
  68         struct dt_object        *ofd_health_check_file;
  69
  70         int                      ofd_subdir_count;
  71
  72         int                      ofd_max_group;
  73         obd_id                   ofd_last_objids[OFD_MAX_GROUPS];
  74         cfs_mutex_t              ofd_create_locks[OFD_MAX_GROUPS];
  75         struct dt_object        *ofd_lastid_obj[OFD_MAX_GROUPS];
  76         cfs_spinlock_t           ofd_objid_lock;
  77
  78         cfs_spinlock_t           ofd_flags_lock;
  79         unsigned long            ofd_raid_degraded:1,
  80                                  /* sync journal on writes */
  81                                  ofd_syncjournal:1,
  82                                  /* sync on lock cancel */
  83                                  ofd_sync_lock_cancel:2;
  84
  85         struct lu_site           ofd_site;
  86 };
  87
  88 static inline struct ofd_device *ofd_dev(struct lu_device *d)
  89 {
  90         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
  91 }
  92
  93 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
  94 {
  95         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
  96 }
  97
  98 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
  99 {
 100         return ofd_dev(exp->exp_obd->obd_lu_dev);
 101 }
 102
 103 static inline char *ofd_name(struct ofd_device *ofd)
 104 {
 105         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
 106 }
 107
 108 struct ofd_object {
 109         struct lu_object_header ofo_header;
 110         struct dt_object        ofo_obj;
 111 };
 112
 113 static inline struct ofd_object *ofd_obj(struct lu_object *o)
 114 {
 115         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
 116 }
 117
 118 /*
 119  * Common data shared by obdofd-level handlers. This is allocated per-thread
 120  * to reduce stack consumption.
 121  */
 122 struct ofd_thread_info {
 123         const struct lu_env             *fti_env;
 124
 125         struct obd_export               *fti_exp;
 126         struct lu_fid                    fti_fid;
 127         struct lu_attr                   fti_attr;
 128         union {
 129                 char                     name[64]; /* for ofd_init0() */
 130                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
 131         } fti_u;
 132
 133         struct dt_object_format          fti_dof;
 134         struct lu_buf                    fti_buf;
 135         loff_t                           fti_off;
 136 };
 137
 138 extern void target_recovery_fini(struct obd_device *obd);
 139 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
 140
 141 /* ofd_capa.c */
 142 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
 143 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 144                   struct lustre_capa *capa, __u64 opc);
 145 void ofd_free_capa_keys(struct ofd_device *ofd);
 146
 147 /* ofd_dev.c */
 148 extern struct lu_context_key ofd_thread_key;
 149
 150 /* ofd_obd.c */
 151 extern struct obd_ops ofd_obd_ops;
 152
 153 /* ofd_fs.c */
 154 obd_id ofd_last_id(struct ofd_device *ofd, obd_seq seq);
 155 int ofd_group_load(const struct lu_env *env, struct ofd_device *ofd, int);
 156 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
 157                  struct obd_device *obd);
 158 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
 159
 160 /* lproc_ofd.c */
 161 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
 162 int lproc_ofd_attach_seqstat(struct obd_device *dev);
 163 extern struct file_operations ofd_per_nid_stats_fops;
 164
 165 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
 166 {
 167         struct ofd_thread_info *info;
 168
 169         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 170         LASSERT(info);
 171         LASSERT(info->fti_env);
 172         LASSERT(info->fti_env == env);
 173         return info;
 174 }
 175
 176 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
 177                                                      struct obd_export *exp)
 178 {
 179         struct ofd_thread_info *info;
 180
 181         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 182         LASSERT(info);
 183         LASSERT(info->fti_exp == NULL);
 184         LASSERT(info->fti_env == NULL);
 185
 186         info->fti_env = env;
 187         info->fti_exp = exp;
 188         return info;
 189 }
 190
 191 /* sync on lock cancel is useless when we force a journal flush,
 192  * and if we enable async journal commit, we should also turn on
 193  * sync on lock cancel if it is not enabled already. */
 194 static inline void ofd_slc_set(struct ofd_device *ofd)
 195 {
 196         if (ofd->ofd_syncjournal == 1)
 197                 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 198         else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 199                 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 200 }
 201
 202 #endif /* _OFD_INTERNAL_H */