src/gromacs/legacyheaders/gmx_cpuid.h

   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 #ifndef GMX_CPUID_H_
  22 #define GMX_CPUID_H_
  23
  24 #include <stdio.h>
  25
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30 #if 0
  31 } /* fixes auto-indentation problems */
  32 #endif
  33
  34
  35 /* Currently identifiable CPU Vendors */
  36 enum gmx_cpuid_vendor
  37 {
  38     GMX_CPUID_VENDOR_CANNOTDETECT,   /* Should only be used if something fails */
  39     GMX_CPUID_VENDOR_UNKNOWN,
  40     GMX_CPUID_VENDOR_INTEL,
  41     GMX_CPUID_VENDOR_AMD,
  42     GMX_CPUID_NVENDORS
  43 };
  44
  45
  46 /* CPU feature/property list, to be used as indices into the feature array of the
  47  * gmxcpuid_t data structure.
  48  *
  49  * To facilitate looking things up, we keep this list alphabetical.
  50  * The list is NOT exhaustive - we have basically added stuff that might be
  51  * useful in an application like Gromacs.
  52  *
  53  * AMD and Intel tend to share most architectural elements, and even if the
  54  * flags might have to be detected in different ways (different cpuid registers),
  55  * once the flag is present the functions should be identical. Unfortunately the
  56  * trend right now (2012) seems to be that they are diverging. This means that
  57  * we need to use specific flags to the compiler to maximize performance, and
  58  * then the binaries might not be portable between Intel and AMD as they were
  59  * before when we only needed to check for SSE and/or SSE2 support in Gromacs.
  60  */
  61 enum gmx_cpuid_feature
  62 {
  63     GMX_CPUID_FEATURE_CANNOTDETECT,      /* Flag set if we could not detect on this CPU  */
  64     GMX_CPUID_FEATURE_X86_AES,           /* x86 advanced encryption standard accel.      */
  65     GMX_CPUID_FEATURE_X86_APIC,          /* APIC support                                 */
  66     GMX_CPUID_FEATURE_X86_AVX,           /* Advanced vector extensions                   */
  67     GMX_CPUID_FEATURE_X86_AVX2,          /* AVX2 including gather support (not used yet) */
  68     GMX_CPUID_FEATURE_X86_CLFSH,         /* Supports CLFLUSH instruction                 */
  69     GMX_CPUID_FEATURE_X86_CMOV,          /* Conditional move insn support                */
  70     GMX_CPUID_FEATURE_X86_CX8,           /* Supports CMPXCHG8B (8-byte compare-exchange) */
  71     GMX_CPUID_FEATURE_X86_CX16,          /* Supports CMPXCHG16B (16-byte compare-exchg)  */
  72     GMX_CPUID_FEATURE_X86_F16C,          /* Supports 16-bit FP conversion instructions   */
  73     GMX_CPUID_FEATURE_X86_FMA,           /* Fused-multiply add support (mainly for AVX)  */
  74     GMX_CPUID_FEATURE_X86_FMA4,          /* 4-operand FMA, only on AMD for now           */
  75     GMX_CPUID_FEATURE_X86_HTT,           /* Hyper-Threading supported                    */
  76     GMX_CPUID_FEATURE_X86_LAHF_LM,       /* LAHF/SAHF support in 64 bits                 */
  77     GMX_CPUID_FEATURE_X86_MISALIGNSSE,   /* Support for misaligned SSE data instructions */
  78     GMX_CPUID_FEATURE_X86_MMX,           /* MMX registers and instructions               */
  79     GMX_CPUID_FEATURE_X86_MSR,           /* Supports Intel model-specific-registers      */
  80     GMX_CPUID_FEATURE_X86_NONSTOP_TSC,   /* Invariant TSC (constant rate in ACPI states) */
  81     GMX_CPUID_FEATURE_X86_PCID,          /* Process context identifier support           */
  82     GMX_CPUID_FEATURE_X86_PCLMULDQ,      /* Carry-less 64-bit multiplication supported   */
  83     GMX_CPUID_FEATURE_X86_PDCM,          /* Perfmon and Debug Capability                 */
  84     GMX_CPUID_FEATURE_X86_PDPE1GB,       /* Support for 1GB pages                        */
  85     GMX_CPUID_FEATURE_X86_POPCNT,        /* Supports the POPCNT (population count) insn  */
  86     GMX_CPUID_FEATURE_X86_PSE,           /* Supports 4MB-pages (page size extension)     */
  87     GMX_CPUID_FEATURE_X86_RDRND,         /* RDRAND high-quality hardware random numbers  */
  88     GMX_CPUID_FEATURE_X86_RDTSCP,        /* Serializing rdtscp instruction available     */
  89     GMX_CPUID_FEATURE_X86_SSE2,          /* SSE 2                                        */
  90     GMX_CPUID_FEATURE_X86_SSE3,          /* SSE 3                                        */
  91     GMX_CPUID_FEATURE_X86_SSE4A,         /* SSE 4A                                       */
  92     GMX_CPUID_FEATURE_X86_SSE4_1,        /* SSE 4.1                                      */
  93     GMX_CPUID_FEATURE_X86_SSE4_2,        /* SSE 4.2                                      */
  94     GMX_CPUID_FEATURE_X86_SSSE3,         /* Supplemental SSE3                            */
  95     GMX_CPUID_FEATURE_X86_TDT,           /* TSC deadline timer                           */
  96     GMX_CPUID_FEATURE_X86_X2APIC,        /* Extended xAPIC Support                       */
  97     GMX_CPUID_FEATURE_X86_XOP,           /* AMD extended instructions, only AMD for now  */
  98     GMX_CPUID_NFEATURES
  99 };
 100
 101
 102 /* Currently supported acceleration instruction sets, intrinsics or other similar combinations
 103  * in Gromacs. There is not always a 1-to-1 correspondence with feature flags; on some AMD
 104  * hardware we prefer to use 128bit AVX instructions (although 256-bit ones could be executed),
 105  * and we still haven't written the AVX2 kernels.
 106  */
 107 enum gmx_cpuid_acceleration
 108 {
 109     GMX_CPUID_ACCELERATION_CANNOTDETECT,    /* Should only be used if something fails */
 110     GMX_CPUID_ACCELERATION_NONE,
 111     GMX_CPUID_ACCELERATION_X86_SSE2,
 112     GMX_CPUID_ACCELERATION_X86_SSE4_1,
 113     GMX_CPUID_ACCELERATION_X86_AVX_128_FMA,
 114     GMX_CPUID_ACCELERATION_X86_AVX_256,
 115     GMX_CPUID_NACCELERATIONS
 116 };
 117
 118 /* Text strings corresponding to CPU vendors */
 119 extern const char *
 120 gmx_cpuid_vendor_string[GMX_CPUID_NVENDORS];
 121
 122 /* Text strings for CPU feature indices */
 123 extern const char *
 124 gmx_cpuid_feature_string[GMX_CPUID_NFEATURES];
 125
 126 /* Text strings for Gromacs acceleration/instruction sets */
 127 extern const char *
 128 gmx_cpuid_acceleration_string[GMX_CPUID_NACCELERATIONS];
 129
 130
 131 /* Abstract data type with CPU detection information. Set by gmx_cpuid_init(). */
 132 typedef struct gmx_cpuid *
 133 gmx_cpuid_t;
 134
 135
 136 /* Fill the data structure by using CPU detection instructions.
 137  * Return 0 on success, 1 if something bad happened.
 138  */
 139 int
 140 gmx_cpuid_init              (gmx_cpuid_t *              cpuid);
 141
 142
 143 /* Return the vendor id as enumerated type. Use gmx_cpuid_vendor_string[]
 144  * to get the corresponding text string.
 145  */
 146 enum gmx_cpuid_vendor
 147 gmx_cpuid_vendor            (gmx_cpuid_t                cpuid);
 148
 149
 150 /* Return a constant pointer to the processor brand string. */
 151 const char *
 152 gmx_cpuid_brand             (gmx_cpuid_t                cpuid);
 153
 154
 155 /* Return processor family version. For a chip of version 1.2.3, this is 1 */
 156 int
 157 gmx_cpuid_family            (gmx_cpuid_t                cpuid);
 158
 159 /* Return processor model version, For a chip of version 1.2.3, this is 2. */
 160 int
 161 gmx_cpuid_model             (gmx_cpuid_t                cpuid);
 162
 163 /* Return processor stepping version, For a chip of version 1.2.3, this is 3. */
 164 int
 165 gmx_cpuid_stepping          (gmx_cpuid_t                cpuid);
 166
 167
 168 /* Check whether a particular CPUID feature is set.
 169  * Returns 0 if flag "feature" is not set, 1 if the flag is set. We cannot use
 170  * gmx_bool here since this file must be possible to compile without simple.h.
 171  */
 172 int
 173 gmx_cpuid_feature           (gmx_cpuid_t                cpuid,
 174                              enum gmx_cpuid_feature     feature);
 175
 176
 177 /* Return pointers to cpu topology information.
 178  *
 179  * Important: CPU topology requires more OS support than most other
 180  * functions in this file, including support for thread pinning to hardware.
 181  * This means it will not work on some platforms, including e.g. Mac OS X.
 182  * Thus, it is IMPERATIVE that you check the return value from this routine
 183  * before doing anything with the information. It is only if the return
 184  * value is zero that the data is valid.
 185  *
 186  * For the returned values we have:
 187  * - nprocessors         Total number of logical processors reported by OS
 188  * - npackages           Usually number of CPU sockets
 189  * - ncores_per_package  Number of cores in each package
 190  * - nhwthreads_per_core Number of hardware threads per core; 2 for hyperthreading.
 191  * - package_id          Array with the package index for each logical cpu
 192  * - core_id             Array with local core index for each logical cpu
 193  * - hwthread_id         Array with local hwthread index for each logical cpu
 194  * - locality_order      Array with logical cpu numbers, sorted in order
 195  *                       of physical and logical locality in the system.
 196  *
 197  * All arrays are of length nprocessors.
 198  */
 199 int
 200 gmx_cpuid_topology(gmx_cpuid_t        cpuid,
 201                    int *              nprocessors,
 202                    int *              npackages,
 203                    int *              ncores_per_package,
 204                    int *              nhwthreads_per_core,
 205                    const int **       package_id,
 206                    const int **       core_id,
 207                    const int **       hwthread_id,
 208                    const int **       locality_order);
 209
 210 /* Enumerated values for x86 SMT enabled-status. Note that this does not refer
 211  * to Hyper-Threading support (that is the flag GMX_CPUID_FEATURE_X86_HTT), but
 212  * whether Hyper-Threading is _enabled_ and _used_ in bios right now.
 213  */
 214 enum gmx_cpuid_x86_smt
 215 {
 216     GMX_CPUID_X86_SMT_CANNOTDETECT,
 217     GMX_CPUID_X86_SMT_DISABLED,
 218     GMX_CPUID_X86_SMT_ENABLED
 219 };
 220
 221 /* Returns the status of x86 SMT support. IMPORTANT: There are non-zero
 222  * return values for this routine that still do not indicate supported and
 223  * enabled smt/Hyper-Threading. You need to carefully check the return value
 224  * against the enumerated type values to see what you are getting.
 225  *
 226  * Long-term, this functionality will move to a new hardware topology detection
 227  * layer, but that will require a lot of new code and a working interface to the
 228  * hwloc library. Surprisingly, there is no simple way to find out that
 229  * Hyper-Threading is actually turned on without fully enumerating and checking
 230  * all the cores, which we presently can only do on Linux. This means a couple
 231  * of things:
 232  *
 233  * 1) If you want to know whether your CPU _supports_ Hyper-Threading in the
 234  *    first place, check the GMX_CPUID_FEATURE_X86_HTT flag instead!
 235  * 2) There are several scenarios where this routine will say that it cannot
 236  *    detect whether SMT is enabled and used right now.
 237  * 3) If you need support on non-Linux x86, you have to write it :-)
 238  * 4) Don't invest too much efforts, since this will be replaced with
 239  *    full hardware topology detection in the future.
 240  * 5) Don't worry if the detection does not work. It is not a catastrophe, but
 241  *    but we get slightly better performance on x86 if we use Hyper-Threading
 242  *    cores in direct space, but not reciprocal space.
 243  *
 244  * Since this routine presently only supports Hyper-Threading we say X86_SMT
 245  * in order not to give the impression we can detect any SMT. We haven't
 246  * even tested the performance on other SMT implementations, so it is not
 247  * obvious we shouldn't use SMT there.
 248  *
 249  * Note that you can get more complete topology information from
 250  * gmx_cpuid_topology(), although that requires slightly more OS support.
 251  */
 252 enum gmx_cpuid_x86_smt
 253 gmx_cpuid_x86_smt(gmx_cpuid_t cpuid);
 254
 255
 256 /* Formats a text string (up to n characters) from the data structure.
 257  * The output will have max 80 chars between newline characters.
 258  */
 259 int
 260 gmx_cpuid_formatstring      (gmx_cpuid_t                cpuid,
 261                              char *                     s,
 262                              int                        n);
 263
 264
 265 /* Suggests a suitable gromacs acceleration based on the support in the
 266  * hardware.
 267  */
 268 enum gmx_cpuid_acceleration
 269 gmx_cpuid_acceleration_suggest  (gmx_cpuid_t                    cpuid);
 270
 271
 272 /* Check if this binary was compiled with the same acceleration as we
 273  * would suggest for the current hardware. Always print stats to the log file
 274  * if it is non-NULL, and print a warning in stdout if we don't have a match.
 275  */
 276 int
 277 gmx_cpuid_acceleration_check    (gmx_cpuid_t                cpuid,
 278                                  FILE *                     log);
 279
 280
 281 /* Release resources used by data structure. Note that the pointer to the
 282  * CPU brand string will no longer be valid once this routine has been called.
 283  */
 284 void
 285 gmx_cpuid_done              (gmx_cpuid_t                cpuid);
 286
 287
 288
 289
 290 #ifdef __cplusplus
 291 }
 292 #endif
 293
 294
 295 #endif /* GMX_CPUID_H_ */