SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 /* same as hb delay, we're waiting for another node to recognize our hb */
  31 #define O2NET_RECONNECT_DELAY_MS        O2HB_REGION_TIMEOUT_MS
  32
  33 /* we're delaying our quorum decision so that heartbeat will have timed
  34  * out truly dead nodes by the time we come around to making decisions
  35  * on their number */
  36 #define O2NET_QUORUM_DELAY_MS   ((o2hb_dead_threshold + 2) * O2HB_REGION_TIMEOUT_MS)
  37
  38 #define O2NET_KEEPALIVE_DELAY_SECS      5
  39 #define O2NET_IDLE_TIMEOUT_SECS         10
  40
  41 /*
  42  * This version number represents quite a lot, unfortunately.  It not
  43  * only represents the raw network message protocol on the wire but also
  44  * locking semantics of the file system using the protocol.  It should
  45  * be somewhere else, I'm sure, but right now it isn't.
  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 3ULL
  55 struct o2net_handshake {
  56         __be64  protocol_version;
  57         __be64  connector_id;
  58 };
  59
  60 struct o2net_node {
  61         /* this is never called from int/bh */
  62         spinlock_t                      nn_lock;
  63
  64         /* set the moment an sc is allocated and a connect is started */
  65         struct o2net_sock_container     *nn_sc;
  66         /* _valid is only set after the handshake passes and tx can happen */
  67         unsigned                        nn_sc_valid:1;
  68         /* if this is set tx just returns it */
  69         int                             nn_persistent_error;
  70
  71         /* threads waiting for an sc to arrive wait on the wq for generation
  72          * to increase.  it is increased when a connecting socket succeeds
  73          * or fails or when an accepted socket is attached. */
  74         wait_queue_head_t               nn_sc_wq;
  75
  76         struct idr                      nn_status_idr;
  77         struct list_head                nn_status_list;
  78
  79         /* connects are attempted from when heartbeat comes up until either hb
  80          * goes down, the node is unconfigured, no connect attempts succeed
  81          * before O2NET_CONN_IDLE_DELAY, or a connect succeeds.  connect_work
  82          * is queued from set_nn_state both from hb up and from itself if a
  83          * connect attempt fails and so can be self-arming.  shutdown is
  84          * careful to first mark the nn such that no connects will be attempted
  85          * before canceling delayed connect work and flushing the queue. */
  86         struct work_struct              nn_connect_work;
  87         unsigned long                   nn_last_connect_attempt;
  88
  89         /* this is queued as nodes come up and is canceled when a connection is
  90          * established.  this expiring gives up on the node and errors out
  91          * transmits */
  92         struct work_struct              nn_connect_expired;
  93
  94         /* after we give up on a socket we wait a while before deciding
  95          * that it is still heartbeating and that we should do some
  96          * quorum work */
  97         struct work_struct              nn_still_up;
  98 };
  99
 100 struct o2net_sock_container {
 101         struct kref             sc_kref;
 102         /* the next two are vaild for the life time of the sc */
 103         struct socket           *sc_sock;
 104         struct o2nm_node        *sc_node;
 105
 106         /* all of these sc work structs hold refs on the sc while they are
 107          * queued.  they should not be able to ref a freed sc.  the teardown
 108          * race is with o2net_wq destruction in o2net_stop_listening() */
 109
 110         /* rx and connect work are generated from socket callbacks.  sc
 111          * shutdown removes the callbacks and then flushes the work queue */
 112         struct work_struct      sc_rx_work;
 113         struct work_struct      sc_connect_work;
 114         /* shutdown work is triggered in two ways.  the simple way is
 115          * for a code path calls ensure_shutdown which gets a lock, removes
 116          * the sc from the nn, and queues the work.  in this case the
 117          * work is single-shot.  the work is also queued from a sock
 118          * callback, though, and in this case the work will find the sc
 119          * still on the nn and will call ensure_shutdown itself.. this
 120          * ends up triggering the shutdown work again, though nothing
 121          * will be done in that second iteration.  so work queue teardown
 122          * has to be careful to remove the sc from the nn before waiting
 123          * on the work queue so that the shutdown work doesn't remove the
 124          * sc and rearm itself.
 125          */
 126         struct work_struct      sc_shutdown_work;
 127
 128         struct timer_list       sc_idle_timeout;
 129         struct work_struct      sc_keepalive_work;
 130
 131         unsigned                sc_handshake_ok:1;
 132
 133         struct page             *sc_page;
 134         size_t                  sc_page_off;
 135
 136         /* original handlers for the sockets */
 137         void                    (*sc_state_change)(struct sock *sk);
 138         void                    (*sc_data_ready)(struct sock *sk, int bytes);
 139
 140         struct timeval          sc_tv_timer;
 141         struct timeval          sc_tv_data_ready;
 142         struct timeval          sc_tv_advance_start;
 143         struct timeval          sc_tv_advance_stop;
 144         struct timeval          sc_tv_func_start;
 145         struct timeval          sc_tv_func_stop;
 146         u32                     sc_msg_key;
 147         u16                     sc_msg_type;
 148 };
 149
 150 struct o2net_msg_handler {
 151         struct rb_node          nh_node;
 152         u32                     nh_max_len;
 153         u32                     nh_msg_type;
 154         u32                     nh_key;
 155         o2net_msg_handler_func  *nh_func;
 156         o2net_msg_handler_func  *nh_func_data;
 157         struct kref             nh_kref;
 158         struct list_head        nh_unregister_item;
 159 };
 160
 161 enum o2net_system_error {
 162         O2NET_ERR_NONE = 0,
 163         O2NET_ERR_NO_HNDLR,
 164         O2NET_ERR_OVERFLOW,
 165         O2NET_ERR_DIED,
 166         O2NET_ERR_MAX
 167 };
 168
 169 struct o2net_status_wait {
 170         enum o2net_system_error ns_sys_status;
 171         s32                     ns_status;
 172         int                     ns_id;
 173         wait_queue_head_t       ns_wq;
 174         struct list_head        ns_node_item;
 175 };
 176
 177 #endif /* O2CLUSTER_TCP_INTERNAL_H */