corosync/include/corosync/ipc_cpg.h

/*
 * Copyright (c) 2006-2015 Red Hat, Inc.
 *
 * All rights reserved.
 *
 * Author: Christine Caulfield (ccaulfie@redhat.com)
 * Author: Jan Friesse (jfriesse@redhat.com)
 *
 * This software licensed under BSD license, the text of which follows:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of the MontaVista Software, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef IPC_CPG_H_DEFINED
#define IPC_CPG_H_DEFINED

#include <netinet/in.h>
#include <qb/qbipc_common.h>
#include <corosync/corotypes.h>
#include <corosync/mar_gen.h>

#define CPG_ZC_PATH_LEN				128

/**
 * @brief The req_cpg_types enum
 */
enum req_cpg_types {
	MESSAGE_REQ_CPG_JOIN = 0,
	MESSAGE_REQ_CPG_LEAVE = 1,
	MESSAGE_REQ_CPG_MCAST = 2,
	MESSAGE_REQ_CPG_MEMBERSHIP = 3,
	MESSAGE_REQ_CPG_LOCAL_GET = 4,
	MESSAGE_REQ_CPG_ITERATIONINITIALIZE = 5,
	MESSAGE_REQ_CPG_ITERATIONNEXT = 6,
	MESSAGE_REQ_CPG_ITERATIONFINALIZE = 7,
	MESSAGE_REQ_CPG_FINALIZE = 8,
	MESSAGE_REQ_CPG_ZC_ALLOC = 9,
	MESSAGE_REQ_CPG_ZC_FREE = 10,
	MESSAGE_REQ_CPG_ZC_EXECUTE = 11,
	MESSAGE_REQ_CPG_PARTIAL_MCAST = 12,
};

/**
 * @brief The res_cpg_types enum
 */
enum res_cpg_types {
	MESSAGE_RES_CPG_JOIN = 0,
	MESSAGE_RES_CPG_LEAVE = 1,
	MESSAGE_RES_CPG_MCAST = 2,
	MESSAGE_RES_CPG_MEMBERSHIP = 3,
	MESSAGE_RES_CPG_CONFCHG_CALLBACK = 4,
	MESSAGE_RES_CPG_DELIVER_CALLBACK = 5,
	MESSAGE_RES_CPG_FLOW_CONTROL_STATE_SET = 6,
	MESSAGE_RES_CPG_LOCAL_GET = 7,
	MESSAGE_RES_CPG_FLOWCONTROL_CALLBACK = 8,
	MESSAGE_RES_CPG_ITERATIONINITIALIZE = 9,
	MESSAGE_RES_CPG_ITERATIONNEXT = 10,
	MESSAGE_RES_CPG_ITERATIONFINALIZE = 11,
	MESSAGE_RES_CPG_FINALIZE = 12,
	MESSAGE_RES_CPG_TOTEM_CONFCHG_CALLBACK = 13,
	MESSAGE_RES_CPG_ZC_ALLOC = 14,
	MESSAGE_RES_CPG_ZC_FREE = 15,
	MESSAGE_RES_CPG_ZC_EXECUTE = 16,
	MESSAGE_RES_CPG_PARTIAL_DELIVER_CALLBACK = 17,
	MESSAGE_RES_CPG_PARTIAL_SEND = 18,
};

/**
 * @brief The lib_cpg_confchg_reason enum
 */
enum lib_cpg_confchg_reason {
	CONFCHG_CPG_REASON_JOIN = 1,
	CONFCHG_CPG_REASON_LEAVE = 2,
	CONFCHG_CPG_REASON_NODEDOWN = 3,
	CONFCHG_CPG_REASON_NODEUP = 4,
	CONFCHG_CPG_REASON_PROCDOWN = 5
};

/**
 * @brief The lib_cpg_partial_types enum
 */
enum lib_cpg_partial_types {
	LIBCPG_PARTIAL_FIRST = 1,
	LIBCPG_PARTIAL_CONTINUED = 2,
	LIBCPG_PARTIAL_LAST = 3,
};

/**
 * @brief mar_cpg_name_t struct
 */
typedef struct {
	uint32_t length __attribute__((aligned(8)));
	char value[CPG_MAX_NAME_LENGTH] __attribute__((aligned(8)));
} mar_cpg_name_t;

/**
 * @brief swab_mar_cpg_name_t
 * @param to_swab
 */
static inline void swab_mar_cpg_name_t (mar_cpg_name_t *to_swab)
{
	swab_mar_uint32_t (&to_swab->length);
}

