Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update to reflect last code changes
authormquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Mon, 26 Apr 2004 10:14:05 +0000 (10:14 +0000)
committermquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Mon, 26 Apr 2004 10:14:05 +0000 (10:14 +0000)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@84 48e7efb5-ca39-0410-a469-dd3cf9ba447f

cruft/doc/gras-docs.sgml
cruft/doc/gras-sections.txt
cruft/doc/tmpl/comm_datadesc.sgml
cruft/doc/tmpl/comm_datadesc_expert.sgml [deleted file]
cruft/doc/tmpl/comm_messages.sgml
cruft/doc/tmpl/comm_socks.sgml
cruft/doc/tmpl/gras-unused.sgml
cruft/doc/tmpl/gras_rl.sgml
cruft/doc/tmpl/tbx_log.sgml

index 5251291..5ca0b78 100644 (file)
@@ -2,7 +2,6 @@
 
 <!ENTITY comm-socks SYSTEM "sgml/comm_socks.sgml">
 <!ENTITY comm-datadesc SYSTEM "sgml/comm_datadesc.sgml">
-<!ENTITY comm-dd-expert SYSTEM "sgml/comm_datadesc_expert.sgml">
 <!ENTITY comm-messages SYSTEM "sgml/comm_messages.sgml">
 
 <!ENTITY virtu-globals SYSTEM "sgml/virtu_globals.sgml">
@@ -37,7 +36,6 @@
   <chapter>
    <title>Communication facilities</title>
     &comm-datadesc;
-    &comm-dd-expert;
     &comm-socks;
     &comm-messages;
   </chapter>
@@ -295,8 +293,8 @@ In SG, it shouldn't be that difficult either ;)
 =item
 
 Write examples.
--->
   </chapter>
+-->
 
   <chapter>
    <title>GRAS toolbox</title>
index e9cb3bb..1e5eca6 100644 (file)
@@ -29,7 +29,7 @@ gras_log_default_appender
 CDEBUG6
 CVERB6
 CINFO6
-CWARNING6
+CWARN6
 CERROR6
 CCRITICAL6
 
@@ -37,7 +37,7 @@ CCRITICAL6
 DEBUG6
 VERB6
 INFO6
-WARNING6
+WARN6
 ERROR6
 CRITICAL6
 
@@ -71,12 +71,12 @@ CINFO2
 CINFO3
 CINFO4
 CINFO5
-CWARNING0
-CWARNING1
-CWARNING2
-CWARNING3
-CWARNING4
-CWARNING5
+CWARN0
+CWARN1
+CWARN2
+CWARN3
+CWARN4
+CWARN5
 CERROR0
 CERROR1
 CERROR2
@@ -115,12 +115,12 @@ INFO2
 INFO3
 INFO4
 INFO5
-WARNING0
-WARNING1
-WARNING2
-WARNING3
-WARNING4
-WARNING5
+WARN0
+WARN1
+WARN2
+WARN3
+WARN4
+WARN5
 ERROR0
 ERROR1
 ERROR2
@@ -249,69 +249,33 @@ gras_cfgelm_type_t
 gras_cfg_get_type
 </SECTION>
 
-
-
-
-
-
-
 <SECTION>
 <FILE>comm_datadesc</FILE>
 <TITLE>Data description</TITLE>
-gras_datadesc_from_nws
-gras_datadesc_parse
-gras_datadesc_copy_data
+gras_datadesc_by_name
+gras_datadesc_by_symbol
+gras_datadesc_import_nws
 
 gras_datadesc_declare_array
 gras_datadesc_declare_array_dyn
 gras_datadesc_declare_ref
 gras_datadesc_declare_ref_disc
 gras_datadesc_declare_struct
-gras_datadesc_declare_struct_add_code
-gras_datadesc_declare_struct_add_name
+gras_datadesc_declare_struct_append_name
 gras_datadesc_declare_union
