Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reindent everything (possibly breaking all branches, but for the last time)
[simgrid.git] / src / amok / PeerManagement / peermanagement.c
index 7650f35..022344c 100644 (file)
 #include "xbt/sysdep.h"
 #include "xbt/peer.h"
 #include "amok/peermanagement.h"
-#include "gras/Virtu/virtu_interface.h" /* libdata */
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(amok_hm,amok,"peer management");
+#include "amok/amok_modinter.h" /* prototype of my module declaration */
+#include "gras/module.h"        /* module mecanism */
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(amok_pm, amok, "peer management");
 
-/* libdata management */
-static int amok_hm_libdata_id=-1;
-typedef struct {
-  /* set headers */
-  unsigned int ID;
-  char        *name;
-  unsigned int name_len;
 
-  /* payload */
+/* data management */
+int amok_pm_moddata_id = -1;
+typedef struct {
   int done;
   xbt_dict_t groups;
-} s_amok_hm_libdata_t, *amok_hm_libdata_t;
-
-static void *amok_hm_libdata_new() {
-  amok_hm_libdata_t res=xbt_new(s_amok_hm_libdata_t,1);
-  res->name=xbt_strdup("amok_hm");
-  res->name_len=0;
-  res->done = 0;
-  res->groups = xbt_dict_new();
-  return res;
-}
-static void amok_hm_libdata_free(void *d) {
-  amok_hm_libdata_t data=(amok_hm_libdata_t)d;
-  free(data->name);
-  xbt_dict_free(&data->groups);
-  free (data);
-}
+} s_amok_pm_moddata_t, *amok_pm_moddata_t;
+
+/* Payload of join message */
+typedef struct {
+  char *group;
+  int rank;
+} s_amok_pm_msg_join_t, *amok_pm_msg_join_t;
 
 /* Message callbacks */
