src/gromacs/gmxlib/gmx_cpuid.c

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *
   4  * This file is part of GROMACS.
   5  * Copyright (c) 2012-
   6  *
   7  * Written by the Gromacs development team under coordination of
   8  * David van der Spoel, Berk Hess, and Erik Lindahl.
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * To help us fund GROMACS development, we humbly ask that you cite
  16  * the research papers on the package. Check out http://www.gromacs.org
  17  *
  18  * And Hey:
  19  * Gnomes, ROck Monsters And Chili Sauce
  20  */
  21 #ifdef HAVE_CONFIG_H
  22 #include <config.h>
  23 #endif
  24
  25 #ifdef HAVE_SCHED_H
  26 #define _GNU_SOURCE
  27 #include <sched.h>
  28 #endif
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <ctype.h>
  34 #ifdef _MSC_VER
  35 /* MSVC definition for __cpuid() */
  36 #include <intrin.h>
  37 /* sysinfo functions */
  38 #include <windows.h>
  39 #endif
  40 #ifdef HAVE_UNISTD_H
  41 /* sysconf() definition */
  42 #include <unistd.h>
  43 #endif
  44
  45 #include "gmx_cpuid.h"
  46
  47
  48
  49 /* For convenience, and to enable configure-time invocation, we keep all architectures
  50  * in a single file, but to avoid repeated ifdefs we set the overall architecture here.
  51  */
  52 #if defined (__i386__) || defined (__x86_64__) || defined (_M_IX86) || defined (_M_X64)
  53 /* OK, it is x86, but can we execute cpuid? */
  54 #if defined(GMX_X86_GCC_INLINE_ASM) || ( defined(_MSC_VER) && ( (_MSC_VER > 1500) || (_MSC_VER==1500 & _MSC_FULL_VER >= 150030729)))
  55 #    define GMX_CPUID_X86
  56 #endif
  57 #endif
  58
  59 /* Global constant character strings corresponding to our enumerated types */
  60 const char *
  61 gmx_cpuid_vendor_string[GMX_CPUID_NVENDORS] =
  62 {
  63     "CannotDetect",
  64     "Unknown",
  65     "GenuineIntel",
  66     "AuthenticAMD",
  67     "Fujitsu",
  68     "IBM"
  69 };
  70
  71 const char *
  72 gmx_cpuid_feature_string[GMX_CPUID_NFEATURES] =
  73 {
  74     "CannotDetect",
  75     "aes",
  76     "apic",
  77     "avx",
  78     "avx2",
  79     "clfsh",
  80     "cmov",
  81     "cx8",
  82     "cx16",
  83     "f16c",
  84     "fma",
  85     "fma4",
  86     "htt",
  87     "lahf_lm",
  88     "misalignsse",
  89     "mmx",
  90     "msr",
  91     "nonstop_tsc",
  92     "pcid",
  93     "pclmuldq",
  94     "pdcm",
  95     "pdpe1gb",
  96     "popcnt",
  97     "pse",
  98     "rdrnd",
  99     "rdtscp",
 100     "sse2",
 101     "sse3",
 102     "sse4a",
 103     "sse4.1",
 104     "sse4.2",
 105     "ssse3",
 106     "tdt",
 107     "x2apic",
 108     "xop"
 109 };
 110
 111 const char *
 112 gmx_cpuid_acceleration_string[GMX_CPUID_NACCELERATIONS] =
 113 {
 114     "CannotDetect",
 115     "None",
 116     "SSE2",
 117     "SSE4.1",
 118     "AVX_128_FMA",
 119     "AVX_256",
 120     "Sparc64 HPC-ACE"
 121 };
 122
 123 /* Max length of brand string */
 124 #define GMX_CPUID_BRAND_MAXLEN 256
 125
 126
 127 /* Contents of the abstract datatype */
 128 struct gmx_cpuid
 129 {
 130     enum gmx_cpuid_vendor      vendor;
 131     char                       brand[GMX_CPUID_BRAND_MAXLEN];
 132     int                        family;
 133     int                        model;
 134     int                        stepping;
 135     /* Not using gmx_bool here, since this file must be possible to compile without simple.h */
 136     char                       feature[GMX_CPUID_NFEATURES];
 137
 138     /* Basic CPU topology information. For x86 this is a bit complicated since the topology differs between
 139      * operating systems and sometimes even settings. For most other architectures you can likely just check
 140      * the documentation and then write static information to these arrays rather than detecting on-the-fly.
 141      */
 142     int                        have_cpu_topology;
 143     int                        nproc;               /* total number of logical processors from OS */
 144     int                        npackages;
 145     int                        ncores_per_package;
 146     int                        nhwthreads_per_core;
 147     int *                      package_id;
 148     int *                      core_id;             /* Local core id in each package */
 149     int *                      hwthread_id;         /* Local hwthread id in each core */
 150     int *                      locality_order;      /* Processor indices sorted in locality order */
 151 };
 152
 153
 154 /* Simple routines to access the data structure. The initialization routine is
 155  * further down since that needs to call other static routines in this file.
 156  */
 157 enum gmx_cpuid_vendor
 158 gmx_cpuid_vendor            (gmx_cpuid_t                cpuid)
 159 {
 160     return cpuid->vendor;
 161 }
 162
 163
 164 const char *
 165 gmx_cpuid_brand             (gmx_cpuid_t                cpuid)
 166 {
 167     return cpuid->brand;
 168 }
 169
 170 int
 171 gmx_cpuid_family            (gmx_cpuid_t                cpuid)
 172 {
 173     return cpuid->family;
 174 }
 175
 176 int
 177 gmx_cpuid_model             (gmx_cpuid_t                cpuid)
 178 {
 179     return cpuid->model;
 180 }
 181
 182 int
 183 gmx_cpuid_stepping          (gmx_cpuid_t                cpuid)
 184 {
 185     return cpuid->stepping;
 186 }
 187
 188 int
 189 gmx_cpuid_feature           (gmx_cpuid_t                cpuid,
 190                              enum gmx_cpuid_feature     feature)
 191 {
 192     return (cpuid->feature[feature] != 0);
 193 }
 194
 195
 196
 197
 198 /* What type of acceleration was compiled in, if any?
 199  * This is set from Cmake. Note that the SSE2 and SSE4_1 macros are set for
 200  * AVX too, so it is important that they appear last in the list.
 201  */
 202 #ifdef GMX_X86_AVX_256
 203 static const
 204 enum gmx_cpuid_acceleration
 205     compiled_acc = GMX_CPUID_ACCELERATION_X86_AVX_256;
 206 #elif defined GMX_X86_AVX_128_FMA
 207 static const
 208 enum gmx_cpuid_acceleration
 209     compiled_acc = GMX_CPUID_ACCELERATION_X86_AVX_128_FMA;
 210 #elif defined GMX_X86_SSE4_1
 211 static const
 212 enum gmx_cpuid_acceleration
 213     compiled_acc = GMX_CPUID_ACCELERATION_X86_SSE4_1;
 214 #elif defined GMX_X86_SSE2
 215 static const
 216 enum gmx_cpuid_acceleration
 217     compiled_acc = GMX_CPUID_ACCELERATION_X86_SSE2;
 218 #elif defined GMX_CPU_ACCELERATION_SPARC64_HPC_ACE
 219 static const
 220 enum gmx_cpuid_acceleration
 221     compiled_acc = GMX_CPUID_ACCELERATION_SPARC64_HPC_ACE;
 222 #else
 223 static const
 224 enum gmx_cpuid_acceleration
 225     compiled_acc = GMX_CPUID_ACCELERATION_NONE;
 226 #endif
 227
 228
 229 #ifdef GMX_CPUID_X86
 230
 231 /* Execute CPUID on x86 class CPUs. level sets function to exec, and the
 232  * contents of register output is returned. See Intel/AMD docs for details.
 233  *
 234  * This version supports extended information where we can also have an input
 235  * value in the ecx register. This is ignored for most levels, but some of them
 236  * (e.g. level 0xB on Intel) use it.
 237  */
 238 static int
 239 execute_x86cpuid(unsigned int   level,
 240                  unsigned int   ecxval,
 241                  unsigned int * eax,
 242                  unsigned int * ebx,
 243                  unsigned int * ecx,
 244                  unsigned int * edx)
 245 {
 246     int rc = 0;
 247
 248     /* Currently CPUID is only supported (1) if we can use an instruction on MSVC, or (2)
 249      * if the compiler handles GNU-style inline assembly.
 250      */
 251
 252 #if (defined _MSC_VER)
 253     int CPUInfo[4];
 254
 255 #if (_MSC_VER > 1500) || (_MSC_VER == 1500 & _MSC_FULL_VER >= 150030729)
 256     /* MSVC 9.0 SP1 or later */
 257     __cpuidex(CPUInfo, level, ecxval);
 258     rc = 0;
 259 #else
 260     __cpuid(CPUInfo, level);
 261     /* Set an error code if the user wanted a non-zero ecxval, since we did not have cpuidex */
 262     rc = (ecxval > 0) ? -1 : 0;
 263 #endif
 264     *eax = CPUInfo[0];
 265     *ebx = CPUInfo[1];
 266     *ecx = CPUInfo[2];
 267     *edx = CPUInfo[3];
 268
 269 #elif (defined GMX_X86_GCC_INLINE_ASM)
 270     /* for now this means GMX_X86_GCC_INLINE_ASM should be defined,
 271      * but there might be more options added in the future.
 272      */
 273     *eax = level;
 274     *ecx = ecxval;
 275     *ebx = 0;
 276     *edx = 0;
 277 #if defined(__i386__) && defined(__PIC__)
 278     /* Avoid clobbering the global offset table in 32-bit pic code (ebx register) */
 279     __asm__ __volatile__ ("xchgl %%ebx, %1  \n\t"
 280                           "cpuid            \n\t"
 281                           "xchgl %%ebx, %1  \n\t"
 282                           : "+a" (*eax), "+r" (*ebx), "+c" (*ecx), "+d" (*edx));
 283 #else
 284     /* i386 without PIC, or x86-64. Things are easy and we can clobber any reg we want :-) */
 285     __asm__ __volatile__ ("cpuid            \n\t"
 286                           : "+a" (*eax), "+b" (*ebx), "+c" (*ecx), "+d" (*edx));
 287 #endif
 288     rc = 0;
 289 #else
 290     /* Death and horror!
 291      * Apparently this is an x86 platform where we don't know how to call cpuid.
 292      *
 293      * This is REALLY bad, since we will lose all Gromacs acceleration.
 294      */
 295     *eax = 0;
 296     *ebx = 0;
 297     *ecx = 0;
 298     *edx = 0;
 299
 300     rc = -1;
 301 #endif
 302     return rc;
 303 }
 304
 305
 306 /* Identify CPU features common to Intel & AMD - mainly brand string,
 307  * version and some features. Vendor has already been detected outside this.
 308  */
 309 static int
 310 cpuid_check_common_x86(gmx_cpuid_t                cpuid)
 311 {
 312     int                       fn, max_stdfn, max_extfn;
 313     unsigned int              eax, ebx, ecx, edx;
 314     char                      str[GMX_CPUID_BRAND_MAXLEN];
 315     char *                    p;
 316
 317     /* Find largest standard/extended function input value */
 318     execute_x86cpuid(0x0, 0, &eax, &ebx, &ecx, &edx);
 319     max_stdfn = eax;
 320     execute_x86cpuid(0x80000000, 0, &eax, &ebx, &ecx, &edx);
 321     max_extfn = eax;
 322
 323     p = str;
 324     if (max_extfn >= 0x80000005)
 325     {
 326         /* Get CPU brand string */
 327         for (fn = 0x80000002; fn < 0x80000005; fn++)
 328         {
 329             execute_x86cpuid(fn, 0, &eax, &ebx, &ecx, &edx);
 330             memcpy(p, &eax, 4);
 331             memcpy(p+4, &ebx, 4);
 332             memcpy(p+8, &ecx, 4);
 333             memcpy(p+12, &edx, 4);
 334             p += 16;
 335         }
 336         *p = '\0';
 337
 338         /* Remove empty initial space */
 339         p = str;
 340         while (isspace(*(p)))
 341         {
 342             p++;
 343         }
 344         strncpy(cpuid->brand, p, GMX_CPUID_BRAND_MAXLEN);
 345     }
 346     else
 347     {
 348         strncpy(cpuid->brand, "Unknown CPU brand", GMX_CPUID_BRAND_MAXLEN);
 349     }
 350
 351     /* Find basic CPU properties */
 352     if (max_stdfn >= 1)
 353     {
 354         execute_x86cpuid(0x1, 0, &eax, &ebx, &ecx, &edx);
 355
 356         cpuid->family   = ((eax & 0x0FF00000) >> 20) + ((eax & 0x00000F00) >> 8);
 357         /* Note that extended model should be shifted left 4, so only shift right 12 iso 16. */
 358         cpuid->model    = ((eax & 0x000F0000) >> 12) + ((eax & 0x000000F0) >> 4);
 359         cpuid->stepping = (eax & 0x0000000F);
 360
 361         /* Feature flags common to AMD and intel */
 362         cpuid->feature[GMX_CPUID_FEATURE_X86_SSE3]     = (ecx & (1 << 0))  != 0;
 363         cpuid->feature[GMX_CPUID_FEATURE_X86_PCLMULDQ] = (ecx & (1 << 1))  != 0;
 364         cpuid->feature[GMX_CPUID_FEATURE_X86_SSSE3]    = (ecx & (1 << 9))  != 0;
 365         cpuid->feature[GMX_CPUID_FEATURE_X86_FMA]      = (ecx & (1 << 12)) != 0;
 366         cpuid->feature[GMX_CPUID_FEATURE_X86_CX16]     = (ecx & (1 << 13)) != 0;
 367         cpuid->feature[GMX_CPUID_FEATURE_X86_SSE4_1]   = (ecx & (1 << 19)) != 0;
 368         cpuid->feature[GMX_CPUID_FEATURE_X86_SSE4_2]   = (ecx & (1 << 20)) != 0;
 369         cpuid->feature[GMX_CPUID_FEATURE_X86_POPCNT]   = (ecx & (1 << 23)) != 0;
 370         cpuid->feature[GMX_CPUID_FEATURE_X86_AES]      = (ecx & (1 << 25)) != 0;
 371         cpuid->feature[GMX_CPUID_FEATURE_X86_AVX]      = (ecx & (1 << 28)) != 0;
 372         cpuid->feature[GMX_CPUID_FEATURE_X86_F16C]     = (ecx & (1 << 29)) != 0;
 373         cpuid->feature[GMX_CPUID_FEATURE_X86_RDRND]    = (ecx & (1 << 30)) != 0;
 374
 375         cpuid->feature[GMX_CPUID_FEATURE_X86_PSE]      = (edx & (1 << 3))  != 0;
 376         cpuid->feature[GMX_CPUID_FEATURE_X86_MSR]      = (edx & (1 << 5))  != 0;
 377         cpuid->feature[GMX_CPUID_FEATURE_X86_CX8]      = (edx & (1 << 8))  != 0;
 378         cpuid->feature[GMX_CPUID_FEATURE_X86_APIC]     = (edx & (1 << 9))  != 0;
 379         cpuid->feature[GMX_CPUID_FEATURE_X86_CMOV]     = (edx & (1 << 15)) != 0;
 380         cpuid->feature[GMX_CPUID_FEATURE_X86_CLFSH]    = (edx & (1 << 19)) != 0;
 381         cpuid->feature[GMX_CPUID_FEATURE_X86_MMX]      = (edx & (1 << 23)) != 0;
 382         cpuid->feature[GMX_CPUID_FEATURE_X86_SSE2]     = (edx & (1 << 26)) != 0;
 383         cpuid->feature[GMX_CPUID_FEATURE_X86_HTT]      = (edx & (1 << 28)) != 0;
 384     }
 385     else
 386     {
 387         cpuid->family   = -1;
 388         cpuid->model    = -1;
 389         cpuid->stepping = -1;
 390     }
 391
 392     if (max_extfn >= 0x80000001)
 393     {
 394         execute_x86cpuid(0x80000001, 0, &eax, &ebx, &ecx, &edx);
 395         cpuid->feature[GMX_CPUID_FEATURE_X86_LAHF_LM] = (ecx & (1 << 0))  != 0;
 396         cpuid->feature[GMX_CPUID_FEATURE_X86_PDPE1GB] = (edx & (1 << 26)) != 0;
 397         cpuid->feature[GMX_CPUID_FEATURE_X86_RDTSCP]  = (edx & (1 << 27)) != 0;
 398     }
 399
 400     if (max_extfn >= 0x80000007)
 401     {
 402         execute_x86cpuid(0x80000007, 0, &eax, &ebx, &ecx, &edx);
 403         cpuid->feature[GMX_CPUID_FEATURE_X86_NONSTOP_TSC]  = (edx & (1 << 8))  != 0;
 404     }
 405     return 0;
 406 }
 407
 408 /* This routine returns the number of unique different elements found in the array,
 409  * and renumbers these starting from 0. For example, the array {0,1,2,8,9,10,8,9,10,0,1,2}
 410  * will be rewritten to {0,1,2,3,4,5,3,4,5,0,1,2}, and it returns 6 for the
 411  * number of unique elements.
 412  */
 413 static int
 414 cpuid_renumber_elements(int *data, int n)
 415 {
 416     int *unique;
 417     int  i, j, nunique, found;
 418
 419     unique = malloc(sizeof(int)*n);
 420
 421     nunique = 0;
 422     for (i = 0; i < n; i++)
 423     {
 424         for (j = 0, found = 0; j < nunique && !found; j++)
 425         {
 426             found = (data[i] == unique[j]);
 427         }
 428         if (!found)
 429         {
 430             /* Insert in sorted order! */
 431             for (j = nunique++; j > 0 && unique[j-1] > data[i]; j--)
 432             {
 433                 unique[j] = unique[j-1];
 434             }
 435             unique[j] = data[i];
 436         }
 437     }
 438     /* renumber */
 439     for (i = 0; i < n; i++)
 440     {
 441         for (j = 0; j < nunique; j++)
 442         {
 443             if (data[i] == unique[j])
 444             {
 445                 data[i] = j;
 446             }
 447         }
 448     }
 449     return nunique;
 450 }
 451
 452 /* APIC IDs, or everything you wanted to know about your x86 cores but were afraid to ask...
 453  *
 454  * Raw APIC IDs are unfortunately somewhat dirty. For technical reasons they are assigned
 455  * in power-of-2 chunks, and even then there are no guarantees about specific numbers - all
 456  * we know is that the part for each thread/core/package is unique, and how many bits are
 457  * reserved for that part.
 458  * This routine does internal renumbering so we get continuous indices, and also
 459  * decodes the actual number of packages,cores-per-package and hwthreads-per-core.
 460  */
 461 static void
 462 cpuid_x86_decode_apic_id(gmx_cpuid_t cpuid, int *apic_id, int core_bits, int hwthread_bits)
 463 {
 464     int i, idx;
 465     int hwthread_mask, core_mask_after_shift;
 466
 467     cpuid->hwthread_id     = malloc(sizeof(int)*cpuid->nproc);
 468     cpuid->core_id         = malloc(sizeof(int)*cpuid->nproc);
 469     cpuid->package_id      = malloc(sizeof(int)*cpuid->nproc);
 470     cpuid->locality_order  = malloc(sizeof(int)*cpuid->nproc);
 471
 472     hwthread_mask         = (1 << hwthread_bits) - 1;
 473     core_mask_after_shift = (1 << core_bits) - 1;
 474
 475     for (i = 0; i < cpuid->nproc; i++)
 476     {
 477         cpuid->hwthread_id[i] = apic_id[i] & hwthread_mask;
 478         cpuid->core_id[i]     = (apic_id[i] >> hwthread_bits) & core_mask_after_shift;
 479         cpuid->package_id[i]  = apic_id[i] >> (core_bits + hwthread_bits);
 480     }
 481
 482     cpuid->npackages            = cpuid_renumber_elements(cpuid->package_id, cpuid->nproc);
 483     cpuid->ncores_per_package   = cpuid_renumber_elements(cpuid->core_id, cpuid->nproc);
 484     cpuid->nhwthreads_per_core  = cpuid_renumber_elements(cpuid->hwthread_id, cpuid->nproc);
 485
 486     /* Create a locality order array, i.e. first all resources in package0, which in turn
 487      * are sorted so we first have all resources in core0, where threads are sorted in order, etc.
 488      */
 489     for (i = 0; i < cpuid->nproc; i++)
 490     {
 491         idx = (cpuid->package_id[i]*cpuid->ncores_per_package + cpuid->core_id[i])*cpuid->nhwthreads_per_core + cpuid->hwthread_id[i];
 492         cpuid->locality_order[idx] = i;
 493     }
 494 }
 495
 496
 497 /* Detection of AMD-specific CPU features */
 498 static int
 499 cpuid_check_amd_x86(gmx_cpuid_t                cpuid)
 500 {
 501     int                       max_stdfn, max_extfn;
 502     unsigned int              eax, ebx, ecx, edx;
 503     int                       hwthread_bits, core_bits;
 504     int *                     apic_id;
 505
 506     cpuid_check_common_x86(cpuid);
 507
 508     execute_x86cpuid(0x0, 0, &eax, &ebx, &ecx, &edx);
 509     max_stdfn = eax;
 510
 511     execute_x86cpuid(0x80000000, 0, &eax, &ebx, &ecx, &edx);
 512     max_extfn = eax;
 513
 514     if (max_extfn >= 0x80000001)
 515     {
 516         execute_x86cpuid(0x80000001, 0, &eax, &ebx, &ecx, &edx);
 517
 518         cpuid->feature[GMX_CPUID_FEATURE_X86_SSE4A]       = (ecx & (1 << 6))  != 0;
 519         cpuid->feature[GMX_CPUID_FEATURE_X86_MISALIGNSSE] = (ecx & (1 << 7))  != 0;
 520         cpuid->feature[GMX_CPUID_FEATURE_X86_XOP]         = (ecx & (1 << 11)) != 0;
 521         cpuid->feature[GMX_CPUID_FEATURE_X86_FMA4]        = (ecx & (1 << 16)) != 0;
 522     }
 523
 524     /* Query APIC information on AMD */
 525     if (max_extfn >= 0x80000008)
 526     {
 527 #if (defined HAVE_SCHED_H && defined HAVE_SCHED_SETAFFINITY && defined HAVE_SYSCONF && defined __linux__)
 528         /* Linux */
 529         unsigned int   i;
 530         cpu_set_t      cpuset, save_cpuset;
 531         cpuid->nproc = sysconf(_SC_NPROCESSORS_ONLN);
 532         apic_id      = malloc(sizeof(int)*cpuid->nproc);
 533         sched_getaffinity(0, sizeof(cpu_set_t), &save_cpuset);
 534         /* Get APIC id from each core */
 535         CPU_ZERO(&cpuset);
 536         for (i = 0; i < cpuid->nproc; i++)
 537         {
 538             CPU_SET(i, &cpuset);
 539             sched_setaffinity(0, sizeof(cpu_set_t), &cpuset);
 540             execute_x86cpuid(0x1, 0, &eax, &ebx, &ecx, &edx);
 541             apic_id[i] = ebx >> 24;
 542             CPU_CLR(i, &cpuset);
 543         }
 544         /* Reset affinity to the value it had when calling this routine */
 545         sched_setaffinity(0, sizeof(cpu_set_t), &save_cpuset);
 546 #define CPUID_HAVE_APIC
 547 #elif defined GMX_NATIVE_WINDOWS
 548         /* Windows */
 549         DWORD_PTR     i;
 550         SYSTEM_INFO   sysinfo;
 551         unsigned int  save_affinity, affinity;
 552         GetSystemInfo( &sysinfo );
 553         cpuid->nproc  = sysinfo.dwNumberOfProcessors;
 554         apic_id       = malloc(sizeof(int)*cpuid->nproc);
 555         /* Get previous affinity mask */
 556         save_affinity = SetThreadAffinityMask(GetCurrentThread(), 1);
 557         for (i = 0; i < cpuid->nproc; i++)
 558         {
 559             SetThreadAffinityMask(GetCurrentThread(), (((DWORD_PTR)1)<<i));
 560             Sleep(0);
 561             execute_x86cpuid(0x1, 0, &eax, &ebx, &ecx, &edx);
 562             apic_id[i] = ebx >> 24;
 563         }
 564         SetThreadAffinityMask(GetCurrentThread(), save_affinity);
 565 #define CPUID_HAVE_APIC
 566 #endif
 567 #ifdef CPUID_HAVE_APIC
 568         /* AMD does not support SMT yet - there are no hwthread bits in apic ID */
 569         hwthread_bits = 0;
 570         /* Get number of core bits in apic ID - try modern extended method first */
 571         execute_x86cpuid(0x80000008, 0, &eax, &ebx, &ecx, &edx);
 572         core_bits = (ecx >> 12) & 0xf;
 573         if (core_bits == 0)
 574         {
 575             /* Legacy method for old single/dual core AMD CPUs */
 576             int i = ecx & 0xF;
 577             for (core_bits = 0; (i>>core_bits) > 0; core_bits++)
 578             {
 579                 ;
 580             }
 581         }
 582         cpuid_x86_decode_apic_id(cpuid, apic_id, core_bits, hwthread_bits);
 583         cpuid->have_cpu_topology = 1;
 584 #endif
 585     }
 586     return 0;
 587 }
 588
 589 /* Detection of Intel-specific CPU features */
 590 static int
 591 cpuid_check_intel_x86(gmx_cpuid_t                cpuid)
 592 {
 593     unsigned int              max_stdfn, max_extfn;
 594     unsigned int              eax, ebx, ecx, edx;
 595     unsigned int              max_logical_cores, max_physical_cores;
 596     int                       hwthread_bits, core_bits;
 597     int *                     apic_id;
 598
 599     cpuid_check_common_x86(cpuid);
 600
 601     execute_x86cpuid(0x0, 0, &eax, &ebx, &ecx, &edx);
 602     max_stdfn = eax;
 603
 604     execute_x86cpuid(0x80000000, 0, &eax, &ebx, &ecx, &edx);
 605     max_extfn = eax;
 606
 607     if (max_stdfn >= 1)
 608     {
 609         execute_x86cpuid(0x1, 0, &eax, &ebx, &ecx, &edx);
 610         cpuid->feature[GMX_CPUID_FEATURE_X86_PDCM]    = (ecx & (1 << 15)) != 0;
 611         cpuid->feature[GMX_CPUID_FEATURE_X86_PCID]    = (ecx & (1 << 17)) != 0;
 612         cpuid->feature[GMX_CPUID_FEATURE_X86_X2APIC]  = (ecx & (1 << 21)) != 0;
 613         cpuid->feature[GMX_CPUID_FEATURE_X86_TDT]     = (ecx & (1 << 24)) != 0;
 614     }
 615
 616     if (max_stdfn >= 7)
 617     {
 618         execute_x86cpuid(0x7, 0, &eax, &ebx, &ecx, &edx);
 619         cpuid->feature[GMX_CPUID_FEATURE_X86_AVX2]    = (ebx & (1 << 5))  != 0;
 620     }
 621
 622     /* Check whether Hyper-Threading is enabled, not only supported */
 623     if (cpuid->feature[GMX_CPUID_FEATURE_X86_HTT] && max_stdfn >= 4)
 624     {
 625         execute_x86cpuid(0x1, 0, &eax, &ebx, &ecx, &edx);
 626         max_logical_cores  = (ebx >> 16) & 0x0FF;
 627         execute_x86cpuid(0x4, 0, &eax, &ebx, &ecx, &edx);
 628         max_physical_cores = ((eax >> 26) & 0x3F) + 1;
 629
 630         /* Clear HTT flag if we only have 1 logical core per physical */
 631         if (max_logical_cores/max_physical_cores < 2)
 632         {
 633             cpuid->feature[GMX_CPUID_FEATURE_X86_HTT] = 0;
 634         }
 635     }
 636
 637     if (max_stdfn >= 0xB)
 638     {
 639         /* Query x2 APIC information from cores */
 640 #if (defined HAVE_SCHED_H && defined HAVE_SCHED_SETAFFINITY && defined HAVE_SYSCONF && defined __linux__)
 641         /* Linux */
 642         unsigned int   i;
 643         cpu_set_t      cpuset, save_cpuset;
 644         cpuid->nproc = sysconf(_SC_NPROCESSORS_ONLN);
 645         apic_id      = malloc(sizeof(int)*cpuid->nproc);
 646         sched_getaffinity(0, sizeof(cpu_set_t), &save_cpuset);
 647         /* Get x2APIC ID from each hardware thread */
 648         CPU_ZERO(&cpuset);
 649         for (i = 0; i < cpuid->nproc; i++)
 650         {
 651             CPU_SET(i, &cpuset);
 652             sched_setaffinity(0, sizeof(cpu_set_t), &cpuset);
 653             execute_x86cpuid(0xB, 0, &eax, &ebx, &ecx, &edx);
 654             apic_id[i] = edx;
 655             CPU_CLR(i, &cpuset);
 656         }
 657         /* Reset affinity to the value it had when calling this routine */
 658         sched_setaffinity(0, sizeof(cpu_set_t), &save_cpuset);
 659 #define CPUID_HAVE_APIC
 660 #elif defined GMX_NATIVE_WINDOWS
 661         /* Windows */
 662         DWORD_PTR     i;
 663         SYSTEM_INFO   sysinfo;
 664         unsigned int  save_affinity, affinity;
 665         GetSystemInfo( &sysinfo );
 666         cpuid->nproc  = sysinfo.dwNumberOfProcessors;
 667         apic_id       = malloc(sizeof(int)*cpuid->nproc);
 668         /* Get previous affinity mask */
 669         save_affinity = SetThreadAffinityMask(GetCurrentThread(), 1);
 670         for (i = 0; i < cpuid->nproc; i++)
 671         {
 672             SetThreadAffinityMask(GetCurrentThread(), (((DWORD_PTR)1)<<i));
 673             Sleep(0);
 674             execute_x86cpuid(0xB, 0, &eax, &ebx, &ecx, &edx);
 675             apic_id[i] = edx;
 676         }
 677         SetThreadAffinityMask(GetCurrentThread(), save_affinity);
 678 #define CPUID_HAVE_APIC
 679 #endif
 680 #ifdef CPUID_HAVE_APIC
 681         execute_x86cpuid(0xB, 0, &eax, &ebx, &ecx, &edx);
 682         hwthread_bits    = eax & 0x1F;
 683         execute_x86cpuid(0xB, 1, &eax, &ebx, &ecx, &edx);
 684         core_bits        = (eax & 0x1F) - hwthread_bits;
 685         cpuid_x86_decode_apic_id(cpuid, apic_id, core_bits, hwthread_bits);
 686         cpuid->have_cpu_topology = 1;
 687 #endif
 688     }
 689     return 0;
 690 }
 691 #endif /* GMX_CPUID_X86 */
 692
 693
 694
 695
 696 static void
 697 chomp_substring_before_colon(const char *in, char *s, int maxlength)
 698 {
 699     char *p;
 700     strncpy(s,in,maxlength);
 701     p = strchr(s,':');
 702     if(p!=NULL)
 703     {
 704         *p='\0';
 705         while(isspace(*(--p)) && (p>=s))
 706         {
 707             *p='\0';
 708         }
 709     }
 710     else
 711     {
 712         *s='\0';
 713     }
 714 }
 715
 716 static void
 717 chomp_substring_after_colon(const char *in, char *s, int maxlength)
 718 {
 719     char *p;
 720     if( (p = strchr(in,':'))!=NULL)
 721     {
 722         p++;
 723         while(isspace(*p)) p++;
 724         strncpy(s,p,maxlength);
 725         p = s+strlen(s);
 726         while(isspace(*(--p)) && (p>=s))
 727         {
 728             *p='\0';
 729         }
 730     }
 731     else
 732     {
 733         *s='\0';
 734     }
 735 }
 736
 737 /* Try to find the vendor of the current CPU, so we know what specific
 738  * detection routine to call.
 739  */
 740 static enum gmx_cpuid_vendor
 741 cpuid_check_vendor(void)
 742 {
 743     enum gmx_cpuid_vendor      i, vendor;
 744     /* Register data used on x86 */
 745     unsigned int               eax, ebx, ecx, edx;
 746     char                       vendorstring[13];
 747     FILE *                     fp;
 748     char                       buffer[255],buffer2[255];
 749
 750     /* Set default first */
 751     vendor = GMX_CPUID_VENDOR_UNKNOWN;
 752
 753 #ifdef GMX_CPUID_X86
 754     execute_x86cpuid(0x0, 0, &eax, &ebx, &ecx, &edx);
 755
 756     memcpy(vendorstring, &ebx, 4);
 757     memcpy(vendorstring+4, &edx, 4);
 758     memcpy(vendorstring+8, &ecx, 4);
 759
 760     vendorstring[12] = '\0';
 761
 762     for (i = GMX_CPUID_VENDOR_UNKNOWN; i < GMX_CPUID_NVENDORS; i++)
 763     {
 764         if (!strncmp(vendorstring, gmx_cpuid_vendor_string[i], 12))
 765         {
 766             vendor = i;
 767         }
 768     }
 769 #elif defined(__linux__) || defined(__linux)
 770     /* General Linux. Try to get CPU vendor from /proc/cpuinfo */
 771     if( (fp = fopen("/proc/cpuinfo","r")) != NULL)
 772     {
 773         while( (vendor == GMX_CPUID_VENDOR_UNKNOWN) && (fgets(buffer,sizeof(buffer),fp) != NULL))
 774         {
 775             chomp_substring_before_colon(buffer,buffer2,sizeof(buffer2));
 776             /* Intel/AMD use "vendor_id", IBM "vendor". Fujitsu "manufacture". Add others if you have them! */
 777             if( !strcmp(buffer2,"vendor_id") || !strcmp(buffer2,"vendor") || !strcmp(buffer2,"manufacture") )
 778             {
 779                 chomp_substring_after_colon(buffer,buffer2,sizeof(buffer2));
 780                 for(i=GMX_CPUID_VENDOR_UNKNOWN; i<GMX_CPUID_NVENDORS; i++)
 781                 {
 782                     /* Be liberal and accept if we find the vendor anywhere in string */
 783                     if(strstr(buffer2,gmx_cpuid_vendor_string[i]))
 784                     {
 785                         vendor = i;
 786                     }
 787                 }
 788             }
 789         }
 790     }
 791     fclose(fp);
 792 #else
 793     vendor = GMX_CPUID_VENDOR_UNKNOWN;
 794 #endif
 795
 796     return vendor;
 797 }
 798
 799
 800
 801 int
 802 gmx_cpuid_topology(gmx_cpuid_t        cpuid,
 803                    int *              nprocessors,
 804                    int *              npackages,
 805                    int *              ncores_per_package,
 806                    int *              nhwthreads_per_core,
 807                    const int **       package_id,
 808                    const int **       core_id,
 809                    const int **       hwthread_id,
 810                    const int **       locality_order)
 811 {
 812     int rc;
 813
 814     if (cpuid->have_cpu_topology)
 815     {
 816         *nprocessors          = cpuid->nproc;
 817         *npackages            = cpuid->npackages;
 818         *ncores_per_package   = cpuid->ncores_per_package;
 819         *nhwthreads_per_core  = cpuid->nhwthreads_per_core;
 820         *package_id           = cpuid->package_id;
 821         *core_id              = cpuid->core_id;
 822         *hwthread_id          = cpuid->hwthread_id;
 823         *locality_order       = cpuid->locality_order;
 824         rc                    = 0;
 825     }
 826     else
 827     {
 828         rc = -1;
 829     }
 830     return rc;
 831 }
 832
 833
 834 enum gmx_cpuid_x86_smt
 835 gmx_cpuid_x86_smt(gmx_cpuid_t cpuid)
 836 {
 837     enum gmx_cpuid_x86_smt rc;
 838
 839     if (cpuid->have_cpu_topology)
 840     {
 841         rc = (cpuid->nhwthreads_per_core > 1) ? GMX_CPUID_X86_SMT_ENABLED : GMX_CPUID_X86_SMT_DISABLED;
 842     }
 843     else if (cpuid->vendor == GMX_CPUID_VENDOR_AMD || gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_HTT) == 0)
 844     {
 845         rc = GMX_CPUID_X86_SMT_DISABLED;
 846     }
 847     else
 848     {
 849         rc = GMX_CPUID_X86_SMT_CANNOTDETECT;
 850     }
 851     return rc;
 852 }
 853
 854
 855 int
 856 gmx_cpuid_init               (gmx_cpuid_t *              pcpuid)
 857 {
 858     gmx_cpuid_t cpuid;
 859     int         i;
 860     FILE *      fp;
 861     char        buffer[255],buffer2[255];
 862     int         found_brand;
 863
 864     cpuid = malloc(sizeof(*cpuid));
 865
 866     *pcpuid = cpuid;
 867
 868     for (i = 0; i < GMX_CPUID_NFEATURES; i++)
 869     {
 870         cpuid->feature[i] = 0;
 871     }
 872
 873     cpuid->have_cpu_topology   = 0;
 874     cpuid->nproc               = 0;
 875     cpuid->npackages           = 0;
 876     cpuid->ncores_per_package  = 0;
 877     cpuid->nhwthreads_per_core = 0;
 878     cpuid->package_id          = NULL;
 879     cpuid->core_id             = NULL;
 880     cpuid->hwthread_id         = NULL;
 881     cpuid->locality_order      = NULL;
 882
 883     cpuid->vendor = cpuid_check_vendor();
 884
 885     switch (cpuid->vendor)
 886     {
 887 #ifdef GMX_CPUID_X86
 888         case GMX_CPUID_VENDOR_INTEL:
 889             cpuid_check_intel_x86(cpuid);
 890             break;
 891         case GMX_CPUID_VENDOR_AMD:
 892             cpuid_check_amd_x86(cpuid);
 893             break;
 894 #endif
 895         default:
 896             /* Default value */
 897             strncpy(cpuid->brand,"Unknown CPU brand",GMX_CPUID_BRAND_MAXLEN);
 898 #if defined(__linux__) || defined(__linux)
 899             /* General Linux. Try to get CPU type from /proc/cpuinfo */
 900             if( (fp = fopen("/proc/cpuinfo","r")) != NULL)
 901             {
 902                 found_brand = 0;
 903                 while( (found_brand==0) && (fgets(buffer,sizeof(buffer),fp) !=NULL))
 904                 {
 905                     chomp_substring_before_colon(buffer,buffer2,sizeof(buffer2));
 906                     /* Intel uses "model name", Fujitsu and IBM "cpu". */
 907                     if( !strcmp(buffer2,"model name") || !strcmp(buffer2,"cpu"))
 908                     {
 909                         chomp_substring_after_colon(buffer,cpuid->brand,GMX_CPUID_BRAND_MAXLEN);
 910                         found_brand = 1;
 911                     }
 912                 }
 913             }
 914             fclose(fp);
 915 #endif
 916             cpuid->family         = 0;
 917             cpuid->model          = 0;
 918             cpuid->stepping       = 0;
 919
 920             for(i=0; i<GMX_CPUID_NFEATURES; i++)
 921             {
 922                 cpuid->feature[i]=0;
 923             }
 924             cpuid->feature[GMX_CPUID_FEATURE_CANNOTDETECT] = 1;
 925             break;
 926     }
 927     return 0;
 928 }
 929
 930
 931
 932 void
 933 gmx_cpuid_done               (gmx_cpuid_t              cpuid)
 934 {
 935     free(cpuid);
 936 }
 937
 938
 939 int
 940 gmx_cpuid_formatstring       (gmx_cpuid_t              cpuid,
 941                               char *                   str,
 942                               int                      n)
 943 {
 944     int                     c;
 945     int                     i;
 946     enum gmx_cpuid_feature  feature;
 947
 948 #ifdef _MSC_VER
 949     _snprintf(str, n,
 950               "Vendor: %s\n"
 951               "Brand:  %s\n"
 952               "Family: %2d  Model: %2d  Stepping: %2d\n"
 953               "Features:",
 954               gmx_cpuid_vendor_string[gmx_cpuid_vendor(cpuid)],
 955               gmx_cpuid_brand(cpuid),
 956               gmx_cpuid_family(cpuid), gmx_cpuid_model(cpuid), gmx_cpuid_stepping(cpuid));
 957 #else
 958     snprintf(str, n,
 959              "Vendor: %s\n"
 960              "Brand:  %s\n"
 961              "Family: %2d  Model: %2d  Stepping: %2d\n"
 962              "Features:",
 963              gmx_cpuid_vendor_string[gmx_cpuid_vendor(cpuid)],
 964              gmx_cpuid_brand(cpuid),
 965              gmx_cpuid_family(cpuid), gmx_cpuid_model(cpuid), gmx_cpuid_stepping(cpuid));
 966 #endif
 967
 968     str[n-1] = '\0';
 969     c        = strlen(str);
 970     n       -= c;
 971     str     += c;
 972
 973     for (feature = GMX_CPUID_FEATURE_CANNOTDETECT; feature < GMX_CPUID_NFEATURES; feature++)
 974     {
 975         if (gmx_cpuid_feature(cpuid, feature) == 1)
 976         {
 977 #ifdef _MSC_VER
 978             _snprintf(str, n, " %s", gmx_cpuid_feature_string[feature]);
 979 #else
 980             snprintf(str, n, " %s", gmx_cpuid_feature_string[feature]);
 981 #endif
 982             str[n-1] = '\0';
 983             c        = strlen(str);
 984             n       -= c;
 985             str     += c;
 986         }
 987     }
 988 #ifdef _MSC_VER
 989     _snprintf(str, n, "\n");
 990 #else
 991     snprintf(str, n, "\n");
 992 #endif
 993     str[n-1] = '\0';
 994
 995     return 0;
 996 }
 997
 998
 999