-gras_datadesc_declare_union_add_code
-gras_datadesc_declare_union_add_name
-</SECTION>
-
-<SECTION>
-<FILE>comm_datadesc_expert</FILE>
-<TITLE>Advanced Data description</TITLE>
-gras_datadesc_declare_array_cb
-gras_datadesc_declare_ref_cb
-gras_datadesc_declare_struct_add_code_cb
-gras_datadesc_declare_struct_add_name_cb
-gras_datadesc_declare_struct_cb
-gras_datadesc_declare_union_add_code_cb
-gras_datadesc_declare_union_add_name_cb
-gras_datadesc_declare_union_cb
+gras_datadesc_declare_union_append_name
 
+gras_datadesc_cb_set_pre
+gras_datadesc_cb_set_post
 
-gras_dd_cbps_block_begin
-gras_dd_cbps_block_end
-gras_dd_cbps_get
 gras_dd_cbps_pop
 gras_dd_cbps_push
 gras_dd_cbps_set
-</SECTION>
+gras_dd_cbps_get
+gras_dd_cbps_block_begin
+gras_dd_cbps_block_end
 
-<SECTION>
-<FILE>dd_internal</FILE>
-<TITLE>Implementation of data description</TITLE>
-gras_ddt_free
-gras_ddt_get_by_code
-gras_ddt_get_by_name
-gras_ddt_new_array
-gras_ddt_new_from_nws
-gras_ddt_new_ignored
-gras_ddt_new_parse
-gras_ddt_new_ref
-gras_ddt_new_scalar
-gras_ddt_new_struct
-gras_ddt_new_struct_append
-gras_ddt_new_union
-gras_ddt_new_union_append
-gras_ddt_register
+gras_arch_selfid
 </SECTION>
 
 <SECTION>
@@ -321,33 +285,30 @@ gras_socket_client
 gras_socket_server
 gras_socket_close
 gras_socket_peer_name
-gras_socket_peer_addr
+gras_socket_peer_port
+gras_socket_my_port
 </SECTION>
 
-
-
-
-
-
-
-
-
-
-
-
-
-
 <SECTION>
 <FILE>comm_messages</FILE>
 <TITLE>Messages</TITLE>
-gras_msgtype_register
+gras_msgtype_declare
+gras_msgtype_declare_v
+gras_msgtype_by_name
+gras_msgtype_by_namev
+
 gras_cb_t
 gras_cb_register
-gras_msg_new
-gras_msg_free
-gras_msg_handle
+gras_cb_unregister
+
 gras_msg_send
 gras_msg_wait
+gras_msg_handle
+
+<SUBSECTION Standard>
+gras_msg_recv
+gras_msg_init
+gras_msg_exit
 </SECTION>
 
 <SECTION>
@@ -371,45 +332,6 @@ gras_sleep
 gras_fs_fopen
 </SECTION>
 
-
-
-<SECTION>
-<FILE>gras_private</FILE>
-gras_lock
-gras_unlock
-gras_msg_discard
-FormatTypes
-gras_datadesc_cmp
-SIMPLE_TYPE_COUNT
-</SECTION>
-
-<SECTION>
-<FILE>gras_rl</FILE>
-<TITLE>Real life specific stuff</TITLE>
-grasMsgRecv
-ConvertData
-DataSize
-DifferentFormat
-DifferentOrder
-DifferentSize
-HomogenousConvertData
-HomogenousDataSize
-ReverseData
-<SUBSECTION Standard>
-headerDescriptorCount
-countDescriptorCount
-PEER_NAME_LEN
-</SECTION>
-
-<SECTION>
-<FILE>gras_sg</FILE>
-CloseSocket
-</SECTION>
-
-
-
-
-
 <SECTION>
 <FILE>cruft</FILE>
 <TITLE>Cruft to ignore in the documentation</TITLE>
index cbfbfc9..1f92175 100644 (file)
@@ -2,7 +2,7 @@
 Data description
 
 <!-- ##### SECTION Short_Description ##### -->