/**
 * @brief marshall_from_mar_cpg_name_t
 * @param dest
 * @param src
 */
static inline void marshall_from_mar_cpg_name_t (
	struct cpg_name *dest,
	const mar_cpg_name_t *src)
{
	dest->length = src->length;
	memcpy (&dest->value, &src->value, CPG_MAX_NAME_LENGTH);
}

/**
 * @brief marshall_to_mar_cpg_name_t
 * @param dest
 * @param src
 */
static inline void marshall_to_mar_cpg_name_t (
	mar_cpg_name_t *dest,
	const struct cpg_name *src)
{
	dest->length = src->length;
	memcpy (&dest->value, &src->value, CPG_MAX_NAME_LENGTH);
}

/**
 * @brief mar_cpg_address_t struct
 */
typedef struct {
        mar_uint32_t nodeid __attribute__((aligned(8)));
        mar_uint32_t pid __attribute__((aligned(8)));
        mar_uint32_t reason __attribute__((aligned(8)));
} mar_cpg_address_t;

/**
 * @brief marshall_from_mar_cpg_address_t
 * @param dest
 * @param src
 */
static inline void marshall_from_mar_cpg_address_t (
	struct cpg_address *dest,
	const mar_cpg_address_t *src)
{
	dest->nodeid = src->nodeid;
	dest->pid = src->pid;
	dest->reason = src->reason;
}

/**
 * @brief marshall_to_mar_cpg_address_t
 * @param dest
 * @param src
 */
static inline void marshall_to_mar_cpg_address_t (
	mar_cpg_address_t *dest,
	const struct cpg_address *src)
{
	dest->nodeid = src->nodeid;
	dest->pid = src->pid;
	dest->reason = src->reason;
}

/**
 * @brief mar_name_compare
 * @param g1
 * @param g2
 * @return
 */
static inline int mar_name_compare (
		const mar_cpg_name_t *g1,
		const mar_cpg_name_t *g2)
{
	return (g1->length == g2->length?
		memcmp (g1->value, g2->value, g1->length):
		g1->length - g2->length);
}

/**
 * @brief mar_cpg_iteration_description_t struct
 */
typedef struct {
	mar_cpg_name_t group;
	mar_uint32_t nodeid;
	mar_uint32_t pid;
} mar_cpg_iteration_description_t;

/**
 * @brief marshall_from_mar_cpg_iteration_description_t
 * @param dest
 * @param src
 */
static inline void marshall_from_mar_cpg_iteration_description_t(
	struct cpg_iteration_description_t *dest,
	const mar_cpg_iteration_description_t *src)
{
	dest->nodeid = src->nodeid;
	dest->pid = src->pid;
	marshall_from_mar_cpg_name_t (&dest->group, &src->group);
};

/**
 * @brief mar_cpg_ring_id_t struct
 */
typedef struct {
        mar_uint32_t nodeid __attribute__((aligned(8)));
        mar_uint64_t seq __attribute__((aligned(8)));
} mar_cpg_ring_id_t;

/**
 * @brief marshall_from_mar_cpg_ring_id_t
 * @param dest
 * @param src
 */
static inline void marshall_from_mar_cpg_ring_id_t (
	struct cpg_ring_id *dest,
	const mar_cpg_ring_id_t *src)
{
	dest->nodeid = src->nodeid;
	dest->seq = src->seq;
}

/**
 * @brief The req_lib_cpg_join struct
 */
