summaryrefslogtreecommitdiffstats
path: root/xlators/features/locks/src/locks.h
blob: 9d030f15e1363ceb218160005211699747b04331 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
   Copyright (c) 2006, 2007, 2008 Gluster, Inc. <http://www.gluster.com>
   This file is part of GlusterFS.

   GlusterFS is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published
   by the Free Software Foundation; either version 3 of the License,
   or (at your option) any later version.

   GlusterFS is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see
   <http://www.gnu.org/licenses/>.
*/

#ifndef __POSIX_LOCKS_H__
#define __POSIX_LOCKS_H__

#ifndef _CONFIG_H
#define _CONFIG_H
#include "config.h"
#endif

#include "compat-errno.h"
#include "transport.h"
#include "stack.h"
#include "call-stub.h"

struct __pl_fd;

struct __posix_lock {
	struct list_head   list;

	short              fl_type;
	off_t              fl_start;
	off_t              fl_end;

	short              blocked;    /* waiting to acquire */
	struct flock       user_flock; /* the flock supplied by the user */
	xlator_t          *this;       /* required for blocked locks */
	fd_t              *fd;

	call_frame_t      *frame;

	/* These two together serve to uniquely identify each process
	   across nodes */

	transport_t       *transport;     /* to identify client node */
	pid_t              client_pid;    /* pid of client process */
};
typedef struct __posix_lock posix_lock_t;

struct __pl_inode_lock {
        struct list_head   list;
        struct list_head   blocked_locks; /* list_head pointing to blocked_inodelks */

        short              fl_type;
        off_t              fl_start;
        off_t              fl_end;

        const char        *volume;

        struct flock       user_flock; /* the flock supplied by the user */
        xlator_t          *this;       /* required for blocked locks */
        fd_t              *fd;

        call_frame_t      *frame;

        /* These two together serve to uniquely identify each process
           across nodes */

        transport_t       *transport;     /* to identify client node */
        pid_t              client_pid;    /* pid of client process */
};
typedef struct __pl_inode_lock pl_inode_lock_t;

struct __pl_rw_req_t {
	struct list_head      list;
	call_stub_t          *stub;
	posix_lock_t          region;
};
typedef struct __pl_rw_req_t pl_rw_req_t;

struct __pl_dom_list_t {
        struct list_head   inode_list;       /* list_head back to pl_inode_t */
        const char        *domain;
        struct list_head   entrylk_list;     /* List of entry locks */
        struct list_head   blocked_entrylks; /* List of all blocked entrylks */
        struct list_head   inodelk_list;     /* List of inode locks */
        struct list_head   blocked_inodelks; /* List of all blocked inodelks */
};
typedef struct __pl_dom_list_t pl_dom_list_t;

struct __entry_lock {
	struct list_head  domain_list;    /* list_head back to pl_dom_list_t */
	struct list_head  blocked_locks; /* list_head back to blocked_entrylks */

	call_frame_t     *frame;
	xlator_t         *this;

        const char       *volume;

	const char       *basename;
	entrylk_type      type;

	transport_t      *trans;
	pid_t             client_pid;    /* pid of client process */
};
typedef struct __entry_lock pl_entry_lock_t;


/* The "simulated" inode. This contains a list of all the locks associated
   with this file */

struct __pl_inode {
	pthread_mutex_t  mutex;

	struct list_head dom_list;       /* list of domains */
	struct list_head ext_list;       /* list of fcntl locks */
	struct list_head rw_list;        /* list of waiting r/w requests */
	int              mandatory;      /* if mandatory locking is enabled */

        inode_t          *refkeeper;     /* hold refs on an inode while locks are
                                            held to prevent pruning */
};
typedef struct __pl_inode pl_inode_t;


struct __pl_fd {
	gf_boolean_t nonblocking;       /* whether O_NONBLOCK has been set */
};
typedef struct __pl_fd pl_fd_t;


typedef struct {
	gf_boolean_t    mandatory;      /* if mandatory locking is enabled */
} posix_locks_private_t;


#endif /* __POSIX_LOCKS_H__ */