libs/pbd/fpu.cc

   1 /*
   2     Copyright (C) 2012 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "libpbd-config.h"
  21
  22 #define _XOPEN_SOURCE 600
  23 #include <cstring> // for memset
  24 #include <cstdlib>
  25 #include <stdint.h>
  26 #include <assert.h>
  27
  28 #ifdef PLATFORM_WINDOWS
  29 #include <intrin.h>
  30 #endif
  31
  32 #include "pbd/compose.h"
  33 #include "pbd/fpu.h"
  34 #include "pbd/error.h"
  35
  36 #include "pbd/i18n.h"
  37
  38 using namespace PBD;
  39 using namespace std;
  40
  41 FPU* FPU::_instance (0);
  42
  43 #if ( (defined __x86_64__) || (defined __i386__) || (defined _M_X64) || (defined _M_IX86) ) // ARCH_X86
  44 #ifndef PLATFORM_WINDOWS
  45
  46 /* use __cpuid() as the name to match the MSVC/mingw intrinsic */
  47
  48 static void
  49 __cpuid(int regs[4], int cpuid_leaf)
  50 {
  51         asm volatile (
  52 #if defined(__i386__)
  53                 "pushl %%ebx;\n\t"
  54 #endif
  55                 "cpuid;\n\t"
  56                 "movl %%eax, (%1);\n\t"
  57                 "movl %%ebx, 4(%1);\n\t"
  58                 "movl %%ecx, 8(%1);\n\t"
  59                 "movl %%edx, 12(%1);\n\t"
  60 #if defined(__i386__)
  61                 "popl %%ebx;\n\t"
  62 #endif
  63                 :"=a" (cpuid_leaf) /* %eax clobbered by CPUID */
  64                 :"S" (regs), "a" (cpuid_leaf)
  65                 :
  66 #if !defined(__i386__)
  67                  "%ebx",
  68 #endif
  69                  "%ecx", "%edx", "memory");
  70 }
  71
  72 #endif /* !PLATFORM_WINDOWS */
  73
  74 #ifndef COMPILER_MSVC
  75
  76 static uint64_t
  77 _xgetbv (uint32_t xcr)
  78 {
  79 #ifdef __APPLE__
  80         /* it would be nice to make this work on OS X but as long we use veclib,
  81            we don't really need to know about SSE/AVX on that platform.
  82         */
  83         return 0;
  84 #else
  85         uint32_t eax, edx;
  86         __asm__ volatile ("xgetbv" : "=a" (eax), "=d" (edx) : "c" (xcr));
  87         return (static_cast<uint64_t>(edx) << 32) | eax;
  88 #endif
  89 }
  90
  91 #elif _MSC_VER < 1600
  92
  93 // '_xgetbv()' was only available from VC10 onwards
  94 __declspec(noinline) static uint64_t
  95 _xgetbv (uint32_t xcr)
  96 {
  97         return 0;
  98
  99         // N.B.  The following would probably work for a pre-VC10 build,
 100         // although it might suffer from optimization issues.  We'd need
 101         // to place this function into its own (unoptimized) source file.
 102         __asm {
 103                          mov ecx, [xcr]
 104                          __asm _emit 0x0f __asm _emit 0x01 __asm _emit 0xd0   /*xgetbv*/
 105                   }
 106 }
 107
 108 #endif /* !COMPILER_MSVC */
 109 #endif /* ARCH_X86 */
 110
 111 #ifndef _XCR_XFEATURE_ENABLED_MASK
 112 #define _XCR_XFEATURE_ENABLED_MASK 0
 113 #endif
 114
 115 FPU*
 116 FPU::instance()
 117 {
 118         if (!_instance) {
 119                 _instance = new FPU;
 120         }
 121
 122         return _instance;
 123 }
 124
 125 void
 126 FPU::destroy ()
 127 {
 128         delete _instance;
 129         _instance = 0;
 130 }
 131
 132 FPU::FPU ()
 133         : _flags ((Flags) 0)
 134 {
 135         if (_instance) {
 136                 error << _("FPU object instantiated more than once") << endmsg;
 137         }
 138
 139         if (getenv("ARDOUR_FPU_FLAGS")) {
 140                 _flags = Flags (atoi (getenv("ARDOUR_FPU_FLAGS")));
 141                 return;
 142         }
 143
 144 #if !( (defined __x86_64__) || (defined __i386__) || (defined _M_X64) || (defined _M_IX86) ) // !ARCH_X86
 145         /* Non-Intel architecture, nothing to do here */
 146         return;
 147 #else
 148
 149         /* Get the CPU vendor just for kicks */
 150
 151         // __cpuid with an InfoType argument of 0 returns the number of
 152         // valid Ids in CPUInfo[0] and the CPU identification string in
 153         // the other three array elements. The CPU identification string is
 154         // not in linear order. The code below arranges the information
 155         // in a human readable form. The human readable order is CPUInfo[1] |
 156         // CPUInfo[3] | CPUInfo[2]. CPUInfo[2] and CPUInfo[3] are swapped
 157         // before using memcpy to copy these three array elements to cpu_string.
 158
 159         int cpu_info[4];
 160         char cpu_string[48];
 161         string cpu_vendor;
 162
 163         __cpuid (cpu_info, 0);
 164
 165         int num_ids = cpu_info[0];
 166         std::swap(cpu_info[2], cpu_info[3]);
 167         memcpy(cpu_string, &cpu_info[1], 3 * sizeof(cpu_info[1]));
 168         cpu_vendor.assign(cpu_string, 3 * sizeof(cpu_info[1]));
 169
 170         info << string_compose (_("CPU vendor: %1"), cpu_vendor) << endmsg;
 171
 172         if (num_ids > 0) {
 173
 174                 /* Now get CPU/FPU flags */
 175
 176                 __cpuid (cpu_info, 1);
 177
 178                 if ((cpu_info[2] & (1<<27)) /* OSXSAVE */ &&
 179                     (cpu_info[2] & (1<<28) /* AVX */) &&
 180                     ((_xgetbv (_XCR_XFEATURE_ENABLED_MASK) & 0x6) == 0x6)) { /* OS really supports XSAVE */
 181                         info << _("AVX-capable processor") << endmsg;
 182                         _flags = Flags (_flags | (HasAVX) );
 183                 }
 184
 185                 if (cpu_info[3] & (1<<25)) {
 186                         _flags = Flags (_flags | (HasSSE|HasFlushToZero));
 187                 }
 188
 189                 if (cpu_info[3] & (1<<26)) {
 190                         _flags = Flags (_flags | HasSSE2);
 191                 }
 192
 193                 /* Figure out CPU/FPU denormal handling capabilities */
 194
 195                 if (cpu_info[3] & (1 << 24)) {
 196
 197                         char** fxbuf = 0;
 198
 199                         /* DAZ wasn't available in the first version of SSE. Since
 200                            setting a reserved bit in MXCSR causes a general protection
 201                            fault, we need to be able to check the availability of this
 202                            feature without causing problems. To do this, one needs to
 203                            set up a 512-byte area of memory to save the SSE state to,
 204                            using fxsave, and then one needs to inspect bytes 28 through
 205                            31 for the MXCSR_MASK value. If bit 6 is set, DAZ is
 206                            supported, otherwise, it isn't.
 207                         */
 208
 209 #ifndef HAVE_POSIX_MEMALIGN
 210 #  ifdef PLATFORM_WINDOWS
 211                         fxbuf = (char **) _aligned_malloc (sizeof (char *), 16);
 212                         assert (fxbuf);
 213                         *fxbuf = (char *) _aligned_malloc (512, 16);
 214                         assert (*fxbuf);
 215 #  else
 216 #  warning using default malloc for aligned memory
 217                         fxbuf = (char **) malloc (sizeof (char *));
 218                         assert (fxbuf);
 219                         *fxbuf = (char *) malloc (512);
 220                         assert (*fxbuf);
 221 #  endif
 222 #else
 223                         (void) posix_memalign ((void **) &fxbuf, 16, sizeof (char *));
 224                         assert (fxbuf);
 225                         (void) posix_memalign ((void **) fxbuf, 16, 512);
 226                         assert (*fxbuf);
 227 #endif
 228
 229                         memset (*fxbuf, 0, 512);
 230
 231 #ifdef COMPILER_MSVC
 232                         char *buf = *fxbuf;
 233                         __asm {
 234                                 mov eax, buf
 235                                         fxsave   [eax]
 236                                         };
 237 #else
 238                         asm volatile (
 239                                 "fxsave (%0)"
 240                                 :
 241                                 : "r" (*fxbuf)
 242                                 : "memory"
 243                                 );
 244 #endif
 245
 246                         uint32_t mxcsr_mask = *((uint32_t*) &((*fxbuf)[28]));
 247
 248                         /* if the mask is zero, set its default value (from intel specs) */
 249
 250                         if (mxcsr_mask == 0) {
 251                                 mxcsr_mask = 0xffbf;
 252                         }
 253
 254                         if (mxcsr_mask & (1<<6)) {
 255                                 _flags = Flags (_flags | HasDenormalsAreZero);
 256                         }
 257
 258 #if !defined HAVE_POSIX_MEMALIGN && defined PLATFORM_WINDOWS
 259                         _aligned_free (*fxbuf);
 260                         _aligned_free (fxbuf);
 261 #else
 262                         free (*fxbuf);
 263                         free (fxbuf);
 264 #endif
 265                 }
 266
 267                 /* finally get the CPU brand */
 268
 269                 __cpuid (cpu_info, 0x80000000);
 270
 271                 const int parameter_end = 0x80000004;
 272                 string cpu_brand;
 273
 274                 if (cpu_info[0] >= parameter_end) {
 275                         char* cpu_string_ptr = cpu_string;
 276
 277                         for (int parameter = 0x80000002; parameter <= parameter_end &&
 278                                      cpu_string_ptr < &cpu_string[sizeof(cpu_string)]; parameter++) {
 279                                 __cpuid(cpu_info, parameter);
 280                                 memcpy(cpu_string_ptr, cpu_info, sizeof(cpu_info));
 281                                 cpu_string_ptr += sizeof(cpu_info);
 282                         }
 283                         cpu_brand.assign(cpu_string, cpu_string_ptr - cpu_string);
 284                         info << string_compose (_("CPU brand: %1"), cpu_brand) << endmsg;
 285                 }
 286         }
 287 #endif /* !ARCH_X86 */
 288 }
 289
 290 FPU::~FPU ()
 291 {
 292 }