-Simple ways to describe data to exchange
+Describing data to be exchanged
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -14,7 +14,25 @@ Simple ways to describe data to exchange
 
 </para>
 
-<!-- ##### FUNCTION gras_datadesc_from_nws ##### -->
+<!-- ##### FUNCTION gras_datadesc_by_name ##### -->
+<para>
+
+</para>
+
+@name: 
+@type: 
+@Returns: 
+
+
+<!-- ##### MACRO gras_datadesc_by_symbol ##### -->
+<para>
+
+</para>
+
+@name: 
+
+
+<!-- ##### FUNCTION gras_datadesc_import_nws ##### -->
 <para>
 
 </para>
@@ -22,123 +40,167 @@ Simple ways to describe data to exchange
 @name: 
 @desc: 
 @howmany: 
-@code: 
-@Returns: 
-<!-- # Unused Parameters # -->
 @dst: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gras_datadesc_parse ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_array_dyn ##### -->
 <para>
 
 </para>
 
 @name: 
-@Cdefinition: 
-@code: 
+@element_type: 
+@dynamic_size: 
+@dst: 
 @Returns: 
 <!-- # Unused Parameters # -->
-@def
-@dst
+@elm_type
+@code
 
 
-<!-- ##### MACRO gras_datadesc_declare_array ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_ref ##### -->
 <para>
 
 </para>
 
 @name: 
-@elm_type: 
-@size: 
+@referenced_type: 
+@dst: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@ref_type: 
 @code: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_array_dyn ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_struct ##### -->
 <para>
 
 </para>
 
 @name: 
-@elm_type: 
-@dynamic_size: 
+@dst: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @code: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_ref ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_struct_append_name ##### -->
 <para>
 
 </para>
 
+@struct_type: 
 @name: 
-@ref_type: 
-@code
+@field_type_name: 
+@Returns
 
 
-<!-- ##### MACRO gras_datadesc_declare_ref_disc ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_union ##### -->
 <para>
 
 </para>
 
 @name: 
-@discriminant: 
+@selector: 
+@dst: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @code: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_struct ##### -->
+<!-- ##### FUNCTION gras_datadesc_declare_union_append_name ##### -->
 <para>
 
 </para>
 
+@union_type: 
 @name: 
-@code: 
+@field_type_name: 
+@Returns: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_struct_add_code ##### -->
+<!-- ##### FUNCTION gras_datadesc_cb_set_pre ##### -->
 <para>
 
 </para>
 
-@struct_code: 
-@field_name: 
-@field_type_code: 
+@type: 
+@pre: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_struct_add_name ##### -->
+<!-- ##### FUNCTION gras_datadesc_cb_set_post ##### -->
 <para>
 
 </para>
 
-@struct_code: 
-@field_name: 
-@field_type_name: 
+@type: 
+@post: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_union ##### -->
+<!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
 <para>
 
 </para>
 
+@ps: 
 @name: 
-@code
+@ddt
 
 
-<!-- ##### MACRO gras_datadesc_declare_union_add_code ##### -->
+<!-- ##### FUNCTION gras_dd_cbps_push ##### -->
 <para>
 
 </para>
 
-@union_code: 
-@field_name: 
-@field_type_code: 
+@ps: 
+@name: 
+@data: 
+@ddt: 
 
 
-<!-- ##### MACRO gras_datadesc_declare_union_add_name ##### -->
+<!-- ##### FUNCTION gras_dd_cbps_set ##### -->
 <para>
 
 </para>
 
