linux/fs/ocfs2/cluster/tcp_internal.h
<<
>>
Prefs
   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 * With version 11, we separate out the filesystem locking portion.  The
  42 * filesystem now has a major.minor version it negotiates.  Version 11
  43 * introduces this negotiation to the o2dlm protocol, and as such the
  44 * version here in tcp_internal.h should not need to be bumped for
  45 * filesystem locking changes.
  46 *
  47 * New in version 11
  48 *      - Negotiation of filesystem locking in the dlm join.
  49 *
  50 * New in version 10:
  51 *      - Meta/data locks combined
  52 *
  53 * New in version 9:
  54 *      - All votes removed
  55 *
  56 * New in version 8:
  57 *      - Replace delete inode votes with a cluster lock
  58 *
  59 * New in version 7:
  60 *      - DLM join domain includes the live nodemap
  61 *
  62 * New in version 6:
  63 *      - DLM lockres remote refcount fixes.
  64 *
  65 * New in version 5:
  66 *      - Network timeout checking protocol
  67 *
  68 * New in version 4:
  69 *      - Remove i_generation from lock names for better stat performance.
  70 *
  71 * New in version 3:
  72 *      - Replace dentry votes with a cluster lock
  73 *
  74 * New in version 2:
  75 *      - full 64 bit i_size in the metadata lock lvbs
  76 *      - introduction of "rw" lock and pushing meta/data locking down
  77 */
  78#define O2NET_PROTOCOL_VERSION 11ULL
  79struct o2net_handshake {
  80        __be64  protocol_version;
  81        __be64  connector_id;
  82        __be32  o2hb_heartbeat_timeout_ms;
  83        __be32  o2net_idle_timeout_ms;
  84        __be32  o2net_keepalive_delay_ms;
  85        __be32  o2net_reconnect_delay_ms;
  86};
  87
  88struct o2net_node {
  89        /* this is never called from int/bh */
  90        spinlock_t                      nn_lock;
  91
  92        /* set the moment an sc is allocated and a connect is started */
  93        struct o2net_sock_container     *nn_sc;
  94        /* _valid is only set after the handshake passes and tx can happen */
  95        unsigned                        nn_sc_valid:1;
  96        /* if this is set tx just returns it */
  97        int                             nn_persistent_error;
  98        /* It is only set to 1 after the idle time out. */
  99        atomic_t                        nn_timeout;
 100
 101        /* threads waiting for an sc to arrive wait on the wq for generation
 102         * to increase.  it is increased when a connecting socket succeeds
 103         * or fails or when an accepted socket is attached. */
 104        wait_queue_head_t               nn_sc_wq;
 105
 106        struct idr                      nn_status_idr;
 107        struct list_head                nn_status_list;
 108
 109        /* connects are attempted from when heartbeat comes up until either hb
 110         * goes down, the node is unconfigured, or a connect succeeds.
 111         * connect_work is queued from set_nn_state both from hb up and from
 112         * itself if a connect attempt fails and so can be self-arming.
 113         * shutdown is careful to first mark the nn such that no connects will
 114         * be attempted before canceling delayed connect work and flushing the
 115         * queue. */
 116        struct delayed_work             nn_connect_work;
 117        unsigned long                   nn_last_connect_attempt;
 118
 119        /* this is queued as nodes come up and is canceled when a connection is
 120         * established.  this expiring gives up on the node and errors out
 121         * transmits */
 122        struct delayed_work             nn_connect_expired;
 123
 124        /* after we give up on a socket we wait a while before deciding
 125         * that it is still heartbeating and that we should do some
 126         * quorum work */
 127        struct delayed_work             nn_still_up;
 128};
 129
 130struct o2net_sock_container {
 131        struct kref             sc_kref;
 132        /* the next two are valid for the life time of the sc */
 133        struct socket           *sc_sock;
 134        struct o2nm_node        *sc_node;
 135
 136        /* all of these sc work structs hold refs on the sc while they are
 137         * queued.  they should not be able to ref a freed sc.  the teardown
 138         * race is with o2net_wq destruction in o2net_stop_listening() */
 139
 140        /* rx and connect work are generated from socket callbacks.  sc
 141         * shutdown removes the callbacks and then flushes the work queue */
 142        struct work_struct      sc_rx_work;
 143        struct work_struct      sc_connect_work;
 144        /* shutdown work is triggered in two ways.  the simple way is
 145         * for a code path calls ensure_shutdown which gets a lock, removes
 146         * the sc from the nn, and queues the work.  in this case the
 147         * work is single-shot.  the work is also queued from a sock
 148         * callback, though, and in this case the work will find the sc
 149         * still on the nn and will call ensure_shutdown itself.. this
 150         * ends up triggering the shutdown work again, though nothing
 151         * will be done in that second iteration.  so work queue teardown
 152         * has to be careful to remove the sc from the nn before waiting
 153         * on the work queue so that the shutdown work doesn't remove the
 154         * sc and rearm itself.
 155         */
 156        struct work_struct      sc_shutdown_work;
 157
 158        struct timer_list       sc_idle_timeout;
 159        struct delayed_work     sc_keepalive_work;
 160
 161        unsigned                sc_handshake_ok:1;
 162
 163        struct page             *sc_page;
 164        size_t                  sc_page_off;
 165
 166        /* original handlers for the sockets */
 167        void                    (*sc_state_change)(struct sock *sk);
 168        void                    (*sc_data_ready)(struct sock *sk);
 169
 170        u32                     sc_msg_key;
 171        u16                     sc_msg_type;
 172
 173#ifdef CONFIG_DEBUG_FS
 174        struct list_head        sc_net_debug_item;
 175        ktime_t                 sc_tv_timer;
 176        ktime_t                 sc_tv_data_ready;
 177        ktime_t                 sc_tv_advance_start;
 178        ktime_t                 sc_tv_advance_stop;
 179        ktime_t                 sc_tv_func_start;
 180        ktime_t                 sc_tv_func_stop;
 181#endif
 182#ifdef CONFIG_OCFS2_FS_STATS
 183        ktime_t                 sc_tv_acquiry_total;
 184        ktime_t                 sc_tv_send_total;
 185        ktime_t                 sc_tv_status_total;
 186        u32                     sc_send_count;
 187        u32                     sc_recv_count;
 188        ktime_t                 sc_tv_process_total;
 189#endif
 190        struct mutex            sc_send_lock;
 191};
 192
 193struct o2net_msg_handler {
 194        struct rb_node          nh_node;
 195        u32                     nh_max_len;
 196        u32                     nh_msg_type;
 197        u32                     nh_key;
 198        o2net_msg_handler_func  *nh_func;
 199        o2net_msg_handler_func  *nh_func_data;
 200        o2net_post_msg_handler_func
 201                                *nh_post_func;
 202        struct kref             nh_kref;
 203        struct list_head        nh_unregister_item;
 204};
 205
 206enum o2net_system_error {
 207        O2NET_ERR_NONE = 0,
 208        O2NET_ERR_NO_HNDLR,
 209        O2NET_ERR_OVERFLOW,
 210        O2NET_ERR_DIED,
 211        O2NET_ERR_MAX
 212};
 213
 214struct o2net_status_wait {
 215        enum o2net_system_error ns_sys_status;
 216        s32                     ns_status;
 217        int                     ns_id;
 218        wait_queue_head_t       ns_wq;
 219        struct list_head        ns_node_item;
 220};
 221
 222#ifdef CONFIG_DEBUG_FS
 223/* just for state dumps */
 224struct o2net_send_tracking {
 225        struct list_head                st_net_debug_item;
 226        struct task_struct              *st_task;
 227        struct o2net_sock_container     *st_sc;
 228        u32                             st_id;
 229        u32                             st_msg_type;
 230        u32                             st_msg_key;
 231        u8                              st_node;
 232        ktime_t                         st_sock_time;
 233        ktime_t                         st_send_time;
 234        ktime_t                         st_status_time;
 235};
 236#else
 237struct o2net_send_tracking {
 238        u32     dummy;
 239};
 240#endif  /* CONFIG_DEBUG_FS */
 241
 242#endif /* O2CLUSTER_TCP_INTERNAL_H */
 243