new doxygen structure for converse machine layer
authorFilippo Gioachin <gioachin@illinois.edu>
Wed, 6 Oct 2004 01:28:55 +0000 (01:28 +0000)
committerFilippo Gioachin <gioachin@illinois.edu>
Wed, 6 Oct 2004 01:28:55 +0000 (01:28 +0000)
25 files changed:
src/arch/elan/machine.c
src/arch/elan/persistent.c
src/arch/exemplar/machine.c
src/arch/mpi/machine.c
src/arch/ncube2/machine.c
src/arch/net/machine-dgram.c
src/arch/net/machine-eth.c
src/arch/net/machine-gm.c
src/arch/net/machine-tcp.c
src/arch/net/machine.c
src/arch/origin-pthreads/machine.c
src/arch/origin2000/machine.c
src/arch/shmem/machine.c
src/arch/sp3/machine.c
src/arch/t3e/machine.c
src/arch/uth/machine.c
src/arch/util/immediate.c
src/arch/util/machine-smp.c
src/arch/util/machine-smp.h
src/arch/util/machine.h
src/arch/util/pcqueue.h
src/arch/util/persist-comm.c
src/arch/util/persist_impl.h
src/arch/vmi/machine.c
src/arch/vmi/machine.h

index b5590f2c35921247968bb128ff75ca92a9fad1ef..320ed0df3ee0302890de93e7d7bf242a937a58b4 100644 (file)
@@ -1,3 +1,8 @@
+/** @file
+ * Elan machine layer
+ * @ingroup Machine
+*/
+
 /* Charm++ Machine Layer for ELAN network interface 
 Developed by Sameer Kumar
 */
index 4a91db35484a7d7f5106831aedebe8ce99729add..880b3d0f6a89d78334a1d4cb14b1c9add55e7939 100644 (file)
@@ -1,3 +1,8 @@
+/** @file
+ * Elan persistent communication
+ * @ingroup Machine
+*/
+
 /*
   included in machine.c
   common code for persistent communication now is moved to persist-comm.c
index 10204f954f01c2bdf2bce9b7cc8c5e93b37c7bd1..d0de8b59d3417d097960042b4552d302adaf34c4 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * Exemplar machine layer
+ * @ingroup Machine
+ */
+/*@{*/
+
 #include <spp_prog_model.h>
 #include <memory.h>
 #include <cps.h>
@@ -363,3 +369,5 @@ McQueue *queue;
        m_unlock(&(queue->sema));
        return element;
 }
+
+/*@}*/
index d5db07c40260357a87b6a930c0edcc104749f2a8..f94331611b90db57b4404b2f11a2b3a6f37c5d37 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * MPI based machine layer
+ * @ingroup Machine
+ */
+/*@{*/
+
 #include <stdio.h>
 #include <errno.h>
 #include "converse.h"
@@ -1508,3 +1514,5 @@ void * recdQueueRemoveFromFront(void)
 }
 
 #endif
+
+/*@}*/
index 15d7fd241545cc493171e9db0dac4f819f330c8a..89ae31875c303ec899713068061243c7a8982bb0 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * Ncube2 machine layer
+ * @ingroup Machine
+ */
+/*@{*/
+
 #include <stdio.h>
 #include "converse.h"
 
@@ -258,5 +264,4 @@ int usched, initret;
   }
 }
 
-
-
+/*@}*/
index f16781ebe28e3a57b850ca4a2865fd2a9e566ce5..f9f4d9ffc543f12152f2a88fac7089dddb164198 100644 (file)
@@ -1,17 +1,21 @@
-/*
-  Datagram implementation of Converse NET version
+/** @file
+ * Datagram implementation of Converse NET version
+ * @ingroup NET
+ * converse basic message header:<br>
+ * d0 d1 d2 d3:  DgramHeader<br>
+ * d4 d5:        msg length (32-bit number)<br>
+ * hdl:          handler<br>
+ * xhdl:         extended handler<br>
 
   moved from machine.c by 
   Orion Sky Lawlor, olawlor@acm.org, 7/25/2001
 */
 
 /**
-  converse basic message header:
-  d0 d1 d2 d3:  DgramHeader
-  d4 d5:        msg length (32-bit number)
-  hdl:          handler
-  xhdl:         extended handler
-*/
+ * @addtogroup NET
+ * @{
+ */
+
 #define DGRAM_HEADER_SIZE 8
 
 #define CmiMsgHeaderSetLength(msg, len) (((int*)(msg))[2] = (len))
@@ -585,3 +589,5 @@ void CmiBarrierZero()
 }
 
 #endif
