minor change in coding style to avoid potential bug
[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 INLINE_KEYWORD void processProcBcastMsg(int size, char *msg);
76 static INLINE_KEYWORD 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 CmiAsyncNodeeroadcastFn(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 enum MACHINE_SMP_MODE {
148     INVALID_MODE,
149     COMM_THREAD_SEND_RECV = 0,
150     COMM_THREAD_ONLY_RECV, /* work threads will do the send */
151     COMM_THREAD_NOT_EXIST /* work threads will do both send and recv */
152 };
153 /* The default mode of smp charm runtime */
154 static enum MACHINE_SMP_MODE Cmi_smp_mode_setting = COMM_THREAD_SEND_RECV;
155
156
157 #if CMK_SMP
158 static volatile int commThdExit = 0;
159 static CmiNodeLock  commThdExitLock = 0;
160
161 /**
162  *  The macro defines whether to have a comm thd to offload some
163  *  work such as forwarding bcast messages etc. This macro
164  *  should be defined before including "machine-smp.c". Note
165  *  that whether a machine layer in SMP mode could run w/o comm
166  *  thread depends on the support of the underlying
167  *  communication library.
168  *
169  */
170 #ifndef CMK_SMP_NO_COMMTHD
171 #define CMK_SMP_NO_COMMTHD 0
172 #endif
173
174 #if CMK_SMP_NO_COMMTHD
175 int Cmi_commthread = 0;
176 #else
177 int Cmi_commthread = 1;
178 #endif
179
180 #endif
181
182 /*SHOULD BE MOVED TO MACHINE-SMP.C ??*/
183 static int Cmi_nodestart;
184
185 /*
186  * Network progress utility variables. Period controls the rate at
187  * which the network poll is called
188  */
189 #ifndef NETWORK_PROGRESS_PERIOD_DEFAULT
190 #define NETWORK_PROGRESS_PERIOD_DEFAULT 1000
191 #endif
192
193 CpvDeclare(unsigned , networkProgressCount);
194 int networkProgressPeriod;
195
196
197 /* ===== Beginning of Common Function Declarations ===== */
198 void CmiAbort(const char *message);
199 static void PerrorExit(const char *msg);
200
201 /* This function handles the msg received as which queue to push into */
202 static void handleOneRecvedMsg(int size, char *msg);
203
204 /* Utility functions for forwarding broadcast messages,
205  * should not be used in machine-specific implementations
206  * except in some special occasions.
207  */
208 static void SendToPeers(int size, char *msg);
209
210
211 void CmiPushPE(int rank, void *msg);
212
213 #if CMK_NODE_QUEUE_AVAILABLE
214 void CmiPushNode(void *msg);
215 #endif
216
217 /* Functions regarding send ops declared in converse.h */
218
219 /* In default, using the common codes for msg sending */
220 #ifndef USE_COMMON_SYNC_P2P
221 #define USE_COMMON_SYNC_P2P 1
222 #endif
223 #ifndef USE_COMMON_ASYNC_P2P
224 #define USE_COMMON_ASYNC_P2P 1
225 #endif
226 #ifndef USE_COMMON_SYNC_BCAST
227 #define USE_COMMON_SYNC_BCAST 1
228 #endif
229 #ifndef USE_COMMON_ASYNC_BCAST
230 #define USE_COMMON_ASYNC_BCAST 1
231 #endif
232
233 static void CmiSendSelf(char *msg);
234
235 void CmiSyncSendFn(int destPE, int size, char *msg);
236 CmiCommHandle CmiAsyncSendFn(int destPE, int size, char *msg);
237 void CmiFreeSendFn(int destPE, int size, char *msg);
238
239 #if CMK_NODE_QUEUE_AVAILABLE
240 static void CmiSendNodeSelf(char *msg);
241
242 void CmiSyncNodeSendFn(int destNode, int size, char *msg);
243 CmiCommHandle CmiAsyncNodeSendFn(int destNode, int size, char *msg);
244 void CmiFreeNodeSendFn(int destNode, int size, char *msg);
245
246 #endif
247
248 /* Functions and variables regarding machine startup */
249 static char     **Cmi_argv;
250 static char     **Cmi_argvcopy;
251 static CmiStartFn Cmi_startfn;   /* The start function */
252 static int        Cmi_usrsched;  /* Continue after start function finishes? */
253 void ConverseInit(int argc, char **argv, CmiStartFn fn, int usched, int initret);
254 static void ConverseRunPE(int everReturn);
255
256 /* Functions regarding machine running on every proc */
257 static void AdvanceCommunication(int whenidle);
258 static void CommunicationServer(int sleepTime);
259 static void CommunicationServerThread(int sleepTime);
260 void ConverseExit(void);
261
262 /* Functions providing incoming network messages */
263 void *CmiGetNonLocal(void);
264 #if CMK_NODE_QUEUE_AVAILABLE
265 void *CmiGetNonLocalNodeQ(void);
266 #endif
267 /* Utiltiy functions */
268 static char *CopyMsg(char *msg, int len);
269
270 /* ===== End of Common Function Declarations ===== */
271
272 #include "machine-smp.c"
273
274 /* ===== Beginning of Idle-state Related Declarations =====  */
275 typedef struct {
276     int sleepMs; /*Milliseconds to sleep while idle*/
277     int nIdles; /*Number of times we've been idle in a row*/
278     CmiState cs; /*Machine state*/
279 } CmiIdleState;
280
281 static CmiIdleState *CmiNotifyGetState(void);
282
283 /**
284  *  Generally,
285  *
286  *  CmiNotifyIdle is used in non-SMP mode when the proc is idle.
287  *  When the proc is idle, AdvanceCommunication needs to be
288  *  called.
289  *
290  *  CmiNotifyStillIdle and CmiNotifyBeginIdle are used in SMP mode.
291  *
292  *  Different layers have choices of registering different callbacks for
293  *  idle state.
294  */
295 static void CmiNotifyBeginIdle(CmiIdleState *s);
296 static void CmiNotifyStillIdle(CmiIdleState *s);
297 void CmiNotifyIdle(void);
298 /* ===== End of Idle-state Related Declarations =====  */
299
300 /* ===== Beginning of Processor/Node State-related Stuff =====*/
301 #if !CMK_SMP
302 /************ non SMP **************/
303 static struct CmiStateStruct Cmi_state;
304 int _Cmi_mype;
305 int _Cmi_myrank;
306
307 void CmiMemLock() {}
308 void CmiMemUnlock() {}
309
310 #define CmiGetState() (&Cmi_state)
311 #define CmiGetStateN(n) (&Cmi_state)
312
313 void CmiYield(void) {
314     sleep(0);
315 }
316
317 static void CmiStartThreads(char **argv) {
318     CmiStateInit(Cmi_nodestart, 0, &Cmi_state);
319     _Cmi_mype = Cmi_nodestart;
320     _Cmi_myrank = 0;
321 }
322 #else
323 /************** SMP *******************/
324 INLINE_KEYWORD int CmiMyPe() {
325     return CmiGetState()->pe;
326 }
327 INLINE_KEYWORD int CmiMyRank() {
328     return CmiGetState()->rank;
329 }
330 INLINE_KEYWORD int CmiNodeFirst(int node) {
331     return node*_Cmi_mynodesize;
332 }
333 INLINE_KEYWORD int CmiNodeSize(int node) {
334     return _Cmi_mynodesize;
335 }
336 INLINE_KEYWORD int CmiNodeOf(int pe) {
337     return (pe/_Cmi_mynodesize);
338 }
339 INLINE_KEYWORD int CmiRankOf(int pe) {
340     return pe%_Cmi_mynodesize;
341 }
342 #endif
343 CsvDeclare(CmiNodeState, NodeState);
344 /* ===== End of Processor/Node State-related Stuff =====*/
345
346 #include "machine-broadcast.c"
347 #include "machine-commthd-util.c"
348 #include "immediate.c"
349
350 /* ===== Beginning of Common Function Definitions ===== */
351 static void PerrorExit(const char *msg) {
352     perror(msg);
353     exit(1);
354 }
355
356 /* ##### Beginning of Functions Related with Message Sending OPs ##### */
357 /*Add a message to this processor's receive queue, pe is a rank */
358 void CmiPushPE(int rank,void *msg) {
359     CmiState cs = CmiGetStateN(rank);
360     MACHSTATE2(3,"Pushing message into rank %d's queue %p{",rank, cs->recv);
361 #if CMK_IMMEDIATE_MSG
362     if (CmiIsImmediate(msg)) {
363         MACHSTATE1(3, "[%p] Push Immediate Message begin{",CmiGetState());
364         CMI_DEST_RANK(msg) = rank;
365         CmiPushImmediateMsg(msg);
366         MACHSTATE1(3, "[%p] Push Immediate Message end}",CmiGetState());
367         return;
368     }
369 #endif
370
371     PCQueuePush(cs->recv,msg);
372
373 #if CMK_SHARED_VARS_POSIX_THREADS_SMP
374   if (_Cmi_noprocforcommthread)
375 #endif
376     CmiIdleLock_addMessage(&cs->idle);
377     MACHSTATE1(3,"} Pushing message into rank %d's queue done",rank);
378 }
379
380 #if CMK_NODE_QUEUE_AVAILABLE
381 /*Add a message to this processor's receive queue */
382 void CmiPushNode(void *msg) {
383     MACHSTATE(3,"Pushing message into NodeRecv queue");
384 #if CMK_IMMEDIATE_MSG
385     if (CmiIsImmediate(msg)) {
386         CMI_DEST_RANK(msg) = 0;
387         CmiPushImmediateMsg(msg);
388         return;
389     }
390 #endif
391     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
392     PCQueuePush(CsvAccess(NodeState).NodeRecv,msg);
393     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
394
395 #if CMK_SHARED_VARS_POSIX_THREADS_SMP
396     if (_Cmi_noprocforcommthread)
397 #endif
398     {
399         CmiState cs=CmiGetStateN(0);
400         CmiIdleLock_addMessage(&cs->idle);
401     }
402 }
403 #endif
404
405 /* This function handles the msg received as which queue to push into */
406 static INLINE_KEYWORD void handleOneRecvedMsg(int size, char *msg) {
407     int isBcastMsg = 0;
408 #if CMK_BROADCAST_SPANNING_TREE || CMK_BROADCAST_HYPERCUBE
409     isBcastMsg = (CMI_BROADCAST_ROOT(msg)!=0);
410 #endif
411
412     if (isBcastMsg) {
413         handleOneBcastMsg(size, msg);
414         return;
415     }
416
417 #if CMK_NODE_QUEUE_AVAILABLE
418     if (CMI_DEST_RANK(msg)==DGRAM_NODEMESSAGE){
419         CmiPushNode(msg);
420         return;
421     }
422 #endif
423     CmiPushPE(CMI_DEST_RANK(msg), msg);
424
425 }
426
427
428 static void SendToPeers(int size, char *msg) {
429     /* FIXME: now it's just a flat p2p send!! When node size is large,
430     * it should also be sent in a tree
431     */
432     int exceptRank = CMI_DEST_RANK(msg);
433     int i;
434     for (i=0; i<exceptRank; i++) {
435         CmiPushPE(i, CopyMsg(msg, size));
436     }
437     for (i=exceptRank+1; i<CmiMyNodeSize(); i++) {
438         CmiPushPE(i, CopyMsg(msg, size));
439     }
440 }
441
442
443 /* Functions regarding sending operations */
444 static void CmiSendSelf(char *msg) {
445 #if CMK_IMMEDIATE_MSG
446     if (CmiIsImmediate(msg)) {
447         /* CmiBecomeNonImmediate(msg); */
448         CmiPushImmediateMsg(msg);
449         CmiHandleImmediate();
450         return;
451     }
452 #endif
453     CdsFifo_Enqueue(CpvAccess(CmiLocalQueue),msg);
454 }
455
456 /* Functions regarding P2P send op */
457 #if USE_COMMON_SYNC_P2P
458 void CmiSyncSendFn(int destPE, int size, char *msg) {
459     char *dupmsg = CopyMsg(msg, size);
460     CmiFreeSendFn(destPE, size, dupmsg);
461 }
462
463 #if CMK_USE_PXSHM
464 inline int CmiValidPxshm(int dst, int size);
465 void CmiSendMessagePxshm(char *msg, int size, int dstpe, int *refcount, int rank,unsigned int broot);
466 void CmiInitPxshm(char **argv);
467 inline void CommunicationServerPxshm();
468 void CmiExitPxshm();
469 #endif
470
471 int refcount = 0;
472
473 void CmiFreeSendFn(int destPE, int size, char *msg) {
474     CMI_SET_BROADCAST_ROOT(msg, 0);
475     CQdCreate(CpvAccess(cQdState), 1);
476     if (CmiMyPe()==destPE) {
477         CmiSendSelf(msg);
478 #if CMK_PERSISTENT_COMM
479         if (phs) curphs++;
480 #endif
481     } else {
482 #if CMK_PERSISTENT_COMM
483         if (phs && size > 8192) {
484             CmiAssert(curphs < phsSize);
485             LrtsSendPersistentMsg(phs[curphs++], destPE, size, msg);
486             return;
487         }
488 #endif
489
490         int destNode = CmiNodeOf(destPE);
491 #if CMK_SMP
492         if (CmiMyNode()==destNode) {
493             CmiPushPE(CmiRankOf(destPE), msg);
494             return;
495         }
496 #endif
497         CMI_DEST_RANK(msg) = CmiRankOf(destPE);
498 #if CMK_USE_PXSHM
499         int ret=CmiValidPxshm(destPE, size);
500         if (ret) {
501           CmiSendMessagePxshm(msg, size, destPE, &refcount, CmiRankOf(destPE), 0);
502           //for (int i=0; i<refcount; i++) CmiReference(msg);
503 #if CMK_PERSISTENT_COMM
504           if (phs) curphs++;
505 #endif
506           return;
507         }
508 #endif
509 if (  MSG_STATISTIC)
510 {
511     int ret_log = _cmi_log2(size);
512     if(ret_log >21) ret_log = 21;
513     msg_histogram[ret_log]++;
514 }
515         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
516     }
517 }
518 #endif
519
520 #if USE_COMMON_ASYNC_P2P
521 CmiCommHandle CmiAsyncSendFn(int destPE, int size, char *msg) {
522     int destNode = CmiNodeOf(destPE);
523     if (destNode == CmiMyNode()) {
524         CmiSyncSendFn(destPE,size,msg);
525         return 0;
526     } else {
527 if (  MSG_STATISTIC)
528 {
529     int ret_log = _cmi_log2(size);
530         if(ret_log >21) ret_log = 21;
531         msg_histogram[ret_log]++;
532 }
533         return LrtsSendFunc(destPE, size, msg, P2P_ASYNC);
534     }
535 }
536 #endif
537
538 #if CMK_NODE_QUEUE_AVAILABLE
539 static void CmiSendNodeSelf(char *msg) {
540 #if CMK_IMMEDIATE_MSG
541     if (CmiIsImmediate(msg)) {
542         CmiPushImmediateMsg(msg);
543         if (!_immRunning) CmiHandleImmediate();
544         return;
545     }
546 #endif
547     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
548     PCQueuePush(CsvAccess(NodeState).NodeRecv, msg);
549     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
550 }
551
552 #if USE_COMMON_ASYNC_P2P
553 void CmiSyncNodeSendFn(int destNode, int size, char *msg) {
554     char *dupmsg = CopyMsg(msg, size);
555     CmiFreeNodeSendFn(destNode, size, dupmsg);
556 }
557
558 void CmiFreeNodeSendFn(int destNode, int size, char *msg) {
559     CMI_DEST_RANK(msg) = DGRAM_NODEMESSAGE;
560     CQdCreate(CpvAccess(cQdState), 1);
561     CMI_SET_BROADCAST_ROOT(msg, 0);
562     if (destNode == CmiMyNode()) {
563         CmiSendNodeSelf(msg);
564     } else {
565 if (  MSG_STATISTIC)
566 {
567     int ret_log = _cmi_log2(size);
568     if(ret_log >21) ret_log = 21;
569     msg_histogram[ret_log]++;
570 }
571         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
572     }
573 }
574 #endif
575
576 #if USE_COMMON_ASYNC_P2P
577 CmiCommHandle CmiAsyncNodeSendFn(int destNode, int size, char *msg) {
578     if (destNode == CmiMyNode()) {
579         CmiSyncNodeSendFn(destNode, size, msg);
580         return 0;
581     } else {
582 if (  MSG_STATISTIC)
583 {
584         int ret_log = _cmi_log2(size);
585         if(ret_log >21) ret_log = 21;
586         msg_histogram[ret_log]++;
587 }
588         return LrtsSendFunc(destNode, size, msg, P2P_ASYNC);
589     }
590 }
591 #endif
592 #endif
593
594 /* ##### Beginning of Functions Related with Machine Startup ##### */
595 void ConverseInit(int argc, char **argv, CmiStartFn fn, int usched, int initret) {
596     int _ii;
597     int tmp;
598     MSG_STATISTIC = CmiGetArgFlag(argv, "+msgstatistic");
599     /* processor per node */
600     _Cmi_mynodesize = 1;
601     if (!CmiGetArgInt(argv,"+ppn", &_Cmi_mynodesize))
602         CmiGetArgInt(argv,"++ppn", &_Cmi_mynodesize);
603 #if ! CMK_SMP
604     if (_Cmi_mynodesize > 1 && _Cmi_mynode == 0)
605         CmiAbort("+ppn cannot be used in non SMP version!\n");
606 #endif
607
608     /* Network progress function is used to poll the network when for
609     messages. This flushes receive buffers on some  implementations*/
610     networkProgressPeriod = NETWORK_PROGRESS_PERIOD_DEFAULT;
611     CmiGetArgInt(argv, "+networkProgressPeriod", &networkProgressPeriod);
612
613     /* _Cmi_mynodesize has to be obtained before LrtsInit
614      * because it may be used inside LrtsInit
615      */
616     /* argv could be changed inside LrtsInit */
617     /* Inside this function, the number of nodes and my node id are obtained */
618 if (  MSG_STATISTIC)
619 {
620     for(_ii=0; _ii<22; _ii++)
621         msg_histogram[_ii] = 0;
622 }
623
624     LrtsInit(&argc, &argv, &_Cmi_numnodes, &_Cmi_mynode);
625    
626         if (_Cmi_mynode==0) {
627 #if !CMK_SMP 
628                 printf("Charm++> Running on non-SMP mode\n");
629 #else
630                 printf("Charm++> Running on SMP mode, %d worker threads per process\n", _Cmi_mynodesize);
631                 if (Cmi_smp_mode_setting == COMM_THREAD_SEND_RECV) {
632                         printf("Charm++> The comm. thread will both send and receive messages\n");
633                 } else if (Cmi_smp_mode_setting == COMM_THREAD_ONLY_RECV) {
634                         printf("Charm++> The comm. thread will only receive messages, while work threads will send messages\n");
635                 } else if (Cmi_smp_mode_setting == COMM_THREAD_NOT_EXIST) {
636                         printf("Charm++> There's no comm. thread. Work threads will both send and receive messages\n");
637                 } else {
638                         CmiAbort("Charm++> Invalid SMP mode setting\n");
639                 }
640 #endif
641         }
642
643     _Cmi_numpes = _Cmi_numnodes * _Cmi_mynodesize;
644     Cmi_nodestart = _Cmi_mynode * _Cmi_mynodesize;
645     Cmi_argvcopy = CmiCopyArgs(argv);
646     Cmi_argv = argv;
647     Cmi_startfn = fn;
648     Cmi_usrsched = usched;
649
650 #if CMK_USE_PXSHM
651     CmiInitPxshm(argv);
652 #endif
653
654     /* CmiTimerInit(); */
655 #if CMK_BROADCAST_HYPERCUBE
656     /* CmiNodesDim = ceil(log2(CmiNumNodes)) except when #nodes is 1*/
657     tmp = CmiNumNodes()-1;
658     CmiNodesDim = 0;
659     while (tmp>0) {
660         CmiNodesDim++;
661         tmp = tmp >> 1;
662     }
663     if (CmiNumNodes()==1) CmiNodesDim=1;
664 #endif
665
666     CsvInitialize(CmiNodeState, NodeState);
667     CmiNodeStateInit(&CsvAccess(NodeState));
668 #if CMK_SMP
669     commThdExitLock = CmiCreateLock();
670 #endif
671
672 #if CMK_OFFLOAD_BCAST_PROCESS
673     /* the actual queues should be created on comm thread considering NUMA in SMP */
674     CsvInitialize(PCQueue, procBcastQ);
675 #if CMK_NODE_QUEUE_AVAILABLE
676     CsvInitialize(PCQueue, nodeBcastQ);
677 #endif
678 #endif
679
680 #if CMK_SMP && CMK_LEVERAGE_COMMTHREAD
681     CsvInitialize(PCQueue, notifyCommThdQ);
682 #endif
683
684     CmiStartThreads(argv);
685
686     ConverseRunPE(initret);
687 }
688
689 static void ConverseRunPE(int everReturn) {
690     CmiState cs;
691     char** CmiMyArgv;
692
693     LrtsPreCommonInit(everReturn);
694
695 #if CMK_OFFLOAD_BCAST_PROCESS
696     int createQueue = 1;
697 #if CMK_SMP
698 #if CMK_SMP_NO_COMMTHD
699     /* If there's no comm thread, then the queue is created on rank 0 */
700     if (CmiMyRank()) createQueue = 0;
701 #else
702     if (CmiMyRank()<CmiMyNodeSize()) createQueue = 0;
703 #endif
704 #endif
705
706     if (createQueue) {
707         CsvAccess(procBcastQ) = PCQueueCreate();
708 #if CMK_NODE_QUEUE_AVAILABLE
709         CsvAccess(nodeBcastQ) = PCQueueCreate();
710 #endif
711     }
712 #endif
713
714 #if CMK_SMP && CMK_LEVERAGE_COMMTHREAD
715     if (CmiMyRank() == CmiMyNodeSize()) {
716         CsvAccess(notifyCommThdQ) = PCQueueCreate();
717     }
718 #endif
719
720     CmiNodeAllBarrier();
721
722     cs = CmiGetState();
723     CpvInitialize(void *,CmiLocalQueue);
724     CpvAccess(CmiLocalQueue) = cs->localqueue;
725
726     if (CmiMyRank())
727         CmiMyArgv=CmiCopyArgs(Cmi_argvcopy);
728     else
729         CmiMyArgv=Cmi_argv;
730
731     CthInit(CmiMyArgv);
732
733     /* initialize the network progress counter*/
734     /* Network progress function is used to poll the network when for
735        messages. This flushes receive buffers on some  implementations*/
736     CpvInitialize(unsigned , networkProgressCount);
737     CpvAccess(networkProgressCount) = 0;
738
739     ConverseCommonInit(CmiMyArgv);
740
741     LrtsPostCommonInit(everReturn);
742
743     /* Converse initialization finishes, immediate messages can be processed.
744        node barrier previously should take care of the node synchronization */
745     _immediateReady = 1;
746
747     /* communication thread */
748     if (CmiMyRank() == CmiMyNodeSize()) {
749         Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
750         while (1) CommunicationServerThread(5);
751     } else { /* worker thread */
752         if (!everReturn) {
753             Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
754             if (Cmi_usrsched==0) CsdScheduler(-1);
755             ConverseExit();
756         }
757     }
758 }
759 /* ##### End of Functions Related with Machine Startup ##### */
760
761 /* ##### Beginning of Functions Related with Machine Running ##### */
762 static INLINE_KEYWORD void AdvanceCommunication(int whenidle) {
763     int doProcessBcast = 1;
764
765 #if CMK_USE_PXSHM
766     CommunicationServerPxshm();
767 #endif
768
769     LrtsAdvanceCommunication(whenidle);
770
771 #if CMK_OFFLOAD_BCAST_PROCESS
772 #if CMK_SMP_NO_COMMTHD
773     /*FIXME: only asks rank 0 to process bcast msgs, so perf may suffer*/
774     if (CmiMyRank()) doProcessBcast = 0;
775 #endif
776     if (doProcessBcast) processBcastQs();
777 #endif
778
779 #if CMK_IMMEDIATE_MSG
780 #if !CMK_SMP
781     CmiHandleImmediate();
782 #endif
783 #if CMK_SMP && CMK_SMP_NO_COMMTHD
784     if (CmiMyRank()==0) CmiHandleImmediate();
785 #endif
786 #endif
787
788 #if CMK_SMP && CMK_LEVERAGE_COMMTHREAD
789     CmiPollCommThdNotificationQ();
790 #endif
791
792 }
793
794 static void CommunicationServer(int sleepTime) {
795 #if CMK_SMP
796     AdvanceCommunication(0);
797
798     if (commThdExit == CmiMyNodeSize()) {
799         MACHSTATE(2, "CommunicationServer exiting {");
800         LrtsDrainResources();
801         MACHSTATE(2, "} CommunicationServer EXIT");
802
803         ConverseCommonExit();
804
805 #if CMK_USE_PXSHM
806         CmiExitPxshm();
807 #endif
808         LrtsExit();
809     }
810 #endif
811 }
812
813 static void CommunicationServerThread(int sleepTime) {
814     CommunicationServer(sleepTime);
815 #if CMK_IMMEDIATE_MSG
816     CmiHandleImmediate();
817 #endif
818 }
819
820 void ConverseExit(void) {
821     int i;
822 #if !CMK_SMP
823     LrtsDrainResources();
824 #else
825         if(Cmi_smp_mode_setting == COMM_THREAD_ONLY_RECV
826            || Cmi_smp_mode_setting == COMM_THREAD_NOT_EXIST)
827                 LrtsDrainResources();
828 #endif
829
830     ConverseCommonExit();
831
832 if (MSG_STATISTIC)
833 {
834     for(i=0; i<22; i++)
835     {
836         CmiPrintf("[MSG PE:%d]", CmiMyPe());
837         if(msg_histogram[i] >0)
838             CmiPrintf("(%d:%d) ", 1<<i, msg_histogram[i]);
839     }
840     CmiPrintf("\n");
841 }
842 #if (CMK_DEBUG_MODE || CMK_WEB_MODE || NODE_0_IS_CONVHOST)
843     if (CmiMyPe() == 0) CmiPrintf("End of program\n");
844 #endif
845
846 #if !CMK_SMP
847 #if CMK_USE_PXSHM
848     CmiExitPxshm();
849 #endif
850     LrtsExit();
851 #else
852     /* In SMP, the communication thread will exit */
853     /* atomic increment */
854     CmiLock(commThdExitLock);
855     commThdExit++;
856     CmiUnlock(commThdExitLock);
857     while (1) CmiYield();
858 #endif
859 }
860 /* ##### End of Functions Related with Machine Running ##### */
861
862
863 /* ##### Beginning of Functions Providing Incoming Network Messages ##### */
864 void *CmiGetNonLocal(void) {
865     CmiState cs = CmiGetState();
866     void *msg = NULL;
867
868 #if !CMK_SMP || CMK_SMP_NO_COMMTHD
869     /**
870       * In SMP mode with comm thread, it's possible a normal
871       * msg is sent from an immediate msg which is executed
872       * on comm thread. In this case, the msg is sent to
873       * the network queue of the work thread. Therefore,
874       * even there's only one worker thread, the polling of
875       * network queue is still required.
876       */
877     if (CmiNumPes() == 1) return NULL;
878 #endif
879
880     MACHSTATE2(3, "[%p] CmiGetNonLocal begin %d{", cs, CmiMyPe());
881     CmiIdleLock_checkMessage(&cs->idle);
882     /* ?????although it seems that lock is not needed, I found it crashes very often
883        on mpi-smp without lock */
884     msg = PCQueuePop(cs->recv);
885 #if !CMK_SMP
886     if (!msg) {
887        AdvanceCommunication(0);
888        msg = PCQueuePop(cs->recv);
889     }
890 #else
891 //    LrtsPostNonLocal();
892 #endif
893
894     MACHSTATE3(3,"[%p] CmiGetNonLocal from queue %p with msg %p end }",CmiGetState(),(cs->recv), msg);
895
896     return msg;
897 }
898
899 #if CMK_NODE_QUEUE_AVAILABLE
900 void *CmiGetNonLocalNodeQ(void) {
901     CmiState cs = CmiGetState();
902     char *result = 0;
903     CmiIdleLock_checkMessage(&cs->idle);
904     if (!PCQueueEmpty(CsvAccess(NodeState).NodeRecv)) {
905         MACHSTATE1(3,"CmiGetNonLocalNodeQ begin %d {", CmiMyPe());
906         CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
907         result = (char *) PCQueuePop(CsvAccess(NodeState).NodeRecv);
908         CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
909         MACHSTATE1(3,"} CmiGetNonLocalNodeQ end %d ", CmiMyPe());
910     }
911
912     return result;
913 }
914 #endif
915 /* ##### End of Functions Providing Incoming Network Messages ##### */
916
917 static CmiIdleState *CmiNotifyGetState(void) {
918     CmiIdleState *s=(CmiIdleState *)malloc(sizeof(CmiIdleState));
919     s->sleepMs=0;
920     s->nIdles=0;
921     s->cs=CmiGetState();
922     return s;
923 }
924
925 static void CmiNotifyBeginIdle(CmiIdleState *s) {
926     s->sleepMs=0;
927     s->nIdles=0;
928 }
929
930 /*Number of times to spin before sleeping*/
931 #define SPINS_BEFORE_SLEEP 20
932 static void CmiNotifyStillIdle(CmiIdleState *s) {
933     MACHSTATE1(2,"still idle (%d) begin {",CmiMyPe())
934 #if !CMK_SMP
935     AdvanceCommunication(1);
936 #else
937     LrtsPostNonLocal();
938
939     if (_Cmi_noprocforcommthread) {
940     s->nIdles++;
941     if (s->nIdles>SPINS_BEFORE_SLEEP) { /*Start giving some time back to the OS*/
942         s->sleepMs+=2;
943         if (s->sleepMs>10) s->sleepMs=10;
944     }
945
946     if (s->sleepMs>0) {
947         MACHSTATE1(2,"idle lock(%d) {",CmiMyPe())
948         CmiIdleLock_sleep(&s->cs->idle,s->sleepMs);
949         MACHSTATE1(2,"} idle lock(%d)",CmiMyPe())
950     }
951     }
952 #endif
953
954     MACHSTATE1(2,"still idle (%d) end {",CmiMyPe())
955 }
956
957 /* usually called in non-smp mode */
958 void CmiNotifyIdle(void) {
959     AdvanceCommunication(1);
960     CmiYield();
961 }
962
963 /* Utiltiy functions */
964 static char *CopyMsg(char *msg, int len) {
965     char *copy = (char *)CmiAlloc(len);
966 #if CMK_ERROR_CHECKING
967     if (!copy) {
968         CmiAbort("Error: out of memory in machine layer\n");
969     }
970 #endif
971     memcpy(copy, msg, len);
972     return copy;
973 }
974
975
976 #if CMK_USE_PXSHM
977 #include "machine-pxshm.c"
978 #endif
979
980