1000 enum gmx_cpuid_acceleration
1001 gmx_cpuid_acceleration_suggest  (gmx_cpuid_t                 cpuid)
1002 {
1003     enum gmx_cpuid_acceleration  tmpacc;
1004
1005     tmpacc = GMX_CPUID_ACCELERATION_NONE;
1006
1007     if (gmx_cpuid_vendor(cpuid) == GMX_CPUID_VENDOR_INTEL)
1008     {
1009         if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_AVX))
1010         {
1011             tmpacc = GMX_CPUID_ACCELERATION_X86_AVX_256;
1012         }
1013         else if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_SSE4_1))
1014         {
1015             tmpacc = GMX_CPUID_ACCELERATION_X86_SSE4_1;
1016         }
1017         else if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_SSE2))
1018         {
1019             tmpacc = GMX_CPUID_ACCELERATION_X86_SSE2;
1020         }
1021     }
1022     else if (gmx_cpuid_vendor(cpuid) == GMX_CPUID_VENDOR_AMD)
1023     {
1024         if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_AVX))
1025         {
1026             tmpacc = GMX_CPUID_ACCELERATION_X86_AVX_128_FMA;
1027         }
1028         else if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_SSE4_1))
1029         {
1030             tmpacc = GMX_CPUID_ACCELERATION_X86_SSE4_1;
1031         }
1032         else if (gmx_cpuid_feature(cpuid, GMX_CPUID_FEATURE_X86_SSE2))
1033         {
1034             tmpacc = GMX_CPUID_ACCELERATION_X86_SSE2;
1035         }
1036     }
1037     else if(gmx_cpuid_vendor(cpuid)==GMX_CPUID_VENDOR_FUJITSU)
1038     {
1039         if(strstr(gmx_cpuid_brand(cpuid),"SPARC64"))
1040         {
1041             tmpacc = GMX_CPUID_ACCELERATION_SPARC64_HPC_ACE;
1042         }
1043     }
1044     return tmpacc;
1045 }
1046
1047
1048
1049 int
1050 gmx_cpuid_acceleration_check(gmx_cpuid_t   cpuid,
1051                              FILE *        log)
1052 {
1053     int                           rc;
1054     char                          str[1024];
1055     enum gmx_cpuid_acceleration   acc;
1056
1057     acc = gmx_cpuid_acceleration_suggest(cpuid);
1058
1059     rc = (acc != compiled_acc);
1060
1061     gmx_cpuid_formatstring(cpuid, str, 1023);
1062     str[1023] = '\0';
1063
1064     if (log != NULL)
1065     {
1066         fprintf(log,
1067                 "\nDetecting CPU-specific acceleration.\nPresent hardware specification:\n"
1068                 "%s"
1069                 "Acceleration most likely to fit this hardware: %s\n"
1070                 "Acceleration selected at GROMACS compile time: %s\n\n",
1071                 str,
1072                 gmx_cpuid_acceleration_string[acc],
1073                 gmx_cpuid_acceleration_string[compiled_acc]);
1074     }
1075
1076     if (rc != 0)
1077     {
1078         if (log != NULL)
1079         {
1080             fprintf(log, "\nBinary not matching hardware - you might be losing performance.\n"
1081                     "Acceleration most likely to fit this hardware: %s\n"
1082                     "Acceleration selected at GROMACS compile time: %s\n\n",
1083                     gmx_cpuid_acceleration_string[acc],
1084                     gmx_cpuid_acceleration_string[compiled_acc]);
1085         }
1086         printf("Compiled acceleration: %s (Gromacs could use %s on this machine, which is better)\n",
1087                gmx_cpuid_acceleration_string[compiled_acc],
1088                gmx_cpuid_acceleration_string[acc]);
1089     }
1090     return rc;
1091 }
1092
1093
1094 #ifdef GMX_CPUID_STANDALONE
1095 /* Stand-alone program to enable queries of CPU features from Cmake.
1096  * Note that you need to check inline ASM capabilities before compiling and set
1097  * -DGMX_X86_GCC_INLINE_ASM for the cpuid instruction to work...
1098  */
1099 int
1100 main(int argc, char **argv)
1101 {
1102     gmx_cpuid_t                   cpuid;
1103     enum gmx_cpuid_acceleration   acc;
1104     int                           i, cnt;
1105
1106     if (argc < 2)
1107     {
1108         fprintf(stdout,
1109                 "Usage:\n\n%s [flags]\n\n"
1110                 "Available flags:\n"
1111                 "-vendor        Print CPU vendor.\n"
1112                 "-brand         Print CPU brand string.\n"
1113                 "-family        Print CPU family version.\n"
1114                 "-model         Print CPU model version.\n"
1115                 "-stepping      Print CPU stepping version.\n"
1116                 "-features      Print CPU feature flags.\n"
1117                 "-acceleration  Print suggested GROMACS acceleration.\n",
1118                 argv[0]);
1119         exit(0);
1120     }
1121
1122     gmx_cpuid_init(&cpuid);
1123
1124     if (!strncmp(argv[1], "-vendor", 3))
1125     {
1126         printf("%s\n", gmx_cpuid_vendor_string[cpuid->vendor]);
1127     }
1128     else if (!strncmp(argv[1], "-brand", 3))
1129     {
1130         printf("%s\n", cpuid->brand);
1131     }
1132     else if (!strncmp(argv[1], "-family", 3))
1133     {
1134         printf("%d\n", cpuid->family);
1135     }
1136     else if (!strncmp(argv[1], "-model", 3))
1137     {
1138         printf("%d\n", cpuid->model);
1139     }
1140     else if (!strncmp(argv[1], "-stepping", 3))
1141     {
1142         printf("%d\n", cpuid->stepping);
1143     }
1144     else if (!strncmp(argv[1], "-features", 3))
1145     {
1146         cnt = 0;
1147         for (i = 0; i < GMX_CPUID_NFEATURES; i++)
1148         {
1149             if (cpuid->feature[i] == 1)
1150             {
1151                 if (cnt++ > 0)
1152                 {
1153                     printf(" ");
1154                 }
1155                 printf("%s", gmx_cpuid_feature_string[i]);
1156             }
1157         }
1158         printf("\n");
1159     }
1160     else if (!strncmp(argv[1], "-acceleration", 3))
1161     {
1162         acc = gmx_cpuid_acceleration_suggest(cpuid);
1163         fprintf(stdout, "%s\n", gmx_cpuid_acceleration_string[acc]);
1164     }
1165
1166     gmx_cpuid_done(cpuid);
1167
1168
1169     return 0;
1170 }
1171
1172 #endif