xref: /openbmc/linux/fs/ocfs2/cluster/tcp.h (revision df388556)
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * tcp.h
5  *
6  * Function prototypes
7  *
8  * Copyright (C) 2004 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public
21  * License along with this program; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 021110-1307, USA.
24  *
25  */
26 
27 #ifndef O2CLUSTER_TCP_H
28 #define O2CLUSTER_TCP_H
29 
30 #include <linux/socket.h>
31 #ifdef __KERNEL__
32 #include <net/sock.h>
33 #include <linux/tcp.h>
34 #else
35 #include <sys/socket.h>
36 #endif
37 #include <linux/inet.h>
38 #include <linux/in.h>
39 
40 struct o2net_msg
41 {
42 	__be16 magic;
43 	__be16 data_len;
44 	__be16 msg_type;
45 	__be16 pad1;
46 	__be32 sys_status;
47 	__be32 status;
48 	__be32 key;
49 	__be32 msg_num;
50 	__u8  buf[0];
51 };
52 
53 typedef int (o2net_msg_handler_func)(struct o2net_msg *msg, u32 len, void *data,
54 				     void **ret_data);
55 typedef void (o2net_post_msg_handler_func)(int status, void *data,
56 					   void *ret_data);
57 
58 #define O2NET_MAX_PAYLOAD_BYTES  (4096 - sizeof(struct o2net_msg))
59 
60 /* same as hb delay, we're waiting for another node to recognize our hb */
61 #define O2NET_RECONNECT_DELAY_MS_DEFAULT	2000
62 
63 #define O2NET_KEEPALIVE_DELAY_MS_DEFAULT	2000
64 #define O2NET_IDLE_TIMEOUT_MS_DEFAULT		30000
65 
66 
67 /* TODO: figure this out.... */
68 static inline int o2net_link_down(int err, struct socket *sock)
69 {
70 	if (sock) {
71 		if (sock->sk->sk_state != TCP_ESTABLISHED &&
72 	    	    sock->sk->sk_state != TCP_CLOSE_WAIT)
73 			return 1;
74 	}
75 
76 	if (err >= 0)
77 		return 0;
78 	switch (err) {
79 		/* ????????????????????????? */
80 		case -ERESTARTSYS:
81 		case -EBADF:
82 		/* When the server has died, an ICMP port unreachable
83 		 * message prompts ECONNREFUSED. */
84 		case -ECONNREFUSED:
85 		case -ENOTCONN:
86 		case -ECONNRESET:
87 		case -EPIPE:
88 			return 1;
89 	}
90 	return 0;
91 }
92 
93 enum {
94 	O2NET_DRIVER_UNINITED,
95 	O2NET_DRIVER_READY,
96 };
97 
98 int o2net_send_message(u32 msg_type, u32 key, void *data, u32 len,
99 		       u8 target_node, int *status);
100 int o2net_send_message_vec(u32 msg_type, u32 key, struct kvec *vec,
101 			   size_t veclen, u8 target_node, int *status);
102 
103 int o2net_register_handler(u32 msg_type, u32 key, u32 max_len,
104 			   o2net_msg_handler_func *func, void *data,
105 			   o2net_post_msg_handler_func *post_func,
106 			   struct list_head *unreg_list);
107 void o2net_unregister_handler_list(struct list_head *list);
108 
109 struct o2nm_node;
110 int o2net_register_hb_callbacks(void);
111 void o2net_unregister_hb_callbacks(void);
112 int o2net_start_listening(struct o2nm_node *node);
113 void o2net_stop_listening(struct o2nm_node *node);
114 void o2net_disconnect_node(struct o2nm_node *node);
115 int o2net_num_connected_peers(void);
116 
117 int o2net_init(void);
118 void o2net_exit(void);
119 
120 struct o2net_send_tracking;
121 struct o2net_sock_container;
122 
123 #ifdef CONFIG_DEBUG_FS
124 int o2net_debugfs_init(void);
125 void o2net_debugfs_exit(void);
126 void o2net_debug_add_nst(struct o2net_send_tracking *nst);
127 void o2net_debug_del_nst(struct o2net_send_tracking *nst);
128 void o2net_debug_add_sc(struct o2net_sock_container *sc);
129 void o2net_debug_del_sc(struct o2net_sock_container *sc);
130 #else
131 static inline int o2net_debugfs_init(void)
132 {
133 	return 0;
134 }
135 static inline void o2net_debugfs_exit(void)
136 {
137 }
138 static inline void o2net_debug_add_nst(struct o2net_send_tracking *nst)
139 {
140 }
141 static inline void o2net_debug_del_nst(struct o2net_send_tracking *nst)
142 {
143 }
144 static inline void o2net_debug_add_sc(struct o2net_sock_container *sc)
145 {
146 }
147 static inline void o2net_debug_del_sc(struct o2net_sock_container *sc)
148 {
149 }
150 #endif	/* CONFIG_DEBUG_FS */
151 
152 #endif /* O2CLUSTER_TCP_H */
153