linux/fs/ocfs2/dlmglue.h
<<
>>
Prefs
   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/* -*- mode: c; c-basic-offset: 8; -*-
   3 * vim: noexpandtab sw=8 ts=8 sts=0:
   4 *
   5 * dlmglue.h
   6 *
   7 * description here
   8 *
   9 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
  10 */
  11
  12
  13#ifndef DLMGLUE_H
  14#define DLMGLUE_H
  15
  16#include "dcache.h"
  17
  18#define OCFS2_LVB_VERSION 5
  19
  20struct ocfs2_meta_lvb {
  21        __u8         lvb_version;
  22        __u8         lvb_reserved0;
  23        __be16       lvb_idynfeatures;
  24        __be32       lvb_iclusters;
  25        __be32       lvb_iuid;
  26        __be32       lvb_igid;
  27        __be64       lvb_iatime_packed;
  28        __be64       lvb_ictime_packed;
  29        __be64       lvb_imtime_packed;
  30        __be64       lvb_isize;
  31        __be16       lvb_imode;
  32        __be16       lvb_inlink;
  33        __be32       lvb_iattr;
  34        __be32       lvb_igeneration;
  35        __be32       lvb_reserved2;
  36};
  37
  38#define OCFS2_QINFO_LVB_VERSION 1
  39
  40struct ocfs2_qinfo_lvb {
  41        __u8    lvb_version;
  42        __u8    lvb_reserved[3];
  43        __be32  lvb_bgrace;
  44        __be32  lvb_igrace;
  45        __be32  lvb_syncms;
  46        __be32  lvb_blocks;
  47        __be32  lvb_free_blk;
  48        __be32  lvb_free_entry;
  49};
  50
  51#define OCFS2_ORPHAN_LVB_VERSION 1
  52
  53struct ocfs2_orphan_scan_lvb {
  54        __u8    lvb_version;
  55        __u8    lvb_reserved[3];
  56        __be32  lvb_os_seqno;
  57};
  58
  59#define OCFS2_TRIMFS_LVB_VERSION 1
  60
  61struct ocfs2_trim_fs_lvb {
  62        __u8    lvb_version;
  63        __u8    lvb_success;
  64        __u8    lvb_reserved[2];
  65        __be32  lvb_nodenum;
  66        __be64  lvb_start;
  67        __be64  lvb_len;
  68        __be64  lvb_minlen;
  69        __be64  lvb_trimlen;
  70};
  71
  72struct ocfs2_trim_fs_info {
  73        u8      tf_valid;       /* lvb is valid, or not */
  74        u8      tf_success;     /* trim is successful, or not */
  75        u32     tf_nodenum;     /* osb node number */
  76        u64     tf_start;       /* trim start offset in clusters */
  77        u64     tf_len;         /* trim end offset in clusters */
  78        u64     tf_minlen;      /* trim minimum contiguous free clusters */
  79        u64     tf_trimlen;     /* trimmed length in bytes */
  80};
  81
  82struct ocfs2_lock_holder {
  83        struct list_head oh_list;
  84        struct pid *oh_owner_pid;
  85        int oh_ex;
  86};
  87
  88/* ocfs2_inode_lock_full() 'arg_flags' flags */
  89/* don't wait on recovery. */
  90#define OCFS2_META_LOCK_RECOVERY        (0x01)
  91/* Instruct the dlm not to queue ourselves on the other node. */
  92#define OCFS2_META_LOCK_NOQUEUE         (0x02)
  93/* don't block waiting for the downconvert thread, instead return -EAGAIN */
  94#define OCFS2_LOCK_NONBLOCK             (0x04)
  95/* just get back disk inode bh if we've got cluster lock. */
  96#define OCFS2_META_LOCK_GETBH           (0x08)
  97
  98/* Locking subclasses of inode cluster lock */
  99enum {
 100        OI_LS_NORMAL = 0,
 101        OI_LS_PARENT,
 102        OI_LS_RENAME1,
 103        OI_LS_RENAME2,
 104        OI_LS_REFLINK_TARGET,
 105};
 106
 107int ocfs2_dlm_init(struct ocfs2_super *osb);
 108void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
 109void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
 110void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
 111                               enum ocfs2_lock_type type,
 112                               unsigned int generation,
 113                               struct inode *inode);
 114void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
 115                                u64 parent, struct inode *inode);
 116struct ocfs2_file_private;
 117void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
 118                              struct ocfs2_file_private *fp);
 119struct ocfs2_mem_dqinfo;
 120void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
 121                               struct ocfs2_mem_dqinfo *info);
 122void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
 123                                  struct ocfs2_super *osb, u64 ref_blkno,
 124                                  unsigned int generation);
 125void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
 126int ocfs2_create_new_inode_locks(struct inode *inode);
 127int ocfs2_drop_inode_locks(struct inode *inode);
 128int ocfs2_rw_lock(struct inode *inode, int write);
 129int ocfs2_try_rw_lock(struct inode *inode, int write);
 130void ocfs2_rw_unlock(struct inode *inode, int write);
 131int ocfs2_open_lock(struct inode *inode);
 132int ocfs2_try_open_lock(struct inode *inode, int write);
 133void ocfs2_open_unlock(struct inode *inode);
 134int ocfs2_inode_lock_atime(struct inode *inode,
 135                          struct vfsmount *vfsmnt,
 136                          int *level, int wait);
 137int ocfs2_inode_lock_full_nested(struct inode *inode,
 138                         struct buffer_head **ret_bh,
 139                         int ex,
 140                         int arg_flags,
 141                         int subclass);
 142int ocfs2_inode_lock_with_page(struct inode *inode,
 143                              struct buffer_head **ret_bh,
 144                              int ex,
 145                              struct page *page);
 146/* Variants without special locking class or flags */
 147#define ocfs2_inode_lock_full(i, r, e, f)\
 148                ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
 149#define ocfs2_inode_lock_nested(i, b, e, s)\
 150                ocfs2_inode_lock_full_nested(i, b, e, 0, s)
 151/* 99% of the time we don't want to supply any additional flags --
 152 * those are for very specific cases only. */
 153#define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
 154#define ocfs2_try_inode_lock(i, b, e)\
 155                ocfs2_inode_lock_full_nested(i, b, e, OCFS2_META_LOCK_NOQUEUE,\
 156                OI_LS_NORMAL)
 157void ocfs2_inode_unlock(struct inode *inode,
 158                       int ex);
 159int ocfs2_super_lock(struct ocfs2_super *osb,
 160                     int ex);
 161void ocfs2_super_unlock(struct ocfs2_super *osb,
 162                        int ex);
 163int ocfs2_orphan_scan_lock(struct ocfs2_super *osb, u32 *seqno);
 164void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);
 165
 166int ocfs2_rename_lock(struct ocfs2_super *osb);
 167void ocfs2_rename_unlock(struct ocfs2_super *osb);
 168int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
 169void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
 170void ocfs2_trim_fs_lock_res_init(struct ocfs2_super *osb);
 171void ocfs2_trim_fs_lock_res_uninit(struct ocfs2_super *osb);
 172int ocfs2_trim_fs_lock(struct ocfs2_super *osb,
 173                       struct ocfs2_trim_fs_info *info, int trylock);
 174void ocfs2_trim_fs_unlock(struct ocfs2_super *osb,
 175                          struct ocfs2_trim_fs_info *info);
 176int ocfs2_dentry_lock(struct dentry *dentry, int ex);
 177void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
 178int ocfs2_file_lock(struct file *file, int ex, int trylock);
 179void ocfs2_file_unlock(struct file *file);
 180int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
 181void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
 182struct ocfs2_refcount_tree;
 183int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
 184void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);
 185
 186
 187void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
 188                                struct ocfs2_lock_res *lockres);
 189void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
 190                               struct ocfs2_lock_res *lockres);
 191
 192/* for the downconvert thread */
 193void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
 194
 195struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
 196void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
 197
 198/* To set the locking protocol on module initialization */
 199void ocfs2_set_locking_protocol(void);
 200
 201/* The _tracker pair is used to avoid cluster recursive locking */
 202int ocfs2_inode_lock_tracker(struct inode *inode,
 203                             struct buffer_head **ret_bh,
 204                             int ex,
 205                             struct ocfs2_lock_holder *oh);
 206void ocfs2_inode_unlock_tracker(struct inode *inode,
 207                                int ex,
 208                                struct ocfs2_lock_holder *oh,
 209                                int had_lock);
 210
 211#endif  /* DLMGLUE_H */
 212