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 /* per-client-per-object persistent state (LRU) */
  53 struct ofd_mod_data {
  54         cfs_list_t      fmd_list;        /* linked to fed_mod_list */
  55         struct lu_fid   fmd_fid;         /* FID being written to */
  56         __u64           fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
  57         cfs_time_t      fmd_expire;      /* time when the fmd should expire */
  58         int             fmd_refcount;    /* reference counter - list holds 1 */
  59 };
  60
  61 #define OFD_FMD_MAX_NUM_DEFAULT 128
  62 #define OFD_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * CFS_HZ)
  63
  64 enum {
  65         LPROC_OFD_READ_BYTES = 0,
  66         LPROC_OFD_WRITE_BYTES = 1,
  67         LPROC_OFD_LAST,
  68 };
  69
  70 struct ofd_device {
  71         struct dt_device         ofd_dt_dev;
  72         struct dt_device        *ofd_osd;
  73         struct dt_device_param   ofd_dt_conf;
  74         /* DLM name-space for meta-data locks maintained by this server */
  75         struct ldlm_namespace   *ofd_namespace;
  76
  77         /* last_rcvd file */
  78         struct lu_target         ofd_lut;
  79         struct dt_object        *ofd_last_group_file;
  80         struct dt_object        *ofd_health_check_file;
  81
  82         int                      ofd_subdir_count;
  83
  84         int                      ofd_max_group;
  85         obd_id                   ofd_last_objids[OFD_MAX_GROUPS];
  86         cfs_mutex_t              ofd_create_locks[OFD_MAX_GROUPS];
  87         struct dt_object        *ofd_lastid_obj[OFD_MAX_GROUPS];
  88         cfs_spinlock_t           ofd_objid_lock;
  89
  90         /* ofd mod data: ofd_device wide values */
  91         int                      ofd_fmd_max_num; /* per ofd ofd_mod_data */
  92         cfs_duration_t           ofd_fmd_max_age; /* time to fmd expiry */
  93
  94         cfs_spinlock_t           ofd_flags_lock;
  95         unsigned long            ofd_raid_degraded:1,
  96                                  /* sync journal on writes */
  97                                  ofd_syncjournal:1,
  98                                  /* sync on lock cancel */
  99                                  ofd_sync_lock_cancel:2;
 100
 101         struct lu_site           ofd_site;
 102 };
 103
 104 static inline struct ofd_device *ofd_dev(struct lu_device *d)
 105 {
 106         return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
 107 }
 108
 109 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
 110 {
 111         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
 112 }
 113
 114 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
 115 {
 116         return ofd_dev(exp->exp_obd->obd_lu_dev);
 117 }
 118
 119 static inline char *ofd_name(struct ofd_device *ofd)
 120 {
 121         return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
 122 }
 123
 124 struct ofd_object {
 125         struct lu_object_header ofo_header;
 126         struct dt_object        ofo_obj;
 127 };
 128
 129 static inline struct ofd_object *ofd_obj(struct lu_object *o)
 130 {
 131         return container_of0(o, struct ofd_object, ofo_obj.do_lu);
 132 }
 133
 134 /*
 135  * Common data shared by obdofd-level handlers. This is allocated per-thread
 136  * to reduce stack consumption.
 137  */
 138 struct ofd_thread_info {
 139         const struct lu_env             *fti_env;
 140
 141         struct obd_export               *fti_exp;
 142         struct lu_fid                    fti_fid;
 143         struct lu_attr                   fti_attr;
 144         union {
 145                 char                     name[64]; /* for ofd_init0() */
 146                 struct obd_statfs        osfs;    /* for obdofd_statfs() */
 147         } fti_u;
 148
 149         struct dt_object_format          fti_dof;
 150         struct lu_buf                    fti_buf;
 151         loff_t                           fti_off;
 152 };
 153
 154 extern void target_recovery_fini(struct obd_device *obd);
 155 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
 156
 157 /* ofd_capa.c */
 158 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
 159 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
 160                   struct lustre_capa *capa, __u64 opc);
 161 void ofd_free_capa_keys(struct ofd_device *ofd);
 162
 163 /* ofd_dev.c */
 164 extern struct lu_context_key ofd_thread_key;
 165
 166 /* ofd_obd.c */
 167 extern struct obd_ops ofd_obd_ops;
 168
 169 /* ofd_fs.c */
 170 obd_id ofd_last_id(struct ofd_device *ofd, obd_seq seq);
 171 int ofd_group_load(const struct lu_env *env, struct ofd_device *ofd, int);
 172 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
 173                  struct obd_device *obd);
 174 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
 175
 176 /* lproc_ofd.c */
 177 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
 178 int lproc_ofd_attach_seqstat(struct obd_device *dev);
 179 extern struct file_operations ofd_per_nid_stats_fops;
 180
 181 /* ofd_fmd.c */
 182 int ofd_fmd_init(void);
 183 void ofd_fmd_exit(void);
 184 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
 185                                   struct lu_fid *fid);
 186 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
 187                                  struct lu_fid *fid);
 188 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
 189 void ofd_fmd_expire(struct obd_export *exp);
 190 void ofd_fmd_cleanup(struct obd_export *exp);
 191 #ifdef DO_FMD_DROP
 192 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
 193 #else
 194 #define ofd_fmd_drop(exp, fid) do {} while (0)
 195 #endif
 196
 197 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
 198 {
 199         struct ofd_thread_info *info;
 200
 201         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 202         LASSERT(info);
 203         LASSERT(info->fti_env);
 204         LASSERT(info->fti_env == env);
 205         return info;
 206 }
 207
 208 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
 209                                                      struct obd_export *exp)
 210 {
 211         struct ofd_thread_info *info;
 212
 213         info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
 214         LASSERT(info);
 215         LASSERT(info->fti_exp == NULL);
 216         LASSERT(info->fti_env == NULL);
 217
 218         info->fti_env = env;
 219         info->fti_exp = exp;
 220         return info;
 221 }
 222
 223 /* sync on lock cancel is useless when we force a journal flush,
 224  * and if we enable async journal commit, we should also turn on
 225  * sync on lock cancel if it is not enabled already. */
 226 static inline void ofd_slc_set(struct ofd_device *ofd)
 227 {
 228         if (ofd->ofd_syncjournal == 1)
 229                 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
 230         else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
 231                 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
 232 }
 233
 234 #endif /* _OFD_INTERNAL_H */