1 /* 2 * Copyright (c) 2016-present, Przemyslaw Skibinski, Yann Collet, Facebook, Inc. 3 * All rights reserved. 4 * 5 * This source code is licensed under both the BSD-style license (found in the 6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found 7 * in the COPYING file in the root directory of this source tree). 8 * You may select, at your option, one of the above-listed licenses. 9 */ 10 11 #ifndef UTIL_H_MODULE 12 #define UTIL_H_MODULE 13 14 #if defined (__cplusplus) 15 extern "C" { 16 #endif 17 18 19 /*-**************************************** 20 * Dependencies 21 ******************************************/ 22 #include "platform.h" /* PLATFORM_POSIX_VERSION, ZSTD_NANOSLEEP_SUPPORT, ZSTD_SETPRIORITY_SUPPORT */ 23 #include <stdlib.h> /* malloc, realloc, free */ 24 #include <stddef.h> /* size_t, ptrdiff_t */ 25 #include <stdio.h> /* fprintf */ 26 #include <sys/types.h> /* stat, utime */ 27 #include <sys/stat.h> /* stat, chmod */ 28 #if defined(_MSC_VER) 29 # include <sys/utime.h> /* utime */ 30 # include <io.h> /* _chmod */ 31 #else 32 # include <unistd.h> /* chown, stat */ 33 # include <utime.h> /* utime */ 34 #endif 35 #include <time.h> /* clock_t, clock, CLOCKS_PER_SEC, nanosleep */ 36 #include "mem.h" /* U32, U64 */ 37 38 39 /*-************************************************************ 40 * Avoid fseek()'s 2GiB barrier with MSVC, macOS, *BSD, MinGW 41 ***************************************************************/ 42 #if defined(_MSC_VER) && (_MSC_VER >= 1400) 43 # define UTIL_fseek _fseeki64 44 #elif !defined(__64BIT__) && (PLATFORM_POSIX_VERSION >= 200112L) /* No point defining Large file for 64 bit */ 45 # define UTIL_fseek fseeko 46 #elif defined(__MINGW32__) && defined(__MSVCRT__) && !defined(__STRICT_ANSI__) && !defined(__NO_MINGW_LFS) 47 # define UTIL_fseek fseeko64 48 #else 49 # define UTIL_fseek fseek 50 #endif 51 52 53 /*-************************************************* 54 * Sleep & priority functions: Windows - Posix - others 55 ***************************************************/ 56 #if defined(_WIN32) 57 # include <windows.h> 58 # define SET_REALTIME_PRIORITY SetPriorityClass(GetCurrentProcess(), REALTIME_PRIORITY_CLASS) 59 # define UTIL_sleep(s) Sleep(1000*s) 60 # define UTIL_sleepMilli(milli) Sleep(milli) 61 62 #elif PLATFORM_POSIX_VERSION > 0 /* Unix-like operating system */ 63 # include <unistd.h> /* sleep */ 64 # define UTIL_sleep(s) sleep(s) 65 # if ZSTD_NANOSLEEP_SUPPORT /* necessarily defined in platform.h */ 66 # define UTIL_sleepMilli(milli) { struct timespec t; t.tv_sec=0; t.tv_nsec=milli*1000000ULL; nanosleep(&t, NULL); } 67 # else 68 # define UTIL_sleepMilli(milli) /* disabled */ 69 # endif 70 # if ZSTD_SETPRIORITY_SUPPORT 71 # include <sys/resource.h> /* setpriority */ 72 # define SET_REALTIME_PRIORITY setpriority(PRIO_PROCESS, 0, -20) 73 # else 74 # define SET_REALTIME_PRIORITY /* disabled */ 75 # endif 76 77 #else /* unknown non-unix operating systen */ 78 # define UTIL_sleep(s) /* disabled */ 79 # define UTIL_sleepMilli(milli) /* disabled */ 80 # define SET_REALTIME_PRIORITY /* disabled */ 81 #endif 82 83 84 /*-************************************* 85 * Constants 86 ***************************************/ 87 #define LIST_SIZE_INCREASE (8*1024) 88 89 90 /*-**************************************** 91 * Compiler specifics 92 ******************************************/ 93 #if defined(__INTEL_COMPILER) 94 # pragma warning(disable : 177) /* disable: message #177: function was declared but never referenced, useful with UTIL_STATIC */ 95 #endif 96 #if defined(__GNUC__) 97 # define UTIL_STATIC static __attribute__((unused)) 98 #elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) 99 # define UTIL_STATIC static inline 100 #elif defined(_MSC_VER) 101 # define UTIL_STATIC static __inline 102 #else 103 # define UTIL_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */ 104 #endif 105 106 107 /*-**************************************** 108 * Console log 109 ******************************************/ 110 extern int g_utilDisplayLevel; 111 #define UTIL_DISPLAY(...) fprintf(stderr, __VA_ARGS__) 112 #define UTIL_DISPLAYLEVEL(l, ...) { if (g_utilDisplayLevel>=l) { UTIL_DISPLAY(__VA_ARGS__); } } 113 114 115 /*-**************************************** 116 * Time functions 117 ******************************************/ 118 #if defined(_WIN32) /* Windows */ 119 120 #define UTIL_TIME_INITIALIZER { { 0, 0 } } 121 typedef LARGE_INTEGER UTIL_time_t; 122 123 #elif defined(__APPLE__) && defined(__MACH__) 124 125 #include <mach/mach_time.h> 126 #define UTIL_TIME_INITIALIZER 0 127 typedef U64 UTIL_time_t; 128 129 #elif (PLATFORM_POSIX_VERSION >= 200112L) \ 130 && (defined(__UCLIBC__) \ 131 || (defined(__GLIBC__) \ 132 && ((__GLIBC__ == 2 && __GLIBC_MINOR__ >= 17) \ 133 || (__GLIBC__ > 2)))) 134 135 #define UTIL_TIME_INITIALIZER { 0, 0 } 136 typedef struct timespec UTIL_freq_t; 137 typedef struct timespec UTIL_time_t; 138 139 UTIL_time_t UTIL_getSpanTime(UTIL_time_t begin, UTIL_time_t end); 140 141 #else /* relies on standard C (note : clock_t measurements can be wrong when using multi-threading) */ 142 143 typedef clock_t UTIL_time_t; 144 #define UTIL_TIME_INITIALIZER 0 145 146 #endif 147 148 UTIL_time_t UTIL_getTime(void); 149 U64 UTIL_getSpanTimeMicro(UTIL_time_t clockStart, UTIL_time_t clockEnd); 150 U64 UTIL_getSpanTimeNano(UTIL_time_t clockStart, UTIL_time_t clockEnd); 151 152 #define SEC_TO_MICRO 1000000 153 154 /* returns time span in microseconds */ 155 U64 UTIL_clockSpanMicro(UTIL_time_t clockStart); 156 157 /* returns time span in microseconds */ 158 U64 UTIL_clockSpanNano(UTIL_time_t clockStart); 159 void UTIL_waitForNextTick(void); 160 161 /*-**************************************** 162 * File functions 163 ******************************************/ 164 #if defined(_MSC_VER) 165 #define chmod _chmod 166 typedef struct __stat64 stat_t; 167 #else 168 typedef struct stat stat_t; 169 #endif 170 171 172 int UTIL_fileExist(const char* filename); 173 int UTIL_isRegularFile(const char* infilename); 174 int UTIL_setFileStat(const char* filename, stat_t* statbuf); 175 U32 UTIL_isDirectory(const char* infilename); 176 int UTIL_getFileStat(const char* infilename, stat_t* statbuf); 177 178 U32 UTIL_isLink(const char* infilename); 179 #define UTIL_FILESIZE_UNKNOWN ((U64)(-1)) 180 U64 UTIL_getFileSize(const char* infilename); 181 182 U64 UTIL_getTotalFileSize(const char* const * const fileNamesTable, unsigned nbFiles); 183 184 /* 185 * A modified version of realloc(). 186 * If UTIL_realloc() fails the original block is freed. 187 */ 188 UTIL_STATIC void* UTIL_realloc(void *ptr, size_t size) 189 { 190 void *newptr = realloc(ptr, size); 191 if (newptr) return newptr; 192 free(ptr); 193 return NULL; 194 } 195 196 int UTIL_prepareFileList(const char* dirName, char** bufStart, size_t* pos, char** bufEnd, int followLinks); 197 #ifdef _WIN32 198 # define UTIL_HAS_CREATEFILELIST 199 #elif defined(__linux__) || (PLATFORM_POSIX_VERSION >= 200112L) /* opendir, readdir require POSIX.1-2001 */ 200 # define UTIL_HAS_CREATEFILELIST 201 # include <dirent.h> /* opendir, readdir */ 202 # include <string.h> /* strerror, memcpy */ 203 #else 204 #endif /* #ifdef _WIN32 */ 205 206 /* 207 * UTIL_createFileList - takes a list of files and directories (params: inputNames, inputNamesNb), scans directories, 208 * and returns a new list of files (params: return value, allocatedBuffer, allocatedNamesNb). 209 * After finishing usage of the list the structures should be freed with UTIL_freeFileList(params: return value, allocatedBuffer) 210 * In case of error UTIL_createFileList returns NULL and UTIL_freeFileList should not be called. 211 */ 212 const char** 213 UTIL_createFileList(const char **inputNames, unsigned inputNamesNb, 214 char** allocatedBuffer, unsigned* allocatedNamesNb, 215 int followLinks); 216 217 UTIL_STATIC void UTIL_freeFileList(const char** filenameTable, char* allocatedBuffer) 218 { 219 if (allocatedBuffer) free(allocatedBuffer); 220 if (filenameTable) free((void*)filenameTable); 221 } 222 223 int UTIL_countPhysicalCores(void); 224 225 #if defined (__cplusplus) 226 } 227 #endif 228 229 #endif /* UTIL_H_MODULE */ 230