-@union_code: 
-@field_name: 
-@field_type_name: 
+@ps: 
+@name: 
+@data: 
+@ddt: 
+
+
+<!-- ##### FUNCTION gras_dd_cbps_get ##### -->
+<para>
+
+</para>
+
+@ps: 
+@name: 
+@ddt: 
+
+
+<!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
+<para>
+
+</para>
+
+@ps: 
+
+
+<!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
+<para>
+
+</para>
+
+@ps: 
+
+
+<!-- ##### FUNCTION gras_arch_selfid ##### -->
+<para>
+
+</para>
+
+@Returns: 
 
 
diff --git a/cruft/doc/tmpl/comm_datadesc_expert.sgml b/cruft/doc/tmpl/comm_datadesc_expert.sgml
deleted file mode 100644 (file)
index 14e6a15..0000000
+++ /dev/null
@@ -1,177 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Advanced Data description
-
-<!-- ##### SECTION Short_Description ##### -->
-Advanced ways to describe data (for experts)
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gras_datadesc_declare_array_cb ##### -->
-<para>
-
-</para>
-
-@name: 
-@element_type: 
-@fixed_size: 
-@dynamic_size: 
-@post: 
-@code: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_ref_cb ##### -->
-<para>
-
-</para>
-
-@name: 
-@referenced_type: 
-@discriminant: 
-@post: 
-@code: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_struct_add_code_cb ##### -->
-<para>
-
-</para>
-
-@struct_code: 
-@field_name: 
-@field_code: 
-@pre_cb: 
-@post_cb: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_struct_add_name_cb ##### -->
-<para>
-
-</para>
-
-@struct_code: 
-@field_name: 
-@field_type_name: 
-@pre_cb: 
-@post_cb: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_struct_cb ##### -->
-<para>
-
-</para>
-
-@name: 
-@pre_cb: 
-@post_cb: 
-@code: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_union_add_code_cb ##### -->
-<para>
-
-</para>
-
-@union_code: 
-@field_name: 
-@field_code: 
-@pre_cb: 
-@post_cb: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_union_add_name_cb ##### -->
-<para>
-
-</para>
-
-@union_code: 
-@field_name: 
-@field_type_name: 
-@pre_cb: 
-@post_cb: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_datadesc_declare_union_cb ##### -->
-<para>
-
-</para>
-
-@name: 
-@field_count: 
-@post: 
-@code: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
-<para>
-
-</para>
-
-@ps: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
-<para>
-
-</para>
-
-@ps: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_get ##### -->
-<para>
-
-</para>
-
-@ps: 
-@name: 
-@ddt: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
-<para>
-
-</para>
-
-@ps: 
-@name: 
-@ddt: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_push ##### -->
-<para>
-
-</para>
-
-@ps: 
-@name: 
-@data: 
-@ddt: 
-
-
-<!-- ##### FUNCTION gras_dd_cbps_set ##### -->
-<para>
-
-</para>
-
-@ps: 
-@name: 
-@data: 
-@ddt: 
-
-
index 0acbe22..9b0f6d2 100644 (file)
@@ -14,65 +14,83 @@ Defining messages and callbacks, and sending/receiving messages.
 
 </para>
 
-<!-- ##### FUNCTION gras_msgtype_register ##### -->
+<!-- ##### FUNCTION gras_msgtype_declare ##### -->
 <para>
 
 </para>
 
-@msgId: 
 @name: 
-@sequence_count
-@Varargs
+@payload
+@dst
 @Returns: 
 
 
-<!-- ##### USER_FUNCTION gras_cb_t ##### -->
+<!-- ##### FUNCTION gras_msgtype_declare_v ##### -->
 <para>
 
 </para>
 
-@msg: 
+@name: 
+@version: 
+@payload: 
+@dst: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gras_cb_register ##### -->
+<!-- ##### FUNCTION gras_msgtype_by_name ##### -->
 <para>
 
 </para>
 
-@message: 
-@TTL: 
-@cb: 
+@name: 
+@dst: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gras_msg_new ##### -->
+<!-- ##### FUNCTION gras_msgtype_by_namev ##### -->
 <para>
 
 </para>
 
-@msgId: 
-@free_data_on_free: 
-@seqCount: 
-@Varargs: 
+@name: 
+@version: 
+@dst: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gras_msg_free ##### -->
+<!-- ##### USER_FUNCTION gras_cb_t ##### -->
 <para>
 
 </para>
 
