include/llvm/Support/Host.h

   1 //===- llvm/Support/Host.h - Host machine characteristics --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Methods for querying the nature of the host machine.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SYSTEM_HOST_H
  15 #define LLVM_SYSTEM_HOST_H
  16
  17 #include "llvm/ADT/StringMap.h"
  18 #include <string>
  19
  20 namespace llvm {
  21 namespace sys {
  22
  23   inline bool isLittleEndianHost() {
  24     union {
  25       int i;
  26       char c;
  27     };
  28     i = 1;
  29     return c;
  30   }
  31
  32   inline bool isBigEndianHost() {
  33     return !isLittleEndianHost();
  34   }
  35
  36   /// getHostTriple() - Return the host where the compiler will be running.
  37   ///
  38   /// The host triple is a string in the format of:
  39   ///   CPU_TYPE-VENDOR-OPERATING_SYSTEM
  40   /// or
  41   ///   CPU_TYPE-VENDOR-KERNEL-OPERATING_SYSTEM
  42   std::string getHostTriple();
  43
  44   /// getDefaultTargetTriple() - Return the default target triple the compiler
  45   /// has been configured to produce code for.
  46   ///
  47   /// The target triple is a string in the format of:
  48   ///   CPU_TYPE-VENDOR-OPERATING_SYSTEM
  49   /// or
  50   ///   CPU_TYPE-VENDOR-KERNEL-OPERATING_SYSTEM
  51   std::string getDefaultTargetTriple();
  52
  53   /// getHostCPUName - Get the LLVM name for the host CPU. The particular format
  54   /// of the name is target dependent, and suitable for passing as -mcpu to the
  55   /// target which matches the host.
  56   ///
  57   /// \return - The host CPU name, or empty if the CPU could not be determined.
  58   std::string getHostCPUName();
  59
  60   /// getHostCPUFeatures - Get the LLVM names for the host CPU features.
  61   /// The particular format of the names are target dependent, and suitable for
  62   /// passing as -mattr to the target which matches the host.
  63   ///
  64   /// \param Features - A string mapping feature names to either
  65   /// true (if enabled) or false (if disabled). This routine makes no guarantees
  66   /// about exactly which features may appear in this map, except that they are
  67   /// all valid LLVM feature names.
  68   ///
  69   /// \return - True on success.
  70   bool getHostCPUFeatures(StringMap<bool> &Features);
  71 }
  72 }
  73
  74 #endif