148171c65d9d2e9f5e88b8909dd56ce383fcaebb
[charm.git] / src / arch / util / machine-common-core.c
1 /*
2  *created by Chao Mei
3  *revised by Yanhua
4  */
5 #if CMK_C_INLINE
6 #define INLINE_KEYWORD inline
7 #else
8 #define INLINE_KEYWORD
9 #endif
10
11 /******* broadcast related  */
12 #ifndef CMK_BROADCAST_SPANNING_TREE
13 #define CMK_BROADCAST_SPANNING_TREE    1
14 #endif
15
16 #ifndef CMK_BROADCAST_HYPERCUBE
17 #define CMK_BROADCAST_HYPERCUBE        0
18 #endif
19
20 #define BROADCAST_SPANNING_FACTOR      4
21 /* The number of children used when a msg is broadcast inside a node */
22 #define BROADCAST_SPANNING_INTRA_FACTOR  8
23
24 /* Root of broadcast:
25  * non-bcast msg: root = 0;
26  * proc-level bcast msg: root >=1; (CmiMyPe()+1)
27  * node-level bcast msg: root <=-1; (-CmiMyNode()-1)
28  */
29 #define CMI_BROADCAST_ROOT(msg)          ((CmiMsgHeaderBasic *)msg)->root
30 #define CMI_SET_BROADCAST_ROOT(msg, root)  CMI_BROADCAST_ROOT(msg) = (root);
31
32 /**
33  * For some machine layers such as on Active Message framework,
34  * the receiver callback is usally executed on an internal
35  * thread (i.e. not the flow managed by ours). Therefore, for
36  * forwarding broadcast messages, we could have a choice whether
37  * to offload such function to the flow we manage such as the
38  * communication thread. -
39  */
40
41 #ifndef CMK_OFFLOAD_BCAST_PROCESS
42 #define CMK_OFFLOAD_BCAST_PROCESS 0
43 #endif
44
45 #if CMK_OFFLOAD_BCAST_PROCESS
46 CsvDeclare(PCQueue, procBcastQ);
47 #if CMK_NODE_QUEUE_AVAILABLE
48 CsvDeclare(PCQueue, nodeBcastQ);
49 #endif
50 #endif
51
52 static int  MSG_STATISTIC = 0;
53 int     msg_histogram[22];
54 static int _cmi_log2(int size)
55 {
56     int ret = 1;
57     size = size-1;
58     while( (size=size>>1)>0) ret++;
59     return ret;
60 }
61 #if CMK_BROADCAST_HYPERCUBE
62 /* ceil(log2(CmiNumNodes)) except when _Cmi_numnodes is 1, used for hypercube */
63 static int CmiNodesDim;
64 #endif
65 /* ###End of Broadcast related definitions ### */
66
67
68 static void handleOneBcastMsg(int size, char *msg);
69 static void processBcastQs();
70
71 /* Utility functions for forwarding broadcast messages,
72  * should not be used in machine-specific implementations
73  * except in some special occasions.
74  */
75 static void processProcBcastMsg(int size, char *msg);
76 static void processNodeBcastMsg(int size, char *msg);
77 static void SendSpanningChildrenProc(int size, char *msg);
78 static void SendHyperCubeProc(int size, char *msg);
79 #if CMK_NODE_QUEUE_AVAILABLE
80 static void SendSpanningChildrenNode(int size, char *msg);
81 static void SendHyperCubeNode(int size, char *msg);
82 #endif
83
84 static void SendSpanningChildren(int size, char *msg, int rankToAssign, int startNode);
85 static void SendHyperCube(int size,  char *msg, int rankToAssign, int startNode);
86
87 #if USE_COMMON_SYNC_BCAST || USE_COMMON_ASYNC_BCAST
88 #if !CMK_BROADCAST_SPANNING_TREE && !CMK_BROADCAST_HYPERCUBE
89 #warning "Broadcast function is based on the plain P2P O(P)-message scheme!!!"
90 #endif
91 #endif
92
93
94 void CmiSyncBroadcastFn(int size, char *msg);
95 CmiCommHandle CmiAsyncBroadcastFn(int size, char *msg);
96 void CmiFreeBroadcastFn(int size, char *msg);
97
98 void CmiSyncBroadcastAllFn(int size, char *msg);
99 CmiCommHandle CmiAsyncBroadcastAllFn(int size, char *msg);
100 void CmiFreeBroadcastAllFn(int size, char *msg);
101
102 #if CMK_NODE_QUEUE_AVAILABLE
103 void CmiSyncNodeBroadcastFn(int size, char *msg);
104 CmiCommHandle CmiAsyncNodeBroadcastFn(int size, char *msg);
105 void CmiFreeNodeBroadcastFn(int size, char *msg);
106
107 void CmiSyncNodeBroadcastAllFn(int size, char *msg);
108 CmiCommHandle CmiAsyncNodeBroadcastAllFn(int size, char *msg);
109 void CmiFreeNodeBroadcastAllFn(int size, char *msg);
110 #endif
111
112 /************** Done with Broadcast related */
113
114 #define CMI_DEST_RANK(msg)               ((CmiMsgHeaderBasic *)msg)->rank
115
116 #ifndef CMK_HAS_SIZE_IN_MSGHDR
117 #define CMK_HAS_SIZE_IN_MSGHDR 1
118 #endif
119 #if CMK_HAS_SIZE_IN_MSGHDR
120 #define CMI_MSG_SIZE(msg)  ((CmiMsgHeaderBasic *)msg)->size
121 #else
122 #define CMI_MSG_SIZE(msg)  (CmiAbort("Has no msg size in header"))
123 #endif
124
125 #if CMK_NODE_QUEUE_AVAILABLE
126 /* This value should be larger than the number of cores used
127  * per charm smp node. So it's currently set to such a large
128  * value.
129  */
130 #define DGRAM_NODEMESSAGE   (0x1FFB)
131 #endif
132
133 /* Node state structure */
134 int               _Cmi_mynode;    /* Which address space am I */
135 int               _Cmi_mynodesize;/* Number of processors in my address space */
136 int               _Cmi_numnodes;  /* Total number of address spaces */
137 int               _Cmi_numpes;    /* Total number of processors */
138
139 CpvDeclare(void*, CmiLocalQueue);
140
141 /* different modes for sending a message */
142 #define P2P_SYNC 0x1
143 #define P2P_ASYNC 0x2
144 #define BCAST_SYNC 0x3
145 #define BCAST_ASYNC 0x4
146
147 #if CMK_SMP
148 static volatile int commThdExit = 0;
149 static CmiNodeLock  commThdExitLock = 0;
150
151 /**
152  *  The macro defines whether to have a comm thd to offload some
153  *  work such as forwarding bcast messages etc. This macro
154  *  should be defined before including "machine-smp.c". Note
155  *  that whether a machine layer in SMP mode could run w/o comm
156  *  thread depends on the support of the underlying
157  *  communication library.
158  *
159  */
160 #ifndef CMK_SMP_NO_COMMTHD
161 #define CMK_SMP_NO_COMMTHD 0
162 #endif
163
164 #if CMK_SMP_NO_COMMTHD
165 int Cmi_commthread = 0;
166 #else
167 int Cmi_commthread = 1;
168 #endif
169
170 #endif
171
172 /*SHOULD BE MOVED TO MACHINE-SMP.C ??*/
173 static int Cmi_nodestart;
174
175 /*
176  * Network progress utility variables. Period controls the rate at
177  * which the network poll is called
178  */
179 #ifndef NETWORK_PROGRESS_PERIOD_DEFAULT
180 #define NETWORK_PROGRESS_PERIOD_DEFAULT 1000
181 #endif
182
183 CpvDeclare(unsigned , networkProgressCount);
184 int networkProgressPeriod;
185
186
187 /* ===== Beginning of Common Function Declarations ===== */
188 void CmiAbort(const char *message);
189 static void PerrorExit(const char *msg);
190
191 /* This function handles the msg received as which queue to push into */
192 static void handleOneRecvedMsg(int size, char *msg);
193
194 /* Utility functions for forwarding broadcast messages,
195  * should not be used in machine-specific implementations
196  * except in some special occasions.
197  */
198 static void SendToPeers(int size, char *msg);
199
200
201 void CmiPushPE(int rank, void *msg);
202
203 #if CMK_NODE_QUEUE_AVAILABLE
204 void CmiPushNode(void *msg);
205 #endif
206
207 /* Functions regarding send ops declared in converse.h */
208
209 /* In default, using the common codes for msg sending */
210 #ifndef USE_COMMON_SYNC_P2P
211 #define USE_COMMON_SYNC_P2P 1
212 #endif
213 #ifndef USE_COMMON_ASYNC_P2P
214 #define USE_COMMON_ASYNC_P2P 1
215 #endif
216 #ifndef USE_COMMON_SYNC_BCAST
217 #define USE_COMMON_SYNC_BCAST 1
218 #endif
219 #ifndef USE_COMMON_ASYNC_BCAST
220 #define USE_COMMON_ASYNC_BCAST 1
221 #endif
222
223 static void CmiSendSelf(char *msg);
224
225 void CmiSyncSendFn(int destPE, int size, char *msg);
226 CmiCommHandle CmiAsyncSendFn(int destPE, int size, char *msg);
227 void CmiFreeSendFn(int destPE, int size, char *msg);
228
229 #if CMK_NODE_QUEUE_AVAILABLE
230 static void CmiSendNodeSelf(char *msg);
231
232 void CmiSyncNodeSendFn(int destNode, int size, char *msg);
233 CmiCommHandle CmiAsyncNodeSendFn(int destNode, int size, char *msg);
234 void CmiFreeNodeSendFn(int destNode, int size, char *msg);
235
236 #endif
237
238 /* Functions and variables regarding machine startup */
239 static char     **Cmi_argv;
240 static char     **Cmi_argvcopy;
241 static CmiStartFn Cmi_startfn;   /* The start function */
242 static int        Cmi_usrsched;  /* Continue after start function finishes? */
243 void ConverseInit(int argc, char **argv, CmiStartFn fn, int usched, int initret);
244 static void ConverseRunPE(int everReturn);
245
246 /* Functions regarding machine running on every proc */
247 static void AdvanceCommunication();
248 static void CommunicationServer(int sleepTime);
249 static void CommunicationServerThread(int sleepTime);
250 void ConverseExit(void);
251
252 /* Functions providing incoming network messages */
253 void *CmiGetNonLocal(void);
254 #if CMK_NODE_QUEUE_AVAILABLE
255 void *CmiGetNonLocalNodeQ(void);
256 #endif
257 /* Utiltiy functions */
258 static char *CopyMsg(char *msg, int len);
259
260 /* ===== End of Common Function Declarations ===== */
261
262 #include "machine-smp.c"
263
264 /* ===== Beginning of Idle-state Related Declarations =====  */
265 typedef struct {
266     int sleepMs; /*Milliseconds to sleep while idle*/
267     int nIdles; /*Number of times we've been idle in a row*/
268     CmiState cs; /*Machine state*/
269 } CmiIdleState;
270
271 static CmiIdleState *CmiNotifyGetState(void);
272
273 /**
274  *  Generally,
275  *
276  *  CmiNotifyIdle is used in non-SMP mode when the proc is idle.
277  *  When the proc is idle, AdvanceCommunication needs to be
278  *  called.
279  *
280  *  CmiNotifyStillIdle and CmiNotifyBeginIdle are used in SMP mode.
281  *
282  *  Different layers have choices of registering different callbacks for
283  *  idle state.
284  */
285 static void CmiNotifyBeginIdle(CmiIdleState *s);
286 static void CmiNotifyStillIdle(CmiIdleState *s);
287 void CmiNotifyIdle(void);
288 /* ===== End of Idle-state Related Declarations =====  */
289
290 /* ===== Beginning of Processor/Node State-related Stuff =====*/
291 #if !CMK_SMP
292 /************ non SMP **************/
293 static struct CmiStateStruct Cmi_state;
294 int _Cmi_mype;
295 int _Cmi_myrank;
296
297 void CmiMemLock() {}
298 void CmiMemUnlock() {}
299
300 #define CmiGetState() (&Cmi_state)
301 #define CmiGetStateN(n) (&Cmi_state)
302
303 void CmiYield(void) {
304     sleep(0);
305 }
306
307 static void CmiStartThreads(char **argv) {
308     CmiStateInit(Cmi_nodestart, 0, &Cmi_state);
309     _Cmi_mype = Cmi_nodestart;
310     _Cmi_myrank = 0;
311 }
312 #else
313 /************** SMP *******************/
314 INLINE_KEYWORD int CmiMyPe() {
315     return CmiGetState()->pe;
316 }
317 INLINE_KEYWORD int CmiMyRank() {
318     return CmiGetState()->rank;
319 }
320 INLINE_KEYWORD int CmiNodeFirst(int node) {
321     return node*_Cmi_mynodesize;
322 }
323 INLINE_KEYWORD int CmiNodeSize(int node) {
324     return _Cmi_mynodesize;
325 }
326 INLINE_KEYWORD int CmiNodeOf(int pe) {
327     return (pe/_Cmi_mynodesize);
328 }
329 INLINE_KEYWORD int CmiRankOf(int pe) {
330     return pe%_Cmi_mynodesize;
331 }
332 #endif
333 CsvDeclare(CmiNodeState, NodeState);
334 /* ===== End of Processor/Node State-related Stuff =====*/
335
336 #include "machine-broadcast.c"
337 #include "immediate.c"
338
339 /* ===== Beginning of Common Function Definitions ===== */
340 static void PerrorExit(const char *msg) {
341     perror(msg);
342     exit(1);
343 }
344
345 /* ##### Beginning of Functions Related with Message Sending OPs ##### */
346 /*Add a message to this processor's receive queue, pe is a rank */
347 void CmiPushPE(int rank,void *msg) {
348     CmiState cs = CmiGetStateN(rank);
349     MACHSTATE2(3,"Pushing message into rank %d's queue %p{",rank, cs->recv);
350 #if CMK_IMMEDIATE_MSG
351     if (CmiIsImmediate(msg)) {
352         MACHSTATE1(3, "[%p] Push Immediate Message begin{",CmiGetState());
353         CMI_DEST_RANK(msg) = rank;
354         CmiPushImmediateMsg(msg);
355         MACHSTATE1(3, "[%p] Push Immediate Message end}",CmiGetState());
356         return;
357     }
358 #endif
359
360     PCQueuePush(cs->recv,msg);
361     CmiIdleLock_addMessage(&cs->idle);
362     MACHSTATE1(3,"} Pushing message into rank %d's queue done",rank);
363 }
364
365 #if CMK_NODE_QUEUE_AVAILABLE
366 /*Add a message to this processor's receive queue */
367 void CmiPushNode(void *msg) {
368     MACHSTATE(3,"Pushing message into NodeRecv queue");
369 #if CMK_IMMEDIATE_MSG
370     if (CmiIsImmediate(msg)) {
371         CMI_DEST_RANK(msg) = 0;
372         CmiPushImmediateMsg(msg);
373         return;
374     }
375 #endif
376     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
377     PCQueuePush(CsvAccess(NodeState).NodeRecv,msg);
378     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
379     {
380         CmiState cs=CmiGetStateN(0);
381         CmiIdleLock_addMessage(&cs->idle);
382     }
383 }
384 #endif
385
386 /* This function handles the msg received as which queue to push into */
387 static INLINE_KEYWORD void handleOneRecvedMsg(int size, char *msg) {
388     int isBcastMsg = 0;
389 #if CMK_BROADCAST_SPANNING_TREE || CMK_BROADCAST_HYPERCUBE
390     isBcastMsg = (CMI_BROADCAST_ROOT(msg)!=0);
391 #endif
392
393     if (isBcastMsg) {
394         handleOneBcastMsg(size, msg);
395         return;
396     }
397
398 #if CMK_NODE_QUEUE_AVAILABLE
399     if (CMI_DEST_RANK(msg)==DGRAM_NODEMESSAGE)
400         CmiPushNode(msg);
401     else
402 #endif
403         CmiPushPE(CMI_DEST_RANK(msg), msg);
404
405 }
406
407
408 static void SendToPeers(int size, char *msg) {
409     /* FIXME: now it's just a flat p2p send!! When node size is large,
410     * it should also be sent in a tree
411     */
412     int exceptRank = CMI_DEST_RANK(msg);
413     int i;
414     for (i=0; i<exceptRank; i++) {
415         CmiPushPE(i, CopyMsg(msg, size));
416     }
417     for (i=exceptRank+1; i<CmiMyNodeSize(); i++) {
418         CmiPushPE(i, CopyMsg(msg, size));
419     }
420 }
421
422
423 /* Functions regarding sending operations */
424 static void CmiSendSelf(char *msg) {
425 #if CMK_IMMEDIATE_MSG
426     if (CmiIsImmediate(msg)) {
427         /* CmiBecomeNonImmediate(msg); */
428         CmiPushImmediateMsg(msg);
429         CmiHandleImmediate();
430         return;
431     }
432 #endif
433     CdsFifo_Enqueue(CpvAccess(CmiLocalQueue),msg);
434 }
435
436 /* Functions regarding P2P send op */
437 #if USE_COMMON_SYNC_P2P
438 void CmiSyncSendFn(int destPE, int size, char *msg) {
439     char *dupmsg = CopyMsg(msg, size);
440     CmiFreeSendFn(destPE, size, dupmsg);
441 }
442
443 #if CMK_USE_PXSHM
444 inline int CmiValidPxshm(int dst, int size);
445 void CmiSendMessagePxshm(char *msg, int size, int dstpe, int *refcount, int rank,unsigned int broot);
446 void CmiInitPxshm(char **argv);
447 inline void CommunicationServerPxshm();
448 void CmiExitPxshm();
449 #endif
450
451 int refcount = 0;
452
453 void CmiFreeSendFn(int destPE, int size, char *msg) {
454     CMI_SET_BROADCAST_ROOT(msg, 0);
455     CQdCreate(CpvAccess(cQdState), 1);
456     if (CmiMyPe()==destPE) {
457         CmiSendSelf(msg);
458     } else {
459 #if CMK_USE_PXSHM
460         int ret=CmiValidPxshm(destPE, size);
461         if (ret) {
462           CMI_DEST_RANK(msg) = CmiRankOf(destPE);
463           CmiSendMessagePxshm(msg, size, destPE, &refcount, CmiRankOf(destPE), 0);
464           //for (int i=0; i<refcount; i++) CmiReference(msg);
465           return;
466         }
467 #endif
468 #if CMK_PERSISTENT_COMM
469     if (phs) {
470         CmiAssert(phsSize == 1);
471         LrtsSendPersistentMsg(*phs, destPE, size, msg);
472         return;
473     }
474 #endif
475
476         int destNode = CmiNodeOf(destPE);
477 #if CMK_SMP
478         if (CmiMyNode()==destNode) {
479             CmiPushPE(CmiRankOf(destPE), msg);
480             return;
481         }
482 #endif
483         CMI_DEST_RANK(msg) = CmiRankOf(destPE);
484 if (  MSG_STATISTIC)
485 {
486     int ret_log = _cmi_log2(size);
487     if(ret_log >21) ret_log = 21;
488     msg_histogram[ret_log]++;
489 }
490         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
491     }
492 }
493 #endif
494
495 #if USE_COMMON_ASYNC_P2P
496 CmiCommHandle CmiAsyncSendFn(int destPE, int size, char *msg) {
497     int destNode = CmiNodeOf(destPE);
498     if (destNode == CmiMyNode()) {
499         CmiSyncSendFn(destPE,size,msg);
500         return 0;
501     } else {
502 if (  MSG_STATISTIC)
503 {
504     int ret_log = _cmi_log2(size);
505         if(ret_log >21) ret_log = 21;
506         msg_histogram[ret_log]++;
507 }
508         return LrtsSendFunc(destPE, size, msg, P2P_ASYNC);
509     }
510 }
511 #endif
512
513 #if CMK_NODE_QUEUE_AVAILABLE
514 static void CmiSendNodeSelf(char *msg) {
515 #if CMK_IMMEDIATE_MSG
516     if (CmiIsImmediate(msg)) {
517         CmiPushImmediateMsg(msg);
518         if (!_immRunning) CmiHandleImmediate();
519         return;
520     }
521 #endif
522     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
523     PCQueuePush(CsvAccess(NodeState).NodeRecv, msg);
524     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
525 }
526
527 #if USE_COMMON_ASYNC_P2P
528 void CmiSyncNodeSendFn(int destNode, int size, char *msg) {
529     char *dupmsg = CopyMsg(msg, size);
530     CmiFreeNodeSendFn(destNode, size, dupmsg);
531 }
532
533 void CmiFreeNodeSendFn(int destNode, int size, char *msg) {
534     CMI_DEST_RANK(msg) = DGRAM_NODEMESSAGE;
535     CQdCreate(CpvAccess(cQdState), 1);
536     CMI_SET_BROADCAST_ROOT(msg, 0);
537     if (destNode == CmiMyNode()) {
538         CmiSendNodeSelf(msg);
539     } else {
540 if (  MSG_STATISTIC)
541 {
542     int ret_log = _cmi_log2(size);
543     if(ret_log >21) ret_log = 21;
544     msg_histogram[ret_log]++;
545 }
546         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
547     }
548 }
549 #endif
550
551 #if USE_COMMON_ASYNC_P2P
552 CmiCommHandle CmiAsyncNodeSendFn(int destNode, int size, char *msg) {
553     if (destNode == CmiMyNode()) {
554         CmiSyncNodeSendFn(destNode, size, msg);
555         return 0;
556     } else {
557 if (  MSG_STATISTIC)
558 {
559         int ret_log = _cmi_log2(size);
560         if(ret_log >21) ret_log = 21;
561         msg_histogram[ret_log]++;
562 }
563         return LrtsSendFunc(destNode, size, msg, P2P_ASYNC);
564     }
565 }
566 #endif
567 #endif
568
569 /* ##### Beginning of Functions Related with Machine Startup ##### */
570 void ConverseInit(int argc, char **argv, CmiStartFn fn, int usched, int initret) {
571     int _ii;
572     int tmp;
573     MSG_STATISTIC = CmiGetArgFlag(argv, "+msgstatistic");
574     /* processor per node */
575     _Cmi_mynodesize = 1;
576     if (!CmiGetArgInt(argv,"+ppn", &_Cmi_mynodesize))
577         CmiGetArgInt(argv,"++ppn", &_Cmi_mynodesize);
578 #if ! CMK_SMP
579     if (_Cmi_mynodesize > 1 && _Cmi_mynode == 0)
580         CmiAbort("+ppn cannot be used in non SMP version!\n");
581 #endif
582
583     /* Network progress function is used to poll the network when for
584     messages. This flushes receive buffers on some  implementations*/
585     networkProgressPeriod = NETWORK_PROGRESS_PERIOD_DEFAULT;
586     CmiGetArgInt(argv, "+networkProgressPeriod", &networkProgressPeriod);
587
588     /* _Cmi_mynodesize has to be obtained before LrtsInit
589      * because it may be used inside LrtsInit
590      */
591     /* argv could be changed inside LrtsInit */
592     /* Inside this function, the number of nodes and my node id are obtained */
593 if (  MSG_STATISTIC)
594 {
595     for(_ii=0; _ii<22; _ii++)
596         msg_histogram[_ii] = 0;
597 }
598
599     LrtsInit(&argc, &argv, &_Cmi_numnodes, &_Cmi_mynode);
600
601     _Cmi_numpes = _Cmi_numnodes * _Cmi_mynodesize;
602     Cmi_nodestart = _Cmi_mynode * _Cmi_mynodesize;
603     Cmi_argvcopy = CmiCopyArgs(argv);
604     Cmi_argv = argv;
605     Cmi_startfn = fn;
606     Cmi_usrsched = usched;
607
608 #if CMK_USE_PXSHM
609     CmiInitPxshm(argv);
610 #endif
611
612     /* CmiTimerInit(); */
613 #if CMK_BROADCAST_HYPERCUBE
614     /* CmiNodesDim = ceil(log2(CmiNumNodes)) except when #nodes is 1*/
615     tmp = CmiNumNodes()-1;
616     CmiNodesDim = 0;
617     while (tmp>0) {
618         CmiNodesDim++;
619         tmp = tmp >> 1;
620     }
621     if (CmiNumNodes()==1) CmiNodesDim=1;
622 #endif
623
624     CsvInitialize(CmiNodeState, NodeState);
625     CmiNodeStateInit(&CsvAccess(NodeState));
626 #if CMK_SMP
627     commThdExitLock = CmiCreateLock();
628 #endif
629
630 #if CMK_OFFLOAD_BCAST_PROCESS
631     /* the actual queues should be created on comm thread considering NUMA in SMP */
632     CsvInitialize(PCQueue, procBcastQ);
633 #if CMK_NODE_QUEUE_AVAILABLE
634     CsvInitialize(PCQueue, nodeBcastQ);
635 #endif
636 #endif
637
638     CmiStartThreads(argv);
639
640     ConverseRunPE(initret);
641 }
642
643 static void ConverseRunPE(int everReturn) {
644     CmiState cs;
645     char** CmiMyArgv;
646
647     LrtsPreCommonInit(everReturn);
648
649 #if CMK_OFFLOAD_BCAST_PROCESS
650     int createQueue = 1;
651 #if CMK_SMP
652 #if CMK_SMP_NO_COMMTHD
653     /* If there's no comm thread, then the queue is created on rank 0 */
654     if (CmiMyRank()) createQueue = 0;
655 #else
656     if (CmiMyRank()<CmiMyNodeSize()) createQueue = 0;
657 #endif
658 #endif
659
660     if (createQueue) {
661         CsvAccess(procBcastQ) = PCQueueCreate();
662 #if CMK_NODE_QUEUE_AVAILABLE
663         CsvAccess(nodeBcastQ) = PCQueueCreate();
664 #endif
665     }
666 #endif
667
668     CmiNodeAllBarrier();
669
670     cs = CmiGetState();
671     CpvInitialize(void *,CmiLocalQueue);
672     CpvAccess(CmiLocalQueue) = cs->localqueue;
673
674     if (CmiMyRank())
675         CmiMyArgv=CmiCopyArgs(Cmi_argvcopy);
676     else
677         CmiMyArgv=Cmi_argv;
678
679     CthInit(CmiMyArgv);
680
681     /* initialize the network progress counter*/
682     /* Network progress function is used to poll the network when for
683        messages. This flushes receive buffers on some  implementations*/
684     CpvInitialize(unsigned , networkProgressCount);
685     CpvAccess(networkProgressCount) = 0;
686
687     ConverseCommonInit(CmiMyArgv);
688
689     LrtsPostCommonInit(everReturn);
690
691     /* Converse initialization finishes, immediate messages can be processed.
692        node barrier previously should take care of the node synchronization */
693     _immediateReady = 1;
694
695     /* communication thread */
696     if (CmiMyRank() == CmiMyNodeSize()) {
697         Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
698         while (1) CommunicationServerThread(5);
699     } else { /* worker thread */
700         if (!everReturn) {
701             Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
702             if (Cmi_usrsched==0) CsdScheduler(-1);
703             ConverseExit();
704         }
705     }
706 }
707 /* ##### End of Functions Related with Machine Startup ##### */
708
709 /* ##### Beginning of Functions Related with Machine Running ##### */
710 static INLINE_KEYWORD void AdvanceCommunication() {
711     int doProcessBcast = 1;
712
713 #if CMK_USE_PXSHM
714     CommunicationServerPxshm();
715 #endif
716
717     LrtsAdvanceCommunication();
718
719 #if CMK_OFFLOAD_BCAST_PROCESS
720 #if CMK_SMP_NO_COMMTHD
721     /*FIXME: only asks rank 0 to process bcast msgs, so perf may suffer*/
722     if (CmiMyRank()) doProcessBcast = 0;
723 #endif
724     if (doProcessBcast) processBcastQs();
725 #endif
726
727 #if CMK_IMMEDIATE_MSG
728 #if !CMK_SMP
729     CmiHandleImmediate();
730 #endif
731 #if CMK_SMP && CMK_SMP_NO_COMMTHD
732     if (CmiMyRank()==0) CmiHandleImmediate();
733 #endif
734 #endif
735
736 }
737
738 static void CommunicationServer(int sleepTime) {
739 #if CMK_SMP
740     AdvanceCommunication();
741
742     if (commThdExit == CmiMyNodeSize()) {
743         MACHSTATE(2, "CommunicationServer exiting {");
744         LrtsDrainResources();
745         MACHSTATE(2, "} CommunicationServer EXIT");
746
747         ConverseCommonExit();
748
749         LrtsExit();
750     }
751 #endif
752 }
753
754 static void CommunicationServerThread(int sleepTime) {
755     CommunicationServer(sleepTime);
756 #if CMK_IMMEDIATE_MSG
757     CmiHandleImmediate();
758 #endif
759 }
760
761 void ConverseExit(void) {
762     int i;
763 #if !CMK_SMP
764     LrtsDrainResources();
765 #endif
766
767 #if CMK_USE_PXSHM
768         CmiExitPxshm();
769 #endif
770     ConverseCommonExit();
771
772 if (MSG_STATISTIC)
773 {
774     CmiPrintf("[MSG PE:%d]", CmiMyPe());
775     for(i=0; i<22; i++)
776     {
777         if(msg_histogram[i] >0)
778             CmiPrintf("(%d:%d) ", 1<<i, msg_histogram[i]);
779     }
780     CmiPrintf("\n");
781 }
782 #if (CMK_DEBUG_MODE || CMK_WEB_MODE || NODE_0_IS_CONVHOST)
783     if (CmiMyPe() == 0) CmiPrintf("End of program\n");
784 #endif
785
786 #if !CMK_SMP
787     LrtsExit();
788 #else
789     /* In SMP, the communication thread will exit */
790     /* atomic increment */
791     CmiLock(commThdExitLock);
792     commThdExit++;
793     CmiUnlock(commThdExitLock);
794     while (1) CmiYield();
795 #endif
796 }
797 /* ##### End of Functions Related with Machine Running ##### */
798
799
800 /* ##### Beginning of Functions Providing Incoming Network Messages ##### */
801 void *CmiGetNonLocal(void) {
802     CmiState cs = CmiGetState();
803     void *msg = NULL;
804
805 #if !CMK_SMP || CMK_SMP_NO_COMMTHD
806     /**
807       * In SMP mode with comm thread, it's possible a normal
808       * msg is sent from an immediate msg which is executed
809       * on comm thread. In this case, the msg is sent to
810       * the network queue of the work thread. Therefore,
811       * even there's only one worker thread, the polling of
812       * network queue is still required.
813       */
814     if (CmiNumPes() == 1) return NULL;
815 #endif
816
817     MACHSTATE2(3, "[%p] CmiGetNonLocal begin %d{", cs, CmiMyPe());
818     CmiIdleLock_checkMessage(&cs->idle);
819     /* ?????although it seems that lock is not needed, I found it crashes very often
820        on mpi-smp without lock */
821     msg = PCQueuePop(cs->recv);
822 #if !CMK_SMP
823     if (!msg) {
824        AdvanceCommunication();
825        msg = PCQueuePop(cs->recv);
826     } 
827 #endif
828
829 #if !CMK_SMP
830     LrtsPostNonLocal();
831 #endif
832
833     MACHSTATE3(3,"[%p] CmiGetNonLocal from queue %p with msg %p end }",CmiGetState(),(cs->recv), msg);
834
835     return msg;
836 }
837
838 #if CMK_NODE_QUEUE_AVAILABLE
839 void *CmiGetNonLocalNodeQ(void) {
840     CmiState cs = CmiGetState();
841     char *result = 0;
842     CmiIdleLock_checkMessage(&cs->idle);
843     if (!PCQueueEmpty(CsvAccess(NodeState).NodeRecv)) {
844         MACHSTATE1(3,"CmiGetNonLocalNodeQ begin %d {", CmiMyPe());
845         CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
846         result = (char *) PCQueuePop(CsvAccess(NodeState).NodeRecv);
847         CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
848         MACHSTATE1(3,"} CmiGetNonLocalNodeQ end %d ", CmiMyPe());
849     }
850
851     return result;
852 }
853 #endif
854 /* ##### End of Functions Providing Incoming Network Messages ##### */
855
856 static CmiIdleState *CmiNotifyGetState(void) {
857     CmiIdleState *s=(CmiIdleState *)malloc(sizeof(CmiIdleState));
858     s->sleepMs=0;
859     s->nIdles=0;
860     s->cs=CmiGetState();
861     return s;
862 }
863
864 static void CmiNotifyBeginIdle(CmiIdleState *s) {
865     s->sleepMs=0;
866     s->nIdles=0;
867 }
868
869 /*Number of times to spin before sleeping*/
870 #define SPINS_BEFORE_SLEEP 20
871 static void CmiNotifyStillIdle(CmiIdleState *s) {
872     MACHSTATE1(2,"still idle (%d) begin {",CmiMyPe())
873     s->nIdles++;
874     if (s->nIdles>SPINS_BEFORE_SLEEP) { /*Start giving some time back to the OS*/
875         s->sleepMs+=2;
876         if (s->sleepMs>10) s->sleepMs=10;
877     }
878
879     if (s->sleepMs>0) {
880         MACHSTATE1(2,"idle lock(%d) {",CmiMyPe())
881         CmiIdleLock_sleep(&s->cs->idle,s->sleepMs);
882         MACHSTATE1(2,"} idle lock(%d)",CmiMyPe())
883     }
884
885 #if !CMK_SMP
886     AdvanceCommunication();
887 #endif
888
889     MACHSTATE1(2,"still idle (%d) end {",CmiMyPe())
890 }
891
892 /* usually called in non-smp mode */
893 void CmiNotifyIdle(void) {
894     AdvanceCommunication();
895     CmiYield();
896 }
897
898 /* Utiltiy functions */
899 static char *CopyMsg(char *msg, int len) {
900     char *copy = (char *)CmiAlloc(len);
901 #if CMK_ERROR_CHECKING
902     if (!copy) {
903         CmiAbort("Error: out of memory in machine layer\n");
904     }
905 #endif
906     memcpy(copy, msg, len);
907     return copy;
908 }
909
910
911 #if CMK_USE_PXSHM
912 #include "machine-pxshm.c"
913 #endif
914
915