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