corosync  2.3.2
totem.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005 MontaVista Software, Inc.
3  * Copyright (c) 2006-2012 Red Hat, Inc.
4  *
5  * Author: Steven Dake (sdake@redhat.com)
6  *
7  * All rights reserved.
8  *
9  * This software licensed under BSD license, the text of which follows:
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * - Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * - Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  * - Neither the name of the MontaVista Software, Inc. nor the names of its
20  * contributors may be used to endorse or promote products derived from this
21  * software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
33  * THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 #ifndef TOTEM_H_DEFINED
36 #define TOTEM_H_DEFINED
37 #include "totemip.h"
38 #include <corosync/hdb.h>
39 
40 #ifdef HAVE_SMALL_MEMORY_FOOTPRINT
41 #define PROCESSOR_COUNT_MAX 16
42 #define MESSAGE_SIZE_MAX 1024*64
43 #define MESSAGE_QUEUE_MAX 512
44 #else
45 #define PROCESSOR_COUNT_MAX 384
46 #define MESSAGE_SIZE_MAX 1024*1024 /* (1MB) */
47 #define MESSAGE_QUEUE_MAX ((4 * MESSAGE_SIZE_MAX) / totem_config->net_mtu)
48 #endif /* HAVE_SMALL_MEMORY_FOOTPRINT */
49 
50 #define FRAME_SIZE_MAX 10000
51 #define TRANSMITS_ALLOWED 16
52 #define SEND_THREADS_MAX 16
53 #define INTERFACE_MAX 2
54 
58 #define MAX_NO_CONT_GATHER 3
59 /*
60  * Maximum number of continuous failures get from sendmsg call
61  */
62 #define MAX_NO_CONT_SENDMSG_FAILURES 30
63 
68  uint16_t ip_port;
69  uint16_t ttl;
72 };
73 
75  void (*log_printf) (
76  int level,
77  int subsys,
78  const char *function_name,
79  const char *file_name,
80  int file_line,
81  const char *format,
82  ...) __attribute__((format(printf, 6, 7)));
83 
91 };
92 
93 enum { TOTEM_PRIVATE_KEY_LEN = 128 };
94 enum { TOTEM_RRP_MODE_BYTES = 64 };
95 
96 typedef enum {
101 
102 struct totem_config {
103  int version;
104 
105  /*
106  * network
107  */
109  unsigned int interface_count;
110  unsigned int node_id;
111  unsigned int clear_node_high_bit;
112 
113  /*
114  * key information
115  */
117 
118  unsigned int private_key_len;
119 
120  /*
121  * Totem configuration parameters
122  */
123  unsigned int token_timeout;
124 
126 
127  unsigned int token_hold_timeout;
128 
130 
131  unsigned int join_timeout;
132 
133  unsigned int send_join_timeout;
134 
135  unsigned int consensus_timeout;
136 
137  unsigned int merge_timeout;
138 
139  unsigned int downcheck_timeout;
140 
141  unsigned int fail_to_recv_const;
142 
143  unsigned int seqno_unchanged_const;
144 
146 
148 
150 
152 
154 
156 
158 
159  unsigned int net_mtu;
160 
161  unsigned int threads;
162 
164 
165  unsigned int max_network_delay;
166 
167  unsigned int window_size;
168 
169  unsigned int max_messages;
170 
171  const char *vsf_type;
172 
173  unsigned int broadcast_use;
174 
176 
178 
180 
181  unsigned int miss_count_const;
182 
184 };
185 
186 #define TOTEM_CONFIGURATION_TYPE
190 };
191 
192 #define TOTEM_CALLBACK_TOKEN_TYPE
196 };
197 
201 };
202 
203 #define MEMB_RING_ID
204 struct memb_ring_id {
205  struct totem_ip_address rep;
206  unsigned long long seq;
207 } __attribute__((packed));
208 
209 typedef struct {
210  int is_dirty;
211  time_t last_updated;
213 
214 typedef struct {
216  uint32_t iface_changes;
218 
219 typedef struct {
222  char *algo_name;
223  uint8_t *faulty;
224  uint32_t interface_count;
226 
227 
228 typedef struct {
229  uint32_t rx;
230  uint32_t tx;
233 
234 typedef struct {
237  uint64_t orf_token_tx;
238  uint64_t orf_token_rx;
241  uint64_t memb_join_tx;
242  uint64_t memb_join_rx;
243  uint64_t mcast_tx;
244  uint64_t mcast_retx;
245  uint64_t mcast_rx;
252  uint64_t gather_entered;
254  uint64_t commit_entered;
259  uint64_t rx_msg_dropped;
262 
265 #define TOTEM_TOKEN_STATS_MAX 100
267 
269 
270 
271  #define TOTEM_CONFIGURATION_TYPE
272 
273 typedef struct {
277 
278 typedef struct {
281  uint32_t msg_reserved;
282  uint32_t msg_queue_avail;
284 
285 #endif /* TOTEM_H_DEFINED */
unsigned int clear_node_high_bit
Definition: totem.h:111
void(*) in log_level_security)
Definition: totem.h:82
uint64_t gather_entered
Definition: totem.h:252
uint64_t memb_commit_token_rx
Definition: totem.h:247
const char * vsf_type
Definition: totem.h:171
struct totem_interface * interfaces
Definition: totem.h:108
unsigned int interface_count
Definition: totem.h:109
uint64_t memb_join_tx
Definition: totem.h:241
totem_transport_t transport_number
Definition: totem.h:179
uint64_t mcast_rx
Definition: totem.h:245
totem_transport_t
Definition: totem.h:96
unsigned int token_hold_timeout
Definition: totem.h:127
int member_count
Definition: totem.h:70
struct totem_ip_address member_list[PROCESSOR_COUNT_MAX]
Definition: totem.h:71
totem_stats_header_t hdr
Definition: totem.h:235
totem_configuration_type
Definition: coroapi.h:110
totem_stats_header_t hdr
Definition: totem.h:215
unsigned char private_key[TOTEM_PRIVATE_KEY_LEN]
Definition: totem.h:116
char rrp_mode[TOTEM_RRP_MODE_BYTES]
Definition: totem.h:155
uint64_t memb_merge_detect_rx
Definition: totem.h:240
unsigned int rrp_problem_count_timeout
Definition: totem.h:147
int earliest_token
Definition: totem.h:263
uint64_t orf_token_tx
Definition: totem.h:237
uint64_t gather_token_lost
Definition: totem.h:253
unsigned int downcheck_timeout
Definition: totem.h:139
unsigned int private_key_len
Definition: totem.h:118
uint64_t memb_commit_token_tx
Definition: totem.h:246
unsigned int max_network_delay
Definition: totem.h:165
unsigned int heartbeat_failures_allowed
Definition: totem.h:163
time_t last_updated
Definition: totem.h:211
#define TOTEM_TOKEN_STATS_MAX
Definition: totem.h:265
unsigned int send_join_timeout
Definition: totem.h:133
unsigned int window_size
Definition: totem.h:167
unsigned int rrp_problem_count_threshold
Definition: totem.h:149
char * algo_name
Definition: totem.h:222
uint64_t operational_entered
Definition: totem.h:250
int latest_token
Definition: totem.h:264
uint64_t operational_token_lost
Definition: totem.h:251
uint64_t consensus_timeouts
Definition: totem.h:258
uint16_t ttl
Definition: totem.h:69
unsigned int node_id
Definition: totem.h:110
uint64_t recovery_token_lost
Definition: totem.h:257
unsigned int token_retransmits_before_loss_const
Definition: totem.h:129
unsigned int seqno_unchanged_const
Definition: totem.h:143
uint64_t commit_token_lost
Definition: totem.h:255
unsigned int miss_count_const
Definition: totem.h:181
uint64_t token_hold_cancel_rx
Definition: totem.h:249
unsigned int join_timeout
Definition: totem.h:131
char * crypto_hash_type
Definition: totem.h:177
struct totem_ip_address mcast_addr
Definition: totem.h:67
unsigned int rrp_autorecovery_check_timeout
Definition: totem.h:153
uint64_t mcast_retx
Definition: totem.h:244
void(* log_printf)(int level, int subsys, const char *function_name, const char *file_name, int file_line, const char *format,...) __attribute__((format(printf
Definition: totem.h:75
unsigned int fail_to_recv_const
Definition: totem.h:141
totemmrp_stats_t * mrp
Definition: totem.h:280
struct totem_ip_address boundto
Definition: totem.h:66
#define PROCESSOR_COUNT_MAX
Definition: totem.h:45
uint32_t msg_queue_avail
Definition: totem.h:282
totem_event_type
Definition: totem.h:198
uint64_t rx_msg_dropped
Definition: totem.h:259
uint16_t ip_port
Definition: totem.h:68
uint32_t iface_changes
Definition: totem.h:216
int version
Definition: totem.h:103
uint32_t continuous_gather
Definition: totem.h:260
totemrrp_stats_t * rrp
Definition: totem.h:236
unsigned int net_mtu
Definition: totem.h:159
totemnet_stats_t * net
Definition: totem.h:221
uint64_t token_hold_cancel_tx
Definition: totem.h:248
int ip_version
Definition: totem.h:183
unsigned int token_timeout
Definition: totem.h:123
unsigned int consensus_timeout
Definition: totem.h:135
uint64_t mcast_tx
Definition: totem.h:243
unsigned int broadcast_use
Definition: totem.h:173
uint64_t memb_merge_detect_tx
Definition: totem.h:239
uint32_t msg_reserved
Definition: totem.h:281
totem_stats_header_t hdr
Definition: totem.h:279
totemsrp_stats_t * srp
Definition: totem.h:275
unsigned int rrp_problem_count_mcast_threshold
Definition: totem.h:151
uint64_t memb_join_rx
Definition: totem.h:242
totem_stats_header_t hdr
Definition: totem.h:220
typedef __attribute__
unsigned long long seq
Definition: coroapi.h:105
unsigned int max_messages
Definition: totem.h:169
uint64_t recovery_entered
Definition: totem.h:256
char * crypto_cipher_type
Definition: totem.h:175
unsigned int merge_timeout
Definition: totem.h:137
uint32_t interface_count
Definition: totem.h:224
unsigned int token_retransmit_timeout
Definition: totem.h:125
struct totem_ip_address bindnet
Definition: totem.h:65
uint32_t continuous_sendmsg_failures
Definition: totem.h:261
uint8_t * faulty
Definition: totem.h:223
totem_stats_header_t hdr
Definition: totem.h:274
uint64_t commit_entered
Definition: totem.h:254
unsigned int rrp_token_expired_timeout
Definition: totem.h:145
uint64_t orf_token_rx
Definition: totem.h:238
unsigned int threads
Definition: totem.h:161
totem_callback_token_type
Definition: coroapi.h:117