93340e260a308ab5c9348ca561b2914ff8754fa2
[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 "immediate.c"
348
349 /* ===== Beginning of Common Function Definitions ===== */
350 static void PerrorExit(const char *msg) {
351     perror(msg);
352     exit(1);
353 }
354
355 /* ##### Beginning of Functions Related with Message Sending OPs ##### */
356 /*Add a message to this processor's receive queue, pe is a rank */
357 void CmiPushPE(int rank,void *msg) {
358     CmiState cs = CmiGetStateN(rank);
359     MACHSTATE2(3,"Pushing message into rank %d's queue %p{",rank, cs->recv);
360 #if CMK_IMMEDIATE_MSG
361     if (CmiIsImmediate(msg)) {
362         MACHSTATE1(3, "[%p] Push Immediate Message begin{",CmiGetState());
363         CMI_DEST_RANK(msg) = rank;
364         CmiPushImmediateMsg(msg);
365         MACHSTATE1(3, "[%p] Push Immediate Message end}",CmiGetState());
366         return;
367     }
368 #endif
369
370     PCQueuePush(cs->recv,msg);
371
372 #if CMK_SHARED_VARS_POSIX_THREADS_SMP
373   if (_Cmi_noprocforcommthread)
374 #endif
375     CmiIdleLock_addMessage(&cs->idle);
376     MACHSTATE1(3,"} Pushing message into rank %d's queue done",rank);
377 }
378
379 #if CMK_NODE_QUEUE_AVAILABLE
380 /*Add a message to this processor's receive queue */
381 void CmiPushNode(void *msg) {
382     MACHSTATE(3,"Pushing message into NodeRecv queue");
383 #if CMK_IMMEDIATE_MSG
384     if (CmiIsImmediate(msg)) {
385         CMI_DEST_RANK(msg) = 0;
386         CmiPushImmediateMsg(msg);
387         return;
388     }
389 #endif
390     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
391     PCQueuePush(CsvAccess(NodeState).NodeRecv,msg);
392     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
393
394 #if CMK_SHARED_VARS_POSIX_THREADS_SMP
395     if (_Cmi_noprocforcommthread)
396 #endif
397     {
398         CmiState cs=CmiGetStateN(0);
399         CmiIdleLock_addMessage(&cs->idle);
400     }
401 }
402 #endif
403
404 /* This function handles the msg received as which queue to push into */
405 static INLINE_KEYWORD void handleOneRecvedMsg(int size, char *msg) {
406     int isBcastMsg = 0;
407 #if CMK_BROADCAST_SPANNING_TREE || CMK_BROADCAST_HYPERCUBE
408     isBcastMsg = (CMI_BROADCAST_ROOT(msg)!=0);
409 #endif
410
411     if (isBcastMsg) {
412         handleOneBcastMsg(size, msg);
413         return;
414     }
415
416 #if CMK_NODE_QUEUE_AVAILABLE
417     if (CMI_DEST_RANK(msg)==DGRAM_NODEMESSAGE)
418         CmiPushNode(msg);
419     else
420 #endif
421         CmiPushPE(CMI_DEST_RANK(msg), msg);
422
423 }
424
425
426 static void SendToPeers(int size, char *msg) {
427     /* FIXME: now it's just a flat p2p send!! When node size is large,
428     * it should also be sent in a tree
429     */
430     int exceptRank = CMI_DEST_RANK(msg);
431     int i;
432     for (i=0; i<exceptRank; i++) {
433         CmiPushPE(i, CopyMsg(msg, size));
434     }
435     for (i=exceptRank+1; i<CmiMyNodeSize(); i++) {
436         CmiPushPE(i, CopyMsg(msg, size));
437     }
438 }
439
440
441 /* Functions regarding sending operations */
442 static void CmiSendSelf(char *msg) {
443 #if CMK_IMMEDIATE_MSG
444     if (CmiIsImmediate(msg)) {
445         /* CmiBecomeNonImmediate(msg); */
446         CmiPushImmediateMsg(msg);
447         CmiHandleImmediate();
448         return;
449     }
450 #endif
451     CdsFifo_Enqueue(CpvAccess(CmiLocalQueue),msg);
452 }
453
454 /* Functions regarding P2P send op */
455 #if USE_COMMON_SYNC_P2P
456 void CmiSyncSendFn(int destPE, int size, char *msg) {
457     char *dupmsg = CopyMsg(msg, size);
458     CmiFreeSendFn(destPE, size, dupmsg);
459 }
460
461 #if CMK_USE_PXSHM
462 inline int CmiValidPxshm(int dst, int size);
463 void CmiSendMessagePxshm(char *msg, int size, int dstpe, int *refcount, int rank,unsigned int broot);
464 void CmiInitPxshm(char **argv);
465 inline void CommunicationServerPxshm();
466 void CmiExitPxshm();
467 #endif
468
469 int refcount = 0;
470
471 void CmiFreeSendFn(int destPE, int size, char *msg) {
472     CMI_SET_BROADCAST_ROOT(msg, 0);
473     CQdCreate(CpvAccess(cQdState), 1);
474     if (CmiMyPe()==destPE) {
475         CmiSendSelf(msg);
476 #if CMK_PERSISTENT_COMM
477         if (phs) curphs++;
478 #endif
479     } else {
480 #if CMK_PERSISTENT_COMM
481         if (phs && size > 8192) {
482             CmiAssert(curphs < phsSize);
483             LrtsSendPersistentMsg(phs[curphs++], destPE, size, msg);
484             return;
485         }
486 #endif
487
488         int destNode = CmiNodeOf(destPE);
489 #if CMK_SMP
490         if (CmiMyNode()==destNode) {
491             CmiPushPE(CmiRankOf(destPE), msg);
492             return;
493         }
494 #endif
495         CMI_DEST_RANK(msg) = CmiRankOf(destPE);
496 #if CMK_USE_PXSHM
497         int ret=CmiValidPxshm(destPE, size);
498         if (ret) {
499           CmiSendMessagePxshm(msg, size, destPE, &refcount, CmiRankOf(destPE), 0);
500           //for (int i=0; i<refcount; i++) CmiReference(msg);
501 #if CMK_PERSISTENT_COMM
502           if (phs) curphs++;
503 #endif
504           return;
505         }
506 #endif
507 if (  MSG_STATISTIC)
508 {
509     int ret_log = _cmi_log2(size);
510     if(ret_log >21) ret_log = 21;
511     msg_histogram[ret_log]++;
512 }
513         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
514     }
515 }
516 #endif
517
518 #if USE_COMMON_ASYNC_P2P
519 CmiCommHandle CmiAsyncSendFn(int destPE, int size, char *msg) {
520     int destNode = CmiNodeOf(destPE);
521     if (destNode == CmiMyNode()) {
522         CmiSyncSendFn(destPE,size,msg);
523         return 0;
524     } else {
525 if (  MSG_STATISTIC)
526 {
527     int ret_log = _cmi_log2(size);
528         if(ret_log >21) ret_log = 21;
529         msg_histogram[ret_log]++;
530 }
531         return LrtsSendFunc(destPE, size, msg, P2P_ASYNC);
532     }
533 }
534 #endif
535
536 #if CMK_NODE_QUEUE_AVAILABLE
537 static void CmiSendNodeSelf(char *msg) {
538 #if CMK_IMMEDIATE_MSG
539     if (CmiIsImmediate(msg)) {
540         CmiPushImmediateMsg(msg);
541         if (!_immRunning) CmiHandleImmediate();
542         return;
543     }
544 #endif
545     CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
546     PCQueuePush(CsvAccess(NodeState).NodeRecv, msg);
547     CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
548 }
549
550 #if USE_COMMON_ASYNC_P2P
551 void CmiSyncNodeSendFn(int destNode, int size, char *msg) {
552     char *dupmsg = CopyMsg(msg, size);
553     CmiFreeNodeSendFn(destNode, size, dupmsg);
554 }
555
556 void CmiFreeNodeSendFn(int destNode, int size, char *msg) {
557     CMI_DEST_RANK(msg) = DGRAM_NODEMESSAGE;
558     CQdCreate(CpvAccess(cQdState), 1);
559     CMI_SET_BROADCAST_ROOT(msg, 0);
560     if (destNode == CmiMyNode()) {
561         CmiSendNodeSelf(msg);
562     } else {
563 if (  MSG_STATISTIC)
564 {
565     int ret_log = _cmi_log2(size);
566     if(ret_log >21) ret_log = 21;
567     msg_histogram[ret_log]++;
568 }
569         LrtsSendFunc(destNode, size, msg, P2P_SYNC);
570     }
571 }
572 #endif
573
574 #if USE_COMMON_ASYNC_P2P
575 CmiCommHandle CmiAsyncNodeSendFn(int destNode, int size, char *msg) {
576     if (destNode == CmiMyNode()) {
577         CmiSyncNodeSendFn(destNode, size, msg);
578         return 0;
579     } else {
580 if (  MSG_STATISTIC)
581 {
582         int ret_log = _cmi_log2(size);
583         if(ret_log >21) ret_log = 21;
584         msg_histogram[ret_log]++;
585 }
586         return LrtsSendFunc(destNode, size, msg, P2P_ASYNC);
587     }
588 }
589 #endif
590 #endif
591     
592 /* ##### Beginning of Functions Related with Machine Startup ##### */
593 void ConverseInit(int argc, char **argv, CmiStartFn fn, int usched, int initret) {
594     int _ii;
595     int tmp;
596     MSG_STATISTIC = CmiGetArgFlag(argv, "+msgstatistic");
597     /* processor per node */
598     _Cmi_mynodesize = 1;
599     if (!CmiGetArgInt(argv,"+ppn", &_Cmi_mynodesize))
600         CmiGetArgInt(argv,"++ppn", &_Cmi_mynodesize);
601 #if ! CMK_SMP
602     if (_Cmi_mynodesize > 1 && _Cmi_mynode == 0)
603         CmiAbort("+ppn cannot be used in non SMP version!\n");
604 #endif
605
606     /* Network progress function is used to poll the network when for
607     messages. This flushes receive buffers on some  implementations*/
608     networkProgressPeriod = NETWORK_PROGRESS_PERIOD_DEFAULT;
609     CmiGetArgInt(argv, "+networkProgressPeriod", &networkProgressPeriod);
610
611     /* _Cmi_mynodesize has to be obtained before LrtsInit
612      * because it may be used inside LrtsInit
613      */
614     /* argv could be changed inside LrtsInit */
615     /* Inside this function, the number of nodes and my node id are obtained */
616 if (  MSG_STATISTIC)
617 {
618     for(_ii=0; _ii<22; _ii++)
619         msg_histogram[_ii] = 0;
620 }
621
622     LrtsInit(&argc, &argv, &_Cmi_numnodes, &_Cmi_mynode);
623   
624         if (_Cmi_mynode==0) {
625 #if !CMK_SMP 
626                 printf("Charm++> Running on Non-smp mode\n");
627 #else
628                 printf("Charm++> Running on SMP mode, %d worker threads per process\n", _Cmi_mynodesize);
629                 if (Cmi_smp_mode_setting == COMM_THREAD_SEND_RECV) {
630                         printf("Charm++> The comm. thread will both send and receive messages\n");
631                 } else if (Cmi_smp_mode_setting == COMM_THREAD_ONLY_RECV) {
632                         printf("Charm++> The comm. thread will only receive messages, while work threads will send messages\n");
633                 } else if (Cmi_smp_mode_setting == COMM_THREAD_NOT_EXIST) {
634                         printf("Charm++> There's no comm. thread. Work threads will both send and receive messages\n");
635                 } else {
636                         CmiAbort("Charm++> Invalid SMP mode setting\n");
637                 }
638 #endif
639         }
640
641     _Cmi_numpes = _Cmi_numnodes * _Cmi_mynodesize;
642     Cmi_nodestart = _Cmi_mynode * _Cmi_mynodesize;
643     Cmi_argvcopy = CmiCopyArgs(argv);
644     Cmi_argv = argv;
645     Cmi_startfn = fn;
646     Cmi_usrsched = usched;
647
648 #if CMK_USE_PXSHM
649     CmiInitPxshm(argv);
650 #endif
651
652     /* CmiTimerInit(); */
653 #if CMK_BROADCAST_HYPERCUBE
654     /* CmiNodesDim = ceil(log2(CmiNumNodes)) except when #nodes is 1*/
655     tmp = CmiNumNodes()-1;
656     CmiNodesDim = 0;
657     while (tmp>0) {
658         CmiNodesDim++;
659         tmp = tmp >> 1;
660     }
661     if (CmiNumNodes()==1) CmiNodesDim=1;
662 #endif
663
664     CsvInitialize(CmiNodeState, NodeState);
665     CmiNodeStateInit(&CsvAccess(NodeState));
666 #if CMK_SMP
667     commThdExitLock = CmiCreateLock();
668 #endif
669
670 #if CMK_OFFLOAD_BCAST_PROCESS
671     /* the actual queues should be created on comm thread considering NUMA in SMP */
672     CsvInitialize(PCQueue, procBcastQ);
673 #if CMK_NODE_QUEUE_AVAILABLE
674     CsvInitialize(PCQueue, nodeBcastQ);
675 #endif
676 #endif
677
678     CmiStartThreads(argv);
679     ConverseRunPE(initret);
680 }
681
682 static void ConverseRunPE(int everReturn) {
683     CmiState cs;
684     char** CmiMyArgv;
685
686     LrtsPreCommonInit(everReturn);
687
688 #if CMK_OFFLOAD_BCAST_PROCESS
689     int createQueue = 1;
690 #if CMK_SMP
691 #if CMK_SMP_NO_COMMTHD
692     /* If there's no comm thread, then the queue is created on rank 0 */
693     if (CmiMyRank()) createQueue = 0;
694 #else
695     if (CmiMyRank()<CmiMyNodeSize()) createQueue = 0;
696 #endif
697 #endif
698
699     if (createQueue) {
700         CsvAccess(procBcastQ) = PCQueueCreate();
701 #if CMK_NODE_QUEUE_AVAILABLE
702         CsvAccess(nodeBcastQ) = PCQueueCreate();
703 #endif
704     }
705 #endif
706
707     CmiNodeAllBarrier();
708
709     cs = CmiGetState();
710     CpvInitialize(void *,CmiLocalQueue);
711     CpvAccess(CmiLocalQueue) = cs->localqueue;
712
713     if (CmiMyRank())
714         CmiMyArgv=CmiCopyArgs(Cmi_argvcopy);
715     else
716         CmiMyArgv=Cmi_argv;
717
718     CthInit(CmiMyArgv);
719
720     /* initialize the network progress counter*/
721     /* Network progress function is used to poll the network when for
722        messages. This flushes receive buffers on some  implementations*/
723     CpvInitialize(unsigned , networkProgressCount);
724     CpvAccess(networkProgressCount) = 0;
725
726     ConverseCommonInit(CmiMyArgv);
727
728     LrtsPostCommonInit(everReturn);
729
730     /* Converse initialization finishes, immediate messages can be processed.
731        node barrier previously should take care of the node synchronization */
732     _immediateReady = 1;
733
734     /* communication thread */
735 #if CMK_INTER_OPERATE
736                 Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
737 #else
738     if (CmiMyRank() == CmiMyNodeSize()) {
739         Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
740         while (1) CommunicationServerThread(5);
741     } else { /* worker thread */
742         if (!everReturn) {
743             Cmi_startfn(CmiGetArgc(CmiMyArgv), CmiMyArgv);
744             if (Cmi_usrsched==0) CsdScheduler(-1);
745             ConverseExit();
746         }
747     }
748 #endif
749 }
750 /* ##### End of Functions Related with Machine Startup ##### */
751
752 #if CMK_INTER_OPERATE
753 void CharmLibInit(int peid, int numpes, int argc, char **argv, CmiStartFn fn) {
754           _Cmi_numnodes = numpes;
755           _Cmi_mynode = peid;
756     ConverseInit(argc, argv, fn, 1, 0);
757 }
758 #endif
759
760 /* ##### Beginning of Functions Related with Machine Running ##### */
761 static INLINE_KEYWORD void AdvanceCommunication(int whenidle) {
762     int doProcessBcast = 1;
763
764 #if CMK_USE_PXSHM
765     CommunicationServerPxshm();
766 #endif
767
768     LrtsAdvanceCommunication(whenidle);
769
770 #if CMK_OFFLOAD_BCAST_PROCESS
771 #if CMK_SMP_NO_COMMTHD
772     /*FIXME: only asks rank 0 to process bcast msgs, so perf may suffer*/
773     if (CmiMyRank()) doProcessBcast = 0;
774 #endif
775     if (doProcessBcast) processBcastQs();
776 #endif
777
778 #if CMK_IMMEDIATE_MSG
779 #if !CMK_SMP
780     CmiHandleImmediate();
781 #endif
782 #if CMK_SMP && CMK_SMP_NO_COMMTHD
783     if (CmiMyRank()==0) CmiHandleImmediate();
784 #endif
785 #endif
786
787 }
788
789 static void CommunicationServer(int sleepTime) {
790 #if CMK_SMP
791     AdvanceCommunication(0);
792
793     if (commThdExit == CmiMyNodeSize()) {
794         MACHSTATE(2, "CommunicationServer exiting {");
795         LrtsDrainResources();
796         MACHSTATE(2, "} CommunicationServer EXIT");
797
798         ConverseCommonExit();
799
800 #if CMK_USE_PXSHM
801         CmiExitPxshm();
802 #endif
803         LrtsExit();
804     }
805 #endif
806 }
807
808 static void CommunicationServerThread(int sleepTime) {
809     CommunicationServer(sleepTime);
810 #if CMK_IMMEDIATE_MSG
811     CmiHandleImmediate();
812 #endif
813 }
814
815 void ConverseExit(void) {
816     int i;
817 #if !CMK_SMP
818     LrtsDrainResources();
819 #else
820         if(Cmi_smp_mode_setting == COMM_THREAD_ONLY_RECV
821            || Cmi_smp_mode_setting == COMM_THREAD_NOT_EXIST)
822                 LrtsDrainResources();
823 #endif
824
825     ConverseCommonExit();
826
827 if (MSG_STATISTIC)
828 {
829     for(i=0; i<22; i++)
830     {
831         CmiPrintf("[MSG PE:%d]", CmiMyPe());
832         if(msg_histogram[i] >0)
833             CmiPrintf("(%d:%d) ", 1<<i, msg_histogram[i]);
834     }
835     CmiPrintf("\n");
836 }
837 #if (CMK_DEBUG_MODE || CMK_WEB_MODE || NODE_0_IS_CONVHOST)
838     if (CmiMyPe() == 0) CmiPrintf("End of program\n");
839 #endif
840
841 #if !CMK_SMP
842 #if CMK_USE_PXSHM
843     CmiExitPxshm();
844 #endif
845     LrtsExit();
846 #else
847     /* In SMP, the communication thread will exit */
848     /* atomic increment */
849     CmiLock(commThdExitLock);
850     commThdExit++;
851     CmiUnlock(commThdExitLock);
852     while (1) CmiYield();
853 #endif
854 }
855 /* ##### End of Functions Related with Machine Running ##### */
856
857
858 /* ##### Beginning of Functions Providing Incoming Network Messages ##### */
859 void *CmiGetNonLocal(void) {
860     CmiState cs = CmiGetState();
861     void *msg = NULL;
862
863 #if !CMK_SMP || CMK_SMP_NO_COMMTHD
864     /**
865       * In SMP mode with comm thread, it's possible a normal
866       * msg is sent from an immediate msg which is executed
867       * on comm thread. In this case, the msg is sent to
868       * the network queue of the work thread. Therefore,
869       * even there's only one worker thread, the polling of
870       * network queue is still required.
871       */
872     if (CmiNumPes() == 1) return NULL;
873 #endif
874
875     MACHSTATE2(3, "[%p] CmiGetNonLocal begin %d{", cs, CmiMyPe());
876     CmiIdleLock_checkMessage(&cs->idle);
877     /* ?????although it seems that lock is not needed, I found it crashes very often
878        on mpi-smp without lock */
879     msg = PCQueuePop(cs->recv);
880 #if !CMK_SMP
881     if (!msg) {
882        AdvanceCommunication(0);
883        msg = PCQueuePop(cs->recv);
884     }
885 #else
886 //    LrtsPostNonLocal();
887 #endif
888
889     MACHSTATE3(3,"[%p] CmiGetNonLocal from queue %p with msg %p end }",CmiGetState(),(cs->recv), msg);
890
891     return msg;
892 }
893
894 #if CMK_NODE_QUEUE_AVAILABLE
895 void *CmiGetNonLocalNodeQ(void) {
896     CmiState cs = CmiGetState();
897     char *result = 0;
898     CmiIdleLock_checkMessage(&cs->idle);
899     if (!PCQueueEmpty(CsvAccess(NodeState).NodeRecv)) {
900         MACHSTATE1(3,"CmiGetNonLocalNodeQ begin %d {", CmiMyPe());
901         CmiLock(CsvAccess(NodeState).CmiNodeRecvLock);
902         result = (char *) PCQueuePop(CsvAccess(NodeState).NodeRecv);
903         CmiUnlock(CsvAccess(NodeState).CmiNodeRecvLock);
904         MACHSTATE1(3,"} CmiGetNonLocalNodeQ end %d ", CmiMyPe());
905     }
906
907     return result;
908 }
909 #endif
910 /* ##### End of Functions Providing Incoming Network Messages ##### */
911
912 static CmiIdleState *CmiNotifyGetState(void) {
913     CmiIdleState *s=(CmiIdleState *)malloc(sizeof(CmiIdleState));
914     s->sleepMs=0;
915     s->nIdles=0;
916     s->cs=CmiGetState();
917     return s;
918 }
919
920 static void CmiNotifyBeginIdle(CmiIdleState *s) {
921     s->sleepMs=0;
922     s->nIdles=0;
923 }
924
925 /*Number of times to spin before sleeping*/
926 #define SPINS_BEFORE_SLEEP 20
927 static void CmiNotifyStillIdle(CmiIdleState *s) {
928     MACHSTATE1(2,"still idle (%d) begin {",CmiMyPe())
929 #if !CMK_SMP
930     AdvanceCommunication(1);
931 #else
932     LrtsPostNonLocal();
933
934     if (_Cmi_noprocforcommthread) {
935     s->nIdles++;
936     if (s->nIdles>SPINS_BEFORE_SLEEP) { /*Start giving some time back to the OS*/
937         s->sleepMs+=2;
938         if (s->sleepMs>10) s->sleepMs=10;
939     }
940
941     if (s->sleepMs>0) {
942         MACHSTATE1(2,"idle lock(%d) {",CmiMyPe())
943         CmiIdleLock_sleep(&s->cs->idle,s->sleepMs);
944         MACHSTATE1(2,"} idle lock(%d)",CmiMyPe())
945     }
946     }
947 #endif
948
949     MACHSTATE1(2,"still idle (%d) end {",CmiMyPe())
950 }
951
952 /* usually called in non-smp mode */
953 void CmiNotifyIdle(void) {
954     AdvanceCommunication(1);
955     CmiYield();
956 }
957
958 /* Utiltiy functions */
959 static char *CopyMsg(char *msg, int len) {
960     char *copy = (char *)CmiAlloc(len);
961 #if CMK_ERROR_CHECKING
962     if (!copy) {
963         CmiAbort("Error: out of memory in machine layer\n");
964     }
965 #endif
966     memcpy(copy, msg, len);
967     return copy;
968 }
969
970
971 #if CMK_USE_PXSHM
972 #include "machine-pxshm.c"
973 #endif
974