struct req_lib_cpg_join {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t pid __attribute__((aligned(8)));
	mar_uint32_t flags __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_join struct
 */
struct res_lib_cpg_join {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_finalize struct
 */
struct req_lib_cpg_finalize {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_finalize struct
 */
struct res_lib_cpg_finalize {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_local_get struct
 */
struct req_lib_cpg_local_get {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_local_get struct
 */
struct res_lib_cpg_local_get {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_uint32_t local_nodeid __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_partial_send struct
 */
struct res_lib_cpg_partial_send {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_mcast struct
 */
struct req_lib_cpg_mcast {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_uint32_t guarantee __attribute__((aligned(8)));
	mar_uint32_t msglen __attribute__((aligned(8)));
	mar_uint8_t message[] __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_partial_mcast struct
 */
struct req_lib_cpg_partial_mcast {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_uint32_t guarantee __attribute__((aligned(8)));
	mar_uint32_t msglen __attribute__((aligned(8)));
	mar_uint32_t fraglen __attribute__((aligned(8)));
	mar_uint32_t type __attribute__((aligned(8)));
	mar_uint8_t message[] __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_mcast struct
 */
struct res_lib_cpg_mcast {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * Message from another node
 */
struct res_lib_cpg_deliver_callback {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t msglen __attribute__((aligned(8)));
	mar_uint32_t nodeid __attribute__((aligned(8)));
	mar_uint32_t pid __attribute__((aligned(8)));
	mar_uint8_t message[] __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_partial_deliver_callback struct
 */
struct res_lib_cpg_partial_deliver_callback {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t msglen __attribute__((aligned(8)));
	mar_uint32_t fraglen __attribute__((aligned(8)));
	mar_uint32_t nodeid __attribute__((aligned(8)));
	mar_uint32_t pid __attribute__((aligned(8)));
	mar_uint32_t type __attribute__((aligned(8)));
	mar_uint8_t message[] __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_flowcontrol_callback struct
 */
struct res_lib_cpg_flowcontrol_callback {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_uint32_t flow_control_state __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_membership_get struct
 */
struct req_lib_cpg_membership_get {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_membership_get struct
 */
struct res_lib_cpg_membership_get {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_uint32_t member_count __attribute__((aligned(8)));
	mar_cpg_address_t member_list[PROCESSOR_COUNT_MAX];
};

/**
 * @brief The res_lib_cpg_confchg_callback struct
 */
struct res_lib_cpg_confchg_callback {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t member_list_entries __attribute__((aligned(8)));
	mar_uint32_t joined_list_entries __attribute__((aligned(8)));
	mar_uint32_t left_list_entries __attribute__((aligned(8)));
	mar_cpg_address_t member_list[];
//	struct cpg_address left_list[];
//	struct cpg_address joined_list[];
};

/**
 * @brief The res_lib_cpg_totem_confchg_callback struct
 */
struct res_lib_cpg_totem_confchg_callback {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_cpg_ring_id_t ring_id __attribute__((aligned(8)));
	mar_uint32_t member_list_entries __attribute__((aligned(8)));
	mar_uint32_t member_list[];
};

/**
 * @brief The req_lib_cpg_leave struct
 */
struct req_lib_cpg_leave {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t pid __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_leave struct
 */
struct res_lib_cpg_leave {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_iterationinitialize struct
 */
struct req_lib_cpg_iterationinitialize {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	mar_cpg_name_t group_name __attribute__((aligned(8)));
	mar_uint32_t iteration_type __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_iterationinitialize struct
 */
struct res_lib_cpg_iterationinitialize {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	hdb_handle_t iteration_handle __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_iterationnext struct
 */
struct req_lib_cpg_iterationnext {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	hdb_handle_t iteration_handle __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_iterationnext struct
 */
struct res_lib_cpg_iterationnext {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
	mar_cpg_iteration_description_t description __attribute__((aligned(8)));
};

/**
 * @brief The req_lib_cpg_iterationfinalize struct
 */
struct req_lib_cpg_iterationfinalize {
	struct qb_ipc_request_header header __attribute__((aligned(8)));
	hdb_handle_t iteration_handle __attribute__((aligned(8)));
};

/**
 * @brief The res_lib_cpg_iterationfinalize struct
 */
struct res_lib_cpg_iterationfinalize {
	struct qb_ipc_response_header header __attribute__((aligned(8)));
};

/**
 * @brief mar_req_coroipcc_zc_alloc_t struct
 */
typedef struct {
        struct qb_ipc_request_header header __attribute__((aligned(8)));
        size_t map_size __attribute__((aligned(8)));
        char path_to_file[CPG_ZC_PATH_LEN] __attribute__((aligned(8)));
} mar_req_coroipcc_zc_alloc_t __attribute__((aligned(8)));

/**
 * @brief mar_req_coroipcc_zc_free_t struct
 */
typedef struct {
        struct qb_ipc_request_header header __attribute__((aligned(8)));
        size_t map_size __attribute__((aligned(8)));
	uint64_t server_address __attribute__((aligned(8)));
} mar_req_coroipcc_zc_free_t __attribute__((aligned(8)));

/**
 * @brief mar_req_coroipcc_zc_execute_t struct
 */
typedef struct {
        struct qb_ipc_request_header header __attribute__((aligned(8)));
	uint64_t server_address __attribute__((aligned(8)));
} mar_req_coroipcc_zc_execute_t __attribute__((aligned(8)));

/**
 * @brief coroipcs_zc_header struct
 */
struct coroipcs_zc_header {
	int map_size;
	uint64_t server_address;
};
#endif /* IPC_CPG_H_DEFINED */