+@expeditor: 
+@payload_type: 
+@payload_data: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @msg: 
 
 
-<!-- ##### FUNCTION gras_msg_handle ##### -->
+<!-- ##### FUNCTION gras_cb_register ##### -->
 <para>
 
 </para>
 
-@timeOut: 
+@msgtype: 
+@cb: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@message: 
+@TTL: 
+
+
+<!-- ##### FUNCTION gras_cb_unregister ##### -->
+<para>
+
+</para>
+
+@msgtype: 
+@cb: 
 
 
 <!-- ##### FUNCTION gras_msg_send ##### -->
@@ -80,10 +98,14 @@ Defining messages and callbacks, and sending/receiving messages.
 
 </para>
 
+@sock: 
+@msgtype: 
+@payload: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @sd: 
 @msg: 
 @freeDirective: 
-@Returns: 
 
 
 <!-- ##### FUNCTION gras_msg_wait ##### -->
@@ -92,8 +114,21 @@ Defining messages and callbacks, and sending/receiving messages.
 </para>
 
 @timeout: 
+@msgt_want: 
+@expeditor: 
+@payload: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @id: 
 @message: 
+
+
+<!-- ##### FUNCTION gras_msg_handle ##### -->
+<para>
+
+</para>
+
+@timeOut: 
 @Returns: 
 
 
index 6bc7b7d..807770c 100644 (file)
@@ -51,3 +51,32 @@ Open/close sockets, and get info on peer.
 @Returns: 
 
 
+<!-- ##### FUNCTION gras_socket_peer_name ##### -->
+<para>
+
+</para>
+
+@sock: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@sd: 
+
+
+<!-- ##### FUNCTION gras_socket_peer_port ##### -->
+<para>
+
+</para>
+
+@sock: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gras_socket_my_port ##### -->
+<para>
+
+</para>
+
+@sock: 
+@Returns: 
+
+
index 4bd27dc..e14b0e6 100644 (file)
@@ -176,6 +176,66 @@ Handling sockets
 Sockets API
 
 
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Title ##### -->
+comm_callbacks
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Title ##### -->
+comm_cb
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Short_Description ##### -->
+Advanced ways to describe data (for experts)
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Title ##### -->
+Advanced Data description
+
+
 <!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:Long_Description ##### -->
 <para>
 
@@ -236,6 +296,26 @@ config
 Data description callbacks persistant state
 
 
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Title ##### -->
+Implementation of data description
+
+
 <!-- ##### SECTION ./tmpl/dico.sgml:Long_Description ##### -->
 <para>
 
@@ -368,6 +448,125 @@ Overview
 gras
 
 
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Title ##### -->
+gras_private
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Short_Description ##### -->
+Implementation of GRAS suited for real life.
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Title ##### -->
+RL
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Long_Description ##### -->
+<para>
+  SimGrid was designed to ease the comparison of algorithms and
+  heuristics. That way, a lot of complicated notion from the system layer
+  were volontary left off. For example, migrating a process from an host to
+  another is as easy as: MSG_process_change_host(process, new_host).
+</para>
+
+<para>
+  No need to tell that performing this operation on real platform is really
+  harder. This simplification is a very good thing when you want to rapidly
+  prototype code, but makes things somehow more complicated in GRAS since
+  we want to have a realistic API, since it have to be implemented in
+  reality also.
+</para>
+
+<para>
+  The best example of complexity in GRAS_SG induced by simplicity in
+  SimGrid is the sockets handling. There is no "socket" in SG, but only
+  m_channel_t. In contrary to sockets from RL, no special treatment is
+  needed for a process before writing or reading on/from a channel. So, a
+  given channel can be pooled by more than one process. Likewise, you can
+  send data to a channel that nobody is actually listening to.
+</para>
+
+<para>
+  The SG implementation of GRAS repport as an error the fact that nobody is
+  listening to the socket when trying to open a socket, or send stuff using
+  a previously openned socket. That way, the SG version can be used to
+  debug all syncronization issues. For that, we store mainly the PID of
+  both the sender and the receiver in the socket structure, and then
+  resolve PID->process at the lastest moment. This search is a bit
+  expensive, but as long as there is no real garbage collection in SG, with
+  the information "dead process" within the structure, it's the only
+  solution to make sure that we won't dereference pointers to an old freed
+  structure when the process on the other side of the structure did finish
+  since the creation of the socket.
+</para>
+
+<para>
+  As said in the overview, the processes can declare to hear on several
+  sockets, but all incoming messages are handled by the same loop. So, we
+  can use only one channel per process, and use a table on each host to
+  determine to which process a message should be delivered depending on the
+  socket number provided by the sender.
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:See_Also ##### -->
+<para>
+RL, the implementation suited for real life.
+</para>
+
+<!--
+Local variables:
+sgml-parent-document:\.\./gras-docs\.sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-namecase-general:t
+sgml-general-insert-case:lower
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Short_Description ##### -->
+Implementation of GRAS on top of the simulator.
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Title ##### -->
+SG
+
+
 <!-- ##### SECTION ./tmpl/nws_comm.sgml:Long_Description ##### -->
 <para>
 