-static int amok_hm_cb_kill(gras_msg_cb_ctx_t ctx,
-                          void             *payload_data) {
+static int amok_pm_cb_kill(gras_msg_cb_ctx_t ctx, void *payload_data)
+{
 
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
   g->done = 1;
-  return 1;
+  return 0;
 }
-static int amok_hm_cb_killrpc(gras_msg_cb_ctx_t ctx,
-                             void             *payload_data) {
 
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
+static int amok_pm_cb_killrpc(gras_msg_cb_ctx_t ctx, void *payload_data)
+{
+
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
   g->done = 1;
-  gras_msg_rpcreturn(30,ctx,NULL);
-  return 1;
+  gras_msg_rpcreturn(30, ctx, NULL);
+  return 0;
 }
 
-static int amok_hm_cb_get(gras_msg_cb_ctx_t ctx, void *payload) {
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
-  char *name = *(void**)payload;
+static int amok_pm_cb_get(gras_msg_cb_ctx_t ctx, void *payload)
+{
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
+  char *name = *(void **) payload;
   xbt_dynar_t res = xbt_dict_get(g->groups, name);
 
   gras_msg_rpcreturn(30, ctx, &res);
-  return 1;
+  return 0;
 }
-static int amok_hm_cb_join(gras_msg_cb_ctx_t ctx, void *payload) {
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
-  char *name = *(void**)payload;
-  xbt_dynar_t group = xbt_dict_get(g->groups, name);
-  
+
+static int amok_pm_cb_join(gras_msg_cb_ctx_t ctx, void *payload)
+{
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
+  amok_pm_msg_join_t msg = *(amok_pm_msg_join_t *) payload;
+  xbt_dynar_t group = xbt_dict_get(g->groups, msg->group);
+
   gras_socket_t exp = gras_msg_cb_ctx_from(ctx);
   xbt_peer_t dude = xbt_peer_new(gras_socket_peer_name(exp),
-                                gras_socket_peer_port(exp));
-
-  VERB2("Contacted by %s:%d",dude->name,dude->port);
-  xbt_dynar_push(group,&dude);
+                                 gras_socket_peer_port(exp));
+  xbt_peer_t previous = NULL;
+
+  if (msg->rank >= 0 && xbt_dynar_length(group) >= msg->rank + 1)
+    xbt_dynar_get_cpy(group, msg->rank, &previous);
+
+  VERB3("Contacted by %s:%d for rank %d", dude->name, dude->port, msg->rank);
+  if (msg->rank < 0) {
+    xbt_dynar_push(group, &dude);
+  } else {
+    if (previous)
+      THROW4(arg_error, 0,
+             "You wanted to get rank %d of group %s, but %s:%d is already there",
+             msg->rank, msg->group, previous->name, previous->port);
+    xbt_dynar_set(group, msg->rank, &dude);
+  }
 
   gras_msg_rpcreturn(10, ctx, NULL);
-  free(name);
-  return 1;
+  free(msg->group);
+  free(msg);
+  return 0;
 }
-static int amok_hm_cb_leave(gras_msg_cb_ctx_t ctx, void *payload) {
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
-  char *name = *(void**)payload;
+
+static int amok_pm_cb_leave(gras_msg_cb_ctx_t ctx, void *payload)
+{
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
+  char *name = *(void **) payload;
   xbt_dynar_t group = xbt_dict_get(g->groups, name);
-  
+
   gras_socket_t exp = gras_msg_cb_ctx_from(ctx);
   xbt_peer_t dude = xbt_peer_new(gras_socket_peer_name(exp),
-                                gras_socket_peer_port(exp));
+                                 gras_socket_peer_port(exp));
 
-  int cpt;
+  unsigned int cpt;
   xbt_peer_t peer_it;
 
   xbt_dynar_foreach(group, cpt, peer_it) {
-    if (!strcmp(peer_it->name, dude->name) && 
-       peer_it->port == dude->port) {
-      xbt_dynar_cursor_rm (group,&cpt);
+    if (!strcmp(peer_it->name, dude->name) && peer_it->port == dude->port) {
+      xbt_dynar_cursor_rm(group, &cpt);
       goto end;
     }
   }
   WARN3("Asked to remove %s:%d from group '%s', but not found. Ignoring",
-       dude->name,dude->port, name);
+        dude->name, dude->port, name);
 
- end:
+end:
   gras_msg_rpcreturn(30, ctx, NULL);
-  return 1;
+  return 0;
 }
 
-static int amok_hm_cb_shutdown(gras_msg_cb_ctx_t ctx, void *payload) {
-  char *name = *(void**)payload;
-  amok_hm_group_shutdown(name);
+static int amok_pm_cb_shutdown(gras_msg_cb_ctx_t ctx, void *payload)
+{
+  char *name = *(void **) payload;
+  amok_pm_group_shutdown(name);
 
   gras_msg_rpcreturn(30, ctx, NULL);
-  return 1;
+  return 0;
 }
 
-
-/* Initialization stuff */
-static short amok_hm_used = 0;
-
-/** \brief Initialize the peer management module. Every process must run it before use */
-void amok_hm_init() {
-  /* pure INIT part */
-  if (! amok_hm_used) {
-
-    /* dependencies */
-    amok_base_init();
-
-    /* module data on each process */
-    amok_hm_libdata_id = gras_procdata_add("amok_hm",
-                                          amok_hm_libdata_new,
-                                          amok_hm_libdata_free);
-
-    /* Datatype and message declarations */
-    gras_msgtype_declare("amok_hm_kill",NULL);   
-    gras_msgtype_declare_rpc("amok_hm_killrpc",NULL,NULL);   
-
-    gras_msgtype_declare_rpc("amok_hm_get",
-                            gras_datadesc_by_name("string"),
-                            gras_datadesc_by_name("xbt_dynar_t"));
-    gras_msgtype_declare_rpc("amok_hm_join",
-                            gras_datadesc_by_name("string"),
-                            NULL);
-    gras_msgtype_declare_rpc("amok_hm_leave",
-                            gras_datadesc_by_name("string"),
-                            NULL);
-
-    gras_msgtype_declare_rpc("amok_hm_shutdown",
-                            gras_datadesc_by_name("string"),
-                            NULL);
-  }
-  amok_hm_used++;
-
-  /* JOIN part */
-  gras_cb_register(gras_msgtype_by_name("amok_hm_kill"),
-                  &amok_hm_cb_kill);
-  gras_cb_register(gras_msgtype_by_name("amok_hm_killrpc"),
-                  &amok_hm_cb_killrpc);
-
-  gras_cb_register(gras_msgtype_by_name("amok_hm_get"),
-                  &amok_hm_cb_get);
-  gras_cb_register(gras_msgtype_by_name("amok_hm_join"),
-                  &amok_hm_cb_join);
-  gras_cb_register(gras_msgtype_by_name("amok_hm_leave"),
-                  &amok_hm_cb_leave);
-  gras_cb_register(gras_msgtype_by_name("amok_hm_shutdown"),
-                  &amok_hm_cb_shutdown);
-}
-
-/** \brief Finalize the peer management module. Every process should run it after use */
-void amok_hm_exit() {
-  /* pure EXIT part */
-  amok_hm_used--;
-
-  /* LEAVE part */
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_kill"),
-                    &amok_hm_cb_kill);
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_killrpc"),
-                    &amok_hm_cb_killrpc);
-
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_get"),
-                    &amok_hm_cb_get);
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_join"),
-                    &amok_hm_cb_join);
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_leave"),
-                    &amok_hm_cb_leave);
-
-  gras_cb_unregister(gras_msgtype_by_name("amok_hm_shutdown"),
-                    &amok_hm_cb_shutdown);
-}
-
-
 /** \brief Enter the main loop of the program. It won't return until we get a kill message. */
