src/porting.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21         Random portability stuff
  22 */
  23
  24 #ifndef PORTING_HEADER
  25 #define PORTING_HEADER
  26
  27 #include <string>
  28 #include "irrlichttypes.h" // u32
  29 #include "debug.h"
  30 #include "constants.h"
  31 #include "gettime.h"
  32 #include "threads.h"
  33
  34 #ifdef _MSC_VER
  35         #define SWPRINTF_CHARSTRING L"%S"
  36 #else
  37         #define SWPRINTF_CHARSTRING L"%s"
  38 #endif
  39
  40 //currently not needed
  41 //template<typename T> struct alignment_trick { char c; T member; };
  42 //#define ALIGNOF(type) offsetof (alignment_trick<type>, member)
  43
  44 #ifdef _WIN32
  45         #ifndef _WIN32_WINNT
  46                 #define _WIN32_WINNT 0x0501
  47         #endif
  48         #include <windows.h>
  49
  50         #define sleep_ms(x) Sleep(x)
  51 #else
  52         #include <unistd.h>
  53         #include <stdint.h> //for uintptr_t
  54
  55         #if (defined(linux) || defined(__linux)) && !defined(_GNU_SOURCE)
  56                 #define _GNU_SOURCE
  57         #endif
  58
  59         #include <sched.h>
  60
  61         #ifdef __FreeBSD__
  62                 #include <pthread_np.h>
  63                 typedef cpuset_t cpu_set_t;
  64         #elif defined(__sun) || defined(sun)
  65                 #include <sys/types.h>
  66                 #include <sys/processor.h>
  67         #elif defined(_AIX)
  68                 #include <sys/processor.h>
  69         #elif __APPLE__
  70                 #include <mach/mach_init.h>
  71                 #include <mach/thread_policy.h>
  72         #endif
  73
  74         #define sleep_ms(x) usleep(x*1000)
  75
  76         #define THREAD_PRIORITY_LOWEST       0
  77         #define THREAD_PRIORITY_BELOW_NORMAL 1
  78         #define THREAD_PRIORITY_NORMAL       2
  79         #define THREAD_PRIORITY_ABOVE_NORMAL 3
  80         #define THREAD_PRIORITY_HIGHEST      4
  81 #endif
  82
  83 #ifdef _MSC_VER
  84         #define ALIGNOF(x) __alignof(x)
  85         #define strtok_r(x, y, z) strtok_s(x, y, z)
  86         #define strtof(x, y) (float)strtod(x, y)
  87         #define strtoll(x, y, z) _strtoi64(x, y, z)
  88         #define strtoull(x, y, z) _strtoui64(x, y, z)
  89         #define strcasecmp(x, y) stricmp(x, y)
  90         #define strncasecmp(x, y, n) strnicmp(x, y, n)
  91 #else
  92         #define ALIGNOF(x) __alignof__(x)
  93 #endif
  94
  95 #ifdef __MINGW32__
  96         #define strtok_r(x, y, z) mystrtok_r(x, y, z)
  97 #endif
  98
  99 #define PADDING(x, y) ((ALIGNOF(y) - ((uintptr_t)(x) & (ALIGNOF(y) - 1))) & (ALIGNOF(y) - 1))
 100
 101 namespace porting
 102 {
 103
 104 /*
 105         Signal handler (grabs Ctrl-C on POSIX systems)
 106 */
 107
 108 void signal_handler_init(void);
 109 // Returns a pointer to a bool.
 110 // When the bool is true, program should quit.
 111 bool * signal_handler_killstatus(void);
 112
 113 /*
 114         Path of static data directory.
 115 */
 116 extern std::string path_share;
 117
 118 /*
 119         Directory for storing user data. Examples:
 120         Windows: "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
 121         Linux: "~/.<PROJECT_NAME>"
 122         Mac: "~/Library/Application Support/<PROJECT_NAME>"
 123 */
 124 extern std::string path_user;
 125
 126 /*
 127         Get full path of stuff in data directory.
 128         Example: "stone.png" -> "../data/stone.png"
 129 */
 130 std::string getDataPath(const char *subpath);
 131
 132 /*
 133         Initialize path_share and path_user.
 134 */
 135 void initializePaths();
 136
 137 /*
 138         Get number of online processors in the system.
 139 */
 140 int getNumberOfProcessors();
 141
 142 /*
 143         Set a thread's affinity to a particular processor.
 144 */
 145 bool threadBindToProcessor(threadid_t tid, int pnumber);
 146
 147 /*
 148         Set a thread's priority.
 149 */
 150 bool threadSetPriority(threadid_t tid, int prio);
 151
 152 /*
 153         Return system information
 154         e.g. "Linux/3.12.7 x86_64"
 155 */
 156 std::string get_sysinfo();
 157
 158 /*
 159         Resolution is 10-20ms.
 160         Remember to check for overflows.
 161         Overflow can occur at any value higher than 10000000.
 162 */
 163 #ifdef _WIN32 // Windows
 164 #ifndef _WIN32_WINNT
 165         #define _WIN32_WINNT 0x0501
 166 #endif
 167         #include <windows.h>
 168
 169         inline u32 getTimeS()
 170         {
 171                 return GetTickCount() / 1000;
 172         }
 173
 174         inline u32 getTimeMs()
 175         {
 176                 return GetTickCount();
 177         }
 178
 179         inline u32 getTimeUs()
 180         {
 181                 LARGE_INTEGER freq, t;
 182                 QueryPerformanceFrequency(&freq);
 183                 QueryPerformanceCounter(&t);
 184                 return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000.0);
 185         }
 186
 187         inline u32 getTimeNs()
 188         {
 189                 LARGE_INTEGER freq, t;
 190                 QueryPerformanceFrequency(&freq);
 191                 QueryPerformanceCounter(&t);
 192                 return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000000.0);
 193         }
 194
 195 #else // Posix
 196         #include <sys/time.h>
 197         #include <time.h>
 198
 199         inline u32 getTimeS()
 200         {
 201                 struct timeval tv;
 202                 gettimeofday(&tv, NULL);
 203                 return tv.tv_sec;
 204         }
 205
 206         inline u32 getTimeMs()
 207         {
 208                 struct timeval tv;
 209                 gettimeofday(&tv, NULL);
 210                 return tv.tv_sec * 1000 + tv.tv_usec / 1000;
 211         }
 212
 213         inline u32 getTimeUs()
 214         {
 215                 struct timeval tv;
 216                 gettimeofday(&tv, NULL);
 217                 return tv.tv_sec * 1000000 + tv.tv_usec;
 218         }
 219
 220         inline u32 getTimeNs()
 221         {
 222                 struct timespec ts;
 223                 clock_gettime(CLOCK_REALTIME, &ts);
 224                 return ts.tv_sec * 1000000000 + ts.tv_nsec;
 225         }
 226
 227         /*#include <sys/timeb.h>
 228         inline u32 getTimeMs()
 229         {
 230                 struct timeb tb;
 231                 ftime(&tb);
 232                 return tb.time * 1000 + tb.millitm;
 233         }*/
 234 #endif
 235
 236 inline u32 getTime(TimePrecision prec)
 237 {
 238         switch (prec) {
 239                 case PRECISION_SECONDS:
 240                         return getTimeS();
 241                 case PRECISION_MILLI:
 242                         return getTimeMs();
 243                 case PRECISION_MICRO:
 244                         return getTimeUs();
 245                 case PRECISION_NANO:
 246                         return getTimeNs();
 247         }
 248         return 0;
 249 }
 250
 251
 252 } // namespace porting
 253
 254 #endif // PORTING_HEADER
 255