@@ -807,6 +1006,20 @@ Sockets
 @a4: 
 @a5: 
 
+<!-- ##### MACRO CWARNING6 ##### -->
+<para>
+
+</para>
+
+@c: 
+@f: 
+@a1: 
+@a2: 
+@a3: 
+@a4: 
+@a5: 
+@a6: 
+
 <!-- ##### FUNCTION CallAddr ##### -->
 <para>
 
@@ -827,6 +1040,17 @@ Sockets
 @waitForPeer: 
 @Returns: 
 
+<!-- ##### FUNCTION ConvertData ##### -->
+<para>
+
+</para>
+
+@destination: 
+@source: 
+@description: 
+@length: 
+@sourceFormat: 
+
 <!-- ##### FUNCTION CreateLocalChild ##### -->
 <para>
 
@@ -872,6 +1096,29 @@ Sockets
 @STRUCT_TYPE: 
 @LAST_TYPE: 
 
+<!-- ##### FUNCTION DifferentFormat ##### -->
+<para>
+
+</para>
+
+@whatType: 
+@Returns: 
+
+<!-- ##### FUNCTION DifferentOrder ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+<!-- ##### FUNCTION DifferentSize ##### -->
+<para>
+
+</para>
+
+@whatType: 
+@Returns: 
+
 <!-- ##### MACRO END_DECL ##### -->
 <para>
 
@@ -981,6 +1228,27 @@ Sockets
 </para>
 
 
+<!-- ##### FUNCTION HomogenousConvertData ##### -->
+<para>
+
+</para>
+
+@destination: 
+@source: 
+@whatType: 
+@repetitions: 
+@sourceFormat: 
+
+<!-- ##### FUNCTION HomogenousDataSize ##### -->
+<para>
+
+</para>
+
+@whatType: 
+@repetitions: 
+@format: 
+@Returns: 
+
 <!-- ##### TYPEDEF IPAddress ##### -->
 <para>
 
@@ -1204,6 +1472,17 @@ Sockets
 @sd: 
 @Returns: 
 
+<!-- ##### FUNCTION ReverseData ##### -->
+<para>
+
+</para>
+
+@destination: 
+@source: 
+@whatType: 
+@repetitions: 
+@format: 
+
 <!-- ##### MACRO SIMPLE_DATA ##### -->
 <para>
 
@@ -1221,6 +1500,12 @@ Sockets
 @repetitions: 
 @offset: 
 
+<!-- ##### MACRO SIMPLE_TYPE_COUNT ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### MACRO STDC_HEADERS ##### -->
 <para>
 
@@ -1269,6 +1554,19 @@ Sockets
 </para>
 
 