+
+/*@}*/
index 519275401ede6c5f97fb6431ab97043d677fff29..da44fed7597b930042ac26de7015cb772c6a9937 100644 (file)
@@ -1,15 +1,21 @@
-/*
-  UDP implementation of Converse NET version
-  contains only UDP specific code for:
-  * CmiMachineInit()
-  * CmiNotifyIdle()
-  * DeliverViaNetwork()
-  * CommunicationServer()
+/** @file
+ * UDP implementation of Converse NET version
+ * @ingroup NET
+ * contains only UDP specific code for:
+ * - CmiMachineInit()
+ * - CmiNotifyIdle()
+ * - DeliverViaNetwork()
+ * - CommunicationServer()
 
   moved from machine.c by 
   Gengbin Zheng, gzheng@uiuc.edu  4/22/2001
 */
 
+/**
+ * @addtogroup NET
+ * @{
+ */
+
 /******************************************************************************
  *
  * CmiNotifyIdle()-- wait until a packet comes in
index 8892dd8d2855e6d28f6f87d82c3cb2f4a7d6bbc3..e48f5257ab1de561deaa550369bf5dd7abbcb9e5 100644 (file)
@@ -1,10 +1,11 @@
-/*
-  Myrinet API GM implementation of Converse NET version
-  contains only GM API specific code for:
-  * CmiMachineInit()
-  * CmiNotifyIdle()
-  * DeliverViaNetwork()
-  * CommunicationServer()
+/** @file
+ * Myrinet API GM implementation of Converse NET version
+ * @ingroup NET
+ * contains only GM API specific code for:
+ * - CmiMachineInit()
+ * - CmiNotifyIdle()
+ * - DeliverViaNetwork()
+ * - CommunicationServer()
 
   written by 
   Gengbin Zheng, gzheng@uiuc.edu  4/22/2001
   1. DMAable buffer reuse;
 */
 
+/**
+ * @addtogroup NET
+ * @{
+ */
+
 #ifdef GM_API_VERSION_2_0
 #if GM_API_VERSION >= GM_API_VERSION_2_0
 #define CMK_USE_GM2    1
@@ -787,3 +793,5 @@ static char *getErrorMsg(gm_status_t status)
   }
   return errmsg;
 }
+
+/*@}*/
index da08e04a63b6a4c4dd15874acd8adbbe4042ab3c..92fd7b0a63697079e5d95c03ed88486a98702bac 100644 (file)
@@ -1,11 +1,12 @@
-/*
-  TCP implementation of Converse NET version
-  contains only TCP specific code for:
-  * CmiMachineInit()
-  * CheckSocketsReady()
-  * CmiNotifyIdle()
-  * DeliverViaNetwork()
-  * CommunicationServer()
+/** @file
+ * TCP implementation of Converse NET version
+ * @ingroup NET
+ * contains only TCP specific code for:
+ * - CmiMachineInit()
+ * - CheckSocketsReady()
+ * - CmiNotifyIdle()
+ * - DeliverViaNetwork()
+ * - CommunicationServer()
 
   written by 
   Gengbin Zheng, 12/21/2001
   now also works with SMP version  //  Gengbin 6/18/2003
 */
 
+/**
+ * @addtogroup NET
+ * @{
+ */
+
 #if !defined(_WIN32) || defined(__CYGWIN__)
 #include <netinet/tcp.h>
 #include <sys/types.h>
