exec/totemsrp.h

   1 /*
   2  * Copyright (c) 2003-2005 MontaVista Software, Inc.
   3  * Copyright (c) 2006-2007 Red Hat, Inc.
   4  *
   5  * All rights reserved.
   6  *
   7  * Author: Steven Dake (sdake@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 TOTEMSRP_H_DEFINED
  36 #define TOTEMSRP_H_DEFINED
  37
  38 #include "totem.h"
  39 #include "aispoll.h"
  40
  41 typedef unsigned int totemsrp_handle;
  42
  43 /*
  44  * Totem Single Ring Protocol
  45  * depends on poll abstraction, POSIX, IPV4
  46  */
  47
  48 /*
  49  * Create a protocol instance
  50  */
  51 int totemsrp_initialize (
  52         poll_handle poll_handle,
  53         totemsrp_handle *handle,
  54         struct totem_config *totem_config,
  55
  56         void (*deliver_fn) (
  57                 unsigned int nodeid,
  58                 struct iovec *iovec,
  59                 int iov_len,
  60                 int endian_conversion_required),
  61         void (*confchg_fn) (
  62                 enum totem_configuration_type configuration_type,
  63                 unsigned int *member_list, int member_list_entries,
  64                 unsigned int *left_list, int left_list_entries,
  65                 unsigned int *joined_list, int joined_list_entries,
  66                 struct memb_ring_id *ring_id));
  67
  68 void totemsrp_finalize (totemsrp_handle handle);
  69
  70 /*
  71  * Multicast a message
  72  */
  73 int totemsrp_mcast (
  74         totemsrp_handle handle,
  75         struct iovec *iovec,
  76         int iov_len,
  77         int priority);
  78
  79 /*
  80  * Return number of available messages that can be queued
  81  */
  82 int totemsrp_avail (totemsrp_handle handle);
  83
  84 int totemsrp_callback_token_create (
  85         totemsrp_handle handle,
  86         void **handle_out,
  87         enum totem_callback_token_type type,
  88         int delete,
  89         int (*callback_fn) (enum totem_callback_token_type type, void *),
  90         void *data);
  91
  92 void totemsrp_callback_token_destroy (
  93         totemsrp_handle handle,
  94         void **handle_out);
  95
  96 int totemsrp_new_msg_signal (totemsrp_handle handle);
  97
  98 extern void totemsrp_net_mtu_adjust (struct totem_config *totem_config);
  99
 100 extern int totemsrp_ifaces_get (
 101         totemsrp_handle handle,
 102         unsigned int nodeid,
 103         struct totem_ip_address *interfaces,
 104         char ***status,
 105         unsigned int *iface_count);
 106
 107 extern int totemsrp_my_nodeid_get (
 108         totemsrp_handle handle);
 109
 110 extern int totemsrp_my_family_get (
 111         totemsrp_handle handle);
 112
 113 extern int totemsrp_ring_reenable (
 114         totemsrp_handle handle);
 115
 116 #endif /* TOTEMSRP_H_DEFINED */