+<!-- ##### MACRO WARNING6 ##### -->
+<para>
+
+</para>
+
+@f: 
+@a1: 
+@a2: 
+@a3: 
+@a4: 
+@a5: 
+@a6: 
+
 <!-- ##### USER_FUNCTION grasCallbackFunction ##### -->
 <para>
 
@@ -1424,6 +1722,16 @@ Sockets
 @Varargs: 
 @Returns: 
 
+<!-- ##### FUNCTION grasMsgRecv ##### -->
+<para>
+
+</para>
+
+@msg: 
+@timeout: 
+@Returns: 
+@sd: 
+
 <!-- ##### FUNCTION grasMsgRegister ##### -->
 <para>
 
@@ -1585,6 +1893,328 @@ Sockets
 @c: 
 @data: 
 
+<!-- ##### MACRO gras_datadesc_declare_array ##### -->
+<para>
+
+</para>
+
+@name: 
+@elm_type: 
+@size: 
+@code: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_array_cb ##### -->
+<para>
+
+</para>
+
+@name: 
+@element_type: 
+@fixed_size: 
+@dynamic_size: 
+@post: 
+@code: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_ref_cb ##### -->
+<para>
+
+</para>
+
+@name: 
+@referenced_type: 
+@discriminant: 
+@post: 
+@code: 
+@Returns: 
+
+<!-- ##### MACRO gras_datadesc_declare_ref_disc ##### -->
+<para>
+
+</para>
+
+@name: 
+@discriminant: 
+@code: 
+
+<!-- ##### MACRO gras_datadesc_declare_struct_add_code ##### -->
+<para>
+
+</para>
+
+@struct_code: 
+@field_name: 
+@field_type_code: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_add_code_cb ##### -->
+<para>
+
+</para>
+
+@struct_code: 
+@field_name: 
+@field_code: 
+@pre_cb: 
+@post_cb: 
+@Returns: 
+
+<!-- ##### MACRO gras_datadesc_declare_struct_add_name ##### -->
+<para>
+
+</para>
+
+@struct_code: 
+@field_name: 
+@field_type_name: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_add_name_cb ##### -->
+<para>
+
+</para>
+
+@struct_code: 
+@field_name: 
+@field_type_name: 
+@pre_cb: 
+@post_cb: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_cb ##### -->
+<para>
+
+</para>
+
+@name: 
+@pre_cb: 
+@post_cb: 
+@code: 
+@Returns: 
+
+<!-- ##### MACRO gras_datadesc_declare_union_add_code ##### -->
+<para>
+
+</para>
+
+@union_code: 
+@field_name: 
+@field_type_code: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_add_code_cb ##### -->
+<para>
+
+</para>
+
+@union_code: 
+@field_name: 
+@field_code: 
+@pre_cb: 
+@post_cb: 
+@Returns: 
+
+<!-- ##### MACRO gras_datadesc_declare_union_add_name ##### -->
+<para>
+
+</para>
+
+@union_code: 
+@field_name: 
+@field_type_name: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_add_name_cb ##### -->
+<para>
+
+</para>
+
+@union_code: 
+@field_name: 
+@field_type_name: 
+@pre_cb: 
+@post_cb: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_cb ##### -->
+<para>
+
+</para>
+
+@name: 
+@field_count: 
+@post: 
+@code: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_datadesc_from_nws ##### -->
+<para>
+
+</para>
+
+@name: 
+@desc: 
+@howmany: 
+@code: 
+@Returns: 
+@dst: 
+
+<!-- ##### FUNCTION gras_datadesc_parse ##### -->
+<para>
+
+</para>
+
+@name: 
+@Cdefinition: 
+@dst: 
+@Returns: 
+@code: 
+@def: 
+
+<!-- ##### FUNCTION gras_ddt_free ##### -->
+<para>
+
+</para>
+
+@type: 
+
+<!-- ##### FUNCTION gras_ddt_get_by_code ##### -->
+<para>
+
+</para>
+
+@code: 
+@type: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_get_by_name ##### -->
+<para>
+
+</para>
+
+@name: 
+@type: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_array ##### -->
+<para>
+
+</para>
+
+@name: 
+@element_type: 
+@fixed_size: 
+@dynamic_size: 
+@post: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_from_nws ##### -->
+<para>
+
+</para>
+
+@name: 
+@desc: 
+@howmany: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_ignored ##### -->
+<para>
+
+</para>
+
+@name: 
+@default_value: 
+@free_func: 
+@size: 
+@alignment: 
+@post: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_parse ##### -->
+<para>
+
+</para>
+
+@name: 
+@C_definition: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_ref ##### -->
+<para>
+
+</para>
+
+@name: 
+@referenced_type: 
+@discriminant: 
+@post: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_scalar ##### -->
+<para>
+
+</para>
+
+@name: 
+@type: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_struct ##### -->
+<para>
+
+</para>
+
+@name: 
+@pre: 
+@post: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_struct_append ##### -->
+<para>
+
+</para>
+
+@struct_type: 
+@name: 
+@field_type: 
+@pre: 
+@post: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_union ##### -->
+<para>
+
+</para>
+
+@name: 
+@field_count: 
+@post: 
+@dst: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_new_union_append ##### -->
+<para>
+
+</para>
+
+@union_type: 
+@name: 
+@field_type: 
+@pre: 
+@post: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_ddt_register ##### -->
+<para>
+
+</para>
+
+@type: 
+@Returns: 
+
 <!-- ##### FUNCTION gras_dict_cursor_next ##### -->
 <para>
 