-void amok_hm_mainloop(double timeOut) {
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
-  
+void amok_pm_mainloop(double timeOut)
+{
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
+
   while (!g->done) {
     gras_msg_handle(timeOut);
   }
 }
 
-/** \brief kill a buddy identified by its peername and port */
-void amok_hm_kill_hp(char *name,int port) {
-  gras_socket_t sock=gras_socket_client(name,port);
-  amok_hm_kill(sock);
+/** \brief kill a buddy identified by its peername and port. Note that it is not removed from any group it may belong to. */
+void amok_pm_kill_hp(char *name, int port)
+{
+  gras_socket_t sock = gras_socket_client(name, port);
+  amok_pm_kill(sock);
   gras_socket_close(sock);
 }
 
-/** \brief kill a buddy to which we have a socket already */
-void amok_hm_kill(gras_socket_t buddy) {
-  gras_msg_send(buddy,gras_msgtype_by_name("amok_hm_kill"),NULL);
+/** \brief kill a buddy to which we have a socket already. Note that it is not removed from any group it may belong to. */
+void amok_pm_kill(gras_socket_t buddy)
+{
+  gras_msg_send(buddy, "amok_pm_kill", NULL);
 }
 
-/** \brief kill syncronously a buddy (do not return before its death) */
-void amok_hm_kill_sync(gras_socket_t buddy) {
-  gras_msg_rpccall(buddy,30,gras_msgtype_by_name("amok_hm_killrpc"),NULL,NULL);
+/** \brief kill syncronously a buddy (do not return before its death). Note that it is not removed from any group it may belong to. */
+void amok_pm_kill_sync(gras_socket_t buddy)
+{
+  gras_msg_rpccall(buddy, 30, "amok_pm_killrpc", NULL, NULL);
 }
 
 
@@ -226,65 +160,195 @@ void amok_hm_kill_sync(gras_socket_t buddy) {
  *
  * The dynar elements are of type xbt_peer_t
  */
-xbt_dynar_t amok_hm_group_new(const char *group_name) {
-  amok_hm_libdata_t g;
+xbt_dynar_t amok_pm_group_new(const char *group_name)
+{
+  amok_pm_moddata_t g;
   xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_peer_t),
-                                 xbt_peer_free_voidp);
+                                  xbt_peer_free_voidp);
+
+  xbt_assert0(amok_pm_moddata_id != -1, "Run amok_pm_init first!");
+  g = gras_moddata_by_id(amok_pm_moddata_id);
 
-  xbt_assert0(amok_hm_libdata_id != -1,"Run amok_hm_init first!");
-  g=gras_libdata_by_id(amok_hm_libdata_id);
-   
-  xbt_dict_set(g->groups,group_name,res,NULL); /*FIXME: leaking xbt_dynar_free_voidp);*/
-  VERB1("Group %s created",group_name);
+  DEBUG1("retrieved groups=%p", g->groups);
+
+  xbt_dict_set(g->groups, group_name, res, NULL);       /*FIXME: leaking xbt_dynar_free_voidp); */
+  VERB1("Group %s created", group_name);
 
   return res;
 }
+
 /** \brief retrieve all members of the given remote group */
-xbt_dynar_t amok_hm_group_get(gras_socket_t master, const char *group_name) {
+xbt_dynar_t amok_pm_group_get(gras_socket_t master, const char *group_name)
+{
   xbt_dynar_t res;
-  
-  gras_msg_rpccall(master,30,gras_msgtype_by_name("amok_hm_get"),
-                  &group_name,&res);
+
+  gras_msg_rpccall(master, 30, "amok_pm_get", &group_name, &res);
   return res;
 }
 
-/** \brief add current peer to the given remote group */
-void        amok_hm_group_join(gras_socket_t master, const char *group_name) {
-  VERB3("Join group '%s' on %s:%d",
-       group_name,gras_socket_peer_name(master),gras_socket_peer_port(master));
-  gras_msg_rpccall(master,30,gras_msgtype_by_name("amok_hm_join"),
-                  &group_name,NULL);
+/** \brief add current peer to the given remote group 
+ *
+ * You should provide rank only when you want to force the order of members 
+ * (for example in strict test cases). Give -1 to leave the system choose it for you.
+ */
+void amok_pm_group_join(gras_socket_t master, const char *group_name,
+                        int rank)
+{
+  amok_pm_msg_join_t msg = xbt_new(s_amok_pm_msg_join_t, 1);
+  msg->group = (char *) group_name;
+  msg->rank = rank;
+  VERB4("Join group '%s' on %s:%d (at rank %d)",
+        group_name, gras_socket_peer_name(master),
+        gras_socket_peer_port(master), rank);
+  gras_msg_rpccall(master, 30, "amok_pm_join", &msg, NULL);
+  free(msg);
   VERB3("Joined group '%s' on %s:%d",
-       group_name,gras_socket_peer_name(master),gras_socket_peer_port(master));
+        group_name, gras_socket_peer_name(master),
+        gras_socket_peer_port(master));
 }
+
 /** \brief remove current peer from the given remote group if found
  *
  * If not found, call is ignored 
  */
-void        amok_hm_group_leave(gras_socket_t master, const char *group_name) {
-  gras_msg_rpccall(master,30,gras_msgtype_by_name("amok_hm_leave"),
-                  &group_name,NULL);
+void amok_pm_group_leave(gras_socket_t master, const char *group_name)
+{
+  gras_msg_rpccall(master, 30, "amok_pm_leave", &group_name, NULL);
   VERB3("Leaved group '%s' on %s:%d",
-       group_name,gras_socket_peer_name(master),gras_socket_peer_port(master));
+        group_name, gras_socket_peer_name(master),
+        gras_socket_peer_port(master));
 }
 
 /** \brief stops all members of the given local group */
-void amok_hm_group_shutdown(const char *group_name) {
-  amok_hm_libdata_t g=gras_libdata_by_id(amok_hm_libdata_id);
+void amok_pm_group_shutdown(const char *group_name)
+{
+  amok_pm_moddata_t g = gras_moddata_by_id(amok_pm_moddata_id);
   xbt_dynar_t group = xbt_dict_get(g->groups, group_name);
-  
-  int cpt;
+
+  unsigned int cpt;
   xbt_peer_t peer_it;
 
   xbt_dynar_foreach(group, cpt, peer_it) {
-    amok_hm_kill_hp(peer_it->name, peer_it->port);
+    amok_pm_kill_hp(peer_it->name, peer_it->port);
   }
 
   xbt_dynar_free(&group);
-  xbt_dict_remove(g->groups,group_name);
+  xbt_dict_remove(g->groups, group_name);
 }
+
 /** \brief stops all members of the given remote group */
-void amok_hm_group_shutdown_remote(gras_socket_t master, const char *group_name){
-  gras_msg_rpccall(master,30,gras_msgtype_by_name("amok_hm_shutdown"),
-                  &group_name,NULL);
+void amok_pm_group_shutdown_remote(gras_socket_t master,
+                                   const char *group_name)
+{
+  gras_msg_rpccall(master, 30, "amok_pm_shutdown", &group_name, NULL);
+}
+
+
+/* *
+ * *
+ * * Module management functions
+ * *
+ * */
+
+
+
+static void _amok_pm_init(void)
+{
+  /* no world-wide globals */
+  /* Datatype and message declarations */
+  gras_datadesc_type_t pm_group_type =
+    gras_datadesc_dynar(gras_datadesc_by_name("xbt_peer_t"),
+                        xbt_peer_free_voidp);
+
+  gras_datadesc_type_t msg_join_t =
+    gras_datadesc_struct("s_amok_pm_moddata_t");
+  gras_datadesc_struct_append(msg_join_t, "group",
+                              gras_datadesc_by_name("string"));
+  gras_datadesc_struct_append(msg_join_t, "rank",
+                              gras_datadesc_by_name("int"));
+  gras_datadesc_struct_close(msg_join_t);
+  msg_join_t =
+    gras_datadesc_ref("amok_pm_moddata_t",
+                      gras_datadesc_by_name("s_amok_pm_moddata_t"));
+
+  gras_msgtype_declare("amok_pm_kill", NULL);
+  gras_msgtype_declare_rpc("amok_pm_killrpc", NULL, NULL);
+
+  gras_msgtype_declare_rpc("amok_pm_get",
+                           gras_datadesc_by_name("string"), pm_group_type);
+  gras_msgtype_declare_rpc("amok_pm_join", msg_join_t, NULL);
+  gras_msgtype_declare_rpc("amok_pm_leave",
+                           gras_datadesc_by_name("string"), NULL);
+
+  gras_msgtype_declare_rpc("amok_pm_shutdown",
+                           gras_datadesc_by_name("string"), NULL);
+}
+
+static void _amok_pm_join(void *p)
+{
+  /* moddata management */
+  amok_pm_moddata_t mod = (amok_pm_moddata_t) p;
+
+  mod->groups = NULL;
+
+  mod->done = 0;
+  mod->groups = xbt_dict_new();
+
+  /* callbacks */
+  gras_cb_register("amok_pm_kill", &amok_pm_cb_kill);
+  gras_cb_register("amok_pm_killrpc", &amok_pm_cb_killrpc);
+
+  gras_cb_register("amok_pm_get", &amok_pm_cb_get);
+  gras_cb_register("amok_pm_join", &amok_pm_cb_join);
+  gras_cb_register("amok_pm_leave", &amok_pm_cb_leave);
+  gras_cb_register("amok_pm_shutdown", &amok_pm_cb_shutdown);
+}
+
+static void _amok_pm_exit(void)
+{
+  /* no world-wide globals */
+}
+
+static void _amok_pm_leave(void *p)
+{
+  /* moddata */
+  amok_pm_moddata_t mod = (amok_pm_moddata_t) p;
+
+  if (mod->groups)
+    xbt_dict_free(&mod->groups);
+
+  /* callbacks */
+  gras_cb_unregister("amok_pm_kill", &amok_pm_cb_kill);
+  gras_cb_unregister("amok_pm_killrpc", &amok_pm_cb_killrpc);
+
+  gras_cb_unregister("amok_pm_get", &amok_pm_cb_get);
+  gras_cb_unregister("amok_pm_join", &amok_pm_cb_join);
+  gras_cb_unregister("amok_pm_leave", &amok_pm_cb_leave);
+  gras_cb_unregister("amok_pm_shutdown", &amok_pm_cb_shutdown);
+}
+
+void amok_pm_modulecreate()
+{
+  gras_module_add("amok_pm", sizeof(s_amok_pm_moddata_t), &amok_pm_moddata_id,
+                  _amok_pm_init, _amok_pm_exit, _amok_pm_join,
+                  _amok_pm_leave);
+}
+
+
+
+/* *
+ * *
+ * * Old module functions (kept for compatibility)
+ * *
+ * */
+/** \brief Initialize the peer management module. Every process must run it before use */
+void amok_pm_init()
+{
+  gras_module_join("amok_pm");
+}
+
+/** \brief Finalize the peer management module. Every process should run it after use */
+void amok_pm_exit()
+{
+  gras_module_leave("amok_pm");
 }