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 #pragma once
  25
  26 #ifdef _WIN32
  27         #ifdef _WIN32_WINNT
  28                 #undef _WIN32_WINNT
  29         #endif
  30         #define _WIN32_WINNT 0x0501 // We need to do this before any other headers
  31                 // because those might include sdkddkver.h which defines _WIN32_WINNT if not already set
  32 #endif
  33
  34 #include <string>
  35 #include <vector>
  36 #include "irrlicht.h"
  37 #include "irrlichttypes.h" // u32
  38 #include "irrlichttypes_extrabloated.h"
  39 #include "debug.h"
  40 #include "constants.h"
  41 #include "gettime.h"
  42
  43 #ifdef _MSC_VER
  44         #define SWPRINTF_CHARSTRING L"%S"
  45 #else
  46         #define SWPRINTF_CHARSTRING L"%s"
  47 #endif
  48
  49 //currently not needed
  50 //template<typename T> struct alignment_trick { char c; T member; };
  51 //#define ALIGNOF(type) offsetof (alignment_trick<type>, member)
  52
  53 #ifdef _WIN32
  54         #include <windows.h>
  55
  56         #define sleep_ms(x) Sleep(x)
  57 #else
  58         #include <unistd.h>
  59         #include <stdint.h> //for uintptr_t
  60
  61         // Use standard Posix macro for Linux
  62         #if (defined(linux) || defined(__linux)) && !defined(__linux__)
  63                 #define __linux__
  64         #endif
  65         #if (defined(__linux__) || defined(__GNU__)) && !defined(_GNU_SOURCE)
  66                 #define _GNU_SOURCE
  67         #endif
  68
  69         #define sleep_ms(x) usleep(x*1000)
  70 #endif
  71
  72 #ifdef _MSC_VER
  73         #define ALIGNOF(x) __alignof(x)
  74         #define strtok_r(x, y, z) strtok_s(x, y, z)
  75         #define strtof(x, y) (float)strtod(x, y)
  76         #define strtoll(x, y, z) _strtoi64(x, y, z)
  77         #define strtoull(x, y, z) _strtoui64(x, y, z)
  78         #define strcasecmp(x, y) stricmp(x, y)
  79         #define strncasecmp(x, y, n) strnicmp(x, y, n)
  80 #else
  81         #define ALIGNOF(x) __alignof__(x)
  82 #endif
  83
  84 #ifdef __MINGW32__
  85         #define strtok_r(x, y, z) mystrtok_r(x, y, z)
  86 #endif
  87
  88 // strlcpy is missing from glibc.  thanks a lot, drepper.
  89 // strlcpy is also missing from AIX and HP-UX because they aim to be weird.
  90 // We can't simply alias strlcpy to MSVC's strcpy_s, since strcpy_s by
  91 // default raises an assertion error and aborts the program if the buffer is
  92 // too small.
  93 #if defined(__FreeBSD__) || defined(__NetBSD__)    || \
  94         defined(__OpenBSD__) || defined(__DragonFly__) || \
  95         defined(__APPLE__)   ||                           \
  96         defined(__sun)       || defined(sun)           || \
  97         defined(__QNX__)     || defined(__QNXNTO__)
  98         #define HAVE_STRLCPY
  99 #endif
 100
 101 // So we need to define our own.
 102 #ifndef HAVE_STRLCPY
 103         #define strlcpy(d, s, n) mystrlcpy(d, s, n)
 104 #endif
 105
 106 #define PADDING(x, y) ((ALIGNOF(y) - ((uintptr_t)(x) & (ALIGNOF(y) - 1))) & (ALIGNOF(y) - 1))
 107
 108 #if defined(__APPLE__)
 109         #include <mach-o/dyld.h>
 110         #include <CoreFoundation/CoreFoundation.h>
 111 #endif
 112
 113 #ifndef _WIN32 // Posix
 114         #include <sys/time.h>
 115         #include <time.h>
 116         #if defined(__MACH__) && defined(__APPLE__)
 117                 #include <mach/clock.h>
 118                 #include <mach/mach.h>
 119         #endif
 120 #endif
 121
 122 namespace porting
 123 {
 124
 125 /*
 126         Signal handler (grabs Ctrl-C on POSIX systems)
 127 */
 128
 129 void signal_handler_init(void);
 130 // Returns a pointer to a bool.
 131 // When the bool is true, program should quit.
 132 bool * signal_handler_killstatus(void);
 133
 134 /*
 135         Path of static data directory.
 136 */
 137 extern std::string path_share;
 138
 139 /*
 140         Directory for storing user data. Examples:
 141         Windows: "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
 142         Linux: "~/.<PROJECT_NAME>"
 143         Mac: "~/Library/Application Support/<PROJECT_NAME>"
 144 */
 145 extern std::string path_user;
 146
 147 /*
 148         Path to gettext locale files
 149 */
 150 extern std::string path_locale;
 151
 152 /*
 153         Path to directory for storing caches.
 154 */
 155 extern std::string path_cache;
 156
 157 /*
 158         Get full path of stuff in data directory.
 159         Example: "stone.png" -> "../data/stone.png"
 160 */
 161 std::string getDataPath(const char *subpath);
 162
 163 /*
 164         Move cache folder from path_user to the
 165         system cache location if possible.
 166 */
 167 void migrateCachePath();
 168
 169 /*
 170         Initialize path_*.
 171 */
 172 void initializePaths();
 173
 174 /*
 175         Return system information
 176         e.g. "Linux/3.12.7 x86_64"
 177 */
 178 std::string get_sysinfo();
 179
 180
 181 // Monotonic counter getters.
 182
 183 #ifdef _WIN32 // Windows
 184
 185 extern double perf_freq;
 186
 187 inline u64 os_get_time(double mult)
 188 {
 189         LARGE_INTEGER t;
 190         QueryPerformanceCounter(&t);
 191         return static_cast<double>(t.QuadPart) / (perf_freq / mult);
 192 }
 193
 194 // Resolution is <1us.
 195 inline u64 getTimeS() { return os_get_time(1); }
 196 inline u64 getTimeMs() { return os_get_time(1000); }
 197 inline u64 getTimeUs() { return os_get_time(1000*1000); }
 198 inline u64 getTimeNs() { return os_get_time(1000*1000*1000); }
 199
 200 #else // Posix
 201
 202 inline void os_get_clock(struct timespec *ts)
 203 {
 204 #if defined(__MACH__) && defined(__APPLE__)
 205 // From http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x
 206 // OS X does not have clock_gettime, use clock_get_time
 207         clock_serv_t cclock;
 208         mach_timespec_t mts;
 209         host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock);
 210         clock_get_time(cclock, &mts);
 211         mach_port_deallocate(mach_task_self(), cclock);
 212         ts->tv_sec = mts.tv_sec;
 213         ts->tv_nsec = mts.tv_nsec;
 214 #elif defined(CLOCK_MONOTONIC_RAW)
 215         clock_gettime(CLOCK_MONOTONIC_RAW, ts);
 216 #elif defined(_POSIX_MONOTONIC_CLOCK)
 217         clock_gettime(CLOCK_MONOTONIC, ts);
 218 #else
 219         struct timeval tv;
 220         gettimeofday(&tv, NULL);
 221         TIMEVAL_TO_TIMESPEC(&tv, ts);
 222 #endif
 223 }
 224
 225 inline u64 getTimeS()
 226 {
 227         struct timespec ts;
 228         os_get_clock(&ts);
 229         return ts.tv_sec;
 230 }
 231
 232 inline u64 getTimeMs()
 233 {
 234         struct timespec ts;
 235         os_get_clock(&ts);
 236         return ts.tv_sec * 1000 + ts.tv_nsec / 1000000;
 237 }
 238
 239 inline u64 getTimeUs()
 240 {
 241         struct timespec ts;
 242         os_get_clock(&ts);
 243         return ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
 244 }
 245
 246 inline u64 getTimeNs()
 247 {
 248         struct timespec ts;
 249         os_get_clock(&ts);
 250         return ts.tv_sec * 1000000000 + ts.tv_nsec;
 251 }
 252
 253 #endif
 254
 255 inline u64 getTime(TimePrecision prec)
 256 {
 257         switch (prec) {
 258         case PRECISION_SECONDS: return getTimeS();
 259         case PRECISION_MILLI:   return getTimeMs();
 260         case PRECISION_MICRO:   return getTimeUs();
 261         case PRECISION_NANO:    return getTimeNs();
 262         }
 263         FATAL_ERROR("Called getTime with invalid time precision");
 264 }
 265
 266 /**
 267  * Delta calculation function arguments.
 268  * @param old_time_ms old time for delta calculation
 269  * @param new_time_ms new time for delta calculation
 270  * @return positive delta value
 271  */
 272 inline u64 getDeltaMs(u64 old_time_ms, u64 new_time_ms)
 273 {
 274         if (new_time_ms >= old_time_ms) {
 275                 return (new_time_ms - old_time_ms);
 276         } else {
 277                 return (old_time_ms - new_time_ms);
 278         }
 279 }
 280
 281 inline const char *getPlatformName()
 282 {
 283         return
 284 #if defined(ANDROID)
 285         "Android"
 286 #elif defined(__linux__)
 287         "Linux"
 288 #elif defined(_WIN32) || defined(_WIN64)
 289         "Windows"
 290 #elif defined(__DragonFly__) || defined(__FreeBSD__) || \
 291                 defined(__NetBSD__) || defined(__OpenBSD__)
 292         "BSD"
 293 #elif defined(__APPLE__) && defined(__MACH__)
 294         #if TARGET_OS_MAC
 295                 "OSX"
 296         #elif TARGET_OS_IPHONE
 297                 "iOS"
 298         #else
 299                 "Apple"
 300         #endif
 301 #elif defined(_AIX)
 302         "AIX"
 303 #elif defined(__hpux)
 304         "HP-UX"
 305 #elif defined(__sun) || defined(sun)
 306         #if defined(__SVR4)
 307                 "Solaris"
 308         #else
 309                 "SunOS"
 310         #endif
 311 #elif defined(__CYGWIN__)
 312         "Cygwin"
 313 #elif defined(__unix__) || defined(__unix)
 314         #if defined(_POSIX_VERSION)
 315                 "Posix"
 316         #else
 317                 "Unix"
 318         #endif
 319 #else
 320         "?"
 321 #endif
 322         ;
 323 }
 324
 325 bool secure_rand_fill_buf(void *buf, size_t len);
 326
 327 // This attaches to the parents process console, or creates a new one if it doesnt exist.
 328 void attachOrCreateConsole(void);
 329 } // namespace porting
 330
 331 #ifdef __ANDROID__
 332 #include "porting_android.h"
 333 #endif