corosync  2.3.5
cpg.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006-2011 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 
50 typedef uint64_t cpg_handle_t;
51 
52 typedef uint64_t cpg_iteration_handle_t;
53 
54 typedef enum {
60 
61 typedef enum {
65 
66 
67 typedef enum {
73 } cpg_reason_t;
74 
75 typedef enum {
80 
81 typedef enum {
83 } cpg_model_t;
84 
85 struct cpg_address {
86  uint32_t nodeid;
87  uint32_t pid;
88  uint32_t reason;
89 };
90 
91 #define CPG_MAX_NAME_LENGTH 128
92 struct cpg_name {
93  uint32_t length;
95 };
96 
97 #define CPG_MEMBERS_MAX 128
98 
100  struct cpg_name group;
101  uint32_t nodeid;
102  uint32_t pid;
103 };
104 
105 struct cpg_ring_id {
106  uint32_t nodeid;
107  uint64_t seq;
108 };
109 
110 typedef void (*cpg_deliver_fn_t) (
111  cpg_handle_t handle,
112  const struct cpg_name *group_name,
113  uint32_t nodeid,
114  uint32_t pid,
119  void *msg,
120  size_t msg_len);
121 
122 typedef void (*cpg_confchg_fn_t) (
123  cpg_handle_t handle,
124  const struct cpg_name *group_name,
125  const struct cpg_address *member_list, size_t member_list_entries,
126  const struct cpg_address *left_list, size_t left_list_entries,
127  const struct cpg_address *joined_list, size_t joined_list_entries);
128 
129 typedef void (*cpg_totem_confchg_fn_t) (
130  cpg_handle_t handle,
131  struct cpg_ring_id ring_id,
132  uint32_t member_list_entries,
133  const uint32_t *member_list);
134 
135 typedef struct {
139 
140 typedef struct {
143 
144 #define CPG_MODEL_V1_DELIVER_INITIAL_TOTEM_CONF 0x01
145 
146 typedef struct {
151  unsigned int flags;
153 
154 
161  cpg_handle_t *handle,
162  cpg_callbacks_t *callbacks);
163 
168  cpg_handle_t *handle,
169  cpg_model_t model,
170  cpg_model_data_t *model_data,
171  void *context);
172 
177  cpg_handle_t handle);
178 
185  cpg_handle_t handle,
186  int *fd);
187 
192  cpg_handle_t handle,
193  uint32_t *size);
194 
199  cpg_handle_t handle,
200  void **context);
201 
206  cpg_handle_t handle,
207  void *context);
208 
209 
214  cpg_handle_t handle,
215  cs_dispatch_flags_t dispatch_types);
216 
225  cpg_handle_t handle,
226  const struct cpg_name *group);
227 
232  cpg_handle_t handle,
233  const struct cpg_name *group);
234 
245  cpg_handle_t handle,
247  const struct iovec *iovec,
248  unsigned int iov_len);
249 
254  cpg_handle_t handle,
255  struct cpg_name *groupName,
256  struct cpg_address *member_list,
257  int *member_list_entries);
258 
260  cpg_handle_t handle,
261  unsigned int *local_nodeid);
262 
264  cpg_handle_t handle,
265  cpg_flow_control_state_t *flow_control_enabled);
266 
268  cpg_handle_t handle,
269  size_t size,
270  void **buffer);
271 
273  cpg_handle_t handle,
274  void *buffer);
275 
277  cpg_handle_t handle,
279  void *msg,
280  size_t msg_len);
281 
286  cpg_handle_t handle,
287  cpg_iteration_type_t iteration_type,
288  const struct cpg_name *group,
289  cpg_iteration_handle_t *cpg_iteration_handle);
290 
292  cpg_iteration_handle_t handle,
293  struct cpg_iteration_description_t *description);
294 
296  cpg_iteration_handle_t handle);
297 
298 #ifdef __cplusplus
299 }
300 #endif
301 
302 #endif /* COROSYNC_CPG_H_DEFINED */
uint32_t pid
Definition: cpg.h:87
cs_error_t cpg_iteration_next(cpg_iteration_handle_t handle, struct cpg_iteration_description_t *description)
Definition: lib/cpg.c:1262
cs_error_t cpg_flow_control_state_get(cpg_handle_t handle, cpg_flow_control_state_t *flow_control_enabled)
Definition: lib/cpg.c:789
#define CPG_MAX_NAME_LENGTH
Definition: cpg.h:91
cpg_deliver_fn_t cpg_deliver_fn
Definition: cpg.h:148
cpg_flow_control_state_t
Definition: cpg.h:61
cs_error_t cpg_context_set(cpg_handle_t handle, void *context)
Set contexts for a CPG handle.
Definition: lib/cpg.c:348
cpg_confchg_fn_t cpg_confchg_fn
Definition: cpg.h:137
Definition: cpg.h:92
cs_error_t cpg_local_get(cpg_handle_t handle, unsigned int *local_nodeid)
Definition: lib/cpg.c:751
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:688
cs_error_t cpg_iteration_finalize(cpg_iteration_handle_t handle)
Definition: lib/cpg.c:1312
int guarantee
Definition: totemsrp.c:66
cpg_guarantee_t
Definition: cpg.h:54
cpg_confchg_fn_t cpg_confchg_fn
Definition: cpg.h:149
cpg_reason_t
Definition: cpg.h:67
cs_error_t cpg_fd_get(cpg_handle_t handle, int *fd)
Get a file descriptor on which to poll.
Definition: lib/cpg.c:291
cpg_model_t model
Definition: cpg.h:147
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)
Definition: cpg.h:122
cs_error_t cpg_zcb_alloc(cpg_handle_t handle, size_t size, void **buffer)
Definition: lib/cpg.c:887
cpg_totem_confchg_fn_t cpg_totem_confchg_fn
Definition: cpg.h:150
unsigned int flags
Definition: cpg.h:151
cs_error_t cpg_zcb_mcast_joined(cpg_handle_t handle, cpg_guarantee_t guarantee, void *msg, size_t msg_len)
Definition: lib/cpg.c:979
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)
Definition: cpg.h:129
not implemented
Definition: cpg.h:58
uint64_t cpg_handle_t
Definition: cpg.h:50
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:1121
cs_error_t
Definition: corotypes.h:78
char value[CPG_MAX_NAME_LENGTH]
Definition: cpg.h:94
cs_error_t cpg_dispatch(cpg_handle_t handle, cs_dispatch_flags_t dispatch_types)
Dispatch messages and configuration changes.
Definition: lib/cpg.c:367
cs_dispatch_flags_t
Definition: corotypes.h:67
struct cpg_name group
Definition: cpg.h:100
uint32_t nodeid
Definition: cpg.h:86
cs_error_t cpg_join(cpg_handle_t handle, const struct cpg_name *group)
Join one or more groups.
Definition: lib/cpg.c:589
uint32_t nodeid
Definition: cpg.h:106
not implemented
Definition: cpg.h:55
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)
Definition: cpg.h:110
cpg_model_t model
Definition: cpg.h:141
cpg_iteration_type_t
Definition: cpg.h:75
flow control is enabled - new messages should not be sent
Definition: cpg.h:63
flow control is disabled - new messages may be sent
Definition: cpg.h:62
cs_error_t cpg_finalize(cpg_handle_t handle)
Close the cpg handle.
Definition: lib/cpg.c:246
uint32_t reason
Definition: cpg.h:88
cs_error_t cpg_leave(cpg_handle_t handle, const struct cpg_name *group)
Leave one or more groups.
Definition: lib/cpg.c:643
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:184
cs_error_t cpg_context_get(cpg_handle_t handle, void **context)
Get contexts for a CPG handle.
Definition: lib/cpg.c:329
uint64_t cpg_iteration_handle_t
Definition: cpg.h:52
uint32_t length
Definition: cpg.h:93
cs_error_t cpg_initialize(cpg_handle_t *handle, cpg_callbacks_t *callbacks)
Create a new cpg connection.
Definition: lib/cpg.c:168
cpg_model_t
Definition: cpg.h:81
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)
Iteration.
Definition: lib/cpg.c:1169
unsigned int nodeid
Definition: coroapi.h:65
struct memb_ring_id ring_id
Definition: totemsrp.c:64
same as agreed
Definition: cpg.h:56
uint64_t seq
Definition: cpg.h:107
cpg_deliver_fn_t cpg_deliver_fn
Definition: cpg.h:136
cs_error_t cpg_zcb_free(cpg_handle_t handle, void *buffer)
Definition: lib/cpg.c:941
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:310