doc: quickly shovel other calls into node topo and quiescence
authorRamprasad Venkataraman <ramv@illinois.edu>
Tue, 31 Jul 2012 19:58:14 +0000 (14:58 -0500)
committerRamprasad Venkataraman <ramv@illinois.edu>
Tue, 31 Jul 2012 19:58:14 +0000 (14:58 -0500)
doc/charm++/othercalls.tex
doc/charm++/quiesce.tex
doc/charm++/topology.tex

index ca52712b81a302d5d7f664069293996906c35e51..1f7e6d3cf410ea570985c23bcef2bdb75b740fab 100644 (file)
@@ -41,48 +41,8 @@ before the computation actually begins.
 
 \label{other Charm++ calls}
 
-The following calls provide information about the machines upon which the
-parallel program is executing.  Processing Element refers to a single CPU.
-Node refers to a single machine-- a set of processing elements which share
-memory (i.e. an address space).  Processing Elements and Nodes are numbered,
-starting from zero.
-
-Thus if a parallel program is executing on one 4-processor workstation and one
-2-processor workstation, there would be 6 processing elements (0, 1 ,2, 3, 4,
-and 5) but only 2 nodes (0 and 1).  A given node's processing elements are
-numbered sequentially.
-
-\function{int CkMyRank()} \index{CkMyRank}
-\desc{returns the rank number of the processor on which the call was made.
-Processing elements within a node are ranked starting from zero.}
-
-\function{int CkMyNode()} \index{CkMyNode}
-\desc{returns the address space number (node number) on which the call was made.}
-
-\function{int CkNumNodes()} \index{CkMyNodes}
-\desc{returns the total number of address spaces.}
-
-\function{int CkNodeFirst(int node)} \index{CkNodeFirst}
-\desc{returns the processor number of the first processor in this address space.}
-
-\function{int CkNodeSize(int node)} \index{CkNodeSize}
-\desc{returns the number of processors in the address space on which the call was made.}
-
-\function{int CkNodeOf(int pe)} \index{CkNodeOf}
-\desc{returns the node number on which the call was made.}
-
-\function{int CkRankOf(int pe)} \index{CkRankOf}
-\desc{returns the rank of the given processor within its node.}
-
 The following calls provide commonly needed functions.
 
-\function{void CkExitAfterQuiescence()} \index{CkExitAfterQuiescence}
-\desc{This call informs the Charm RTS that computation on all processors
-should terminate as soon as the machine becomes completely idle--that is,
-after all messages and entry methods are finished.  This is the state of 
-quiescence, as described further in Section~\ref{sec:qd}.
-This routine returns immediately.}
-
 \function{double CkCpuTimer()} \index{CkCpuTimer} \index{timers}
 \desc{Returns the current value of the system timer in seconds. The system
 timer is started when the program begins execution. This timer measures process
index ffa6f447e1d0056cc4f4fbe7c8f9d85a70e4e7eb..1262ecaae75833edf75655aa8fe4352b8baf08c5 100644 (file)
@@ -153,3 +153,10 @@ method it would suspend the main thread of execution of the processor from
 which \kw{CkWaitQD} was called and the entire program would come to a grinding
 halt on that processor.
 
+\function{void CkExitAfterQuiescence()} \index{CkExitAfterQuiescence}
+\desc{This call informs the Charm RTS that computation on all processors
+should terminate as soon as the machine becomes completely idle--that is,
+after all messages and entry methods are finished.  This is the state of 
+quiescence, as described further in Section~\ref{sec:qd}.
+This routine returns immediately.}
+
index bddaf176ac22bd38d38f5ba158c0554bfd3f0316..b267cd8a1f18e82411085f037bfb362d87b8b9d7 100644 (file)
@@ -1,4 +1,37 @@
 \section{Network Topology}
 \section{Node Topology}
 chao to write this section.
-can move all the text from the "other calls" section
+
+The following calls provide information about the machines upon which the
+parallel program is executing.  Processing Element refers to a single CPU.
+Node refers to a single machine-- a set of processing elements which share
+memory (i.e. an address space).  Processing Elements and Nodes are numbered,
+starting from zero.
+
+Thus if a parallel program is executing on one 4-processor workstation and one
+2-processor workstation, there would be 6 processing elements (0, 1 ,2, 3, 4,
+and 5) but only 2 nodes (0 and 1).  A given node's processing elements are
+numbered sequentially.
+
+\function{int CkMyRank()} \index{CkMyRank}
+\desc{returns the rank number of the processor on which the call was made.
+Processing elements within a node are ranked starting from zero.}
+
+\function{int CkMyNode()} \index{CkMyNode}
+\desc{returns the address space number (node number) on which the call was made.}
+
+\function{int CkNumNodes()} \index{CkMyNodes}
+\desc{returns the total number of address spaces.}
+
+\function{int CkNodeFirst(int node)} \index{CkNodeFirst}
+\desc{returns the processor number of the first processor in this address space.}
+
+\function{int CkNodeSize(int node)} \index{CkNodeSize}
+\desc{returns the number of processors in the address space on which the call was made.}
+
+\function{int CkNodeOf(int pe)} \index{CkNodeOf}
+\desc{returns the node number on which the call was made.}
+
+\function{int CkRankOf(int pe)} \index{CkRankOf}
+\desc{returns the rank of the given processor within its node.}
+