blob: 8d99722b554ec31814df06af150d7001594b8501 [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
Josh Gao13ea01d2016-05-13 14:52:06 -070032// Include this before open/close/unlink are defined as macros below.
Josh Gao3b3e10d2016-02-09 14:59:09 -080033#include <android-base/errors.h>
Josh Gao13ea01d2016-05-13 14:52:06 -070034#include <android-base/unique_fd.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080035#include <android-base/utf8.h>
Spencer Lowd21dc822015-11-12 15:20:15 -080036
Josh Gaof551ea02016-07-28 18:09:48 -070037#include "sysdeps/stat.h"
38
Dan Albertcc731cc2015-02-24 21:26:58 -080039/*
40 * TEMP_FAILURE_RETRY is defined by some, but not all, versions of
41 * <unistd.h>. (Alas, it is not as standard as we'd hoped!) So, if it's
42 * not already defined, then define it here.
43 */
44#ifndef TEMP_FAILURE_RETRY
45/* Used to retry syscalls that can return EINTR. */
46#define TEMP_FAILURE_RETRY(exp) ({ \
47 typeof (exp) _rc; \
48 do { \
49 _rc = (exp); \
50 } while (_rc == -1 && errno == EINTR); \
51 _rc; })
52#endif
53
Spencer Lowcf4ff642015-05-11 01:08:48 -070054// Some printf-like functions are implemented in terms of
55// android::base::StringAppendV, so they should use the same attribute for
56// compile-time format string checking. On Windows, if the mingw version of
57// vsnprintf is used in StringAppendV, use `gnu_printf' which allows z in %zd
58// and PRIu64 (and related) to be recognized by the compile-time checking.
59#define ADB_FORMAT_ARCHETYPE __printf__
60#ifdef __USE_MINGW_ANSI_STDIO
61#if __USE_MINGW_ANSI_STDIO
62#undef ADB_FORMAT_ARCHETYPE
63#define ADB_FORMAT_ARCHETYPE gnu_printf
64#endif
65#endif
66
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080067#ifdef _WIN32
68
Josh Gaoa166e712016-01-29 12:08:34 -080069// Clang-only nullability specifiers
70#define _Nonnull
71#define _Nullable
72
Dan Albert630b9af2014-11-24 23:34:35 -080073#include <ctype.h>
74#include <direct.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070075#include <dirent.h>
Dan Albert630b9af2014-11-24 23:34:35 -080076#include <errno.h>
77#include <fcntl.h>
78#include <io.h>
79#include <process.h>
80#include <sys/stat.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070081#include <utime.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080082#include <winsock2.h>
Stephen Hines2f431a82014-10-01 17:37:06 -070083#include <windows.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080084#include <ws2tcpip.h>
Dan Albert630b9af2014-11-24 23:34:35 -080085
Spencer Low2122c7a2015-08-26 18:46:09 -070086#include <memory> // unique_ptr
Spencer Lowd21dc822015-11-12 15:20:15 -080087#include <string>
Alex Vallée47d67c92015-05-06 16:26:00 -040088
Dan Albert630b9af2014-11-24 23:34:35 -080089#include "fdevent.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080090
Elliott Hughes5c742702015-07-30 17:42:01 -070091#define OS_PATH_SEPARATORS "\\/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080092#define OS_PATH_SEPARATOR '\\'
93#define OS_PATH_SEPARATOR_STR "\\"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -070094#define ENV_PATH_SEPARATOR_STR ";"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080095
Josh Gao07db1192015-11-07 15:38:19 -080096static __inline__ bool adb_is_separator(char c) {
97 return c == '\\' || c == '/';
98}
99
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800100typedef CRITICAL_SECTION adb_mutex_t;
101
102#define ADB_MUTEX_DEFINE(x) adb_mutex_t x
103
104/* declare all mutexes */
JP Abgrall408fa572011-03-16 15:57:42 -0700105/* For win32, adb_sysdeps_init() will do the mutex runtime initialization. */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800106#define ADB_MUTEX(x) extern adb_mutex_t x;
107#include "mutex_list.h"
108
109extern void adb_sysdeps_init(void);
110
111static __inline__ void adb_mutex_lock( adb_mutex_t* lock )
112{
113 EnterCriticalSection( lock );
114}
115
116static __inline__ void adb_mutex_unlock( adb_mutex_t* lock )
117{
118 LeaveCriticalSection( lock );
119}
120
Josh Gaob5fea142016-02-12 14:31:15 -0800121typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800122typedef HANDLE adb_thread_t;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800123
Josh Gaob5fea142016-02-12 14:31:15 -0800124struct adb_winthread_args {
Josh Gao3b3e10d2016-02-09 14:59:09 -0800125 adb_thread_func_t func;
126 void* arg;
127};
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800128
Josh Gaob5fea142016-02-12 14:31:15 -0800129static unsigned __stdcall adb_winthread_wrapper(void* heap_args) {
130 // Move the arguments from the heap onto the thread's stack.
131 adb_winthread_args thread_args = *static_cast<adb_winthread_args*>(heap_args);
132 delete static_cast<adb_winthread_args*>(heap_args);
133 thread_args.func(thread_args.arg);
134 return 0;
Josh Gao3b3e10d2016-02-09 14:59:09 -0800135}
136
137static __inline__ bool adb_thread_create(adb_thread_func_t func, void* arg,
138 adb_thread_t* thread = nullptr) {
Josh Gaob5fea142016-02-12 14:31:15 -0800139 adb_winthread_args* args = new adb_winthread_args{.func = func, .arg = arg};
140 uintptr_t handle = _beginthreadex(nullptr, 0, adb_winthread_wrapper, args, 0, nullptr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800141 if (handle != static_cast<uintptr_t>(0)) {
142 if (thread) {
143 *thread = reinterpret_cast<HANDLE>(handle);
144 } else {
145 CloseHandle(thread);
146 }
147 return true;
148 }
149 return false;
150}
151
152static __inline__ bool adb_thread_join(adb_thread_t thread) {
153 switch (WaitForSingleObject(thread, INFINITE)) {
154 case WAIT_OBJECT_0:
155 CloseHandle(thread);
156 return true;
157
158 case WAIT_FAILED:
159 fprintf(stderr, "adb_thread_join failed: %s\n",
160 android::base::SystemErrorCodeToString(GetLastError()).c_str());
161 break;
162
163 default:
164 abort();
165 }
166
167 return false;
168}
169
170static __inline__ bool adb_thread_detach(adb_thread_t thread) {
171 CloseHandle(thread);
172 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800173}
174
Josh Gaob5fea142016-02-12 14:31:15 -0800175static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
Josh Gaod7b37492016-02-12 15:45:04 -0800176 _endthreadex(0);
Josh Gaob5fea142016-02-12 14:31:15 -0800177}
178
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700179static __inline__ int adb_thread_setname(const std::string& name) {
180 // TODO: See https://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx for how to set
181 // the thread name in Windows. Unfortunately, it only works during debugging, but
182 // our build process doesn't generate PDB files needed for debugging.
183 return 0;
184}
185
Josh Gao3777d2e2016-02-16 17:34:53 -0800186static __inline__ adb_thread_t adb_thread_self() {
187 return GetCurrentThread();
188}
189
190static __inline__ bool adb_thread_equal(adb_thread_t lhs, adb_thread_t rhs) {
191 return GetThreadId(lhs) == GetThreadId(rhs);
192}
193
leozwangcbf02672014-08-15 09:51:27 -0700194static __inline__ unsigned long adb_thread_id()
195{
196 return GetCurrentThreadId();
197}
198
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800199static __inline__ void close_on_exec(int fd)
200{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200201 /* nothing really */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800202}
203
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800204#define S_ISLNK(m) 0 /* no symlinks on Win32 */
205
Spencer Lowcf4ff642015-05-11 01:08:48 -0700206extern int adb_unlink(const char* path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800207#undef unlink
208#define unlink ___xxx_unlink
209
Spencer Lowcf4ff642015-05-11 01:08:48 -0700210extern int adb_mkdir(const std::string& path, int mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800211#undef mkdir
212#define mkdir ___xxx_mkdir
213
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700214// See the comments for the !defined(_WIN32) versions of adb_*().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800215extern int adb_open(const char* path, int options);
216extern int adb_creat(const char* path, int mode);
217extern int adb_read(int fd, void* buf, int len);
218extern int adb_write(int fd, const void* buf, int len);
219extern int adb_lseek(int fd, int pos, int where);
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400220extern int adb_shutdown(int fd);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800221extern int adb_close(int fd);
222
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700223// See the comments for the !defined(_WIN32) version of unix_close().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800224static __inline__ int unix_close(int fd)
225{
226 return close(fd);
227}
228#undef close
229#define close ____xxx_close
230
Spencer Low2e02dc62015-11-07 17:34:39 -0800231// Like unix_read(), but may return EINTR.
232extern int unix_read_interruptible(int fd, void* buf, size_t len);
233
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700234// See the comments for the !defined(_WIN32) version of unix_read().
Spencer Low2e02dc62015-11-07 17:34:39 -0800235static __inline__ int unix_read(int fd, void* buf, size_t len) {
236 return TEMP_FAILURE_RETRY(unix_read_interruptible(fd, buf, len));
237}
Spencer Low50184062015-03-01 15:06:21 -0800238
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800239#undef read
240#define read ___xxx_read
241
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700242// See the comments for the !defined(_WIN32) version of unix_write().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800243static __inline__ int unix_write(int fd, const void* buf, size_t len)
244{
245 return write(fd, buf, len);
246}
247#undef write
248#define write ___xxx_write
249
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700250// See the comments for the !defined(_WIN32) version of adb_open_mode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800251static __inline__ int adb_open_mode(const char* path, int options, int mode)
252{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200253 return adb_open(path, options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800254}
255
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700256// See the comments for the !defined(_WIN32) version of unix_open().
Spencer Lowcf4ff642015-05-11 01:08:48 -0700257extern int unix_open(const char* path, int options, ...);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800258#define open ___xxx_unix_open
259
David Pursellc5b8ad82015-10-28 14:29:51 -0700260// Checks if |fd| corresponds to a console.
261// Standard Windows isatty() returns 1 for both console FDs and character
262// devices like NUL. unix_isatty() performs some extra checking to only match
263// console FDs.
264// |fd| must be a real file descriptor, meaning STDxx_FILENO or unix_open() FDs
265// will work but adb_open() FDs will not. Additionally the OS handle associated
266// with |fd| must have GENERIC_READ access (which console FDs have by default).
267// Returns 1 if |fd| is a console FD, 0 otherwise. The value of errno after
268// calling this function is unreliable and should not be used.
269int unix_isatty(int fd);
270#define isatty ___xxx_isatty
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800271
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800272static __inline__ void adb_sleep_ms( int mseconds )
273{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200274 Sleep( mseconds );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800275}
276
Spencer Low5200c662015-07-30 23:07:55 -0700277int network_loopback_client(int port, int type, std::string* error);
278int network_loopback_server(int port, int type, std::string* error);
279int network_inaddr_any_server(int port, int type, std::string* error);
Josh Gaocfb21412016-08-24 18:38:44 -0700280
281inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
282 abort();
283}
284
285inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
286 abort();
287}
288
Spencer Low5200c662015-07-30 23:07:55 -0700289int network_connect(const std::string& host, int port, int type, int timeout,
290 std::string* error);
291
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800292extern int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen);
293
294#undef accept
295#define accept ___xxx_accept
296
Josh Gao59901912016-08-23 15:28:43 -0700297int adb_getsockname(int fd, struct sockaddr* sockaddr, socklen_t* optlen);
298#undef getsockname
299#define getsockname(...) ___xxx_getsockname(__VA__ARGS__)
300
David Purselleaae97e2016-04-07 11:25:48 -0700301// Returns the local port number of a bound socket, or -1 on failure.
302int adb_socket_get_local_port(int fd);
303
Spencer Lowf055c192015-01-25 14:40:16 -0800304extern int adb_setsockopt(int fd, int level, int optname, const void* optval, socklen_t optlen);
305
306#undef setsockopt
307#define setsockopt ___xxx_setsockopt
308
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800309extern int adb_socketpair( int sv[2] );
310
Josh Gao3777d2e2016-02-16 17:34:53 -0800311struct adb_pollfd {
312 int fd;
313 short events;
314 short revents;
315};
316extern int adb_poll(adb_pollfd* fds, size_t nfds, int timeout);
317#define poll ___xxx_poll
318
Elliott Hughes5c742702015-07-30 17:42:01 -0700319static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800320 return isalpha(path[0]) && path[1] == ':' && path[2] == '\\';
321}
322
Spencer Lowcf4ff642015-05-11 01:08:48 -0700323// UTF-8 versions of POSIX APIs.
324extern DIR* adb_opendir(const char* dirname);
325extern struct dirent* adb_readdir(DIR* dir);
326extern int adb_closedir(DIR* dir);
327
328extern int adb_utime(const char *, struct utimbuf *);
329extern int adb_chmod(const char *, int);
330
331extern int adb_vfprintf(FILE *stream, const char *format, va_list ap)
332 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 0)));
Spencer Lowa30b79a2015-11-15 16:29:36 -0800333extern int adb_vprintf(const char *format, va_list ap)
334 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 0)));
Spencer Lowcf4ff642015-05-11 01:08:48 -0700335extern int adb_fprintf(FILE *stream, const char *format, ...)
336 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 3)));
337extern int adb_printf(const char *format, ...)
338 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 2)));
339
340extern int adb_fputs(const char* buf, FILE* stream);
341extern int adb_fputc(int ch, FILE* stream);
Spencer Lowa30b79a2015-11-15 16:29:36 -0800342extern int adb_putchar(int ch);
343extern int adb_puts(const char* buf);
Spencer Lowcf4ff642015-05-11 01:08:48 -0700344extern size_t adb_fwrite(const void* ptr, size_t size, size_t nmemb,
345 FILE* stream);
346
347extern FILE* adb_fopen(const char* f, const char* m);
348
349extern char* adb_getenv(const char* name);
350
351extern char* adb_getcwd(char* buf, int size);
352
353// Remap calls to POSIX APIs to our UTF-8 versions.
354#define opendir adb_opendir
355#define readdir adb_readdir
356#define closedir adb_closedir
357#define rewinddir rewinddir_utf8_not_yet_implemented
358#define telldir telldir_utf8_not_yet_implemented
Spencer Low363af562015-11-07 18:51:54 -0800359// Some compiler's C++ headers have members named seekdir, so we can't do the
360// macro technique and instead cause a link error if seekdir is called.
361inline void seekdir(DIR*, long) {
362 extern int seekdir_utf8_not_yet_implemented;
363 seekdir_utf8_not_yet_implemented = 1;
364}
Spencer Lowcf4ff642015-05-11 01:08:48 -0700365
366#define utime adb_utime
367#define chmod adb_chmod
368
369#define vfprintf adb_vfprintf
Spencer Lowa30b79a2015-11-15 16:29:36 -0800370#define vprintf adb_vprintf
Spencer Lowcf4ff642015-05-11 01:08:48 -0700371#define fprintf adb_fprintf
372#define printf adb_printf
373#define fputs adb_fputs
374#define fputc adb_fputc
Spencer Lowa30b79a2015-11-15 16:29:36 -0800375// putc may be a macro, so if so, undefine it, so that we can redefine it.
376#undef putc
377#define putc(c, s) adb_fputc(c, s)
378#define putchar adb_putchar
379#define puts adb_puts
Spencer Lowcf4ff642015-05-11 01:08:48 -0700380#define fwrite adb_fwrite
381
382#define fopen adb_fopen
Spencer Lowa30b79a2015-11-15 16:29:36 -0800383#define freopen freopen_utf8_not_yet_implemented
Spencer Lowcf4ff642015-05-11 01:08:48 -0700384
385#define getenv adb_getenv
386#define putenv putenv_utf8_not_yet_implemented
387#define setenv setenv_utf8_not_yet_implemented
388#define unsetenv unsetenv_utf8_not_yet_implemented
389
390#define getcwd adb_getcwd
391
Spencer Low0a796002015-10-18 16:45:09 -0700392char* adb_strerror(int err);
393#define strerror adb_strerror
394
Spencer Lowcf4ff642015-05-11 01:08:48 -0700395// Helper class to convert UTF-16 argv from wmain() to UTF-8 args that can be
396// passed to main().
397class NarrowArgs {
398public:
399 NarrowArgs(int argc, wchar_t** argv);
400 ~NarrowArgs();
401
402 inline char** data() {
403 return narrow_args;
404 }
405
406private:
407 char** narrow_args;
408};
409
Spencer Low5c398d22015-08-08 15:07:07 -0700410// Windows HANDLE values only use 32-bits of the type, even on 64-bit machines,
411// so they can fit in an int. To convert back, we just need to sign-extend.
412// https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203%28v=vs.85%29.aspx
413// Note that this does not make a HANDLE value work with APIs like open(), nor
414// does this make a value from open() passable to APIs taking a HANDLE. This
415// just lets you take a HANDLE, pass it around as an int, and then use it again
416// as a HANDLE.
417inline int cast_handle_to_int(const HANDLE h) {
418 // truncate
419 return static_cast<int>(reinterpret_cast<INT_PTR>(h));
420}
421
422inline HANDLE cast_int_to_handle(const int fd) {
423 // sign-extend
424 return reinterpret_cast<HANDLE>(static_cast<INT_PTR>(fd));
425}
426
Spencer Low2122c7a2015-08-26 18:46:09 -0700427// Deleter for unique_handle. Adapted from many sources, including:
428// http://stackoverflow.com/questions/14841396/stdunique-ptr-deleters-and-the-win32-api
429// https://visualstudiomagazine.com/articles/2013/09/01/get-a-handle-on-the-windows-api.aspx
430class handle_deleter {
431public:
432 typedef HANDLE pointer;
433
434 void operator()(HANDLE h);
435};
436
437// Like std::unique_ptr, but for Windows HANDLE objects that should be
438// CloseHandle()'d. Operator bool() only checks if the handle != nullptr,
439// but does not check if the handle != INVALID_HANDLE_VALUE.
440typedef std::unique_ptr<HANDLE, handle_deleter> unique_handle;
441
Spencer Lowa30b79a2015-11-15 16:29:36 -0800442namespace internal {
443
444size_t ParseCompleteUTF8(const char* first, const char* last, std::vector<char>* remaining_bytes);
445
446}
447
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800448#else /* !_WIN32 a.k.a. Unix */
449
Spencer Low5200c662015-07-30 23:07:55 -0700450#include <cutils/sockets.h>
Spencer Low8d8126a2015-07-21 02:06:26 -0700451#include <cutils/threads.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800452#include <fcntl.h>
Josh Gao3777d2e2016-02-16 17:34:53 -0800453#include <poll.h>
454#include <signal.h>
455#include <sys/stat.h>
456#include <sys/wait.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800457
458#include <pthread.h>
459#include <unistd.h>
460#include <fcntl.h>
461#include <stdarg.h>
Spencer Low5200c662015-07-30 23:07:55 -0700462#include <netdb.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800463#include <netinet/in.h>
464#include <netinet/tcp.h>
465#include <string.h>
Kenny Root73167412012-10-12 15:26:45 -0700466#include <unistd.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800467
Alex Vallée47d67c92015-05-06 16:26:00 -0400468#include <string>
469
Elliott Hughes5c742702015-07-30 17:42:01 -0700470#define OS_PATH_SEPARATORS "/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800471#define OS_PATH_SEPARATOR '/'
472#define OS_PATH_SEPARATOR_STR "/"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -0700473#define ENV_PATH_SEPARATOR_STR ":"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800474
Josh Gao07db1192015-11-07 15:38:19 -0800475static __inline__ bool adb_is_separator(char c) {
476 return c == '/';
477}
478
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800479typedef pthread_mutex_t adb_mutex_t;
JP Abgrall408fa572011-03-16 15:57:42 -0700480
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800481#define ADB_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
482#define adb_mutex_init pthread_mutex_init
483#define adb_mutex_lock pthread_mutex_lock
484#define adb_mutex_unlock pthread_mutex_unlock
485#define adb_mutex_destroy pthread_mutex_destroy
486
JP Abgrall408fa572011-03-16 15:57:42 -0700487#define ADB_MUTEX_DEFINE(m) adb_mutex_t m = PTHREAD_MUTEX_INITIALIZER
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800488
489#define adb_cond_t pthread_cond_t
490#define adb_cond_init pthread_cond_init
491#define adb_cond_wait pthread_cond_wait
492#define adb_cond_broadcast pthread_cond_broadcast
493#define adb_cond_signal pthread_cond_signal
494#define adb_cond_destroy pthread_cond_destroy
495
JP Abgrall408fa572011-03-16 15:57:42 -0700496/* declare all mutexes */
497#define ADB_MUTEX(x) extern adb_mutex_t x;
498#include "mutex_list.h"
499
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800500static __inline__ void close_on_exec(int fd)
501{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200502 fcntl( fd, F_SETFD, FD_CLOEXEC );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800503}
504
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700505// Open a file and return a file descriptor that may be used with unix_read(),
506// unix_write(), unix_close(), but not adb_read(), adb_write(), adb_close().
507//
508// On Unix, this is based on open(), so the file descriptor is a real OS file
509// descriptor, but the Windows implementation (in sysdeps_win32.cpp) returns a
510// file descriptor that can only be used with C Runtime APIs (which are wrapped
511// by unix_read(), unix_write(), unix_close()). Also, the C Runtime has
512// configurable CR/LF translation which defaults to text mode, but is settable
513// with _setmode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800514static __inline__ int unix_open(const char* path, int options,...)
515{
516 if ((options & O_CREAT) == 0)
517 {
Kenny Root73167412012-10-12 15:26:45 -0700518 return TEMP_FAILURE_RETRY( open(path, options) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800519 }
520 else
521 {
522 int mode;
523 va_list args;
524 va_start( args, options );
525 mode = va_arg( args, int );
526 va_end( args );
Kenny Root73167412012-10-12 15:26:45 -0700527 return TEMP_FAILURE_RETRY( open( path, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800528 }
529}
530
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700531// Similar to the two-argument adb_open(), but takes a mode parameter for file
532// creation. See adb_open() for more info.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800533static __inline__ int adb_open_mode( const char* pathname, int options, int mode )
534{
Kenny Root73167412012-10-12 15:26:45 -0700535 return TEMP_FAILURE_RETRY( open( pathname, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800536}
537
538
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700539// Open a file and return a file descriptor that may be used with adb_read(),
540// adb_write(), adb_close(), but not unix_read(), unix_write(), unix_close().
541//
542// On Unix, this is based on open(), but the Windows implementation (in
543// sysdeps_win32.cpp) uses Windows native file I/O and bypasses the C Runtime
544// and its CR/LF translation. The returned file descriptor should be used with
545// adb_read(), adb_write(), adb_close(), etc.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800546static __inline__ int adb_open( const char* pathname, int options )
547{
Kenny Root73167412012-10-12 15:26:45 -0700548 int fd = TEMP_FAILURE_RETRY( open( pathname, options ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800549 if (fd < 0)
550 return -1;
551 close_on_exec( fd );
552 return fd;
553}
554#undef open
555#define open ___xxx_open
556
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400557static __inline__ int adb_shutdown(int fd)
558{
559 return shutdown(fd, SHUT_RDWR);
560}
David Pursell1ed57f02015-10-06 15:30:03 -0700561static __inline__ int adb_shutdown(int fd, int direction)
562{
563 return shutdown(fd, direction);
564}
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400565#undef shutdown
566#define shutdown ____xxx_shutdown
567
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700568// Closes a file descriptor that came from adb_open() or adb_open_mode(), but
569// not designed to take a file descriptor from unix_open(). See the comments
570// for adb_open() for more info.
Josh Gaof0d3b4f2016-03-04 15:15:56 -0800571__inline__ int adb_close(int fd) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800572 return close(fd);
573}
574#undef close
575#define close ____xxx_close
576
577
578static __inline__ int adb_read(int fd, void* buf, size_t len)
579{
Kenny Root73167412012-10-12 15:26:45 -0700580 return TEMP_FAILURE_RETRY( read( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800581}
582
Spencer Low2e02dc62015-11-07 17:34:39 -0800583// Like unix_read(), but does not handle EINTR.
584static __inline__ int unix_read_interruptible(int fd, void* buf, size_t len) {
585 return read(fd, buf, len);
586}
587
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800588#undef read
589#define read ___xxx_read
590
591static __inline__ int adb_write(int fd, const void* buf, size_t len)
592{
Kenny Root73167412012-10-12 15:26:45 -0700593 return TEMP_FAILURE_RETRY( write( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800594}
595#undef write
596#define write ___xxx_write
597
598static __inline__ int adb_lseek(int fd, int pos, int where)
599{
600 return lseek(fd, pos, where);
601}
602#undef lseek
603#define lseek ___xxx_lseek
604
605static __inline__ int adb_unlink(const char* path)
606{
607 return unlink(path);
608}
609#undef unlink
610#define unlink ___xxx_unlink
611
612static __inline__ int adb_creat(const char* path, int mode)
613{
Kenny Root73167412012-10-12 15:26:45 -0700614 int fd = TEMP_FAILURE_RETRY( creat( path, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800615
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200616 if ( fd < 0 )
617 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800618
619 close_on_exec(fd);
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200620 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800621}
622#undef creat
623#define creat ___xxx_creat
624
David Pursellc5b8ad82015-10-28 14:29:51 -0700625static __inline__ int unix_isatty(int fd) {
626 return isatty(fd);
627}
628#define isatty ___xxx_isatty
629
Spencer Low5200c662015-07-30 23:07:55 -0700630// Helper for network_* functions.
631inline int _fd_set_error_str(int fd, std::string* error) {
632 if (fd == -1) {
633 *error = strerror(errno);
634 }
635 return fd;
636}
637
638inline int network_loopback_client(int port, int type, std::string* error) {
639 return _fd_set_error_str(socket_loopback_client(port, type), error);
640}
641
642inline int network_loopback_server(int port, int type, std::string* error) {
643 return _fd_set_error_str(socket_loopback_server(port, type), error);
644}
645
646inline int network_inaddr_any_server(int port, int type, std::string* error) {
647 return _fd_set_error_str(socket_inaddr_any_server(port, type), error);
648}
649
Josh Gaocfb21412016-08-24 18:38:44 -0700650inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
651 return _fd_set_error_str(socket_local_client(name, namespace_id, type), error);
652}
653
654inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
655 return _fd_set_error_str(socket_local_server(name, namespace_id, type), error);
Spencer Low5200c662015-07-30 23:07:55 -0700656}
657
658inline int network_connect(const std::string& host, int port, int type,
659 int timeout, std::string* error) {
660 int getaddrinfo_error = 0;
661 int fd = socket_network_client_timeout(host.c_str(), port, type, timeout,
662 &getaddrinfo_error);
663 if (fd != -1) {
664 return fd;
665 }
666 if (getaddrinfo_error != 0) {
667 *error = gai_strerror(getaddrinfo_error);
668 } else {
669 *error = strerror(errno);
670 }
671 return -1;
672}
673
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800674static __inline__ int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen)
675{
Benoit Goby95ef8282011-02-01 18:57:41 -0800676 int fd;
677
Kenny Root73167412012-10-12 15:26:45 -0700678 fd = TEMP_FAILURE_RETRY( accept( serverfd, addr, addrlen ) );
Benoit Goby95ef8282011-02-01 18:57:41 -0800679 if (fd >= 0)
680 close_on_exec(fd);
681
682 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800683}
684
685#undef accept
686#define accept ___xxx_accept
687
David Purselleaae97e2016-04-07 11:25:48 -0700688inline int adb_socket_get_local_port(int fd) {
689 return socket_get_local_port(fd);
690}
691
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700692// Operate on a file descriptor returned from unix_open() or a well-known file
693// descriptor such as STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
694//
695// On Unix, unix_read(), unix_write(), unix_close() map to adb_read(),
696// adb_write(), adb_close() (which all map to Unix system calls), but the
697// Windows implementations (in the ifdef above and in sysdeps_win32.cpp) call
698// into the C Runtime and its configurable CR/LF translation (which is settable
699// via _setmode()).
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800700#define unix_read adb_read
701#define unix_write adb_write
702#define unix_close adb_close
703
Josh Gaob5fea142016-02-12 14:31:15 -0800704// Win32 is limited to DWORDs for thread return values; limit the POSIX systems to this as well to
705// ensure compatibility.
706typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800707typedef pthread_t adb_thread_t;
708
Josh Gaob5fea142016-02-12 14:31:15 -0800709struct adb_pthread_args {
710 adb_thread_func_t func;
711 void* arg;
712};
713
714static void* adb_pthread_wrapper(void* heap_args) {
715 // Move the arguments from the heap onto the thread's stack.
716 adb_pthread_args thread_args = *reinterpret_cast<adb_pthread_args*>(heap_args);
717 delete static_cast<adb_pthread_args*>(heap_args);
718 thread_args.func(thread_args.arg);
719 return nullptr;
720}
721
Josh Gao3b3e10d2016-02-09 14:59:09 -0800722static __inline__ bool adb_thread_create(adb_thread_func_t start, void* arg,
723 adb_thread_t* thread = nullptr) {
724 pthread_t temp;
Elliott Hughes9b0f3542015-05-05 13:41:21 -0700725 pthread_attr_t attr;
726 pthread_attr_init(&attr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800727 pthread_attr_setdetachstate(&attr, thread ? PTHREAD_CREATE_JOINABLE : PTHREAD_CREATE_DETACHED);
Josh Gaob5fea142016-02-12 14:31:15 -0800728 auto* pthread_args = new adb_pthread_args{.func = start, .arg = arg};
729 errno = pthread_create(&temp, &attr, adb_pthread_wrapper, pthread_args);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800730 if (errno == 0) {
731 if (thread) {
732 *thread = temp;
733 }
734 return true;
735 }
736 return false;
737}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800738
Josh Gao3b3e10d2016-02-09 14:59:09 -0800739static __inline__ bool adb_thread_join(adb_thread_t thread) {
740 errno = pthread_join(thread, nullptr);
741 return errno == 0;
742}
743
744static __inline__ bool adb_thread_detach(adb_thread_t thread) {
745 errno = pthread_detach(thread);
746 return errno == 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800747}
748
Josh Gaob5fea142016-02-12 14:31:15 -0800749static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
750 pthread_exit(nullptr);
751}
752
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700753static __inline__ int adb_thread_setname(const std::string& name) {
754#ifdef __APPLE__
755 return pthread_setname_np(name.c_str());
756#else
757 const char *s = name.c_str();
758
759 // pthread_setname_np fails rather than truncating long strings.
760 const int max_task_comm_len = 16; // including the null terminator
761 if (name.length() > (max_task_comm_len - 1)) {
762 char buf[max_task_comm_len];
763 strncpy(buf, name.c_str(), sizeof(buf) - 1);
764 buf[sizeof(buf) - 1] = '\0';
765 s = buf;
766 }
767
768 return pthread_setname_np(pthread_self(), s) ;
769#endif
770}
771
Spencer Lowf055c192015-01-25 14:40:16 -0800772static __inline__ int adb_setsockopt( int fd, int level, int optname, const void* optval, socklen_t optlen )
773{
774 return setsockopt( fd, level, optname, optval, optlen );
775}
776
777#undef setsockopt
778#define setsockopt ___xxx_setsockopt
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800779
780static __inline__ int unix_socketpair( int d, int type, int protocol, int sv[2] )
781{
782 return socketpair( d, type, protocol, sv );
783}
784
785static __inline__ int adb_socketpair( int sv[2] )
786{
787 int rc;
788
789 rc = unix_socketpair( AF_UNIX, SOCK_STREAM, 0, sv );
790 if (rc < 0)
791 return -1;
792
793 close_on_exec( sv[0] );
794 close_on_exec( sv[1] );
795 return 0;
796}
797
798#undef socketpair
799#define socketpair ___xxx_socketpair
800
Josh Gao3777d2e2016-02-16 17:34:53 -0800801typedef struct pollfd adb_pollfd;
802static __inline__ int adb_poll(adb_pollfd* fds, size_t nfds, int timeout) {
803 return TEMP_FAILURE_RETRY(poll(fds, nfds, timeout));
804}
805
806#define poll ___xxx_poll
807
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800808static __inline__ void adb_sleep_ms( int mseconds )
809{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200810 usleep( mseconds*1000 );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800811}
812
Alex Vallée47d67c92015-05-06 16:26:00 -0400813static __inline__ int adb_mkdir(const std::string& path, int mode)
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800814{
Alex Vallée47d67c92015-05-06 16:26:00 -0400815 return mkdir(path.c_str(), mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800816}
Alex Vallée47d67c92015-05-06 16:26:00 -0400817
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800818#undef mkdir
819#define mkdir ___xxx_mkdir
820
821static __inline__ void adb_sysdeps_init(void)
822{
823}
824
Alex Vallée47d67c92015-05-06 16:26:00 -0400825static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800826 return path[0] == '/';
827}
828
leozwangcbf02672014-08-15 09:51:27 -0700829static __inline__ unsigned long adb_thread_id()
830{
Spencer Low8d8126a2015-07-21 02:06:26 -0700831 return (unsigned long)gettid();
leozwangcbf02672014-08-15 09:51:27 -0700832}
833
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800834#endif /* !_WIN32 */
835
Elliott Hughescc65c3b2015-11-20 22:01:06 -0800836static inline void disable_tcp_nagle(int fd) {
837 int off = 1;
838 adb_setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &off, sizeof(off));
839}
840
David Pursellbfd95032016-02-22 14:27:23 -0800841// Sets TCP socket |fd| to send a keepalive TCP message every |interval_sec| seconds. Set
842// |interval_sec| to 0 to disable keepalives. If keepalives are enabled, the connection will be
843// configured to drop after 10 missed keepalives. Returns true on success.
844bool set_tcp_keepalive(int fd, int interval_sec);
845
Elliott Hughes0aeb5052016-06-29 17:42:01 -0700846#if defined(_WIN32)
847// Win32 defines ERROR, which we don't need, but which conflicts with google3 logging.
848#undef ERROR
849#endif
850
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800851#endif /* _ADB_SYSDEPS_H */