@@ -615,4 +621,4 @@ static void open_tcp_sockets()
   }
 }
 
-
+/*@}*/
index ae0c8e608bb46004a9132b4fc9fcaa5bec927584..e434591d105283f8e4838bedf9efcfb586cbc2ba 100644 (file)
@@ -5,8 +5,14 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * Basic NET implementation of Converse machine layer
+ * @ingroup NET
+ */
 
-/******************************************************************************
+/** @defgroup NET
+ * NET implementation of machine layer, ethernet in particular
+ * @ingroup Machine
  *
  * THE DATAGRAM STREAM
  *
  *
  *****************************************************************************/
 
+/**
+ * @addtogroup NET
+ * @{
+ */
+
 /*****************************************************************************
  *
  * Include Files
@@ -2288,3 +2299,5 @@ void persist_machine_init()
 }
 
 #endif
+
+/*@}*/
index e88bf8af576498e6dc7770b6237c2c2426d266cf..c9b1008c9b089ce1a2b6affe074a3eb29426a89d 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * Origin Pthreads machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include <errno.h>
 #include <pthread.h>
 #include <sched.h>
@@ -413,3 +419,4 @@ double CmiTimer(void)
   return CmiCpuTimer();
 }
 
+/*@}*/
index 5c5cca88ac95658fed052eb81a7b291ced543dd2..9cdefaf82c014d4759c506efc4547909897abfce 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * Origin2000 machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include <sys/types.h>
 #include <sys/sysmp.h>
 #include <sys/sysinfo.h>
@@ -434,3 +440,4 @@ double CmiTimer(void)
   return CmiCpuTimer();
 }
 
+/*@}*/
index ff04a6ce9f449d0473db75f303a3048b031d3e83..6be498106f9f1cd0a34faa205f1a5263065951af 100644 (file)
@@ -5,10 +5,13 @@
  * $Revision$
  *****************************************************************************/
 
-/*
+/** @file
+ * Shared memory machine layer
+ * @ingroup Machine
  * This is a complete port, but could be made considerably more efficient
  * by handling asynchronous messages correctly, ie. without doing
  * an extra copy and synchronous send
+ * @{
  */
 
 #include <stdlib.h>
@@ -987,3 +990,5 @@ double CmiTimer(void)
 static volatile int memflag;
 void CmiMemLock() { memflag=1; }
 void CmiMemUnlock() { memflag=0; }
+
+/*@}*/
index 86d1c16f5ff11bcb9bfb0ed4cb4dbb6fd557ec73..d62a7f12e4c8a4185f936698fa46035922e7b088 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * SP3 machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include <stdio.h>
 #include <sys/time.h>
 #include "converse.h"
@@ -379,3 +385,4 @@ void * recdQueueRemoveFromFront(void)
   return 0;
 }
 
+/*@}*/
index 97f73860f6619f83032459eb988bb7cce02bfc4a..a983a5aaba5d7a0a04b5257523baf3d4c5bda50a 100644 (file)
@@ -5,10 +5,13 @@
  * $Revision$
  *****************************************************************************/
 
-/*
+/** @file
+ * T3E machine layer
+ * @ingroup Machine
  * This is a complete port, but could be made considerably more efficient
  * by handling asynchronous messages correctly, ie. without doing
  * an extra copy and synchronous send
+ * @{
  */
 
 #include <stdlib.h>
@@ -904,3 +907,5 @@ double CmiTimer()
 static volatile int memflag;
 void CmiMemLock() { memflag=1; }
 void CmiMemUnlock() { memflag=0; }
+
+/*@}*/
index 362769da7b5de9206816b312d19695e69769a3a4..32bc5a2b96d827fc3e9f23b82e41a44aededb5d6 100644 (file)
@@ -5,6 +5,12 @@
  * $Revision$
  *****************************************************************************/
 
