b700dc9624d13774cd693ab3bde426829fc9e79a
[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 5:
42  *      - Network timeout checking protocol
43  *
44  * New in version 4:
45  *      - Remove i_generation from lock names for better stat performance.
46  *
47  * New in version 3:
48  *      - Replace dentry votes with a cluster lock
49  *
50  * New in version 2:
51  *      - full 64 bit i_size in the metadata lock lvbs
52  *      - introduction of "rw" lock and pushing meta/data locking down
53  */
54 #define O2NET_PROTOCOL_VERSION 5ULL
55 struct o2net_handshake {
56         __be64  protocol_version;
57         __be64  connector_id;
58         __be32  o2hb_heartbeat_timeout_ms;
59         __be32  o2net_idle_timeout_ms;
60         __be32  o2net_keepalive_delay_ms;
61         __be32  o2net_reconnect_delay_ms;
62 };
63
64 struct o2net_node {
65         /* this is never called from int/bh */
66         spinlock_t                      nn_lock;
67
68         /* set the moment an sc is allocated and a connect is started */
69         struct o2net_sock_container     *nn_sc;
70         /* _valid is only set after the handshake passes and tx can happen */
71         unsigned                        nn_sc_valid:1;
72         /* if this is set tx just returns it */
73         int                             nn_persistent_error;
74
75         /* threads waiting for an sc to arrive wait on the wq for generation
76          * to increase.  it is increased when a connecting socket succeeds
77          * or fails or when an accepted socket is attached. */
78         wait_queue_head_t               nn_sc_wq;
79
80         struct idr                      nn_status_idr;
81         struct list_head                nn_status_list;
82
83         /* connects are attempted from when heartbeat comes up until either hb
84          * goes down, the node is unconfigured, no connect attempts succeed
85          * before O2NET_CONN_IDLE_DELAY, or a connect succeeds.  connect_work
86          * is queued from set_nn_state both from hb up and from itself if a
87          * connect attempt fails and so can be self-arming.  shutdown is
88          * careful to first mark the nn such that no connects will be attempted
89          * before canceling delayed connect work and flushing the queue. */
90         struct delayed_work             nn_connect_work;
91         unsigned long                   nn_last_connect_attempt;
92
93         /* this is queued as nodes come up and is canceled when a connection is
94          * established.  this expiring gives up on the node and errors out
95          * transmits */
96         struct delayed_work             nn_connect_expired;
97
98         /* after we give up on a socket we wait a while before deciding
99          * that it is still heartbeating and that we should do some
100          * quorum work */
101         struct delayed_work             nn_still_up;
102 };
103
104 struct o2net_sock_container {
105         struct kref             sc_kref;
106         /* the next two are vaild for the life time of the sc */
107         struct socket           *sc_sock;
108         struct o2nm_node        *sc_node;
109
110         /* all of these sc work structs hold refs on the sc while they are
111          * queued.  they should not be able to ref a freed sc.  the teardown
112          * race is with o2net_wq destruction in o2net_stop_listening() */
113
114         /* rx and connect work are generated from socket callbacks.  sc
115          * shutdown removes the callbacks and then flushes the work queue */
116         struct work_struct      sc_rx_work;
117         struct work_struct      sc_connect_work;
118         /* shutdown work is triggered in two ways.  the simple way is
119          * for a code path calls ensure_shutdown which gets a lock, removes
120          * the sc from the nn, and queues the work.  in this case the
121          * work is single-shot.  the work is also queued from a sock
122          * callback, though, and in this case the work will find the sc
123          * still on the nn and will call ensure_shutdown itself.. this
124          * ends up triggering the shutdown work again, though nothing
125          * will be done in that second iteration.  so work queue teardown
126          * has to be careful to remove the sc from the nn before waiting
127          * on the work queue so that the shutdown work doesn't remove the
128          * sc and rearm itself.
129          */
130         struct work_struct      sc_shutdown_work;
131
132         struct timer_list       sc_idle_timeout;
133         struct delayed_work     sc_keepalive_work;
134
135         unsigned                sc_handshake_ok:1;
136
137         struct page             *sc_page;
138         size_t                  sc_page_off;
139
140         /* original handlers for the sockets */
141         void                    (*sc_state_change)(struct sock *sk);
142         void                    (*sc_data_ready)(struct sock *sk, int bytes);
143
144         struct timeval          sc_tv_timer;
145         struct timeval          sc_tv_data_ready;
146         struct timeval          sc_tv_advance_start;
147         struct timeval          sc_tv_advance_stop;
148         struct timeval          sc_tv_func_start;
149         struct timeval          sc_tv_func_stop;
150         u32                     sc_msg_key;
151         u16                     sc_msg_type;
152 };
153
154 struct o2net_msg_handler {
155         struct rb_node          nh_node;
156         u32                     nh_max_len;
157         u32                     nh_msg_type;
158         u32                     nh_key;
159         o2net_msg_handler_func  *nh_func;
160         o2net_msg_handler_func  *nh_func_data;
161         struct kref             nh_kref;
162         struct list_head        nh_unregister_item;
163 };
164
165 enum o2net_system_error {
166         O2NET_ERR_NONE = 0,
167         O2NET_ERR_NO_HNDLR,
168         O2NET_ERR_OVERFLOW,
169         O2NET_ERR_DIED,
170         O2NET_ERR_MAX
171 };
172
173 struct o2net_status_wait {
174         enum o2net_system_error ns_sys_status;
175         s32                     ns_status;
176         int                     ns_id;
177         wait_queue_head_t       ns_wq;
178         struct list_head        ns_node_item;
179 };
180
181 #endif /* O2CLUSTER_TCP_INTERNAL_H */