corosync  3.0.3
cpg.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006-2019 Red Hat, Inc.
3  *
4  * All rights reserved.
5  *
6  * Author: Christine Caulfield (ccaulfi@redhat.com)
7  * Author: Jan Friesse (jfriesse@redhat.com)
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 COROSYNC_CPG_H_DEFINED
36 #define COROSYNC_CPG_H_DEFINED
37 
38 #include <netinet/in.h>
39 #include <corosync/corotypes.h>
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
53 typedef uint64_t cpg_handle_t;
54 
58 typedef uint64_t cpg_iteration_handle_t;
59 
63 typedef enum {
69 
73 typedef enum {
77 
78 
82 typedef enum {
89 } cpg_reason_t;
90 
94 typedef enum {
99 
103 typedef enum {
105 } cpg_model_t;
106 
110 struct cpg_address {
111  uint32_t nodeid;
112  uint32_t pid;
113  uint32_t reason;
114 };
115 
116 #define CPG_MAX_NAME_LENGTH 128
117 
120 struct cpg_name {
121  uint32_t length;
123 };
124 
125 #define CPG_MEMBERS_MAX 128
126 
131  struct cpg_name group;
132  uint32_t nodeid;
133  uint32_t pid;
134 };
135 
139 struct cpg_ring_id {
140  uint32_t nodeid;
141  uint64_t seq;
142 };
143 
147 typedef void (*cpg_deliver_fn_t) (
148  cpg_handle_t handle,
149  const struct cpg_name *group_name,
150  uint32_t nodeid,
151  uint32_t pid,
156  void *msg,
157  size_t msg_len);
158 
162 typedef void (*cpg_confchg_fn_t) (
163  cpg_handle_t handle,
164  const struct cpg_name *group_name,
165  const struct cpg_address *member_list, size_t member_list_entries,
166  const struct cpg_address *left_list, size_t left_list_entries,
167  const struct cpg_address *joined_list, size_t joined_list_entries);
168 
172 typedef void (*cpg_totem_confchg_fn_t) (
173  cpg_handle_t handle,
174  struct cpg_ring_id ring_id,
175  uint32_t member_list_entries,
176  const uint32_t *member_list);
177 
181 typedef struct {
185 
189 typedef struct {
192 
193 #define CPG_MODEL_V1_DELIVER_INITIAL_TOTEM_CONF 0x01
194 
198 typedef struct {
203  unsigned int flags;
205 
206 
216  cpg_handle_t *handle,
217  cpg_callbacks_t *callbacks);
218 
228  cpg_handle_t *handle,
229  cpg_model_t model,
230  cpg_model_data_t *model_data,
231  void *context);
232 
239  cpg_handle_t handle);
240 
251  cpg_handle_t handle,
252  int *fd);
253 
261  cpg_handle_t handle,
262  uint32_t *size);
263 
271  cpg_handle_t handle,
272  void **context);
273 
281  cpg_handle_t handle,
282  void *context);
283 
291  cpg_handle_t handle,
292  cs_dispatch_flags_t dispatch_types);
293 
306  cpg_handle_t handle,
307  const struct cpg_name *group);
308 
316  cpg_handle_t handle,
317  const struct cpg_name *group);
318 
329  cpg_handle_t handle,
331  const struct iovec *iovec,
332  unsigned int iov_len);
333 
343  cpg_handle_t handle,
344  struct cpg_name *groupName,
345  struct cpg_address *member_list,
346  int *member_list_entries);
354  cpg_handle_t handle,
355  unsigned int *local_nodeid);
356 
364  cpg_handle_t handle,
365  cpg_flow_control_state_t *flow_control_enabled);
366 
375  cpg_handle_t handle,
376  size_t size,
377  void **buffer);
378 
386  cpg_handle_t handle,
387  void *buffer);
388 
398  cpg_handle_t handle,
400  void *msg,
401  size_t msg_len);
402 
412  cpg_handle_t handle,
413  cpg_iteration_type_t iteration_type,
414  const struct cpg_name *group,
415  cpg_iteration_handle_t *cpg_iteration_handle);
416 
424  cpg_iteration_handle_t handle,
425  struct cpg_iteration_description_t *description);
426 
433  cpg_iteration_handle_t handle);
434 
435 #ifdef __cplusplus
436 }
437 #endif
438 
439 #endif /* COROSYNC_CPG_H_DEFINED */
CPG_REASON_NODEUP
@ CPG_REASON_NODEUP
Definition: cpg.h:87
cpg_ring_id::seq
uint64_t seq
Definition: cpg.h:141
cpg_model_data_t::model
cpg_model_t model
Definition: cpg.h:190
cpg_guarantee_t
cpg_guarantee_t
The cpg_guarantee_t enum.
Definition: cpg.h:63
cpg_join
cs_error_t cpg_join(cpg_handle_t handle, const struct cpg_name *group)
Join one or more groups.
Definition: lib/cpg.c:644
CPG_TYPE_FIFO
@ CPG_TYPE_FIFO
same as agreed
Definition: cpg.h:65
cpg_iteration_description_t
The cpg_iteration_description_t struct.
Definition: cpg.h:130
CPG_TYPE_SAFE
@ CPG_TYPE_SAFE
not implemented
Definition: cpg.h:67
CPG_REASON_NODEDOWN
@ CPG_REASON_NODEDOWN
Definition: cpg.h:86
CPG_FLOW_CONTROL_ENABLED
@ CPG_FLOW_CONTROL_ENABLED
flow control is enabled - new messages should not be sent
Definition: cpg.h:75
cpg_model_v1_data_t::model
cpg_model_t model
Definition: cpg.h:199
cpg_reason_t
cpg_reason_t
The cpg_reason_t enum.
Definition: cpg.h:82
cpg_callbacks_t::cpg_deliver_fn
cpg_deliver_fn_t cpg_deliver_fn
Definition: cpg.h:182
CPG_REASON_UNDEFINED
@ CPG_REASON_UNDEFINED
Definition: cpg.h:83
cpg_totem_confchg_fn_t
void(* cpg_totem_confchg_fn_t)(cpg_handle_t handle, struct cpg_ring_id ring_id, uint32_t member_list_entries, const uint32_t *member_list)
The cpg_totem_confchg_fn_t callback.
Definition: cpg.h:172
cpg_confchg_fn_t
void(* cpg_confchg_fn_t)(cpg_handle_t handle, const struct cpg_name *group_name, const struct cpg_address *member_list, size_t member_list_entries, const struct cpg_address *left_list, size_t left_list_entries, const struct cpg_address *joined_list, size_t joined_list_entries)
The cpg_confchg_fn_t callback.
Definition: cpg.h:162
cpg_model_data_t
The cpg_model_data_t struct.
Definition: cpg.h:189
CPG_REASON_JOIN
@ CPG_REASON_JOIN
Definition: cpg.h:84
cpg_ring_id
The cpg_ring_id struct.
Definition: cpg.h:139
cpg_finalize
cs_error_t cpg_finalize(cpg_handle_t handle)
Close the cpg handle.
Definition: lib/cpg.c:249
cs_dispatch_flags_t
cs_dispatch_flags_t
The cs_dispatch_flags_t enum.
Definition: corotypes.h:83
cpg_leave
cs_error_t cpg_leave(cpg_handle_t handle, const struct cpg_name *group)
Leave one or more groups.
Definition: lib/cpg.c:698
cpg_name::value
char value[CPG_MAX_NAME_LENGTH]
Definition: cpg.h:122
CPG_ITERATION_NAME_ONLY
@ CPG_ITERATION_NAME_ONLY
Definition: cpg.h:95
cpg_address::reason
uint32_t reason
Definition: cpg.h:113
cpg_model_initialize
cs_error_t cpg_model_initialize(cpg_handle_t *handle, cpg_model_t model, cpg_model_data_t *model_data, void *context)
Create a new cpg connection, initialize with model.
Definition: lib/cpg.c:185
CPG_TYPE_UNORDERED
@ CPG_TYPE_UNORDERED
not implemented
Definition: cpg.h:64
cpg_iteration_description_t::pid
uint32_t pid
Definition: cpg.h:133
cpg_context_get
cs_error_t cpg_context_get(cpg_handle_t handle, void **context)
Get contexts for a CPG handle.
Definition: lib/cpg.c:332
CPG_MAX_NAME_LENGTH
#define CPG_MAX_NAME_LENGTH
Definition: cpg.h:116
cpg_max_atomic_msgsize_get
cs_error_t cpg_max_atomic_msgsize_get(cpg_handle_t handle, uint32_t *size)
Get maximum size of a message that will not be fragmented.
Definition: lib/cpg.c:313
cpg_initialize
cs_error_t cpg_initialize(cpg_handle_t *handle, cpg_callbacks_t *callbacks)
Create a new cpg connection.
Definition: lib/cpg.c:169
cpg_iteration_initialize
cs_error_t cpg_iteration_initialize(cpg_handle_t handle, cpg_iteration_type_t iteration_type, const struct cpg_name *group, cpg_iteration_handle_t *cpg_iteration_handle)
cpg_iteration_initialize
Definition: lib/cpg.c:1240
CPG_TYPE_AGREED
@ CPG_TYPE_AGREED
Definition: cpg.h:66
cpg_iteration_next
cs_error_t cpg_iteration_next(cpg_iteration_handle_t handle, struct cpg_iteration_description_t *description)
cpg_iteration_next
Definition: lib/cpg.c:1333
cs_error_t
cs_error_t
The cs_error_t enum.
Definition: corotypes.h:97
cpg_zcb_free
cs_error_t cpg_zcb_free(cpg_handle_t handle, void *buffer)
cpg_zcb_free
Definition: lib/cpg.c:1001
cpg_callbacks_t::cpg_confchg_fn
cpg_confchg_fn_t cpg_confchg_fn
Definition: cpg.h:183
cpg_model_v1_data_t::cpg_confchg_fn
cpg_confchg_fn_t cpg_confchg_fn
Definition: cpg.h:201
cpg_flow_control_state_t
cpg_flow_control_state_t
The cpg_flow_control_state_t enum.
Definition: cpg.h:73
cpg_model_v1_data_t::cpg_totem_confchg_fn
cpg_totem_confchg_fn_t cpg_totem_confchg_fn
Definition: cpg.h:202
cpg_model_v1_data_t::cpg_deliver_fn
cpg_deliver_fn_t cpg_deliver_fn
Definition: cpg.h:200
CPG_REASON_PROCDOWN
@ CPG_REASON_PROCDOWN
Definition: cpg.h:88
cpg_flow_control_state_get
cs_error_t cpg_flow_control_state_get(cpg_handle_t handle, cpg_flow_control_state_t *flow_control_enabled)
cpg_flow_control_state_get
Definition: lib/cpg.c:844
cpg_iteration_handle_t
uint64_t cpg_iteration_handle_t
cpg_iteration_handle_t
Definition: cpg.h:58
cpg_context_set
cs_error_t cpg_context_set(cpg_handle_t handle, void *context)
Set contexts for a CPG handle.
Definition: lib/cpg.c:351
cpg_handle_t
uint64_t cpg_handle_t
cpg_handle_t
Definition: cpg.h:53
cpg_model_t
cpg_model_t
The cpg_model_t enum.
Definition: cpg.h:103
cpg_local_get
cs_error_t cpg_local_get(cpg_handle_t handle, unsigned int *local_nodeid)
cpg_local_get
Definition: lib/cpg.c:806
cpg_address::pid
uint32_t pid
Definition: cpg.h:112
CPG_MODEL_V1
@ CPG_MODEL_V1
Definition: cpg.h:104
CPG_REASON_LEAVE
@ CPG_REASON_LEAVE
Definition: cpg.h:85
cpg_membership_get
cs_error_t cpg_membership_get(cpg_handle_t handle, struct cpg_name *groupName, struct cpg_address *member_list, int *member_list_entries)
Get membership information from cpg.
Definition: lib/cpg.c:743
cpg_address
The cpg_address struct.
Definition: cpg.h:110
cpg_iteration_finalize
cs_error_t cpg_iteration_finalize(cpg_iteration_handle_t handle)
cpg_iteration_finalize
Definition: lib/cpg.c:1383
nodeid
unsigned int nodeid
Definition: coroapi.h:75
CPG_ITERATION_ALL
@ CPG_ITERATION_ALL
Definition: cpg.h:97
cpg_name
The cpg_name struct.
Definition: cpg.h:120
cpg_fd_get
cs_error_t cpg_fd_get(cpg_handle_t handle, int *fd)
Get a file descriptor on which to poll.
Definition: lib/cpg.c:294
cpg_model_v1_data_t
The cpg_model_v1_data_t struct.
Definition: cpg.h:198
ring_id
struct memb_ring_id ring_id
Definition: totemsrp.c:6
cpg_address::nodeid
uint32_t nodeid
Definition: cpg.h:111
cpg_name::length
uint32_t length
Definition: cpg.h:121
cpg_iteration_type_t
cpg_iteration_type_t
The cpg_iteration_type_t enum.
Definition: cpg.h:94
cpg_zcb_alloc
cs_error_t cpg_zcb_alloc(cpg_handle_t handle, size_t size, void **buffer)
cpg_zcb_alloc
Definition: lib/cpg.c:944
corotypes.h
cpg_zcb_mcast_joined
cs_error_t cpg_zcb_mcast_joined(cpg_handle_t handle, cpg_guarantee_t guarantee, void *msg, size_t msg_len)
cpg_zcb_mcast_joined
Definition: lib/cpg.c:1050
cpg_deliver_fn_t
void(* cpg_deliver_fn_t)(cpg_handle_t handle, const struct cpg_name *group_name, uint32_t nodeid, uint32_t pid, void *msg, size_t msg_len)
The cpg_deliver_fn_t callback.
Definition: cpg.h:147
cpg_model_v1_data_t::flags
unsigned int flags
Definition: cpg.h:203
guarantee
int guarantee
Definition: totemsrp.c:8
cpg_mcast_joined
cs_error_t cpg_mcast_joined(cpg_handle_t handle, cpg_guarantee_t guarantee, const struct iovec *iovec, unsigned int iov_len)
Multicast to groups joined with cpg_join.
Definition: lib/cpg.c:1192
CPG_FLOW_CONTROL_DISABLED
@ CPG_FLOW_CONTROL_DISABLED
flow control is disabled - new messages may be sent
Definition: cpg.h:74
cpg_iteration_description_t::group
struct cpg_name group
Definition: cpg.h:131
cpg_ring_id::nodeid
uint32_t nodeid
Definition: cpg.h:140
cpg_callbacks_t
The cpg_callbacks_t struct.
Definition: cpg.h:181
cpg_iteration_description_t::nodeid
uint32_t nodeid
Definition: cpg.h:132
cpg_dispatch
cs_error_t cpg_dispatch(cpg_handle_t handle, cs_dispatch_flags_t dispatch_types)
Dispatch messages and configuration changes.
Definition: lib/cpg.c:370
CPG_ITERATION_ONE_GROUP
@ CPG_ITERATION_ONE_GROUP
Definition: cpg.h:96