+/** @file
+ * User-level threads machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include <stdio.h>
 #include <math.h>
 #include "converse.h"
@@ -335,4 +341,4 @@ int CmiSwitchToPE(int newpe)
 }
 #endif
 
-
+/*@}*/
index baa6b990e92450827c01a2f1c10759c8a5db5114..daf726aedf78f9522aef692287b477d9eed7a554 100644 (file)
@@ -1,3 +1,13 @@
+/** @file
+ * \brief Immediate message implementation
+ * \ingroup Machine
+ */
+
+/**
+ * \addtogroup Machine
+*/
+/*@{*/
+
 /*
   support immediate message in Converse
 */
@@ -120,3 +130,5 @@ void CmiHandleImmediate()
 }
 
 #endif
+
+/*@}*/
index a625c42d22c1274c816c18c4ba50cf3d91fc91a0..68a3b3164bf158d1d3c7ef77a6190a37774b373f 100644 (file)
@@ -1,26 +1,6 @@
-
-/*
-for SMP versions:
-
-CmiStateInit
-CmiNodeStateInit
-CmiGetState
-CmiGetStateN
-CmiYield
-CmiStartThreads
-
-CmiIdleLock_init
-CmiIdleLock_sleep
-CmiIdleLock_addMessage
-CmiIdleLock_checkMessage
-*/
-
-#include "machine-smp.h"
-
-void CmiStateInit(int pe, int rank, CmiState state);
-void CommunicationServerInit();
-
-/******************************************************************************
+/** @file
+ * @brief Common function reimplementation for SMP machines
+ * @ingroup Machine
  *
  * OS Threads
  *
@@ -77,6 +57,32 @@ void CommunicationServerInit();
 
  *****************************************************************************/
 
+/**
+ * \addtogroup Machine
+ * @{
+ */
+
+/*
+for SMP versions:
+
+CmiStateInit
+CmiNodeStateInit
+CmiGetState
+CmiGetStateN
+CmiYield
+CmiStartThreads
+
+CmiIdleLock_init
+CmiIdleLock_sleep
+CmiIdleLock_addMessage
+CmiIdleLock_checkMessage
+*/
+
+#include "machine-smp.h"
+
+void CmiStateInit(int pe, int rank, CmiState state);
+void CommunicationServerInit();
+
 /************************ Win32 kernel SMP threads **************/
 static struct CmiStateStruct Cmi_default_state; /* State structure to return during startup */
 
@@ -546,4 +552,4 @@ void CmiNodeStateInit(CmiNodeState *nodeState)
 #endif
 }
 
-
+/*@}*/
index 0ac4c0b842392dfa347e4f772b31e0dd4e4ab244..b4c3cbf76076fd71ab71907ba51d1c84196c3b9a 100644 (file)
@@ -1,3 +1,12 @@
+/** @file
+ * \brief structures for the SMP versions
+ * \ingroup Machine
+ */
+
+/**
+ * \addtogroup Machine
+ * @{
+ */
 
 #ifndef MACHINE_SMP_H
 #define MACHINE_SMP_H
@@ -70,3 +79,5 @@ typedef struct CmiNodeStateStruct
 CmiNodeState;
 
 #endif
+
+/*@}*/
index 391cf5d47dc6546838a5c040efdef8296051f268..d44d8e5776af48f2086a6c3fad637595cf0d0687 100644 (file)
@@ -1,3 +1,32 @@
+/**
+ * \defgroup Machine Converse Machine Layer
+ * \brief Common structures for all implementations of the machine layer
+ * \ingroup Converse
+
+ The machine layer of Converse consist of few common files to all architectures, shown in this module, which are:
+ - immediate.c
+ - machine-smp.c
+ - machine-smp.h
+ - machine.h
+ - pcqueue.h
+ - persist-comm.c
+ - persist_impl.h
+
+ These files describe the common characteristics of all implementations, and provide converse, and every language built on top of it the same functional interface in all machines, however different they are.
+
+ In addition to these common files, there are files called "machine.c" which are the real implementation for the different architectures. Every file is in a different directory, and get selected for compilation at compile time through the "build" script. With this implementation, only one single machine layer can be compiled into the runtime system. Changing architecture needs a different compilation.
+*/
+
+/** @file
+ * common machine header
+ * @ingroup Machine
+ */
+
+/**
+ * \addtogroup Machine
+*/
+/*@{*/
+
 #ifndef MACHINE_H
 #define MACHINE_H
 
