exec/totempg.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@mvista.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
  36 #ifndef TOTEMPG_H_DEFINED
  37 #define TOTEMPG_H_DEFINED
  38
  39 #include <netinet/in.h>
  40 #include "aispoll.h"
  41 #include "totem.h"
  42
  43 typedef unsigned int totempg_groups_handle;
  44
  45 struct totempg_group {
  46         void *group;
  47         int group_len;
  48 };
  49
  50 #define TOTEMPG_AGREED                  0
  51 #define TOTEMPG_SAFE                    1
  52
  53 /*
  54  * Totem Single Ring Protocol
  55  * depends on poll abstraction, POSIX, IPV4
  56  */
  57
  58 /*
  59  * Initialize the totem process groups abstraction
  60  */
  61 extern int totempg_initialize (
  62         poll_handle poll_handle,
  63         struct totem_config *totem_config
  64 );
  65
  66 extern void totempg_finalize (void);
  67
  68 extern int totempg_callback_token_create (void **handle_out,
  69         enum totem_callback_token_type type,
  70         int delete,
  71         int (*callback_fn) (enum totem_callback_token_type type, void *),
  72         void *data);
  73
  74 extern void totempg_callback_token_destroy (void *handle);
  75
  76 /*
  77  * Initialize a groups instance
  78  */
  79 extern int totempg_groups_initialize (
  80         totempg_groups_handle *handle,
  81
  82         void (*deliver_fn) (
  83                 unsigned int nodeid,
  84                 struct iovec *iovec,
  85                 int iov_len,
  86                 int endian_conversion_required),
  87
  88         void (*confchg_fn) (
  89                 enum totem_configuration_type configuration_type,
  90                 unsigned int *member_list, int member_list_entries,
  91                 unsigned int *left_list, int left_list_entries,
  92                 unsigned int *joined_list, int joined_list_entries,
  93                 struct memb_ring_id *ring_id));
  94
  95 extern int totempg_groups_finalize (
  96         totempg_groups_handle handle);
  97
  98 extern int totempg_groups_join (
  99         totempg_groups_handle handle,
 100         struct totempg_group *groups,
 101         int gruop_cnt);
 102
 103 extern int totempg_groups_leave (
 104         totempg_groups_handle handle,
 105         struct totempg_group *groups,
 106         int gruop_cnt);
 107
 108 extern int totempg_groups_mcast_joined (
 109         totempg_groups_handle handle,
 110         struct iovec *iovec,
 111         int iov_len,
 112         int guarantee);
 113
 114 extern int totempg_groups_send_ok_joined (
 115         totempg_groups_handle handle,
 116         struct iovec *iovec,
 117         int iov_len);
 118
 119 extern int totempg_groups_mcast_groups (
 120         totempg_groups_handle handle,
 121         int guarantee,
 122         struct totempg_group *groups,
 123         int groups_cnt,
 124         struct iovec *iovec,
 125         int iov_len);
 126
 127 extern int totempg_groups_send_ok_groups (
 128         totempg_groups_handle handle,
 129         struct totempg_group *groups,
 130         int groups_cnt,
 131         struct iovec *iovec,
 132         int iov_len);
 133
 134 extern int totempg_ifaces_get (
 135         unsigned int nodeid,
 136         struct totem_ip_address *interfaces,
 137         char ***status,
 138         unsigned int *iface_count);
 139
 140 extern char *totempg_ifaces_print (unsigned int nodeid);
 141
 142 extern int totempg_my_nodeid_get (void);
 143
 144 extern int totempg_my_family_get (void);
 145
 146 extern int totempg_ring_reenable (void);
 147
 148 #endif /* TOTEMPG_H_DEFINED */