coroapi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2012 Red Hat, Inc.
 *
 * All rights reserved.
 *
 * Author: Steven Dake (sdake@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 COROAPI_H_DEFINED
#define COROAPI_H_DEFINED

#include <config.h>

#include <stdio.h>
#ifdef HAVE_SYS_UIO_H
#include <sys/uio.h>
#endif
#include <corosync/hdb.h>
#include <qb/qbloop.h>
#include <corosync/swab.h>

typedef struct {
        uint32_t nodeid __attribute__((aligned(8)));
        void *conn __attribute__((aligned(8)));
} mar_message_source_t __attribute__((aligned(8)));

static inline void swab_mar_message_source_t (mar_message_source_t *to_swab)
{
        swab32 (to_swab->nodeid);
        /*
         * if it is from a byteswapped machine, then we can safely
         * ignore its conn info data structure since this is only
         * local to the machine
         */
        to_swab->conn = NULL;
}

#ifndef TIMER_HANDLE_T

typedef qb_loop_timer_handle corosync_timer_handle_t;
#define TIMER_HANDLE_T 1
#endif

struct corosync_tpg_group {
        const void *group;
        size_t group_len;
};

#define TOTEMIP_ADDRLEN (sizeof(struct in6_addr))

#define INTERFACE_MAX 8

#ifndef MESSAGE_QUEUE_MAX
#ifdef HAVE_SMALL_MEMORY_FOOTPRINT
#define PROCESSOR_COUNT_MAX     16
#define MESSAGE_SIZE_MAX        1024*64
#define MESSAGE_QUEUE_MAX       512
#else
#define PROCESSOR_COUNT_MAX     384
#define MESSAGE_SIZE_MAX        1024*1024
#define MESSAGE_QUEUE_MAX       ((4 * MESSAGE_SIZE_MAX) / totem_config->net_mtu)
#endif /* HAVE_SMALL_MEMORY_FOOTPRINT */
#endif /* MESSAGE_QUEUE_MAX */

#define TOTEM_AGREED    0
#define TOTEM_SAFE      1

#define MILLI_2_NANO_SECONDS 1000000ULL

#if !defined(TOTEM_IP_ADDRESS)

struct totem_ip_address {
        unsigned int   nodeid;
        unsigned short family;
        unsigned char  addr[TOTEMIP_ADDRLEN];
} __attribute__((packed));
#endif

#if !defined(MEMB_RING_ID)

struct memb_ring_id {
        unsigned int nodeid;
        unsigned long long seq;
} __attribute__((packed));
#endif

#if !defined(TOTEM_CONFIGURATION_TYPE)

enum totem_configuration_type {
        TOTEM_CONFIGURATION_REGULAR,
        TOTEM_CONFIGURATION_TRANSITIONAL
};
#endif

#if !defined(TOTEM_CALLBACK_TOKEN_TYPE)

enum totem_callback_token_type {
        TOTEM_CALLBACK_TOKEN_RECEIVED = 1,
        TOTEM_CALLBACK_TOKEN_SENT = 2
};
#endif

enum cs_lib_flow_control {
        CS_LIB_FLOW_CONTROL_REQUIRED = 1,
        CS_LIB_FLOW_CONTROL_NOT_REQUIRED = 2
};
#define corosync_lib_flow_control cs_lib_flow_control
#define COROSYNC_LIB_FLOW_CONTROL_REQUIRED CS_LIB_FLOW_CONTROL_REQUIRED
#define COROSYNC_LIB_FLOW_CONTROL_NOT_REQUIRED CS_LIB_FLOW_CONTROL_NOT_REQUIRED

enum cs_lib_allow_inquorate {
        CS_LIB_DISALLOW_INQUORATE = 0, /* default */
        CS_LIB_ALLOW_INQUORATE = 1
};

#if !defined (COROSYNC_FLOW_CONTROL_STATE)

enum cs_flow_control_state {
        CS_FLOW_CONTROL_STATE_DISABLED,
        CS_FLOW_CONTROL_STATE_ENABLED
};
#define corosync_flow_control_state cs_flow_control_state
#define CS_FLOW_CONTROL_STATE_DISABLED CS_FLOW_CONTROL_STATE_DISABLED
#define CS_FLOW_CONTROL_STATE_ENABLED CS_FLOW_CONTROL_STATE_ENABLED

#endif /* COROSYNC_FLOW_CONTROL_STATE */

typedef enum {
        COROSYNC_FATAL_ERROR_EXIT = -1,
        COROSYNC_LIBAIS_SOCKET = -6,
        COROSYNC_LIBAIS_BIND = -7,
        COROSYNC_READKEY = -8,
        COROSYNC_INVALID_CONFIG = -9,
        COROSYNC_DYNAMICLOAD = -12,
        COROSYNC_OUT_OF_MEMORY = -15,
        COROSYNC_FATAL_ERR = -16
} cs_fatal_error_t;
#define corosync_fatal_error_t cs_fatal_error_t;

#ifndef QUORUM_H_DEFINED

typedef void (*quorum_callback_fn_t) (int quorate, void *context);

struct quorum_callin_functions {
        int (*quorate) (void);
        int (*register_callback) (quorum_callback_fn_t callback_fn, void *contexxt);
        int (*unregister_callback) (quorum_callback_fn_t callback_fn, void *context);
};

typedef void (*sync_callback_fn_t) (
        const unsigned int *view_list,
        size_t view_list_entries,
        int primary_designated,
        struct memb_ring_id *ring_id);

#endif /* QUORUM_H_DEFINED */


struct corosync_api_v1 {
        /*
         * Time and timer APIs
         */
        int (*timer_add_duration) (
                unsigned long long nanoseconds_in_future,
                void *data,
                void (*timer_nf) (void *data),
                corosync_timer_handle_t *handle);

        int (*timer_add_absolute) (
                unsigned long long nanoseconds_from_epoch,
                void *data,
                void (*timer_fn) (void *data),
                corosync_timer_handle_t *handle);

        void (*timer_delete) (
                corosync_timer_handle_t timer_handle);

        unsigned long long (*timer_time_get) (void);

        unsigned long long (*timer_expire_time_get) (
                corosync_timer_handle_t timer_handle);

        /*
         * IPC APIs
         */
        void (*ipc_source_set) (mar_message_source_t *source, void *conn);

        int (*ipc_source_is_local) (const mar_message_source_t *source);

        void *(*ipc_private_data_get) (void *conn);

        int (*ipc_response_send) (void *conn, const void *msg, size_t mlen);

#ifn" rel="stylesheet" type="text/css" />

 <="l00249">totem_logging_configuration< name="l00252">#ifn" rel="stylesheet" type="text/css" />

coroapi.h.