@@ -48,3 +77,5 @@ FILE *debugLog;
 
 
 #endif
+
+/*@}*/
index 0117e04dea4030d2d2bdb548408a6770cb484e76..ebd7d6f7abbafdd1ac7a48ac2cdc5b6ead32bbc3 100644 (file)
@@ -1,10 +1,6 @@
-
-#ifndef __PCQUEUE__
-#define __PCQUEUE__
-
-/*****************************************************************************
- *
- * Producer-Consumer Queues
+/** @file
+ * @brief Producer-Consumer Queues
+ * @ingroup Machine
  *
  * This queue implementation enables a producer and a consumer to
  * communicate via a queue.  The queues are optimized for this situation,
  *
  ****************************************************************************/
 
+/**
+ * \addtogroup Machine
+ * @{
+ */
+
+#ifndef __PCQUEUE__
+#define __PCQUEUE__
+
 /*****************************************************************************
  * #define PCQUEUE_LOCK
  * PCQueue doesn't need any lock, the lock here is only 
@@ -170,3 +174,5 @@ void PCQueuePush(PCQueue Q, char *data)
 
 
 #endif
+
+/*@}*/
index 57eadde8ff54a42f0db16ef5794051448db13043..88dfdd67a0cc75dbbe2fb0a9426b658bae603080 100644 (file)
@@ -1,3 +1,12 @@
+/** @file
+ * Support for persistent communication setup
+ * @ingroup Machine
+ */
+
+/**
+ * \addtogroup Machine
+*/
+/*@{*/
 
 #include "converse.h"
 
@@ -383,3 +392,5 @@ void CmiUsePersistentHandle(PersistentHandle *p, int n)
 }
 
 #endif
+
+/*@}*/
index 23c93932abffc6241af2d8cb4b3c28100fb65c6a..48cddf17853f38067ecc09fc1466345dcc8ede00 100644 (file)
@@ -1,3 +1,12 @@
+/** @file
+ * General implementation of persistent communication support
+ * @ingroup Machine
+ */
+
+/**
+ * \addtogroup Machine
+*/
+/*@{*/
 
 #define PERSIST_BUFFERS_NUM   2
 
@@ -32,4 +41,4 @@ int PumpPersistent();
 void swapSendSlotBuffers(PersistentSendsTable *slot);
 void swapRecvSlotBuffers(PersistentReceivesTable *slot);
 
-
+/*@}*/
index 09941294b8f0e2eaef481f177cba7d189e66f842..53c63d518040460cae5d57f35b922916ff93297a 100644 (file)
 **    * very cool, but very complicated
 */
 
+/** @file
+ * VMI machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include "machine.h"
 
 /* The following are external variables used by the VMI core. */
@@ -4048,3 +4054,5 @@ int CRMRecv (SOCKET s, char *msg, int n)
 
   return recvd;
 }
+
+/*@}*/
index 9cbd5bdf4c5104d22b29dd30e3145acf91ad1692..97c3ddf9ce08c9e3da4a57eeb82278ad82422a42 100644 (file)
@@ -2,6 +2,12 @@
 ** Greg Koenig (koenig@uiuc.edu)
 */
 
+/** @file
+ * VMI machine layer
+ * @ingroup Machine
+ * @{
+ */
+
 #include <ctype.h>
 #include <errno.h>
 #include <fcntl.h>
@@ -477,3 +483,5 @@ BOOLEAN CRMParseMsg (PCRM_Msg msg, int rank, int *nodeIP,
                     int *shutdownPort, int *nodePE);
 int CRMSend (SOCKET s, char *msg, int n);
 int CRMRecv (SOCKET s, char *msg, int n);
+
+/*@}*/