fixed an unitialized variable to please Valgrind.
[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 mpirank, int nummpiranks);
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       numPes = CmiNumPes();
166     }
167     else {
168         // re-number nodeIDs, which may be necessary e.g. on BlueGene/P
169       for (i=0; i<numPes; i++) nodeIDs[i] = nodemap[nodeIDs[i]];
170       CpuTopology::supported = 1;
171     }
172     return numNodes;
173 #endif
174   }
175
176   void sort() {
177     int i;
178     numUniqNodes();
179     bynodes = new CkVec<int>[numNodes];
180     if (supported) {
181       for (i=0; i<numPes; i++){
182         CmiAssert(nodeIDs[i] >=0 && nodeIDs[i] <= numNodes); // Sanity check for bug that occurs on mpi-crayxt
183         bynodes[nodeIDs[i]].push_back(i);
184       }
185     }
186     else {    /* not supported/enabled */
187       for (i=0;i<CmiNumPes();i++)  bynodes[CmiNodeOf(i)].push_back(i);
188     }
189   }
190
191   void print() {
192     int i;
193     CmiPrintf("Charm++> Cpu topology info:\n");
194     CmiPrintf("PE to node map: ");
195     for (i=0; i<CmiNumPes(); i++)
196       CmiPrintf("%d ", nodeIDs[i]);
197     CmiPrintf("\n");
198     CmiPrintf("Node to PE map:\n");
199     for (i=0; i<numNodes; i++) {
200       CmiPrintf("Chip #%d: ", i);
201       for (int j=0; j<bynodes[i].size(); j++)
202         CmiPrintf("%d ", bynodes[i][j]);
203       CmiPrintf("\n");
204     }
205   }
206
207 };
208
209 int *CpuTopology::nodeIDs = NULL;
210 int CpuTopology::numPes = 0;
211 int CpuTopology::numNodes = 0;
212 CkVec<int> *CpuTopology::bynodes = NULL;
213 int CpuTopology::supported = 0;
214
215 static CpuTopology cpuTopo;
216 static CmiNodeLock topoLock = NULL;
217 static int done = 0;
218
219 /* called on PE 0 */
220 static void cpuTopoHandler(void *m)
221 {
222   static int count = 0;
223   static int nodecount = 0;
224   _procInfo *rec;
225   hostnameMsg *msg = (hostnameMsg *)m;
226   char str[256];
227   int tag, tag1, pe, myrank;
228
229   if (topomsg == NULL) {
230     int i;
231     hostTable = CmmNew();
232     topomsg = (nodeTopoMsg *)CmiAlloc(sizeof(nodeTopoMsg)+CmiNumPes()*sizeof(int));
233     CmiSetHandler((char *)topomsg, cpuTopoRecvHandlerIdx);
234     topomsg->nodes = (int *)((char*)topomsg + sizeof(nodeTopoMsg));
235     for (i=0; i<CmiNumPes(); i++) topomsg->nodes[i] = -1;
236   }
237   CmiAssert(topomsg != NULL);
238
239   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
240   CmiAssert(msg->n == CmiNumPes());
241   for (int i=0; i<msg->n; i++) 
242   {
243     _procInfo *proc = msg->procs+i;
244
245 /*   for debug
246   skt_print_ip(str, msg->ip);
247   printf("hostname: %d %s\n", msg->pe, str);
248 */
249     tag = *(int*)&proc->ip;
250     pe = proc->pe;
251     if ((rec = (_procInfo *)CmmProbe(hostTable, 1, &tag, &tag1)) != NULL) {
252     }
253     else {
254 //    msg->nodeID = nodecount++;
255       proc->nodeID = pe;           // we will compact the node ID later
256       rec = proc;
257       CmmPut(hostTable, 1, &tag, proc);
258     }
259     myrank = rec->rank%rec->ncores;
260     topomsg->nodes[pe] = rec->nodeID;
261     rec->rank ++;
262   }
263
264     // assume all nodes have same number of cores
265   int ncores = CmiNumCores();
266   if (ncores > 1)
267     sprintf(str, "Charm++> Running on %d unique compute nodes (%d-way SMP).\n", CmmEntries(hostTable), ncores);
268   else
269     sprintf(str, "Charm++> Running on %d unique compute nodes.\n", CmmEntries(hostTable));
270   CmiPrintf(str);
271     // clean up CmmTable
272   hostnameMsg *tmpm;
273   tag = CmmWildCard;
274   while (tmpm = (hostnameMsg *)CmmGet(hostTable, 1, &tag, &tag1));
275   CmmFree(hostTable);
276   CmiFree(msg);
277
278   CmiSyncBroadcastAllAndFree(sizeof(nodeTopoMsg)+CmiNumPes()*sizeof(int), (char *)topomsg);
279 }
280
281 /* called on each processor */
282 static void cpuTopoRecvHandler(void *msg)
283 {
284   nodeTopoMsg *m = (nodeTopoMsg *)msg;
285   m->nodes = (int *)((char*)m + sizeof(nodeTopoMsg));
286
287   CmiLock(topoLock);
288   if (cpuTopo.nodeIDs == NULL) {
289     cpuTopo.nodeIDs = m->nodes;
290     cpuTopo.sort();
291   }
292   else
293     CmiFree(m);
294   done++;
295   CmiUnlock(topoLock);
296
297   //if (CmiMyPe() == 0) cpuTopo.print();
298 }
299
300 // reduction function
301 static void * combineMessage(int *size, void *data, void **remote, int count) 
302 {
303   int i, j;
304   int nprocs = ((hostnameMsg *)data)->n;
305   if (count == 0) return data;
306   for (i=0; i<count; i++) nprocs += ((hostnameMsg *)remote[i])->n;
307   *size = sizeof(hostnameMsg)+sizeof(_procInfo)*nprocs;
308   hostnameMsg *msg = (hostnameMsg *)CmiAlloc(*size);
309   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
310   msg->n = nprocs;
311   CmiSetHandler((char *)msg, cpuTopoHandlerIdx);
312
313   int n=0;
314   hostnameMsg *m = (hostnameMsg*)data;
315   m->procs = (_procInfo*)((char*)m + sizeof(hostnameMsg));
316   for (j=0; j<m->n; j++)
317     msg->procs[n++] = m->procs[j];
318   for (i=0; i<count; i++) {
319     m = (hostnameMsg*)remote[i];
320     m->procs = (_procInfo*)((char*)m + sizeof(hostnameMsg));
321     for (j=0; j<m->n; j++)
322       msg->procs[n++] = m->procs[j];
323   }
324   return msg;
325 }
326
327 /******************  API implementation **********************/
328
329 extern "C" int CmiCpuTopologyEnabled()
330 {
331   return CpuTopology::supported;
332 }
333
334 extern "C" int CmiPeOnSamePhysicalNode(int pe1, int pe2)
335 {
336   int *nodeIDs = cpuTopo.nodeIDs;
337   if (!cpuTopo.supported || nodeIDs == NULL) return CmiNodeOf(pe1) == CmiNodeOf(pe2);
338   else return nodeIDs[pe1] == nodeIDs[pe2];
339 }
340
341 // return -1 when not supported
342 extern "C" int CmiNumPhysicalNodes()
343 {
344   if (!cpuTopo.supported) return CmiNumNodes();
345   else return cpuTopo.numUniqNodes();
346 }
347
348 extern "C" int CmiNumPesOnPhysicalNode(int node)
349 {
350   return !cpuTopo.supported?CmiNodeSize(node):(int)cpuTopo.bynodes[node].size();
351 }
352
353 // pelist points to system memory, user should not free it
354 extern "C" void CmiGetPesOnPhysicalNode(int node, int **pelist, int *num)
355 {
356   *num = cpuTopo.bynodes[node].size();
357   if (pelist!=NULL && *num>0) *pelist = cpuTopo.bynodes[node].getVec();
358 }
359
360 extern "C" int CmiPhysicalRank(int pe)
361 {
362   if (!cpuTopo.supported) return CmiRankOf(pe);
363   const CkVec<int> &v = cpuTopo.bynodes[cpuTopo.nodeIDs[pe]];
364   int rank = 0;  
365   int npes = v.size();
366   while (rank < npes && v[rank] < pe) rank++;       // already sorted
367   CmiAssert(v[rank] == pe);
368   return rank;
369 }
370
371 extern "C" int CmiPhysicalNodeID(int pe)
372 {
373   if (!cpuTopo.supported) return CmiNodeOf(pe);
374   return cpuTopo.nodeIDs[pe];
375 }
376
377 // the least number processor on the same physical node
378 extern "C"  int CmiGetFirstPeOnPhysicalNode(int node)
379 {
380   if (!cpuTopo.supported) return CmiNodeFirst(node);
381   return cpuTopo.bynodes[node][0];
382 }
383
384
385 static int _noip = 0;
386
387 extern "C" void CmiInitCPUTopology(char **argv)
388 {
389   static skt_ip_t myip;
390   int ret, i;
391   hostnameMsg  *msg;
392   double startT;
393  
394   if (CmiMyRank() ==0) {
395      topoLock = CmiCreateLock();
396   }
397
398   int obtain_flag = 1;              // default on
399 #if __FAULT_|| CMK_BLUEGENEQ
400   obtain_flag = 0;
401 #endif
402   if(CmiGetArgFlagDesc(argv,"+obtain_cpu_topology",
403                                            "obtain cpu topology info"))
404     obtain_flag = 1;
405   if (CmiGetArgFlagDesc(argv,"+skip_cpu_topology",
406                                "skip the processof getting cpu topology info"))
407     obtain_flag = 0;
408
409 #if CMK_BLUEGENE_CHARM
410   if (BgNodeRank() == 0)
411 #endif
412   {
413   cpuTopoHandlerIdx =
414      CmiRegisterHandler((CmiHandler)cpuTopoHandler);
415   cpuTopoRecvHandlerIdx =
416      CmiRegisterHandler((CmiHandler)cpuTopoRecvHandler);
417   }
418
419   if (!obtain_flag) {
420     if (CmiMyRank() == 0) cpuTopo.sort();
421     CmiNodeAllBarrier();
422     CcdRaiseCondition(CcdTOPOLOGY_AVAIL);      // call callbacks
423     return;
424   }
425
426   if (CmiMyPe() == 0) {
427 #if CMK_BLUEGENE_CHARM
428     if (BgNodeRank() == 0)
429 #endif
430       startT = CmiWallTimer();
431   }
432
433 #if CMK_BLUEGENE_CHARM
434   if (BgNodeRank() == 0)
435   {
436     //int numPes = BgNumNodes()*BgGetNumWorkThread();
437     int numPes = cpuTopo.numPes = CkNumPes();
438     cpuTopo.nodeIDs = new int[numPes];
439     CpuTopology::supported = 1;
440     int wth = BgGetNumWorkThread();
441     for (int i=0; i<numPes; i++) {
442       int nid = i / wth;
443       cpuTopo.nodeIDs[i] = nid;
444     }
445     cpuTopo.sort();
446   }
447   return;
448 #else
449
450 #if CMK_USE_GM
451   CmiBarrier();
452 #endif
453
454
455 #if 0
456   if (gethostname(hostname, 999)!=0) {
457       strcpy(hostname, "");
458   }
459 #endif
460 #if CMK_BLUEGENEL || CMK_BLUEGENEP
461   if (CmiMyRank() == 0) {
462     TopoManager tmgr;
463
464     int numPes = cpuTopo.numPes = CmiNumPes();
465     cpuTopo.nodeIDs = new int[numPes];
466     CpuTopology::supported = 1;
467
468     int x, y, z, t, nid;
469     for(int i=0; i<numPes; i++) {
470       tmgr.rankToCoordinates(i, x, y, z, t);
471       nid = tmgr.coordinatesToRank(x, y, z, 0);
472       cpuTopo.nodeIDs[i] = nid;
473     }
474     cpuTopo.sort();
475     if (CmiMyPe()==0)  CmiPrintf("Charm++> Running on %d unique compute nodes (%d-way SMP).\n", cpuTopo.numNodes, CmiNumCores());
476   }
477   CmiNodeAllBarrier();
478 #elif CMK_CRAYXT
479   if(CmiMyRank() == 0) {
480     int numPes = cpuTopo.numPes = CmiNumPes();
481     int numNodes = CmiNumNodes();
482     cpuTopo.nodeIDs = new int[numPes];
483     CpuTopology::supported = 1;
484
485     int nid;
486     for(int i=0; i<numPes; i++) {
487       nid = getXTNodeID(CmiNodeOf(i), numNodes);
488       cpuTopo.nodeIDs[i] = nid;
489     }
490     int prev = -1;
491     nid = -1;
492
493     // this assumes that all cores on a node have consecutive MPI rank IDs
494     // and then changes nodeIDs to 0 to numNodes-1
495     for(int i=0; i<numPes; i++) {
496       if(cpuTopo.nodeIDs[i] != prev) {
497         prev = cpuTopo.nodeIDs[i];
498         cpuTopo.nodeIDs[i] = ++nid;
499       }
500       else
501         cpuTopo.nodeIDs[i] = nid;
502     }
503     cpuTopo.sort();
504     if (CmiMyPe()==0)  CmiPrintf("Charm++> Running on %d unique compute nodes (%d-way SMP).\n", cpuTopo.numNodes, CmiNumCores());
505   }
506   CmiNodeAllBarrier();
507
508 #else
509
510   if (CmiMyPe() >= CmiNumPes()) {
511     CmiNodeAllBarrier();         // comm thread waiting
512 #if CMK_MACHINE_PROGRESS_DEFINED
513 #if ! CMK_CRAYXT
514     while (done < CmiMyNodeSize()) CmiNetworkProgress();
515 #endif
516 #endif
517     return;    /* comm thread return */
518   }
519
520     /* get my ip address */
521   if (CmiMyRank() == 0)
522   {
523   #if CMK_HAS_GETHOSTNAME
524     myip = skt_my_ip();        /* not thread safe, so only calls on rank 0 */
525     // fprintf(stderr, "[%d] IP is %d.%d.%d.%d\n", CmiMyPe(), myip.data[0],myip.data[1],myip.data[2],myip.data[3]);
526   #elif CMK_BPROC
527     myip = skt_innode_my_ip();
528   #else
529     if (!CmiMyPe())
530     CmiPrintf("CmiInitCPUTopology Warning: Can not get unique name for the compute nodes. \n");
531     _noip = 1; 
532   #endif
533   }
534   cpuTopo.numPes = CmiNumPes();
535
536   CmiNodeAllBarrier();
537   if (_noip) return; 
538
539     /* prepare a msg to send */
540   msg = (hostnameMsg *)CmiAlloc(sizeof(hostnameMsg)+sizeof(_procInfo));
541   msg->n = 1;
542   msg->procs = (_procInfo*)((char*)msg + sizeof(hostnameMsg));
543   CmiSetHandler((char *)msg, cpuTopoHandlerIdx);
544   msg->procs[0].pe = CmiMyPe();
545   msg->procs[0].ip = myip;
546   msg->procs[0].ncores = CmiNumCores();
547   msg->procs[0].rank = 0;
548   msg->procs[0].nodeID = 0;
549   CmiReduce(msg, sizeof(hostnameMsg)+sizeof(_procInfo), combineMessage);
550
551     // blocking here
552   while (done != CmiMyNodeSize())
553     CsdSchedulePoll();
554
555   if (CmiMyPe() == 0) {
556 #if CMK_BLUEGENE_CHARM
557     if (BgNodeRank() == 0)
558 #endif
559       CmiPrintf("Charm++> cpu topology info is gathered in %.3f seconds.\n", CmiWallTimer()-startT);
560   }
561 #endif
562
563 #endif   /* __BLUEGENE__ */
564
565   // now every one should have the node info
566   CcdRaiseCondition(CcdTOPOLOGY_AVAIL);      // call callbacks
567 }
568
569 #else           /* not supporting cpu topology */
570
571
572 extern "C" void CmiInitCPUTopology(char **argv)
573 {
574   /* do nothing */
575   int obtain_flag = CmiGetArgFlagDesc(argv,"+obtain_cpu_topology",
576                                                 "obtain cpu topology info");
577   CmiGetArgFlagDesc(argv,"+skip_cpu_topology",
578                                "skip the processof getting cpu topology info");
579 }
580
581 #endif