blob: 3bae09ea199fc5e336d200d76fd3dfe4e18b7898 [file] [log] [blame]
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/* this file contains system-dependent definitions used by ADB
18 * they're related to threads, sockets and file descriptors
19 */
20#ifndef _ADB_SYSDEPS_H
21#define _ADB_SYSDEPS_H
22
23#ifdef __CYGWIN__
24# undef _WIN32
25#endif
26
Elliott Hughes381cfa92015-07-23 17:12:58 -070027#include <errno.h>
28
Spencer Low5200c662015-07-30 23:07:55 -070029#include <string>
Spencer Lowa30b79a2015-11-15 16:29:36 -080030#include <vector>
Spencer Low5200c662015-07-30 23:07:55 -070031
Spencer Lowd21dc822015-11-12 15:20:15 -080032// Include this before open/unlink are defined as macros below.
Josh Gao3b3e10d2016-02-09 14:59:09 -080033#include <android-base/errors.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080034#include <android-base/utf8.h>
Spencer Lowd21dc822015-11-12 15:20:15 -080035
Dan Albertcc731cc2015-02-24 21:26:58 -080036/*
37 * TEMP_FAILURE_RETRY is defined by some, but not all, versions of
38 * <unistd.h>. (Alas, it is not as standard as we'd hoped!) So, if it's
39 * not already defined, then define it here.
40 */
41#ifndef TEMP_FAILURE_RETRY
42/* Used to retry syscalls that can return EINTR. */
43#define TEMP_FAILURE_RETRY(exp) ({ \
44 typeof (exp) _rc; \
45 do { \
46 _rc = (exp); \
47 } while (_rc == -1 && errno == EINTR); \
48 _rc; })
49#endif
50
Spencer Lowcf4ff642015-05-11 01:08:48 -070051// Some printf-like functions are implemented in terms of
52// android::base::StringAppendV, so they should use the same attribute for
53// compile-time format string checking. On Windows, if the mingw version of
54// vsnprintf is used in StringAppendV, use `gnu_printf' which allows z in %zd
55// and PRIu64 (and related) to be recognized by the compile-time checking.
56#define ADB_FORMAT_ARCHETYPE __printf__
57#ifdef __USE_MINGW_ANSI_STDIO
58#if __USE_MINGW_ANSI_STDIO
59#undef ADB_FORMAT_ARCHETYPE
60#define ADB_FORMAT_ARCHETYPE gnu_printf
61#endif
62#endif
63
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080064#ifdef _WIN32
65
Josh Gaoa166e712016-01-29 12:08:34 -080066// Clang-only nullability specifiers
67#define _Nonnull
68#define _Nullable
69
Dan Albert630b9af2014-11-24 23:34:35 -080070#include <ctype.h>
71#include <direct.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070072#include <dirent.h>
Dan Albert630b9af2014-11-24 23:34:35 -080073#include <errno.h>
74#include <fcntl.h>
75#include <io.h>
76#include <process.h>
77#include <sys/stat.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070078#include <utime.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080079#include <winsock2.h>
Stephen Hines2f431a82014-10-01 17:37:06 -070080#include <windows.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080081#include <ws2tcpip.h>
Dan Albert630b9af2014-11-24 23:34:35 -080082
Spencer Low2122c7a2015-08-26 18:46:09 -070083#include <memory> // unique_ptr
Spencer Lowd21dc822015-11-12 15:20:15 -080084#include <string>
Alex Vallée47d67c92015-05-06 16:26:00 -040085
Dan Albert630b9af2014-11-24 23:34:35 -080086#include "fdevent.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080087
Elliott Hughes5c742702015-07-30 17:42:01 -070088#define OS_PATH_SEPARATORS "\\/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080089#define OS_PATH_SEPARATOR '\\'
90#define OS_PATH_SEPARATOR_STR "\\"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -070091#define ENV_PATH_SEPARATOR_STR ";"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080092
Josh Gao07db1192015-11-07 15:38:19 -080093static __inline__ bool adb_is_separator(char c) {
94 return c == '\\' || c == '/';
95}
96
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080097typedef CRITICAL_SECTION adb_mutex_t;
98
99#define ADB_MUTEX_DEFINE(x) adb_mutex_t x
100
101/* declare all mutexes */
JP Abgrall408fa572011-03-16 15:57:42 -0700102/* For win32, adb_sysdeps_init() will do the mutex runtime initialization. */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800103#define ADB_MUTEX(x) extern adb_mutex_t x;
104#include "mutex_list.h"
105
106extern void adb_sysdeps_init(void);
107
108static __inline__ void adb_mutex_lock( adb_mutex_t* lock )
109{
110 EnterCriticalSection( lock );
111}
112
113static __inline__ void adb_mutex_unlock( adb_mutex_t* lock )
114{
115 LeaveCriticalSection( lock );
116}
117
Josh Gaob5fea142016-02-12 14:31:15 -0800118typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800119typedef HANDLE adb_thread_t;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800120
Josh Gaob5fea142016-02-12 14:31:15 -0800121struct adb_winthread_args {
Josh Gao3b3e10d2016-02-09 14:59:09 -0800122 adb_thread_func_t func;
123 void* arg;
124};
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800125
Josh Gaob5fea142016-02-12 14:31:15 -0800126static unsigned __stdcall adb_winthread_wrapper(void* heap_args) {
127 // Move the arguments from the heap onto the thread's stack.
128 adb_winthread_args thread_args = *static_cast<adb_winthread_args*>(heap_args);
129 delete static_cast<adb_winthread_args*>(heap_args);
130 thread_args.func(thread_args.arg);
131 return 0;
Josh Gao3b3e10d2016-02-09 14:59:09 -0800132}
133
134static __inline__ bool adb_thread_create(adb_thread_func_t func, void* arg,
135 adb_thread_t* thread = nullptr) {
Josh Gaob5fea142016-02-12 14:31:15 -0800136 adb_winthread_args* args = new adb_winthread_args{.func = func, .arg = arg};
137 uintptr_t handle = _beginthreadex(nullptr, 0, adb_winthread_wrapper, args, 0, nullptr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800138 if (handle != static_cast<uintptr_t>(0)) {
139 if (thread) {
140 *thread = reinterpret_cast<HANDLE>(handle);
141 } else {
142 CloseHandle(thread);
143 }
144 return true;
145 }
146 return false;
147}
148
149static __inline__ bool adb_thread_join(adb_thread_t thread) {
150 switch (WaitForSingleObject(thread, INFINITE)) {
151 case WAIT_OBJECT_0:
152 CloseHandle(thread);
153 return true;
154
155 case WAIT_FAILED:
156 fprintf(stderr, "adb_thread_join failed: %s\n",
157 android::base::SystemErrorCodeToString(GetLastError()).c_str());
158 break;
159
160 default:
161 abort();
162 }
163
164 return false;
165}
166
167static __inline__ bool adb_thread_detach(adb_thread_t thread) {
168 CloseHandle(thread);
169 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800170}
171
Josh Gaob5fea142016-02-12 14:31:15 -0800172static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
Josh Gaod7b37492016-02-12 15:45:04 -0800173 _endthreadex(0);
Josh Gaob5fea142016-02-12 14:31:15 -0800174}
175
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700176static __inline__ int adb_thread_setname(const std::string& name) {
177 // TODO: See https://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx for how to set
178 // the thread name in Windows. Unfortunately, it only works during debugging, but
179 // our build process doesn't generate PDB files needed for debugging.
180 return 0;
181}
182
leozwangcbf02672014-08-15 09:51:27 -0700183static __inline__ unsigned long adb_thread_id()
184{
185 return GetCurrentThreadId();
186}
187
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800188static __inline__ void close_on_exec(int fd)
189{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200190 /* nothing really */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800191}
192
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800193#define lstat stat /* no symlinks on Win32 */
194
195#define S_ISLNK(m) 0 /* no symlinks on Win32 */
196
Spencer Lowcf4ff642015-05-11 01:08:48 -0700197extern int adb_unlink(const char* path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800198#undef unlink
199#define unlink ___xxx_unlink
200
Spencer Lowcf4ff642015-05-11 01:08:48 -0700201extern int adb_mkdir(const std::string& path, int mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800202#undef mkdir
203#define mkdir ___xxx_mkdir
204
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700205// See the comments for the !defined(_WIN32) versions of adb_*().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800206extern int adb_open(const char* path, int options);
207extern int adb_creat(const char* path, int mode);
208extern int adb_read(int fd, void* buf, int len);
209extern int adb_write(int fd, const void* buf, int len);
210extern int adb_lseek(int fd, int pos, int where);
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400211extern int adb_shutdown(int fd);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800212extern int adb_close(int fd);
213
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700214// See the comments for the !defined(_WIN32) version of unix_close().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800215static __inline__ int unix_close(int fd)
216{
217 return close(fd);
218}
219#undef close
220#define close ____xxx_close
221
Spencer Low2e02dc62015-11-07 17:34:39 -0800222// Like unix_read(), but may return EINTR.
223extern int unix_read_interruptible(int fd, void* buf, size_t len);
224
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700225// See the comments for the !defined(_WIN32) version of unix_read().
Spencer Low2e02dc62015-11-07 17:34:39 -0800226static __inline__ int unix_read(int fd, void* buf, size_t len) {
227 return TEMP_FAILURE_RETRY(unix_read_interruptible(fd, buf, len));
228}
Spencer Low50184062015-03-01 15:06:21 -0800229
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800230#undef read
231#define read ___xxx_read
232
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700233// See the comments for the !defined(_WIN32) version of unix_write().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800234static __inline__ int unix_write(int fd, const void* buf, size_t len)
235{
236 return write(fd, buf, len);
237}
238#undef write
239#define write ___xxx_write
240
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700241// See the comments for the !defined(_WIN32) version of adb_open_mode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800242static __inline__ int adb_open_mode(const char* path, int options, int mode)
243{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200244 return adb_open(path, options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800245}
246
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700247// See the comments for the !defined(_WIN32) version of unix_open().
Spencer Lowcf4ff642015-05-11 01:08:48 -0700248extern int unix_open(const char* path, int options, ...);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800249#define open ___xxx_unix_open
250
David Pursellc5b8ad82015-10-28 14:29:51 -0700251// Checks if |fd| corresponds to a console.
252// Standard Windows isatty() returns 1 for both console FDs and character
253// devices like NUL. unix_isatty() performs some extra checking to only match
254// console FDs.
255// |fd| must be a real file descriptor, meaning STDxx_FILENO or unix_open() FDs
256// will work but adb_open() FDs will not. Additionally the OS handle associated
257// with |fd| must have GENERIC_READ access (which console FDs have by default).
258// Returns 1 if |fd| is a console FD, 0 otherwise. The value of errno after
259// calling this function is unreliable and should not be used.
260int unix_isatty(int fd);
261#define isatty ___xxx_isatty
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800262
263/* normally provided by <cutils/misc.h> */
264extern void* load_file(const char* pathname, unsigned* psize);
265
David 'Digit' Turner414ff7d2009-05-18 17:07:46 +0200266/* normally provided by "fdevent.h" */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800267
268#define FDE_READ 0x0001
269#define FDE_WRITE 0x0002
270#define FDE_ERROR 0x0004
271#define FDE_DONT_CLOSE 0x0080
272
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800273typedef void (*fd_func)(int fd, unsigned events, void *userdata);
274
275fdevent *fdevent_create(int fd, fd_func func, void *arg);
276void fdevent_destroy(fdevent *fde);
277void fdevent_install(fdevent *fde, int fd, fd_func func, void *arg);
278void fdevent_remove(fdevent *item);
279void fdevent_set(fdevent *fde, unsigned events);
280void fdevent_add(fdevent *fde, unsigned events);
281void fdevent_del(fdevent *fde, unsigned events);
282void fdevent_loop();
283
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800284static __inline__ void adb_sleep_ms( int mseconds )
285{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200286 Sleep( mseconds );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800287}
288
Spencer Low5200c662015-07-30 23:07:55 -0700289int network_loopback_client(int port, int type, std::string* error);
290int network_loopback_server(int port, int type, std::string* error);
291int network_inaddr_any_server(int port, int type, std::string* error);
292int network_connect(const std::string& host, int port, int type, int timeout,
293 std::string* error);
294
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800295extern int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen);
296
297#undef accept
298#define accept ___xxx_accept
299
Spencer Lowf055c192015-01-25 14:40:16 -0800300extern int adb_setsockopt(int fd, int level, int optname, const void* optval, socklen_t optlen);
301
302#undef setsockopt
303#define setsockopt ___xxx_setsockopt
304
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800305extern int adb_socketpair( int sv[2] );
306
Elliott Hughes5c742702015-07-30 17:42:01 -0700307static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800308 return isalpha(path[0]) && path[1] == ':' && path[2] == '\\';
309}
310
Spencer Lowcf4ff642015-05-11 01:08:48 -0700311// We later define a macro mapping 'stat' to 'adb_stat'. This causes:
312// struct stat s;
313// stat(filename, &s);
314// To turn into the following:
315// struct adb_stat s;
316// adb_stat(filename, &s);
317// To get this to work, we need to make 'struct adb_stat' the same as
318// 'struct stat'. Note that this definition of 'struct adb_stat' uses the
319// *current* macro definition of stat, so it may actually be inheriting from
320// struct _stat32i64 (or some other remapping).
321struct adb_stat : public stat {};
322
323static_assert(sizeof(struct adb_stat) == sizeof(struct stat),
324 "structures should be the same");
325
326extern int adb_stat(const char* f, struct adb_stat* s);
327
328// stat is already a macro, undefine it so we can redefine it.
329#undef stat
330#define stat adb_stat
331
332// UTF-8 versions of POSIX APIs.
333extern DIR* adb_opendir(const char* dirname);
334extern struct dirent* adb_readdir(DIR* dir);
335extern int adb_closedir(DIR* dir);
336
337extern int adb_utime(const char *, struct utimbuf *);
338extern int adb_chmod(const char *, int);
339
340extern int adb_vfprintf(FILE *stream, const char *format, va_list ap)
341 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 0)));
Spencer Lowa30b79a2015-11-15 16:29:36 -0800342extern int adb_vprintf(const char *format, va_list ap)
343 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 0)));
Spencer Lowcf4ff642015-05-11 01:08:48 -0700344extern int adb_fprintf(FILE *stream, const char *format, ...)
345 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 3)));
346extern int adb_printf(const char *format, ...)
347 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 2)));
348
349extern int adb_fputs(const char* buf, FILE* stream);
350extern int adb_fputc(int ch, FILE* stream);
Spencer Lowa30b79a2015-11-15 16:29:36 -0800351extern int adb_putchar(int ch);
352extern int adb_puts(const char* buf);
Spencer Lowcf4ff642015-05-11 01:08:48 -0700353extern size_t adb_fwrite(const void* ptr, size_t size, size_t nmemb,
354 FILE* stream);
355
356extern FILE* adb_fopen(const char* f, const char* m);
357
358extern char* adb_getenv(const char* name);
359
360extern char* adb_getcwd(char* buf, int size);
361
362// Remap calls to POSIX APIs to our UTF-8 versions.
363#define opendir adb_opendir
364#define readdir adb_readdir
365#define closedir adb_closedir
366#define rewinddir rewinddir_utf8_not_yet_implemented
367#define telldir telldir_utf8_not_yet_implemented
Spencer Low363af562015-11-07 18:51:54 -0800368// Some compiler's C++ headers have members named seekdir, so we can't do the
369// macro technique and instead cause a link error if seekdir is called.
370inline void seekdir(DIR*, long) {
371 extern int seekdir_utf8_not_yet_implemented;
372 seekdir_utf8_not_yet_implemented = 1;
373}
Spencer Lowcf4ff642015-05-11 01:08:48 -0700374
375#define utime adb_utime
376#define chmod adb_chmod
377
378#define vfprintf adb_vfprintf
Spencer Lowa30b79a2015-11-15 16:29:36 -0800379#define vprintf adb_vprintf
Spencer Lowcf4ff642015-05-11 01:08:48 -0700380#define fprintf adb_fprintf
381#define printf adb_printf
382#define fputs adb_fputs
383#define fputc adb_fputc
Spencer Lowa30b79a2015-11-15 16:29:36 -0800384// putc may be a macro, so if so, undefine it, so that we can redefine it.
385#undef putc
386#define putc(c, s) adb_fputc(c, s)
387#define putchar adb_putchar
388#define puts adb_puts
Spencer Lowcf4ff642015-05-11 01:08:48 -0700389#define fwrite adb_fwrite
390
391#define fopen adb_fopen
Spencer Lowa30b79a2015-11-15 16:29:36 -0800392#define freopen freopen_utf8_not_yet_implemented
Spencer Lowcf4ff642015-05-11 01:08:48 -0700393
394#define getenv adb_getenv
395#define putenv putenv_utf8_not_yet_implemented
396#define setenv setenv_utf8_not_yet_implemented
397#define unsetenv unsetenv_utf8_not_yet_implemented
398
399#define getcwd adb_getcwd
400
Spencer Low0a796002015-10-18 16:45:09 -0700401char* adb_strerror(int err);
402#define strerror adb_strerror
403
Spencer Lowcf4ff642015-05-11 01:08:48 -0700404// Helper class to convert UTF-16 argv from wmain() to UTF-8 args that can be
405// passed to main().
406class NarrowArgs {
407public:
408 NarrowArgs(int argc, wchar_t** argv);
409 ~NarrowArgs();
410
411 inline char** data() {
412 return narrow_args;
413 }
414
415private:
416 char** narrow_args;
417};
418
Spencer Low5c398d22015-08-08 15:07:07 -0700419// Windows HANDLE values only use 32-bits of the type, even on 64-bit machines,
420// so they can fit in an int. To convert back, we just need to sign-extend.
421// https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203%28v=vs.85%29.aspx
422// Note that this does not make a HANDLE value work with APIs like open(), nor
423// does this make a value from open() passable to APIs taking a HANDLE. This
424// just lets you take a HANDLE, pass it around as an int, and then use it again
425// as a HANDLE.
426inline int cast_handle_to_int(const HANDLE h) {
427 // truncate
428 return static_cast<int>(reinterpret_cast<INT_PTR>(h));
429}
430
431inline HANDLE cast_int_to_handle(const int fd) {
432 // sign-extend
433 return reinterpret_cast<HANDLE>(static_cast<INT_PTR>(fd));
434}
435
Spencer Low2122c7a2015-08-26 18:46:09 -0700436// Deleter for unique_handle. Adapted from many sources, including:
437// http://stackoverflow.com/questions/14841396/stdunique-ptr-deleters-and-the-win32-api
438// https://visualstudiomagazine.com/articles/2013/09/01/get-a-handle-on-the-windows-api.aspx
439class handle_deleter {
440public:
441 typedef HANDLE pointer;
442
443 void operator()(HANDLE h);
444};
445
446// Like std::unique_ptr, but for Windows HANDLE objects that should be
447// CloseHandle()'d. Operator bool() only checks if the handle != nullptr,
448// but does not check if the handle != INVALID_HANDLE_VALUE.
449typedef std::unique_ptr<HANDLE, handle_deleter> unique_handle;
450
Spencer Lowa30b79a2015-11-15 16:29:36 -0800451namespace internal {
452
453size_t ParseCompleteUTF8(const char* first, const char* last, std::vector<char>* remaining_bytes);
454
455}
456
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800457#else /* !_WIN32 a.k.a. Unix */
458
David 'Digit' Turner414ff7d2009-05-18 17:07:46 +0200459#include "fdevent.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800460#include <cutils/misc.h>
Spencer Low5200c662015-07-30 23:07:55 -0700461#include <cutils/sockets.h>
Spencer Low8d8126a2015-07-21 02:06:26 -0700462#include <cutils/threads.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800463#include <signal.h>
464#include <sys/wait.h>
465#include <sys/stat.h>
466#include <fcntl.h>
467
468#include <pthread.h>
469#include <unistd.h>
470#include <fcntl.h>
471#include <stdarg.h>
Spencer Low5200c662015-07-30 23:07:55 -0700472#include <netdb.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800473#include <netinet/in.h>
474#include <netinet/tcp.h>
475#include <string.h>
Kenny Root73167412012-10-12 15:26:45 -0700476#include <unistd.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800477
Alex Vallée47d67c92015-05-06 16:26:00 -0400478#include <string>
479
Elliott Hughes5c742702015-07-30 17:42:01 -0700480#define OS_PATH_SEPARATORS "/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800481#define OS_PATH_SEPARATOR '/'
482#define OS_PATH_SEPARATOR_STR "/"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -0700483#define ENV_PATH_SEPARATOR_STR ":"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800484
Josh Gao07db1192015-11-07 15:38:19 -0800485static __inline__ bool adb_is_separator(char c) {
486 return c == '/';
487}
488
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800489typedef pthread_mutex_t adb_mutex_t;
JP Abgrall408fa572011-03-16 15:57:42 -0700490
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800491#define ADB_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
492#define adb_mutex_init pthread_mutex_init
493#define adb_mutex_lock pthread_mutex_lock
494#define adb_mutex_unlock pthread_mutex_unlock
495#define adb_mutex_destroy pthread_mutex_destroy
496
JP Abgrall408fa572011-03-16 15:57:42 -0700497#define ADB_MUTEX_DEFINE(m) adb_mutex_t m = PTHREAD_MUTEX_INITIALIZER
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800498
499#define adb_cond_t pthread_cond_t
500#define adb_cond_init pthread_cond_init
501#define adb_cond_wait pthread_cond_wait
502#define adb_cond_broadcast pthread_cond_broadcast
503#define adb_cond_signal pthread_cond_signal
504#define adb_cond_destroy pthread_cond_destroy
505
JP Abgrall408fa572011-03-16 15:57:42 -0700506/* declare all mutexes */
507#define ADB_MUTEX(x) extern adb_mutex_t x;
508#include "mutex_list.h"
509
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800510static __inline__ void close_on_exec(int fd)
511{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200512 fcntl( fd, F_SETFD, FD_CLOEXEC );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800513}
514
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700515// Open a file and return a file descriptor that may be used with unix_read(),
516// unix_write(), unix_close(), but not adb_read(), adb_write(), adb_close().
517//
518// On Unix, this is based on open(), so the file descriptor is a real OS file
519// descriptor, but the Windows implementation (in sysdeps_win32.cpp) returns a
520// file descriptor that can only be used with C Runtime APIs (which are wrapped
521// by unix_read(), unix_write(), unix_close()). Also, the C Runtime has
522// configurable CR/LF translation which defaults to text mode, but is settable
523// with _setmode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800524static __inline__ int unix_open(const char* path, int options,...)
525{
526 if ((options & O_CREAT) == 0)
527 {
Kenny Root73167412012-10-12 15:26:45 -0700528 return TEMP_FAILURE_RETRY( open(path, options) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800529 }
530 else
531 {
532 int mode;
533 va_list args;
534 va_start( args, options );
535 mode = va_arg( args, int );
536 va_end( args );
Kenny Root73167412012-10-12 15:26:45 -0700537 return TEMP_FAILURE_RETRY( open( path, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800538 }
539}
540
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700541// Similar to the two-argument adb_open(), but takes a mode parameter for file
542// creation. See adb_open() for more info.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800543static __inline__ int adb_open_mode( const char* pathname, int options, int mode )
544{
Kenny Root73167412012-10-12 15:26:45 -0700545 return TEMP_FAILURE_RETRY( open( pathname, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800546}
547
548
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700549// Open a file and return a file descriptor that may be used with adb_read(),
550// adb_write(), adb_close(), but not unix_read(), unix_write(), unix_close().
551//
552// On Unix, this is based on open(), but the Windows implementation (in
553// sysdeps_win32.cpp) uses Windows native file I/O and bypasses the C Runtime
554// and its CR/LF translation. The returned file descriptor should be used with
555// adb_read(), adb_write(), adb_close(), etc.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800556static __inline__ int adb_open( const char* pathname, int options )
557{
Kenny Root73167412012-10-12 15:26:45 -0700558 int fd = TEMP_FAILURE_RETRY( open( pathname, options ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800559 if (fd < 0)
560 return -1;
561 close_on_exec( fd );
562 return fd;
563}
564#undef open
565#define open ___xxx_open
566
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400567static __inline__ int adb_shutdown(int fd)
568{
569 return shutdown(fd, SHUT_RDWR);
570}
David Pursell1ed57f02015-10-06 15:30:03 -0700571static __inline__ int adb_shutdown(int fd, int direction)
572{
573 return shutdown(fd, direction);
574}
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400575#undef shutdown
576#define shutdown ____xxx_shutdown
577
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700578// Closes a file descriptor that came from adb_open() or adb_open_mode(), but
579// not designed to take a file descriptor from unix_open(). See the comments
580// for adb_open() for more info.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800581static __inline__ int adb_close(int fd)
582{
583 return close(fd);
584}
585#undef close
586#define close ____xxx_close
587
588
589static __inline__ int adb_read(int fd, void* buf, size_t len)
590{
Kenny Root73167412012-10-12 15:26:45 -0700591 return TEMP_FAILURE_RETRY( read( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800592}
593
Spencer Low2e02dc62015-11-07 17:34:39 -0800594// Like unix_read(), but does not handle EINTR.
595static __inline__ int unix_read_interruptible(int fd, void* buf, size_t len) {
596 return read(fd, buf, len);
597}
598
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800599#undef read
600#define read ___xxx_read
601
602static __inline__ int adb_write(int fd, const void* buf, size_t len)
603{
Kenny Root73167412012-10-12 15:26:45 -0700604 return TEMP_FAILURE_RETRY( write( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800605}
606#undef write
607#define write ___xxx_write
608
609static __inline__ int adb_lseek(int fd, int pos, int where)
610{
611 return lseek(fd, pos, where);
612}
613#undef lseek
614#define lseek ___xxx_lseek
615
616static __inline__ int adb_unlink(const char* path)
617{
618 return unlink(path);
619}
620#undef unlink
621#define unlink ___xxx_unlink
622
623static __inline__ int adb_creat(const char* path, int mode)
624{
Kenny Root73167412012-10-12 15:26:45 -0700625 int fd = TEMP_FAILURE_RETRY( creat( path, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800626
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200627 if ( fd < 0 )
628 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800629
630 close_on_exec(fd);
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200631 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800632}
633#undef creat
634#define creat ___xxx_creat
635
David Pursellc5b8ad82015-10-28 14:29:51 -0700636static __inline__ int unix_isatty(int fd) {
637 return isatty(fd);
638}
639#define isatty ___xxx_isatty
640
Spencer Low5200c662015-07-30 23:07:55 -0700641// Helper for network_* functions.
642inline int _fd_set_error_str(int fd, std::string* error) {
643 if (fd == -1) {
644 *error = strerror(errno);
645 }
646 return fd;
647}
648
649inline int network_loopback_client(int port, int type, std::string* error) {
650 return _fd_set_error_str(socket_loopback_client(port, type), error);
651}
652
653inline int network_loopback_server(int port, int type, std::string* error) {
654 return _fd_set_error_str(socket_loopback_server(port, type), error);
655}
656
657inline int network_inaddr_any_server(int port, int type, std::string* error) {
658 return _fd_set_error_str(socket_inaddr_any_server(port, type), error);
659}
660
661inline int network_local_server(const char *name, int namespace_id, int type,
662 std::string* error) {
663 return _fd_set_error_str(socket_local_server(name, namespace_id, type),
664 error);
665}
666
667inline int network_connect(const std::string& host, int port, int type,
668 int timeout, std::string* error) {
669 int getaddrinfo_error = 0;
670 int fd = socket_network_client_timeout(host.c_str(), port, type, timeout,
671 &getaddrinfo_error);
672 if (fd != -1) {
673 return fd;
674 }
675 if (getaddrinfo_error != 0) {
676 *error = gai_strerror(getaddrinfo_error);
677 } else {
678 *error = strerror(errno);
679 }
680 return -1;
681}
682
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800683static __inline__ int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen)
684{
Benoit Goby95ef8282011-02-01 18:57:41 -0800685 int fd;
686
Kenny Root73167412012-10-12 15:26:45 -0700687 fd = TEMP_FAILURE_RETRY( accept( serverfd, addr, addrlen ) );
Benoit Goby95ef8282011-02-01 18:57:41 -0800688 if (fd >= 0)
689 close_on_exec(fd);
690
691 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800692}
693
694#undef accept
695#define accept ___xxx_accept
696
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700697// Operate on a file descriptor returned from unix_open() or a well-known file
698// descriptor such as STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
699//
700// On Unix, unix_read(), unix_write(), unix_close() map to adb_read(),
701// adb_write(), adb_close() (which all map to Unix system calls), but the
702// Windows implementations (in the ifdef above and in sysdeps_win32.cpp) call
703// into the C Runtime and its configurable CR/LF translation (which is settable
704// via _setmode()).
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800705#define unix_read adb_read
706#define unix_write adb_write
707#define unix_close adb_close
708
Josh Gaob5fea142016-02-12 14:31:15 -0800709// Win32 is limited to DWORDs for thread return values; limit the POSIX systems to this as well to
710// ensure compatibility.
711typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800712typedef pthread_t adb_thread_t;
713
Josh Gaob5fea142016-02-12 14:31:15 -0800714struct adb_pthread_args {
715 adb_thread_func_t func;
716 void* arg;
717};
718
719static void* adb_pthread_wrapper(void* heap_args) {
720 // Move the arguments from the heap onto the thread's stack.
721 adb_pthread_args thread_args = *reinterpret_cast<adb_pthread_args*>(heap_args);
722 delete static_cast<adb_pthread_args*>(heap_args);
723 thread_args.func(thread_args.arg);
724 return nullptr;
725}
726
Josh Gao3b3e10d2016-02-09 14:59:09 -0800727static __inline__ bool adb_thread_create(adb_thread_func_t start, void* arg,
728 adb_thread_t* thread = nullptr) {
729 pthread_t temp;
Elliott Hughes9b0f3542015-05-05 13:41:21 -0700730 pthread_attr_t attr;
731 pthread_attr_init(&attr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800732 pthread_attr_setdetachstate(&attr, thread ? PTHREAD_CREATE_JOINABLE : PTHREAD_CREATE_DETACHED);
Josh Gaob5fea142016-02-12 14:31:15 -0800733 auto* pthread_args = new adb_pthread_args{.func = start, .arg = arg};
734 errno = pthread_create(&temp, &attr, adb_pthread_wrapper, pthread_args);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800735 if (errno == 0) {
736 if (thread) {
737 *thread = temp;
738 }
739 return true;
740 }
741 return false;
742}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800743
Josh Gao3b3e10d2016-02-09 14:59:09 -0800744static __inline__ bool adb_thread_join(adb_thread_t thread) {
745 errno = pthread_join(thread, nullptr);
746 return errno == 0;
747}
748
749static __inline__ bool adb_thread_detach(adb_thread_t thread) {
750 errno = pthread_detach(thread);
751 return errno == 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800752}
753
Josh Gaob5fea142016-02-12 14:31:15 -0800754static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
755 pthread_exit(nullptr);
756}
757
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700758static __inline__ int adb_thread_setname(const std::string& name) {
759#ifdef __APPLE__
760 return pthread_setname_np(name.c_str());
761#else
762 const char *s = name.c_str();
763
764 // pthread_setname_np fails rather than truncating long strings.
765 const int max_task_comm_len = 16; // including the null terminator
766 if (name.length() > (max_task_comm_len - 1)) {
767 char buf[max_task_comm_len];
768 strncpy(buf, name.c_str(), sizeof(buf) - 1);
769 buf[sizeof(buf) - 1] = '\0';
770 s = buf;
771 }
772
773 return pthread_setname_np(pthread_self(), s) ;
774#endif
775}
776
Spencer Lowf055c192015-01-25 14:40:16 -0800777static __inline__ int adb_setsockopt( int fd, int level, int optname, const void* optval, socklen_t optlen )
778{
779 return setsockopt( fd, level, optname, optval, optlen );
780}
781
782#undef setsockopt
783#define setsockopt ___xxx_setsockopt
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800784
785static __inline__ int unix_socketpair( int d, int type, int protocol, int sv[2] )
786{
787 return socketpair( d, type, protocol, sv );
788}
789
790static __inline__ int adb_socketpair( int sv[2] )
791{
792 int rc;
793
794 rc = unix_socketpair( AF_UNIX, SOCK_STREAM, 0, sv );
795 if (rc < 0)
796 return -1;
797
798 close_on_exec( sv[0] );
799 close_on_exec( sv[1] );
800 return 0;
801}
802
803#undef socketpair
804#define socketpair ___xxx_socketpair
805
806static __inline__ void adb_sleep_ms( int mseconds )
807{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200808 usleep( mseconds*1000 );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800809}
810
Alex Vallée47d67c92015-05-06 16:26:00 -0400811static __inline__ int adb_mkdir(const std::string& path, int mode)
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800812{
Alex Vallée47d67c92015-05-06 16:26:00 -0400813 return mkdir(path.c_str(), mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800814}
Alex Vallée47d67c92015-05-06 16:26:00 -0400815
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800816#undef mkdir
817#define mkdir ___xxx_mkdir
818
819static __inline__ void adb_sysdeps_init(void)
820{
821}
822
Alex Vallée47d67c92015-05-06 16:26:00 -0400823static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800824 return path[0] == '/';
825}
826
leozwangcbf02672014-08-15 09:51:27 -0700827static __inline__ unsigned long adb_thread_id()
828{
Spencer Low8d8126a2015-07-21 02:06:26 -0700829 return (unsigned long)gettid();
leozwangcbf02672014-08-15 09:51:27 -0700830}
831
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800832#endif /* !_WIN32 */
833
Elliott Hughescc65c3b2015-11-20 22:01:06 -0800834static inline void disable_tcp_nagle(int fd) {
835 int off = 1;
836 adb_setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &off, sizeof(off));
837}
838
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800839#endif /* _ADB_SYSDEPS_H */