fs/gfs2/glock.h

   1 /*
   2  * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
   3  * Copyright (C) 2004-2006 Red Hat, Inc.  All rights reserved.
   4  *
   5  * This copyrighted material is made available to anyone wishing to use,
   6  * modify, copy, or redistribute it subject to the terms and conditions
   7  * of the GNU General Public License version 2.
   8  */
   9
  10 #ifndef __GLOCK_DOT_H__
  11 #define __GLOCK_DOT_H__
  12
  13 #include <linux/sched.h>
  14 #include <linux/parser.h>
  15 #include "incore.h"
  16
  17 /* Options for hostdata parser */
  18
  19 enum {
  20         Opt_jid,
  21         Opt_id,
  22         Opt_first,
  23         Opt_nodir,
  24         Opt_err,
  25 };
  26
  27 /*
  28  * lm_lockname types
  29  */
  30
  31 #define LM_TYPE_RESERVED        0x00
  32 #define LM_TYPE_NONDISK         0x01
  33 #define LM_TYPE_INODE           0x02
  34 #define LM_TYPE_RGRP            0x03
  35 #define LM_TYPE_META            0x04
  36 #define LM_TYPE_IOPEN           0x05
  37 #define LM_TYPE_FLOCK           0x06
  38 #define LM_TYPE_PLOCK           0x07
  39 #define LM_TYPE_QUOTA           0x08
  40 #define LM_TYPE_JOURNAL         0x09
  41
  42 /*
  43  * lm_lock() states
  44  *
  45  * SHARED is compatible with SHARED, not with DEFERRED or EX.
  46  * DEFERRED is compatible with DEFERRED, not with SHARED or EX.
  47  */
  48
  49 #define LM_ST_UNLOCKED          0
  50 #define LM_ST_EXCLUSIVE         1
  51 #define LM_ST_DEFERRED          2
  52 #define LM_ST_SHARED            3
  53
  54 /*
  55  * lm_lock() flags
  56  *
  57  * LM_FLAG_TRY
  58  * Don't wait to acquire the lock if it can't be granted immediately.
  59  *
  60  * LM_FLAG_TRY_1CB
  61  * Send one blocking callback if TRY is set and the lock is not granted.
  62  *
  63  * LM_FLAG_NOEXP
  64  * GFS sets this flag on lock requests it makes while doing journal recovery.
  65  * These special requests should not be blocked due to the recovery like
  66  * ordinary locks would be.
  67  *
  68  * LM_FLAG_ANY
  69  * A SHARED request may also be granted in DEFERRED, or a DEFERRED request may
  70  * also be granted in SHARED.  The preferred state is whichever is compatible
  71  * with other granted locks, or the specified state if no other locks exist.
  72  *
  73  * LM_FLAG_PRIORITY
  74  * Override fairness considerations.  Suppose a lock is held in a shared state
  75  * and there is a pending request for the deferred state.  A shared lock
  76  * request with the priority flag would be allowed to bypass the deferred
  77  * request and directly join the other shared lock.  A shared lock request
  78  * without the priority flag might be forced to wait until the deferred
  79  * requested had acquired and released the lock.
  80  */
  81
  82 #define LM_FLAG_TRY             0x00000001
  83 #define LM_FLAG_TRY_1CB         0x00000002
  84 #define LM_FLAG_NOEXP           0x00000004
  85 #define LM_FLAG_ANY             0x00000008
  86 #define LM_FLAG_PRIORITY        0x00000010
  87 #define GL_ASYNC                0x00000040
  88 #define GL_EXACT                0x00000080
  89 #define GL_SKIP                 0x00000100
  90 #define GL_ATIME                0x00000200
  91 #define GL_NOCACHE              0x00000400
  92
  93 /*
  94  * lm_async_cb return flags
  95  *
  96  * LM_OUT_ST_MASK
  97  * Masks the lower two bits of lock state in the returned value.
  98  *
  99  * LM_OUT_CANCELED
 100  * The lock request was canceled.
 101  *
 102  */
 103
 104 #define LM_OUT_ST_MASK          0x00000003
 105 #define LM_OUT_CANCELED         0x00000008
 106 #define LM_OUT_ERROR            0x00000004
 107
 108 /*
 109  * lm_recovery_done() messages
 110  */
 111
 112 #define LM_RD_GAVEUP            308
 113 #define LM_RD_SUCCESS           309
 114
 115 #define GLR_TRYFAILED           13
 116
 117 struct lm_lockops {
 118         const char *lm_proto_name;
 119         int (*lm_mount) (struct gfs2_sbd *sdp, const char *fsname);
 120         void (*lm_unmount) (struct gfs2_sbd *sdp);
 121         void (*lm_withdraw) (struct gfs2_sbd *sdp);
 122         void (*lm_put_lock) (struct kmem_cache *cachep, struct gfs2_glock *gl);
 123         int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
 124                         unsigned int flags);
 125         void (*lm_cancel) (struct gfs2_glock *gl);
 126         const match_table_t *lm_tokens;
 127 };
 128
 129 #define LM_FLAG_TRY             0x00000001
 130 #define LM_FLAG_TRY_1CB         0x00000002
 131 #define LM_FLAG_NOEXP           0x00000004
 132 #define LM_FLAG_ANY             0x00000008
 133 #define LM_FLAG_PRIORITY        0x00000010
 134
 135 #define GL_ASYNC                0x00000040
 136 #define GL_EXACT                0x00000080
 137 #define GL_SKIP                 0x00000100
 138 #define GL_NOCACHE              0x00000400
 139
 140 #define GLR_TRYFAILED           13
 141
 142 extern struct workqueue_struct *gfs2_delete_workqueue;
 143 static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
 144 {
 145         struct gfs2_holder *gh;
 146         struct pid *pid;
 147
 148         /* Look in glock's list of holders for one with current task as owner */
 149         spin_lock(&gl->gl_spin);
 150         pid = task_pid(current);
 151         list_for_each_entry(gh, &gl->gl_holders, gh_list) {
 152                 if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
 153                         break;
 154                 if (gh->gh_owner_pid == pid)
 155                         goto out;
 156         }
 157         gh = NULL;
 158 out:
 159         spin_unlock(&gl->gl_spin);
 160
 161         return gh;
 162 }
 163
 164 static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
 165 {
 166         return gl->gl_state == LM_ST_EXCLUSIVE;
 167 }
 168
 169 static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
 170 {
 171         return gl->gl_state == LM_ST_DEFERRED;
 172 }
 173
 174 static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
 175 {
 176         return gl->gl_state == LM_ST_SHARED;
 177 }
 178
 179 static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
 180 {
 181         if (gl->gl_ops->go_flags & GLOF_ASPACE)
 182                 return (struct address_space *)(gl + 1);
 183         return NULL;
 184 }
 185
 186 int gfs2_glock_get(struct gfs2_sbd *sdp,
 187                    u64 number, const struct gfs2_glock_operations *glops,
 188                    int create, struct gfs2_glock **glp);
 189 void gfs2_glock_hold(struct gfs2_glock *gl);
 190 void gfs2_glock_put_nolock(struct gfs2_glock *gl);
 191 int gfs2_glock_put(struct gfs2_glock *gl);
 192 void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, unsigned flags,
 193                       struct gfs2_holder *gh);
 194 void gfs2_holder_reinit(unsigned int state, unsigned flags,
 195                         struct gfs2_holder *gh);
 196 void gfs2_holder_uninit(struct gfs2_holder *gh);
 197 int gfs2_glock_nq(struct gfs2_holder *gh);
 198 int gfs2_glock_poll(struct gfs2_holder *gh);
 199 int gfs2_glock_wait(struct gfs2_holder *gh);
 200 void gfs2_glock_dq(struct gfs2_holder *gh);
 201 void gfs2_glock_dq_wait(struct gfs2_holder *gh);
 202
 203 void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
 204 int gfs2_glock_nq_num(struct gfs2_sbd *sdp,
 205                       u64 number, const struct gfs2_glock_operations *glops,
 206                       unsigned int state, int flags, struct gfs2_holder *gh);
 207
 208 int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
 209 void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
 210 void gfs2_glock_dq_uninit_m(unsigned int num_gh, struct gfs2_holder *ghs);
 211
 212 __attribute__ ((format(printf, 2, 3)))
 213 void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);
 214
 215 /**
 216  * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
 217  * @gl: the glock
 218  * @state: the state we're requesting
 219  * @flags: the modifier flags
 220  * @gh: the holder structure
 221  *
 222  * Returns: 0, GLR_*, or errno
 223  */
 224
 225 static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
 226                                      unsigned int state, int flags,
 227                                      struct gfs2_holder *gh)
 228 {
 229         int error;
 230
 231         gfs2_holder_init(gl, state, flags, gh);
 232
 233         error = gfs2_glock_nq(gh);
 234         if (error)
 235                 gfs2_holder_uninit(gh);
 236
 237         return error;
 238 }
 239
 240 /*  Lock Value Block functions  */
 241
 242 int gfs2_lvb_hold(struct gfs2_glock *gl);
 243 void gfs2_lvb_unhold(struct gfs2_glock *gl);
 244
 245 void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
 246 void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
 247 void gfs2_reclaim_glock(struct gfs2_sbd *sdp);
 248 void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
 249 void gfs2_glock_finish_truncate(struct gfs2_inode *ip);
 250 void gfs2_glock_thaw(struct gfs2_sbd *sdp);
 251
 252 int __init gfs2_glock_init(void);
 253 void gfs2_glock_exit(void);
 254
 255 int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
 256 void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
 257 int gfs2_register_debugfs(void);
 258 void gfs2_unregister_debugfs(void);
 259
 260 extern const struct lm_lockops gfs2_dlm_ops;
 261
 262 #endif /* __GLOCK_DOT_H__ */