compat.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694
  1. /* Copyright (c) 2003-2004, Roger Dingledine
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2012, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. #ifndef TOR_COMPAT_H
  6. #define TOR_COMPAT_H
  7. #include "orconfig.h"
  8. #include "torint.h"
  9. #ifdef _WIN32
  10. #ifndef _WIN32_WINNT
  11. #define _WIN32_WINNT 0x0501
  12. #endif
  13. #define WIN32_LEAN_AND_MEAN
  14. #if defined(_MSC_VER) && (_MSC_VER < 1300)
  15. #include <winsock.h>
  16. #else
  17. #include <winsock2.h>
  18. #include <ws2tcpip.h>
  19. #endif
  20. #endif
  21. #ifdef HAVE_SYS_PARAM_H
  22. #include <sys/param.h>
  23. #endif
  24. #ifdef HAVE_SYS_TYPES_H
  25. #include <sys/types.h>
  26. #endif
  27. #ifdef HAVE_SYS_TIME_H
  28. #include <sys/time.h>
  29. #endif
  30. #ifdef HAVE_TIME_H
  31. #include <time.h>
  32. #endif
  33. #ifdef HAVE_STRING_H
  34. #include <string.h>
  35. #endif
  36. #if defined(HAVE_PTHREAD_H) && !defined(_WIN32)
  37. #include <pthread.h>
  38. #endif
  39. #include <stdarg.h>
  40. #ifdef HAVE_SYS_RESOURCE_H
  41. #include <sys/resource.h>
  42. #endif
  43. #ifdef HAVE_SYS_SOCKET_H
  44. #include <sys/socket.h>
  45. #endif
  46. #ifdef HAVE_NETINET_IN_H
  47. #include <netinet/in.h>
  48. #endif
  49. #ifdef HAVE_NETINET6_IN6_H
  50. #include <netinet6/in6.h>
  51. #endif
  52. #include <stdio.h>
  53. #if defined (WINCE)
  54. #include <fcntl.h>
  55. #include <io.h>
  56. #include <math.h>
  57. #include <projects.h>
  58. #define snprintf _snprintf
  59. /* this is not exported as W .... */
  60. #define SHGetPathFromIDListW SHGetPathFromIDList
  61. /* wcecompat has vasprintf */
  62. #define HAVE_VASPRINTF
  63. /* no service here */
  64. #ifdef NT_SERVICE
  65. #undef NT_SERVICE
  66. #endif
  67. #endif // WINCE
  68. #ifndef NULL_REP_IS_ZERO_BYTES
  69. #error "It seems your platform does not represent NULL as zero. We can't cope."
  70. #endif
  71. #if 'a'!=97 || 'z'!=122 || 'A'!=65 || ' '!=32
  72. #error "It seems that you encode characters in something other than ASCII."
  73. #endif
  74. /* ===== Compiler compatibility */
  75. /* GCC can check printf types on arbitrary functions. */
  76. #ifdef __GNUC__
  77. #define CHECK_PRINTF(formatIdx, firstArg) \
  78. __attribute__ ((format(printf, formatIdx, firstArg)))
  79. #else
  80. #define CHECK_PRINTF(formatIdx, firstArg)
  81. #endif
  82. /* inline is __inline on windows. */
  83. #ifdef _WIN32
  84. #define INLINE __inline
  85. #else
  86. #define INLINE inline
  87. #endif
  88. /* Try to get a reasonable __func__ substitute in place. */
  89. #if defined(_MSC_VER)
  90. /* MSVC compilers before VC7 don't have __func__ at all; later ones call it
  91. * __FUNCTION__. */
  92. #if _MSC_VER < 1300
  93. #define __func__ "???"
  94. #else
  95. #define __func__ __FUNCTION__
  96. #endif
  97. #else
  98. /* For platforms where autoconf works, make sure __func__ is defined
  99. * sanely. */
  100. #ifndef HAVE_MACRO__func__
  101. #ifdef HAVE_MACRO__FUNCTION__
  102. #define __func__ __FUNCTION__
  103. #elif HAVE_MACRO__FUNC__
  104. #define __func__ __FUNC__
  105. #else
  106. #define __func__ "???"
  107. #endif
  108. #endif /* ifndef MAVE_MACRO__func__ */
  109. #endif /* if not windows */
  110. #if defined(_MSC_VER) && (_MSC_VER < 1300)
  111. /* MSVC versions before 7 apparently don't believe that you can cast uint64_t
  112. * to double and really mean it. */
  113. extern INLINE double U64_TO_DBL(uint64_t x) {
  114. int64_t i = (int64_t) x;
  115. return (i < 0) ? ((double) INT64_MAX) : (double) i;
  116. }
  117. #define DBL_TO_U64(x) ((uint64_t)(int64_t) (x))
  118. #else
  119. #define U64_TO_DBL(x) ((double) (x))
  120. #define DBL_TO_U64(x) ((uint64_t) (x))
  121. #endif
  122. /* GCC has several useful attributes. */
  123. #if defined(__GNUC__) && __GNUC__ >= 3
  124. #define ATTR_NORETURN __attribute__((noreturn))
  125. #define ATTR_CONST __attribute__((const))
  126. #define ATTR_MALLOC __attribute__((malloc))
  127. #define ATTR_NORETURN __attribute__((noreturn))
  128. /* Alas, nonnull is not at present a good idea for us. We'd like to get
  129. * warnings when we pass NULL where we shouldn't (which nonnull does, albeit
  130. * spottily), but we don't want to tell the compiler to make optimizations
  131. * with the assumption that the argument can't be NULL (since this would make
  132. * many of our checks go away, and make our code less robust against
  133. * programming errors). Unfortunately, nonnull currently does both of these
  134. * things, and there's no good way to split them up.
  135. *
  136. * #define ATTR_NONNULL(x) __attribute__((nonnull x)) */
  137. #define ATTR_NONNULL(x)
  138. /** Macro: Evaluates to <b>exp</b> and hints the compiler that the value
  139. * of <b>exp</b> will probably be true.
  140. *
  141. * In other words, "if (PREDICT_LIKELY(foo))" is the same as "if (foo)",
  142. * except that it tells the compiler that the branch will be taken most of the
  143. * time. This can generate slightly better code with some CPUs.
  144. */
  145. #define PREDICT_LIKELY(exp) __builtin_expect(!!(exp), 1)
  146. /** Macro: Evaluates to <b>exp</b> and hints the compiler that the value
  147. * of <b>exp</b> will probably be false.
  148. *
  149. * In other words, "if (PREDICT_UNLIKELY(foo))" is the same as "if (foo)",
  150. * except that it tells the compiler that the branch will usually not be
  151. * taken. This can generate slightly better code with some CPUs.
  152. */
  153. #define PREDICT_UNLIKELY(exp) __builtin_expect(!!(exp), 0)
  154. #else
  155. #define ATTR_NORETURN
  156. #define ATTR_CONST
  157. #define ATTR_MALLOC
  158. #define ATTR_NORETURN
  159. #define ATTR_NONNULL(x)
  160. #define PREDICT_LIKELY(exp) (exp)
  161. #define PREDICT_UNLIKELY(exp) (exp)
  162. #endif
  163. /** Expands to a syntactically valid empty statement. */
  164. #define STMT_NIL (void)0
  165. /** Expands to a syntactically valid empty statement, explicitly (void)ing its
  166. * argument. */
  167. #define STMT_VOID(a) while (0) { (void)(a); }
  168. #ifdef __GNUC__
  169. /** STMT_BEGIN and STMT_END are used to wrap blocks inside macros so that
  170. * the macro can be used as if it were a single C statement. */
  171. #define STMT_BEGIN (void) ({
  172. #define STMT_END })
  173. #elif defined(sun) || defined(__sun__)
  174. #define STMT_BEGIN if (1) {
  175. #define STMT_END } else STMT_NIL
  176. #else
  177. #define STMT_BEGIN do {
  178. #define STMT_END } while (0)
  179. #endif
  180. /* ===== String compatibility */
  181. #ifdef _WIN32
  182. /* Windows names string functions differently from most other platforms. */
  183. #define strncasecmp _strnicmp
  184. #define strcasecmp _stricmp
  185. #endif
  186. #ifndef HAVE_STRLCAT
  187. size_t strlcat(char *dst, const char *src, size_t siz) ATTR_NONNULL((1,2));
  188. #endif
  189. #ifndef HAVE_STRLCPY
  190. size_t strlcpy(char *dst, const char *src, size_t siz) ATTR_NONNULL((1,2));
  191. #endif
  192. #ifdef _MSC_VER
  193. /** Casts the uint64_t value in <b>a</b> to the right type for an argument
  194. * to printf. */
  195. #define U64_PRINTF_ARG(a) (a)
  196. /** Casts the uint64_t* value in <b>a</b> to the right type for an argument
  197. * to scanf. */
  198. #define U64_SCANF_ARG(a) (a)
  199. /** Expands to a literal uint64_t-typed constant for the value <b>n</b>. */
  200. #define U64_LITERAL(n) (n ## ui64)
  201. #define I64_PRINTF_ARG(a) (a)
  202. #define I64_SCANF_ARG(a) (a)
  203. #define I64_LITERAL(n) (n ## i64)
  204. #else
  205. #define U64_PRINTF_ARG(a) ((long long unsigned int)(a))
  206. #define U64_SCANF_ARG(a) ((long long unsigned int*)(a))
  207. #define U64_LITERAL(n) (n ## llu)
  208. #define I64_PRINTF_ARG(a) ((long long signed int)(a))
  209. #define I64_SCANF_ARG(a) ((long long signed int*)(a))
  210. #define I64_LITERAL(n) (n ## ll)
  211. #endif
  212. #if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
  213. /** The formatting string used to put a uint64_t value in a printf() or
  214. * scanf() function. See also U64_PRINTF_ARG and U64_SCANF_ARG. */
  215. #define U64_FORMAT "%I64u"
  216. #define I64_FORMAT "%I64d"
  217. #else
  218. #define U64_FORMAT "%llu"
  219. #define I64_FORMAT "%lld"
  220. #endif
  221. /** Represents an mmaped file. Allocated via tor_mmap_file; freed with
  222. * tor_munmap_file. */
  223. typedef struct tor_mmap_t {
  224. const char *data; /**< Mapping of the file's contents. */
  225. size_t size; /**< Size of the file. */
  226. /* None of the fields below should be accessed from outside compat.c */
  227. #ifdef HAVE_SYS_MMAN_H
  228. size_t mapping_size; /**< Size of the actual mapping. (This is this file
  229. * size, rounded up to the nearest page.) */
  230. #elif defined _WIN32
  231. HANDLE mmap_handle;
  232. #endif
  233. } tor_mmap_t;
  234. tor_mmap_t *tor_mmap_file(const char *filename) ATTR_NONNULL((1));
  235. void tor_munmap_file(tor_mmap_t *handle) ATTR_NONNULL((1));
  236. int tor_snprintf(char *str, size_t size, const char *format, ...)
  237. CHECK_PRINTF(3,4) ATTR_NONNULL((1,3));
  238. int tor_vsnprintf(char *str, size_t size, const char *format, va_list args)
  239. CHECK_PRINTF(3,0) ATTR_NONNULL((1,3));
  240. int tor_asprintf(char **strp, const char *fmt, ...)
  241. CHECK_PRINTF(2,3);
  242. int tor_vasprintf(char **strp, const char *fmt, va_list args)
  243. CHECK_PRINTF(2,0);
  244. const void *tor_memmem(const void *haystack, size_t hlen, const void *needle,
  245. size_t nlen) ATTR_NONNULL((1,3));
  246. static const void *tor_memstr(const void *haystack, size_t hlen,
  247. const char *needle) ATTR_NONNULL((1,3));
  248. static INLINE const void *
  249. tor_memstr(const void *haystack, size_t hlen, const char *needle)
  250. {
  251. return tor_memmem(haystack, hlen, needle, strlen(needle));
  252. }
  253. /* Much of the time when we're checking ctypes, we're doing spec compliance,
  254. * which all assumes we're doing ASCII. */
  255. #define DECLARE_CTYPE_FN(name) \
  256. static int TOR_##name(char c); \
  257. extern const uint32_t TOR_##name##_TABLE[]; \
  258. static INLINE int TOR_##name(char c) { \
  259. uint8_t u = c; \
  260. return !!(TOR_##name##_TABLE[(u >> 5) & 7] & (1 << (u & 31))); \
  261. }
  262. DECLARE_CTYPE_FN(ISALPHA)
  263. DECLARE_CTYPE_FN(ISALNUM)
  264. DECLARE_CTYPE_FN(ISSPACE)
  265. DECLARE_CTYPE_FN(ISDIGIT)
  266. DECLARE_CTYPE_FN(ISXDIGIT)
  267. DECLARE_CTYPE_FN(ISPRINT)
  268. DECLARE_CTYPE_FN(ISLOWER)
  269. DECLARE_CTYPE_FN(ISUPPER)
  270. extern const char TOR_TOUPPER_TABLE[];
  271. extern const char TOR_TOLOWER_TABLE[];
  272. #define TOR_TOLOWER(c) (TOR_TOLOWER_TABLE[(uint8_t)c])
  273. #define TOR_TOUPPER(c) (TOR_TOUPPER_TABLE[(uint8_t)c])
  274. char *tor_strtok_r_impl(char *str, const char *sep, char **lasts);
  275. #ifdef HAVE_STRTOK_R
  276. #define tor_strtok_r(str, sep, lasts) strtok_r(str, sep, lasts)
  277. #else
  278. #define tor_strtok_r(str, sep, lasts) tor_strtok_r_impl(str, sep, lasts)
  279. #endif
  280. #ifdef _WIN32
  281. #define _SHORT_FILE_ (tor_fix_source_file(__FILE__))
  282. const char *tor_fix_source_file(const char *fname);
  283. #else
  284. #define _SHORT_FILE_ (__FILE__)
  285. #define tor_fix_source_file(s) (s)
  286. #endif
  287. /* ===== Time compatibility */
  288. #if !defined(HAVE_GETTIMEOFDAY) && !defined(HAVE_STRUCT_TIMEVAL_TV_SEC)
  289. /** Implementation of timeval for platforms that don't have it. */
  290. struct timeval {
  291. time_t tv_sec;
  292. unsigned int tv_usec;
  293. };
  294. #endif
  295. void tor_gettimeofday(struct timeval *timeval);
  296. struct tm *tor_localtime_r(const time_t *timep, struct tm *result);
  297. struct tm *tor_gmtime_r(const time_t *timep, struct tm *result);
  298. #ifndef timeradd
  299. /** Replacement for timeradd on platforms that do not have it: sets tvout to
  300. * the sum of tv1 and tv2. */
  301. #define timeradd(tv1,tv2,tvout) \
  302. do { \
  303. (tvout)->tv_sec = (tv1)->tv_sec + (tv2)->tv_sec; \
  304. (tvout)->tv_usec = (tv1)->tv_usec + (tv2)->tv_usec; \
  305. if ((tvout)->tv_usec >= 1000000) { \
  306. (tvout)->tv_usec -= 1000000; \
  307. (tvout)->tv_sec++; \
  308. } \
  309. } while (0)
  310. #endif
  311. #ifndef timersub
  312. /** Replacement for timersub on platforms that do not have it: sets tvout to
  313. * tv1 minus tv2. */
  314. #define timersub(tv1,tv2,tvout) \
  315. do { \
  316. (tvout)->tv_sec = (tv1)->tv_sec - (tv2)->tv_sec; \
  317. (tvout)->tv_usec = (tv1)->tv_usec - (tv2)->tv_usec; \
  318. if ((tvout)->tv_usec < 0) { \
  319. (tvout)->tv_usec += 1000000; \
  320. (tvout)->tv_sec--; \
  321. } \
  322. } while (0)
  323. #endif
  324. #ifndef timercmp
  325. /** Replacement for timersub on platforms that do not have it: returns true
  326. * iff the relational operator "op" makes the expression tv1 op tv2 true.
  327. *
  328. * Note that while this definition should work for all boolean opeators, some
  329. * platforms' native timercmp definitions do not support >=, <=, or ==. So
  330. * don't use those.
  331. */
  332. #define timercmp(tv1,tv2,op) \
  333. (((tv1)->tv_sec == (tv2)->tv_sec) ? \
  334. ((tv1)->tv_usec op (tv2)->tv_usec) : \
  335. ((tv1)->tv_sec op (tv2)->tv_sec))
  336. #endif
  337. /* ===== File compatibility */
  338. int tor_open_cloexec(const char *path, int flags, unsigned mode);
  339. FILE *tor_fopen_cloexec(const char *path, const char *mode);
  340. int replace_file(const char *from, const char *to);
  341. int touch_file(const char *fname);
  342. typedef struct tor_lockfile_t tor_lockfile_t;
  343. tor_lockfile_t *tor_lockfile_lock(const char *filename, int blocking,
  344. int *locked_out);
  345. void tor_lockfile_unlock(tor_lockfile_t *lockfile);
  346. off_t tor_fd_getpos(int fd);
  347. int tor_fd_seekend(int fd);
  348. #ifdef _WIN32
  349. #define PATH_SEPARATOR "\\"
  350. #else
  351. #define PATH_SEPARATOR "/"
  352. #endif
  353. /* ===== Net compatibility */
  354. #if (SIZEOF_SOCKLEN_T == 0)
  355. typedef int socklen_t;
  356. #endif
  357. #ifdef _WIN32
  358. /* XXX Actually, this should arguably be SOCKET; we use intptr_t here so that
  359. * any inadvertant checks for the socket being <= 0 or > 0 will probably
  360. * still work. */
  361. #define tor_socket_t intptr_t
  362. #define SOCKET_OK(s) ((SOCKET)(s) != INVALID_SOCKET)
  363. #define TOR_INVALID_SOCKET INVALID_SOCKET
  364. #else
  365. /** Type used for a network socket. */
  366. #define tor_socket_t int
  367. /** Macro: true iff 's' is a possible value for a valid initialized socket. */
  368. #define SOCKET_OK(s) ((s) >= 0)
  369. /** Error/uninitialized value for a tor_socket_t. */
  370. #define TOR_INVALID_SOCKET (-1)
  371. #endif
  372. int tor_close_socket(tor_socket_t s);
  373. tor_socket_t tor_open_socket(int domain, int type, int protocol);
  374. tor_socket_t tor_accept_socket(tor_socket_t sockfd, struct sockaddr *addr,
  375. socklen_t *len);
  376. int get_n_open_sockets(void);
  377. #define tor_socket_send(s, buf, len, flags) send(s, buf, len, flags)
  378. #define tor_socket_recv(s, buf, len, flags) recv(s, buf, len, flags)
  379. /** Implementation of struct in6_addr for platforms that do not have it.
  380. * Generally, these platforms are ones without IPv6 support, but we want to
  381. * have a working in6_addr there anyway, so we can use it to parse IPv6
  382. * addresses. */
  383. #if !defined(HAVE_STRUCT_IN6_ADDR)
  384. struct in6_addr
  385. {
  386. union {
  387. uint8_t u6_addr8[16];
  388. uint16_t u6_addr16[8];
  389. uint32_t u6_addr32[4];
  390. } in6_u;
  391. #define s6_addr in6_u.u6_addr8
  392. #define s6_addr16 in6_u.u6_addr16
  393. #define s6_addr32 in6_u.u6_addr32
  394. };
  395. #endif
  396. /** @{ */
  397. /** Many BSD variants seem not to define these. */
  398. #if defined(__APPLE__) || defined(__darwin__) || defined(__FreeBSD__) \
  399. || defined(__NetBSD__) || defined(__OpenBSD__)
  400. #ifndef s6_addr16
  401. #define s6_addr16 __u6_addr.__u6_addr16
  402. #endif
  403. #ifndef s6_addr32
  404. #define s6_addr32 __u6_addr.__u6_addr32
  405. #endif
  406. #endif
  407. /** @} */
  408. #ifndef HAVE_SA_FAMILY_T
  409. typedef uint16_t sa_family_t;
  410. #endif
  411. /** @{ */
  412. /** Apparently, MS and Solaris don't define s6_addr16 or s6_addr32; these
  413. * macros get you a pointer to s6_addr32 or local equivalent. */
  414. #ifdef HAVE_STRUCT_IN6_ADDR_S6_ADDR32
  415. #define S6_ADDR32(x) ((uint32_t*)(x).s6_addr32)
  416. #else
  417. #define S6_ADDR32(x) ((uint32_t*)((char*)&(x).s6_addr))
  418. #endif
  419. #ifdef HAVE_STRUCT_IN6_ADDR_S6_ADDR16
  420. #define S6_ADDR16(x) ((uint16_t*)(x).s6_addr16)
  421. #else
  422. #define S6_ADDR16(x) ((uint16_t*)((char*)&(x).s6_addr))
  423. #endif
  424. /** @} */
  425. /** Implementation of struct sockaddr_in6 on platforms that do not have
  426. * it. See notes on struct in6_addr. */
  427. #if !defined(HAVE_STRUCT_SOCKADDR_IN6)
  428. struct sockaddr_in6 {
  429. sa_family_t sin6_family;
  430. uint16_t sin6_port;
  431. // uint32_t sin6_flowinfo;
  432. struct in6_addr sin6_addr;
  433. // uint32_t sin6_scope_id;
  434. };
  435. #endif
  436. int tor_inet_aton(const char *cp, struct in_addr *addr) ATTR_NONNULL((1,2));
  437. const char *tor_inet_ntop(int af, const void *src, char *dst, size_t len);
  438. int tor_inet_pton(int af, const char *src, void *dst);
  439. int tor_lookup_hostname(const char *name, uint32_t *addr) ATTR_NONNULL((1,2));
  440. void set_socket_nonblocking(tor_socket_t socket);
  441. int tor_socketpair(int family, int type, int protocol, tor_socket_t fd[2]);
  442. int network_init(void);
  443. /* For stupid historical reasons, windows sockets have an independent
  444. * set of errnos, and an independent way to get them. Also, you can't
  445. * always believe WSAEWOULDBLOCK. Use the macros below to compare
  446. * errnos against expected values, and use tor_socket_errno to find
  447. * the actual errno after a socket operation fails.
  448. */
  449. #if defined(_WIN32)
  450. /** Expands to WSA<b>e</b> on Windows, and to <b>e</b> elsewhere. */
  451. #define SOCK_ERRNO(e) WSA##e
  452. /** Return true if e is EAGAIN or the local equivalent. */
  453. #define ERRNO_IS_EAGAIN(e) ((e) == EAGAIN || (e) == WSAEWOULDBLOCK)
  454. /** Return true if e is EINPROGRESS or the local equivalent. */
  455. #define ERRNO_IS_EINPROGRESS(e) ((e) == WSAEINPROGRESS)
  456. /** Return true if e is EINPROGRESS or the local equivalent as returned by
  457. * a call to connect(). */
  458. #define ERRNO_IS_CONN_EINPROGRESS(e) \
  459. ((e) == WSAEINPROGRESS || (e)== WSAEINVAL || (e) == WSAEWOULDBLOCK)
  460. /** Return true if e is EAGAIN or another error indicating that a call to
  461. * accept() has no pending connections to return. */
  462. #define ERRNO_IS_ACCEPT_EAGAIN(e) ERRNO_IS_EAGAIN(e)
  463. /** Return true if e is EMFILE or another error indicating that a call to
  464. * accept() has failed because we're out of fds or something. */
  465. #define ERRNO_IS_ACCEPT_RESOURCE_LIMIT(e) \
  466. ((e) == WSAEMFILE || (e) == WSAENOBUFS)
  467. /** Return true if e is EADDRINUSE or the local equivalent. */
  468. #define ERRNO_IS_EADDRINUSE(e) ((e) == WSAEADDRINUSE)
  469. int tor_socket_errno(tor_socket_t sock);
  470. const char *tor_socket_strerror(int e);
  471. #else
  472. #define SOCK_ERRNO(e) e
  473. #define ERRNO_IS_EAGAIN(e) ((e) == EAGAIN)
  474. #define ERRNO_IS_EINPROGRESS(e) ((e) == EINPROGRESS)
  475. #define ERRNO_IS_CONN_EINPROGRESS(e) ((e) == EINPROGRESS)
  476. #define ERRNO_IS_ACCEPT_EAGAIN(e) ((e) == EAGAIN || (e) == ECONNABORTED)
  477. #define ERRNO_IS_ACCEPT_RESOURCE_LIMIT(e) \
  478. ((e) == EMFILE || (e) == ENFILE || (e) == ENOBUFS || (e) == ENOMEM)
  479. #define ERRNO_IS_EADDRINUSE(e) ((e) == EADDRINUSE)
  480. #define tor_socket_errno(sock) (errno)
  481. #define tor_socket_strerror(e) strerror(e)
  482. #endif
  483. /** Specified SOCKS5 status codes. */
  484. typedef enum {
  485. SOCKS5_SUCCEEDED = 0x00,
  486. SOCKS5_GENERAL_ERROR = 0x01,
  487. SOCKS5_NOT_ALLOWED = 0x02,
  488. SOCKS5_NET_UNREACHABLE = 0x03,
  489. SOCKS5_HOST_UNREACHABLE = 0x04,
  490. SOCKS5_CONNECTION_REFUSED = 0x05,
  491. SOCKS5_TTL_EXPIRED = 0x06,
  492. SOCKS5_COMMAND_NOT_SUPPORTED = 0x07,
  493. SOCKS5_ADDRESS_TYPE_NOT_SUPPORTED = 0x08,
  494. } socks5_reply_status_t;
  495. /* ===== Insecure rng */
  496. void tor_init_weak_random(unsigned seed);
  497. long tor_weak_random(void);
  498. #define TOR_RAND_MAX (RAND_MAX)
  499. /* ===== OS compatibility */
  500. const char *get_uname(void);
  501. uint16_t get_uint16(const void *cp) ATTR_NONNULL((1));
  502. uint32_t get_uint32(const void *cp) ATTR_NONNULL((1));
  503. uint64_t get_uint64(const void *cp) ATTR_NONNULL((1));
  504. void set_uint16(void *cp, uint16_t v) ATTR_NONNULL((1));
  505. void set_uint32(void *cp, uint32_t v) ATTR_NONNULL((1));
  506. void set_uint64(void *cp, uint64_t v) ATTR_NONNULL((1));
  507. /* These uint8 variants are defined to make the code more uniform. */
  508. #define get_uint8(cp) (*(const uint8_t*)(cp))
  509. static void set_uint8(void *cp, uint8_t v);
  510. static INLINE void
  511. set_uint8(void *cp, uint8_t v)
  512. {
  513. *(uint8_t*)cp = v;
  514. }
  515. #if !defined(HAVE_RLIM_T)
  516. typedef unsigned long rlim_t;
  517. #endif
  518. int set_max_file_descriptors(rlim_t limit, int *max);
  519. int tor_disable_debugger_attach(void);
  520. int switch_id(const char *user);
  521. #ifdef HAVE_PWD_H
  522. char *get_user_homedir(const char *username);
  523. #endif
  524. int get_parent_directory(char *fname);
  525. char *make_path_absolute(char *fname);
  526. char **get_environment(void);
  527. int spawn_func(void (*func)(void *), void *data);
  528. void spawn_exit(void) ATTR_NORETURN;
  529. #if defined(ENABLE_THREADS) && defined(_WIN32)
  530. #define USE_WIN32_THREADS
  531. #define TOR_IS_MULTITHREADED 1
  532. #elif (defined(ENABLE_THREADS) && defined(HAVE_PTHREAD_H) && \
  533. defined(HAVE_PTHREAD_CREATE))
  534. #define USE_PTHREADS
  535. #define TOR_IS_MULTITHREADED 1
  536. #else
  537. #undef TOR_IS_MULTITHREADED
  538. #endif
  539. int compute_num_cpus(void);
  540. /* Because we use threads instead of processes on most platforms (Windows,
  541. * Linux, etc), we need locking for them. On platforms with poor thread
  542. * support or broken gethostbyname_r, these functions are no-ops. */
  543. /** A generic lock structure for multithreaded builds. */
  544. typedef struct tor_mutex_t {
  545. #if defined(USE_WIN32_THREADS)
  546. /** Windows-only: on windows, we implement locks with CRITICAL_SECTIONS. */
  547. CRITICAL_SECTION mutex;
  548. #elif defined(USE_PTHREADS)
  549. /** Pthreads-only: with pthreads, we implement locks with
  550. * pthread_mutex_t. */
  551. pthread_mutex_t mutex;
  552. #else
  553. /** No-threads only: Dummy variable so that tor_mutex_t takes up space. */
  554. int _unused;
  555. #endif
  556. } tor_mutex_t;
  557. int tor_mlockall(void);
  558. #ifdef TOR_IS_MULTITHREADED
  559. tor_mutex_t *tor_mutex_new(void);
  560. void tor_mutex_init(tor_mutex_t *m);
  561. void tor_mutex_acquire(tor_mutex_t *m);
  562. void tor_mutex_release(tor_mutex_t *m);
  563. void tor_mutex_free(tor_mutex_t *m);
  564. void tor_mutex_uninit(tor_mutex_t *m);
  565. unsigned long tor_get_thread_id(void);
  566. void tor_threads_init(void);
  567. #else
  568. #define tor_mutex_new() ((tor_mutex_t*)tor_malloc(sizeof(int)))
  569. #define tor_mutex_init(m) STMT_NIL
  570. #define tor_mutex_acquire(m) STMT_VOID(m)
  571. #define tor_mutex_release(m) STMT_NIL
  572. #define tor_mutex_free(m) STMT_BEGIN tor_free(m); STMT_END
  573. #define tor_mutex_uninit(m) STMT_NIL
  574. #define tor_get_thread_id() (1UL)
  575. #define tor_threads_init() STMT_NIL
  576. #endif
  577. void set_main_thread(void);
  578. int in_main_thread(void);
  579. #ifdef TOR_IS_MULTITHREADED
  580. #if 0
  581. typedef struct tor_cond_t tor_cond_t;
  582. tor_cond_t *tor_cond_new(void);
  583. void tor_cond_free(tor_cond_t *cond);
  584. int tor_cond_wait(tor_cond_t *cond, tor_mutex_t *mutex);
  585. void tor_cond_signal_one(tor_cond_t *cond);
  586. void tor_cond_signal_all(tor_cond_t *cond);
  587. #endif
  588. #endif
  589. /** Macros for MIN/MAX. Never use these when the arguments could have
  590. * side-effects.
  591. * {With GCC extensions we could probably define a safer MIN/MAX. But
  592. * depending on that safety would be dangerous, since not every platform
  593. * has it.}
  594. **/
  595. #ifndef MAX
  596. #define MAX(a,b) ( ((a)<(b)) ? (b) : (a) )
  597. #endif
  598. #ifndef MIN
  599. #define MIN(a,b) ( ((a)>(b)) ? (b) : (a) )
  600. #endif
  601. /* Platform-specific helpers. */
  602. #ifdef _WIN32
  603. char *format_win32_error(DWORD err);
  604. #endif
  605. /*for some reason my compiler doesn't have these version flags defined
  606. a nice homework assignment for someone one day is to define the rest*/
  607. //these are the values as given on MSDN
  608. #ifdef _WIN32
  609. #ifndef VER_SUITE_EMBEDDEDNT
  610. #define VER_SUITE_EMBEDDEDNT 0x00000040
  611. #endif
  612. #ifndef VER_SUITE_SINGLEUSERTS
  613. #define VER_SUITE_SINGLEUSERTS 0x00000100
  614. #endif
  615. #endif
  616. #endif