ocfs2: Remove mount/unmount votes
[linux-2.6.git] / fs / ocfs2 / cluster / tcp_internal.h
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * Copyright (C) 2005 Oracle.  All rights reserved.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public
17  * License along with this program; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 021110-1307, USA.
20  */
21
22 #ifndef O2CLUSTER_TCP_INTERNAL_H
23 #define O2CLUSTER_TCP_INTERNAL_H
24
25 #define O2NET_MSG_MAGIC           ((u16)0xfa55)
26 #define O2NET_MSG_STATUS_MAGIC    ((u16)0xfa56)
27 #define O2NET_MSG_KEEP_REQ_MAGIC  ((u16)0xfa57)
28 #define O2NET_MSG_KEEP_RESP_MAGIC ((u16)0xfa58)
29
30 /* we're delaying our quorum decision so that heartbeat will have timed
31  * out truly dead nodes by the time we come around to making decisions
32  * on their number */
33 #define O2NET_QUORUM_DELAY_MS   ((o2hb_dead_threshold + 2) * O2HB_REGION_TIMEOUT_MS)
34
35 /* 
36  * This version number represents quite a lot, unfortunately.  It not
37  * only represents the raw network message protocol on the wire but also
38  * locking semantics of the file system using the protocol.  It should 
39  * be somewhere else, I'm sure, but right now it isn't.
40  *
41  * New in version 9:
42  *      - All votes removed
43  *
44  * New in version 8:
45  *      - Replace delete inode votes with a cluster lock
46  *
47  * New in version 7:
48  *      - DLM join domain includes the live nodemap
49  *
50  * New in version 6:
51  *      - DLM lockres remote refcount fixes.
52  *
53  * New in version 5:
54  *      - Network timeout checking protocol
55  *
56  * New in version 4:
57  *      - Remove i_generation from lock names for better stat performance.
58  *
59  * New in version 3:
60  *      - Replace dentry votes with a cluster lock
61  *
62  * New in version 2:
63  *      - full 64 bit i_size in the metadata lock lvbs
64  *      - introduction of "rw" lock and pushing meta/data locking down
65  */
66 #define O2NET_PROTOCOL_VERSION 9ULL
67 struct o2net_handshake {
68         __be64  protocol_version;
69         __be64  connector_id;
70         __be32  o2hb_heartbeat_timeout_ms;
71         __be32  o2net_idle_timeout_ms;
72         __be32  o2net_keepalive_delay_ms;
73         __be32  o2net_reconnect_delay_ms;
74 };
75
76 struct o2net_node {
77         /* this is never called from int/bh */
78         spinlock_t                      nn_lock;
79
80         /* set the moment an sc is allocated and a connect is started */
81         struct o2net_sock_container     *nn_sc;
82         /* _valid is only set after the handshake passes and tx can happen */
83         unsigned                        nn_sc_valid:1;
84         /* if this is set tx just returns it */
85         int                             nn_persistent_error;
86
87         /* threads waiting for an sc to arrive wait on the wq for generation
88          * to increase.  it is increased when a connecting socket succeeds
89          * or fails or when an accepted socket is attached. */
90         wait_queue_head_t               nn_sc_wq;
91
92         struct idr                      nn_status_idr;
93         struct list_head                nn_status_list;
94
95         /* connects are attempted from when heartbeat comes up until either hb
96          * goes down, the node is unconfigured, no connect attempts succeed
97          * before O2NET_CONN_IDLE_DELAY, or a connect succeeds.  connect_work
98          * is queued from set_nn_state both from hb up and from itself if a
99          * connect attempt fails and so can be self-arming.  shutdown is
100          * careful to first mark the nn such that no connects will be attempted
101          * before canceling delayed connect work and flushing the queue. */
102         struct delayed_work             nn_connect_work;
103         unsigned long                   nn_last_connect_attempt;
104
105         /* this is queued as nodes come up and is canceled when a connection is
106          * established.  this expiring gives up on the node and errors out
107          * transmits */
108         struct delayed_work             nn_connect_expired;
109
110         /* after we give up on a socket we wait a while before deciding
111          * that it is still heartbeating and that we should do some
112          * quorum work */
113         struct delayed_work             nn_still_up;
114 };
115
116 struct o2net_sock_container {
117         struct kref             sc_kref;
118         /* the next two are vaild for the life time of the sc */
119         struct socket           *sc_sock;
120         struct o2nm_node        *sc_node;
121
122         /* all of these sc work structs hold refs on the sc while they are
123          * queued.  they should not be able to ref a freed sc.  the teardown
124          * race is with o2net_wq destruction in o2net_stop_listening() */
125
126         /* rx and connect work are generated from socket callbacks.  sc
127          * shutdown removes the callbacks and then flushes the work queue */
128         struct work_struct      sc_rx_work;
129         struct work_struct      sc_connect_work;
130         /* shutdown work is triggered in two ways.  the simple way is
131          * for a code path calls ensure_shutdown which gets a lock, removes
132          * the sc from the nn, and queues the work.  in this case the
133          * work is single-shot.  the work is also queued from a sock
134          * callback, though, and in this case the work will find the sc
135          * still on the nn and will call ensure_shutdown itself.. this
136          * ends up triggering the shutdown work again, though nothing
137          * will be done in that second iteration.  so work queue teardown
138          * has to be careful to remove the sc from the nn before waiting
139          * on the work queue so that the shutdown work doesn't remove the
140          * sc and rearm itself.
141          */
142         struct work_struct      sc_shutdown_work;
143
144         struct timer_list       sc_idle_timeout;
145         struct delayed_work     sc_keepalive_work;
146
147         unsigned                sc_handshake_ok:1;
148
149         struct page             *sc_page;
150         size_t                  sc_page_off;
151
152         /* original handlers for the sockets */
153         void                    (*sc_state_change)(struct sock *sk);
154         void                    (*sc_data_ready)(struct sock *sk, int bytes);
155
156         struct timeval          sc_tv_timer;
157         struct timeval          sc_tv_data_ready;
158         struct timeval          sc_tv_advance_start;
159         struct timeval          sc_tv_advance_stop;
160         struct timeval          sc_tv_func_start;
161         struct timeval          sc_tv_func_stop;
162         u32                     sc_msg_key;
163         u16                     sc_msg_type;
164
165         struct mutex            sc_send_lock;
166 };
167
168 struct o2net_msg_handler {
169         struct rb_node          nh_node;
170         u32                     nh_max_len;
171         u32                     nh_msg_type;
172         u32                     nh_key;
173         o2net_msg_handler_func  *nh_func;
174         o2net_msg_handler_func  *nh_func_data;
175         o2net_post_msg_handler_func
176                                 *nh_post_func;
177         struct kref             nh_kref;
178         struct list_head        nh_unregister_item;
179 };
180
181 enum o2net_system_error {
182         O2NET_ERR_NONE = 0,
183         O2NET_ERR_NO_HNDLR,
184         O2NET_ERR_OVERFLOW,
185         O2NET_ERR_DIED,
186         O2NET_ERR_MAX
187 };
188
189 struct o2net_status_wait {
190         enum o2net_system_error ns_sys_status;
191         s32                     ns_status;
192         int                     ns_id;
193         wait_queue_head_t       ns_wq;
194         struct list_head        ns_node_item;
195 };
196
197 #endif /* O2CLUSTER_TCP_INTERNAL_H */