@@ -1635,6 +2265,43 @@ Sockets
 @cat: 
 @thresholdPriority: 
 
+<!-- ##### FUNCTION gras_msg_discard ##### -->
+<para>
+
+</para>
+
+@sd: 
+@size: 
+
+<!-- ##### FUNCTION gras_msg_free ##### -->
+<para>
+
+</para>
+
+@msg: 
+
+<!-- ##### FUNCTION gras_msg_new ##### -->
+<para>
+
+</para>
+
+@msgId: 
+@free_data_on_free: 
+@seqCount: 
+@Varargs: 
+@Returns: 
+
+<!-- ##### FUNCTION gras_msgtype_register ##### -->
+<para>
+
+</para>
+
+@msgId: 
+@name: 
+@sequence_count: 
+@Varargs: 
+@Returns: 
+
 <!-- ##### FUNCTION gras_sock_client_open ##### -->
 <para>
 
@@ -1679,14 +2346,6 @@ Sockets
 @sock: 
 @Returns: 
 
-<!-- ##### FUNCTION gras_socket_peer_name ##### -->
-<para>
-
-</para>
-
-@sd: 
-@Returns: 
-
 <!-- ##### FUNCTION gras_unlock ##### -->
 <para>
 
index 65544a5..5e633a5 100644 (file)
@@ -14,18 +14,6 @@ Implementation of GRAS suited for real life.
 
 </para>
 
-<!-- ##### FUNCTION grasMsgRecv ##### -->
-<para>
-
-</para>
-
-@msg: 
-@timeout: 
-@Returns: 
-<!-- # Unused Parameters # -->
-@sd: 
-
-
 <!-- ##### FUNCTION ConvertData ##### -->
 <para>
 
index 0d6f869..fefcb24 100644 (file)
@@ -440,7 +440,7 @@ An easy-to-use, fast and flexible message logging architecture.
 @a6: 
 
 
-<!-- ##### MACRO CWARNING6 ##### -->
+<!-- ##### MACRO CWARN6 ##### -->
 <para>
 
 </para>
@@ -527,7 +527,7 @@ An easy-to-use, fast and flexible message logging architecture.
 @a6: 
 
 
-<!-- ##### MACRO WARNING6 ##### -->
+<!-- ##### MACRO WARN6 ##### -->
 <para>
 
 </para>