in the reduction handler, when count is 0, return the data immediately.
[charm.git] / src / conv-core / cputopology.C
1 /*****************************************************************************
2  * $Source$
3  * $Author$
4  * $Date$
5  * $Revision$
6  *****************************************************************************/
7
8 #include <map>
9 #include "converse.h"
10 #include "sockRoutines.h"
11 #include "cklists.h"
12
13 #define DEBUGP(x)  /** CmiPrintf x; */
14
15 /** This scheme relies on using IP address to identify physical nodes 
16  * written by Gengbin Zheng  9/2008
17  *
18  * last updated 10/4/2009   Gengbin Zheng
19  * added function CmiCpuTopologyEnabled() which retuens 1 when supported
20  * when not supported return 0
21  * all functions when cputopology not support, now act like a normal non-smp 
22  * case and all PEs are unique.
23  *
24  * major changes 10/28/09   Gengbin Zheng
25  * - parameters changed from pe to node to be consistent with the function name
26  * - two new functions:   CmiPhysicalNodeID and CmiPhysicalRank
27  *
28  * 3/5/2010   Gengbin Zheng
29  * - use CmiReduce to optimize the collection of node info
30  */
31
32 #if 1
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <unistd.h>
37
38 #include <stdlib.h>
39 #include <stdio.h>
40
41 #if CMK_BLUEGENEL || CMK_BLUEGENEP
42 #include "TopoManager.h"
43 #endif
44
45 #if CMK_CRAYXT
46 extern "C" int getXTNodeID(int mype, int numpes);
47 #endif
48
49 #if defined(__APPLE__)  && CMK_HAS_MULTIPROCESSING_H
50 #include <Carbon/Carbon.h>
51 #include <Multiprocessing.h>
52 #endif
53
54 #if CMK_BLUEGENE_CHARM
55 #include "middle-blue.h"
56 using namespace BGConverse;
57 #endif
58
59 extern "C" int CmiNumCores(void) {
60   int a = 1;
61 #ifdef _WIN32
62 struct _SYSTEM_INFO sysinfo;
63 #endif  
64
65   /* Allow the user to override the number of CPUs for use
66      in scalability testing, debugging, etc. */
67   char *forcecount = getenv("FORCECPUCOUNT");
68   if (forcecount != NULL) {
69     if (sscanf(forcecount, "%d", &a) == 1) {
70       return a; /* if we got a valid count, return it */
71     } else {
72       a = 1;      /* otherwise use the real available hardware CPU count */
73     }
74   }
75
76 #if defined(__APPLE__)  && CMK_HAS_MULTIPROCESSING_H
77   a = MPProcessorsScheduled(); /* Number of active/running CPUs */
78 #endif
79
80 #ifdef _WIN32
81   //struct _SYSTEM_INFO sysinfo;  
82   GetSystemInfo(&sysinfo);
83   a = sysinfo.dwNumberOfProcessors; /* total number of CPUs */
84 #endif /* _MSC_VER */
85
86
87 #ifdef _SC_NPROCESSORS_ONLN
88   a = sysconf(_SC_NPROCESSORS_ONLN); /* number of active/running CPUs */
89 #elif defined(_SC_CRAY_NCPU)
90   a = sysconf(_SC_CRAY_NCPU);
91 #elif defined(_SC_NPROC_ONLN)
92   a = sysconf(_SC_NPROC_ONLN); /* number of active/running CPUs */
93 #endif
94   if (a == -1) a = 1;
95
96 #if defined(ARCH_HPUX11) || defined(ARCH_HPUX10)
97   a = mpctl(MPC_GETNUMSPUS, 0, 0); /* total number of CPUs */
98 #endif /* HPUX */
99
100   return a;
101 }
102
103 static int cpuTopoHandlerIdx;
104 static int cpuTopoRecvHandlerIdx;
105
106 struct _procInfo {
107   skt_ip_t ip;
108   int pe;
109   int ncores;
110   int rank;
111   int nodeID;
112 };
113
114 typedef struct _hostnameMsg {
115   char core[CmiMsgHeaderSizeBytes];
116   int n;
117   _procInfo *procs;
118 } hostnameMsg;
119
120 typedef struct _nodeTopoMsg {
121   char core[CmiMsgHeaderSizeBytes];
122   int *nodes;
123 } nodeTopoMsg;
124
125 static nodeTopoMsg *topomsg = NULL;
126 static CmmTable hostTable;
127
128 // nodeIDs[pe] is the node number of processor pe
129 class CpuTopology {
130 public:
131   static int *nodeIDs;
132   static int numPes;
133   static int numNodes;
134   static CkVec<int> *bynodes;
135   static int supported;
136
137     // return -1 when not supported
138   int numUniqNodes() {
139 #if 0
140     if (numNodes != 0) return numNodes;
141     int n = 0;
142     for (int i=0; i<CmiNumPes(); i++) 
143       if (nodeIDs[i] > n)
144         n = nodeIDs[i];
145     numNodes = n+1;
146     return numNodes;
147 #else
148     if (numNodes > 0) return numNodes;     // already calculated
149     CkVec<int> unodes;
150     int i;
151     for (i=0; i<numPes; i++)  unodes.push_back(nodeIDs[i]);
152     //unodes.bubbleSort(0, numPes-1);
153     unodes.quickSort();
154     int last = -1;
155     std::map<int, int> nodemap;  // nodeIDs can be out of range of [0,numNodes]
156     for (i=0; i<numPes; i++)  { 
157         if (unodes[i] != last) {
158           last=unodes[i];
159           nodemap[unodes[i]] = numNodes;
160           numNodes++; 
161         }
162     }
163     if (numNodes == 0) 
164       numNodes = CmiNumNodes();
165     else {
166         // re-number nodeIDs, which may be necessary e.g. on BlueGene/P
167       for (i=0; i<numPes; i++) nodeIDs[i] = nodemap[nodeIDs[i]];
168       CpuTopology::supported = 1;
169     }
170     return numNodes;
171 #endif
172   }
173
174   void sort() {
175     int i;
176     numUniqNodes();
177     bynodes = new CkVec<int>[numNodes];
178     if (supported) {
179       for (i=0; i<numPes; i++){
180         CmiAssert(nodeIDs[i] >=0 && nodeIDs[i] <= numNodes); // Sanity check for bug that occurs on mpi-crayxt
181         bynodes[nodeIDs[i]].push_back(i);
182       }
183     }
184     else {    /* not supported/enabled */
185       for (i=0;i<CmiNumPes();i++)  bynodes[CmiNodeOf(i)].push_back(i);
186     }
187   }
188
189   void print() {
190     int i;
191     CmiPrintf("Charm++> Cpu topology info:\n");
192     CmiPrintf("PE to node map: ");
193     for (i=0; i<CmiNumPes(); i++)
194       CmiPrintf("%d ", nodeIDs[i]);
195     CmiPrintf("\n");
196     CmiPrintf("Node to PE map:\n");
197     for (i=0; i<numNodes; i++) {
198       CmiPrintf("Chip #%d: ", i);
199       for (int j=0; j<bynodes[i].size(); j++)
200         CmiPrintf("%d ", bynodes[i][j]);
201       CmiPrintf("\n");
202     }
203   }
204
205 };
206
207 int *CpuTopology::nodeIDs = NULL;
208 int CpuTopology::numPes = 0;
209 int CpuTopology::numNodes = 0;
210 CkVec<int> *CpuTopology::bynodes = NULL;
211 int CpuTopology::supported = 0;
212
213 static CpuTopology cpuTopo;
214 static CmiNodeLock topoLock = NULL;
215 static int done = 0;
216
217 /* called on PE 0 */
218 static void cpuTopoHandler(void *m)
219 {
220   static int count = 0;
221   static int nodecount = 0;
222   _procInfo *rec;
223   hostnameMsg *msg = (hostnameMsg *)m;
224   char str[256];
225   int tag, tag1, pe, myrank;
226
227   if (topomsg == NULL) {
228     int i;
229     hostTable = CmmNew();
230     topomsg = (nodeTopoMsg *)CmiAlloc(sizeof(nodeTopoMsg)+CmiNumPes()*sizeof(int));
231     CmiSetHandler((char *)topomsg, cpuTopoRecvHandlerIdx);
232     topomsg->nodes = (int *)((char*)topomsg + sizeof(nodeTopoMsg));
233     for (i=0; i<CmiNumPes(); i++) topomsg->nodes[i] = -1;
234   }
235   CmiAssert(topomsg != NULL);
236
237   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
238   CmiAssert(msg->n == CmiNumPes());
239   for (int i=0; i<msg->n; i++) 
240   {
241     _procInfo *proc = msg->procs+i;
242
243 /*   for debug
244   skt_print_ip(str, msg->ip);
245   printf("hostname: %d %s\n", msg->pe, str);
246 */
247     tag = *(int*)&proc->ip;
248     pe = proc->pe;
249     if ((rec = (_procInfo *)CmmProbe(hostTable, 1, &tag, &tag1)) != NULL) {
250     }
251     else {
252 //    msg->nodeID = nodecount++;
253       proc->nodeID = pe;           // we will compact the node ID later
254       rec = proc;
255       CmmPut(hostTable, 1, &tag, proc);
256     }
257     myrank = rec->rank%rec->ncores;
258     topomsg->nodes[pe] = rec->nodeID;
259     rec->rank ++;
260   }
261
262     // assume all nodes have same number of cores
263   int ncores = CmiNumCores();
264   if (ncores > 1)
265     sprintf(str, "Charm++> Running on %d unique compute nodes (%d-way SMP).\n", CmmEntries(hostTable), ncores);
266   else
267     sprintf(str, "Charm++> Running on %d unique compute nodes.\n", CmmEntries(hostTable));
268   CmiPrintf(str);
269     // clean up CmmTable
270   hostnameMsg *tmpm;
271   tag = CmmWildCard;
272   while (tmpm = (hostnameMsg *)CmmGet(hostTable, 1, &tag, &tag1));
273   CmmFree(hostTable);
274   CmiFree(msg);
275
276   CmiSyncBroadcastAllAndFree(sizeof(nodeTopoMsg)+CmiNumPes()*sizeof(int), (char *)topomsg);
277 }
278
279 /* called on each processor */
280 static void cpuTopoRecvHandler(void *msg)
281 {
282   nodeTopoMsg *m = (nodeTopoMsg *)msg;
283   m->nodes = (int *)((char*)m + sizeof(nodeTopoMsg));
284
285   CmiLock(topoLock);
286   if (cpuTopo.nodeIDs == NULL) {
287     cpuTopo.nodeIDs = m->nodes;
288     cpuTopo.sort();
289   }
290   else
291     CmiFree(m);
292   done++;
293   CmiUnlock(topoLock);
294
295   //if (CmiMyPe() == 0) cpuTopo.print();
296 }
297
298 // reduction function
299 static void * combineMessage(int *size, void *data, void **remote, int count) 
300 {
301   int i, j;
302   int nprocs = ((hostnameMsg *)data)->n;
303   if (count == 0) return data;
304   for (i=0; i<count; i++) nprocs += ((hostnameMsg *)remote[i])->n;
305   *size = sizeof(hostnameMsg)+sizeof(_procInfo)*nprocs;
306   hostnameMsg *msg = (hostnameMsg *)CmiAlloc(*size);
307   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
308   msg->n = nprocs;
309   CmiSetHandler((char *)msg, cpuTopoHandlerIdx);
310
311   int n=0;
312   hostnameMsg *m = (hostnameMsg*)data;
313   m->procs = (_procInfo*)((char*)m + sizeof(hostnameMsg));
314   for (j=0; j<m->n; j++)
315     msg->procs[n++] = m->procs[j];
316   for (i=0; i<count; i++) {
317     m = (hostnameMsg*)remote[i];
318     m->procs = (_procInfo*)((char*)m + sizeof(hostnameMsg));
319     for (j=0; j<m->n; j++)
320       msg->procs[n++] = m->procs[j];
321   }
322   return msg;
323 }
324
325 /******************  API implementation **********************/
326
327 extern "C" int CmiCpuTopologyEnabled()
328 {
329   return CpuTopology::supported;
330 }
331
332 extern "C" int CmiPeOnSamePhysicalNode(int pe1, int pe2)
333 {
334   int *nodeIDs = cpuTopo.nodeIDs;
335   if (!cpuTopo.supported || nodeIDs == NULL) return CmiNodeOf(pe1) == CmiNodeOf(pe2);
336   else return nodeIDs[pe1] == nodeIDs[pe2];
337 }
338
339 // return -1 when not supported
340 extern "C" int CmiNumPhysicalNodes()
341 {
342   if (!cpuTopo.supported) return CmiNumNodes();
343   else return cpuTopo.numUniqNodes();
344 }
345
346 extern "C" int CmiNumPesOnPhysicalNode(int node)
347 {
348   return !cpuTopo.supported?CmiNodeSize(node):(int)cpuTopo.bynodes[node].size();
349 }
350
351 // pelist points to system memory, user should not free it
352 extern "C" void CmiGetPesOnPhysicalNode(int node, int **pelist, int *num)
353 {
354   *num = cpuTopo.bynodes[node].size();
355   if (pelist!=NULL && *num>0) *pelist = cpuTopo.bynodes[node].getVec();
356 }
357
358 extern "C" int CmiPhysicalRank(int pe)
359 {
360   if (!cpuTopo.supported) return CmiRankOf(pe);
361   const CkVec<int> &v = cpuTopo.bynodes[cpuTopo.nodeIDs[pe]];
362   int rank = 0;  
363   int npes = v.size();
364   while (rank < npes && v[rank] < pe) rank++;       // already sorted
365   CmiAssert(v[rank] == pe);
366   return rank;
367 }
368
369 extern "C" int CmiPhysicalNodeID(int pe)
370 {
371   if (!cpuTopo.supported) return CmiNodeOf(pe);
372   return cpuTopo.nodeIDs[pe];
373 }
374
375 // the least number processor on the same physical node
376 extern "C"  int CmiGetFirstPeOnPhysicalNode(int node)
377 {
378   if (!cpuTopo.supported) return CmiNodeFirst(node);
379   return cpuTopo.bynodes[node][0];
380 }
381
382
383 static int _noip = 0;
384
385 extern "C" void CmiInitCPUTopology(char **argv)
386 {
387   static skt_ip_t myip;
388   int ret, i;
389   hostnameMsg  *msg;
390   double startT;
391  
392   if (CmiMyRank() ==0) {
393      topoLock = CmiCreateLock();
394   }
395
396   int obtain_flag = 1;              // default on
397 #if __FAULT__
398   obtain_flag = 0;
399 #endif
400   if(CmiGetArgFlagDesc(argv,"+obtain_cpu_topology",
401                                            "obtain cpu topology info"))
402     obtain_flag = 1;
403   if (CmiGetArgFlagDesc(argv,"+skip_cpu_topology",
404                                "skip the processof getting cpu topology info"))
405     obtain_flag = 0;
406
407 #if CMK_BLUEGENE_CHARM
408   if (BgNodeRank() == 0)
409 #endif
410   {
411   cpuTopoHandlerIdx =
412      CmiRegisterHandler((CmiHandler)cpuTopoHandler);
413   cpuTopoRecvHandlerIdx =
414      CmiRegisterHandler((CmiHandler)cpuTopoRecvHandler);
415   }
416
417   if (!obtain_flag) {
418     cpuTopo.sort();
419     return;
420   }
421   else if (CmiMyPe() == 0) {
422 #if CMK_BLUEGENE_CHARM
423     if (BgNodeRank() == 0)
424 #endif
425       startT = CmiWallTimer();
426   }
427
428 #if CMK_BLUEGENE_CHARM
429   if (BgNodeRank() == 0)
430   {
431     //int numPes = BgNumNodes()*BgGetNumWorkThread();
432     int numPes = cpuTopo.numPes = CkNumPes();
433     cpuTopo.nodeIDs = new int[numPes];
434     CpuTopology::supported = 1;
435     int wth = BgGetNumWorkThread();
436     for (int i=0; i<numPes; i++) {
437       int nid = i / wth;
438       cpuTopo.nodeIDs[i] = nid;
439     }
440     cpuTopo.sort();
441   }
442   return;
443 #else
444
445 #if CMK_USE_GM
446   CmiBarrier();
447 #endif
448
449   if (CmiMyPe() >= CmiNumPes()) {
450     CmiNodeAllBarrier();         // comm thread waiting
451 #if CMK_MACHINE_PROGRESS_DEFINED
452     while (done < CmiMyNodeSize()) CmiNetworkProgress();
453 #endif
454     return;    /* comm thread return */
455   }
456
457 #if 0
458   if (gethostname(hostname, 999)!=0) {
459       strcpy(hostname, "");
460   }
461 #endif
462 #if CMK_BLUEGENEL || CMK_BLUEGENEP
463   if (CmiMyRank() == 0) {
464     TopoManager tmgr;
465
466     int numPes = cpuTopo.numPes = CmiNumPes();
467     cpuTopo.nodeIDs = new int[numPes];
468     CpuTopology::supported = 1;
469
470     int x, y, z, t, nid;
471     for(int i=0; i<numPes; i++) {
472       tmgr.rankToCoordinates(i, x, y, z, t);
473       nid = tmgr.coordinatesToRank(x, y, z, 0);
474       cpuTopo.nodeIDs[i] = nid;
475     }
476     cpuTopo.sort();
477     if (CmiMyPe()==0)  CmiPrintf("Charm++> Running on %d unique compute nodes (%d-way SMP).\n", cpuTopo.numNodes, CmiNumCores());
478   }
479   CmiNodeAllBarrier();
480   return;
481 #elif CMK_CRAYXT
482   if(CmiMyRank() == 0) {
483     int numPes = cpuTopo.numPes = CmiNumPes();
484     cpuTopo.nodeIDs = new int[numPes];
485     CpuTopology::supported = 1;
486
487     int nid;
488     for(int i=0; i<numPes; i++) {
489       nid = getXTNodeID(i, numPes);
490       cpuTopo.nodeIDs[i] = nid;
491     }
492     int prev = -1;
493     nid = -1;
494
495     // this assumes TXYZ mapping and changes nodeIDs
496     for(int i=0; i<numPes; i++) {
497       if(cpuTopo.nodeIDs[i] != prev) {
498         prev = cpuTopo.nodeIDs[i];
499         cpuTopo.nodeIDs[i] = ++nid;
500       }
501       else
502         cpuTopo.nodeIDs[i] = nid;
503     }
504     cpuTopo.sort();
505     if (CmiMyPe()==0)  CmiPrintf("Charm++> Running on %d unique compute nodes (%d-way SMP).\n", cpuTopo.numNodes, CmiNumCores());
506   }
507   CmiNodeAllBarrier();
508   return;
509 #else
510     /* get my ip address */
511   if (CmiMyRank() == 0)
512   {
513   #if CMK_HAS_GETHOSTNAME
514     myip = skt_my_ip();        /* not thread safe, so only calls on rank 0 */
515   #elif CMK_BPROC
516     myip = skt_innode_my_ip();
517   #else
518     if (!CmiMyPe())
519     CmiPrintf("CmiInitCPUTopology Warning: Can not get unique name for the compute nodes. \n");
520     _noip = 1; 
521   #endif
522   }
523   cpuTopo.numPes = CmiNumPes();
524
525   CmiNodeAllBarrier();
526   if (_noip) return; 
527
528     /* prepare a msg to send */
529   msg = (hostnameMsg *)CmiAlloc(sizeof(hostnameMsg)+sizeof(_procInfo));
530   msg->n = 1;
531   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
532   CmiSetHandler((char *)msg, cpuTopoHandlerIdx);
533   msg->procs[0].pe = CmiMyPe();
534   msg->procs[0].ip = myip;
535   msg->procs[0].ncores = CmiNumCores();
536   msg->procs[0].rank = 0;
537   CmiReduce(msg, sizeof(hostnameMsg)+sizeof(_procInfo), combineMessage);
538
539     // blocking here
540   while (done != CmiMyNodeSize())
541     CsdSchedulePoll();
542
543   if (CmiMyPe() == 0) {
544 #if CMK_BLUEGENE_CHARM
545     if (BgNodeRank() == 0)
546 #endif
547       CmiPrintf("Charm++> cpu topology info is gathered in %.3f seconds.\n", CmiWallTimer()-startT);
548   }
549 #endif
550
551 #endif   /* __BLUEGENE__ */
552
553   // now every one should have the node info
554 }
555
556 #else           /* not supporting cpu topology */
557
558
559 extern "C" void CmiInitCPUTopology(char **argv)
560 {
561   /* do nothing */
562   int obtain_flag = CmiGetArgFlagDesc(argv,"+obtain_cpu_topology",
563                                                 "obtain cpu topology info");
564   CmiGetArgFlagDesc(argv,"+skip_cpu_topology",
565                                "skip the processof getting cpu topology info");
566 }
567
568 #endif