blob: ded8214261d1a5f76027faa4adcc3dc2162a66e0 [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
Josh Gaob5fea142016-02-12 14:31:15 -0800100typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800101typedef HANDLE adb_thread_t;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800102
Josh Gaob5fea142016-02-12 14:31:15 -0800103struct adb_winthread_args {
Josh Gao3b3e10d2016-02-09 14:59:09 -0800104 adb_thread_func_t func;
105 void* arg;
106};
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800107
Josh Gaob5fea142016-02-12 14:31:15 -0800108static unsigned __stdcall adb_winthread_wrapper(void* heap_args) {
109 // Move the arguments from the heap onto the thread's stack.
110 adb_winthread_args thread_args = *static_cast<adb_winthread_args*>(heap_args);
111 delete static_cast<adb_winthread_args*>(heap_args);
112 thread_args.func(thread_args.arg);
113 return 0;
Josh Gao3b3e10d2016-02-09 14:59:09 -0800114}
115
116static __inline__ bool adb_thread_create(adb_thread_func_t func, void* arg,
117 adb_thread_t* thread = nullptr) {
Josh Gaob5fea142016-02-12 14:31:15 -0800118 adb_winthread_args* args = new adb_winthread_args{.func = func, .arg = arg};
119 uintptr_t handle = _beginthreadex(nullptr, 0, adb_winthread_wrapper, args, 0, nullptr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800120 if (handle != static_cast<uintptr_t>(0)) {
121 if (thread) {
122 *thread = reinterpret_cast<HANDLE>(handle);
123 } else {
124 CloseHandle(thread);
125 }
126 return true;
127 }
128 return false;
129}
130
131static __inline__ bool adb_thread_join(adb_thread_t thread) {
132 switch (WaitForSingleObject(thread, INFINITE)) {
133 case WAIT_OBJECT_0:
134 CloseHandle(thread);
135 return true;
136
137 case WAIT_FAILED:
138 fprintf(stderr, "adb_thread_join failed: %s\n",
139 android::base::SystemErrorCodeToString(GetLastError()).c_str());
140 break;
141
142 default:
143 abort();
144 }
145
146 return false;
147}
148
149static __inline__ bool adb_thread_detach(adb_thread_t thread) {
150 CloseHandle(thread);
151 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800152}
153
Josh Gaob5fea142016-02-12 14:31:15 -0800154static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
Josh Gaod7b37492016-02-12 15:45:04 -0800155 _endthreadex(0);
Josh Gaob5fea142016-02-12 14:31:15 -0800156}
157
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700158static __inline__ int adb_thread_setname(const std::string& name) {
159 // TODO: See https://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx for how to set
160 // the thread name in Windows. Unfortunately, it only works during debugging, but
161 // our build process doesn't generate PDB files needed for debugging.
162 return 0;
163}
164
Josh Gao3777d2e2016-02-16 17:34:53 -0800165static __inline__ adb_thread_t adb_thread_self() {
166 return GetCurrentThread();
167}
168
169static __inline__ bool adb_thread_equal(adb_thread_t lhs, adb_thread_t rhs) {
170 return GetThreadId(lhs) == GetThreadId(rhs);
171}
172
leozwangcbf02672014-08-15 09:51:27 -0700173static __inline__ unsigned long adb_thread_id()
174{
175 return GetCurrentThreadId();
176}
177
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800178static __inline__ void close_on_exec(int fd)
179{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200180 /* nothing really */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800181}
182
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800183#define S_ISLNK(m) 0 /* no symlinks on Win32 */
184
Spencer Lowcf4ff642015-05-11 01:08:48 -0700185extern int adb_unlink(const char* path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800186#undef unlink
187#define unlink ___xxx_unlink
188
Spencer Lowcf4ff642015-05-11 01:08:48 -0700189extern int adb_mkdir(const std::string& path, int mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800190#undef mkdir
191#define mkdir ___xxx_mkdir
192
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700193// See the comments for the !defined(_WIN32) versions of adb_*().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800194extern int adb_open(const char* path, int options);
195extern int adb_creat(const char* path, int mode);
196extern int adb_read(int fd, void* buf, int len);
197extern int adb_write(int fd, const void* buf, int len);
198extern int adb_lseek(int fd, int pos, int where);
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400199extern int adb_shutdown(int fd);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800200extern int adb_close(int fd);
201
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700202// See the comments for the !defined(_WIN32) version of unix_close().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800203static __inline__ int unix_close(int fd)
204{
205 return close(fd);
206}
207#undef close
208#define close ____xxx_close
209
Spencer Low2e02dc62015-11-07 17:34:39 -0800210// Like unix_read(), but may return EINTR.
211extern int unix_read_interruptible(int fd, void* buf, size_t len);
212
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700213// See the comments for the !defined(_WIN32) version of unix_read().
Spencer Low2e02dc62015-11-07 17:34:39 -0800214static __inline__ int unix_read(int fd, void* buf, size_t len) {
215 return TEMP_FAILURE_RETRY(unix_read_interruptible(fd, buf, len));
216}
Spencer Low50184062015-03-01 15:06:21 -0800217
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800218#undef read
219#define read ___xxx_read
220
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700221// See the comments for the !defined(_WIN32) version of unix_write().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800222static __inline__ int unix_write(int fd, const void* buf, size_t len)
223{
224 return write(fd, buf, len);
225}
226#undef write
227#define write ___xxx_write
228
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700229// See the comments for the !defined(_WIN32) version of adb_open_mode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800230static __inline__ int adb_open_mode(const char* path, int options, int mode)
231{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200232 return adb_open(path, options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800233}
234
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700235// See the comments for the !defined(_WIN32) version of unix_open().
Spencer Lowcf4ff642015-05-11 01:08:48 -0700236extern int unix_open(const char* path, int options, ...);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800237#define open ___xxx_unix_open
238
David Pursellc5b8ad82015-10-28 14:29:51 -0700239// Checks if |fd| corresponds to a console.
240// Standard Windows isatty() returns 1 for both console FDs and character
241// devices like NUL. unix_isatty() performs some extra checking to only match
242// console FDs.
243// |fd| must be a real file descriptor, meaning STDxx_FILENO or unix_open() FDs
244// will work but adb_open() FDs will not. Additionally the OS handle associated
245// with |fd| must have GENERIC_READ access (which console FDs have by default).
246// Returns 1 if |fd| is a console FD, 0 otherwise. The value of errno after
247// calling this function is unreliable and should not be used.
248int unix_isatty(int fd);
249#define isatty ___xxx_isatty
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800250
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800251static __inline__ void adb_sleep_ms( int mseconds )
252{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200253 Sleep( mseconds );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800254}
255
Spencer Low5200c662015-07-30 23:07:55 -0700256int network_loopback_client(int port, int type, std::string* error);
257int network_loopback_server(int port, int type, std::string* error);
258int network_inaddr_any_server(int port, int type, std::string* error);
Josh Gaocfb21412016-08-24 18:38:44 -0700259
260inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
261 abort();
262}
263
264inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
265 abort();
266}
267
Spencer Low5200c662015-07-30 23:07:55 -0700268int network_connect(const std::string& host, int port, int type, int timeout,
269 std::string* error);
270
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800271extern int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen);
272
273#undef accept
274#define accept ___xxx_accept
275
Josh Gao59901912016-08-23 15:28:43 -0700276int adb_getsockname(int fd, struct sockaddr* sockaddr, socklen_t* optlen);
277#undef getsockname
278#define getsockname(...) ___xxx_getsockname(__VA__ARGS__)
279
David Purselleaae97e2016-04-07 11:25:48 -0700280// Returns the local port number of a bound socket, or -1 on failure.
281int adb_socket_get_local_port(int fd);
282
Spencer Lowf055c192015-01-25 14:40:16 -0800283extern int adb_setsockopt(int fd, int level, int optname, const void* optval, socklen_t optlen);
284
285#undef setsockopt
286#define setsockopt ___xxx_setsockopt
287
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800288extern int adb_socketpair( int sv[2] );
289
Josh Gao3777d2e2016-02-16 17:34:53 -0800290struct adb_pollfd {
291 int fd;
292 short events;
293 short revents;
294};
295extern int adb_poll(adb_pollfd* fds, size_t nfds, int timeout);
296#define poll ___xxx_poll
297
Elliott Hughes5c742702015-07-30 17:42:01 -0700298static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800299 return isalpha(path[0]) && path[1] == ':' && path[2] == '\\';
300}
301
Spencer Lowcf4ff642015-05-11 01:08:48 -0700302// UTF-8 versions of POSIX APIs.
303extern DIR* adb_opendir(const char* dirname);
304extern struct dirent* adb_readdir(DIR* dir);
305extern int adb_closedir(DIR* dir);
306
307extern int adb_utime(const char *, struct utimbuf *);
308extern int adb_chmod(const char *, int);
309
310extern int adb_vfprintf(FILE *stream, const char *format, va_list ap)
311 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 0)));
Spencer Lowa30b79a2015-11-15 16:29:36 -0800312extern int adb_vprintf(const char *format, va_list ap)
313 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 0)));
Spencer Lowcf4ff642015-05-11 01:08:48 -0700314extern int adb_fprintf(FILE *stream, const char *format, ...)
315 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 3)));
316extern int adb_printf(const char *format, ...)
317 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 2)));
318
319extern int adb_fputs(const char* buf, FILE* stream);
320extern int adb_fputc(int ch, FILE* stream);
Spencer Lowa30b79a2015-11-15 16:29:36 -0800321extern int adb_putchar(int ch);
322extern int adb_puts(const char* buf);
Spencer Lowcf4ff642015-05-11 01:08:48 -0700323extern size_t adb_fwrite(const void* ptr, size_t size, size_t nmemb,
324 FILE* stream);
325
326extern FILE* adb_fopen(const char* f, const char* m);
327
328extern char* adb_getenv(const char* name);
329
330extern char* adb_getcwd(char* buf, int size);
331
332// Remap calls to POSIX APIs to our UTF-8 versions.
333#define opendir adb_opendir
334#define readdir adb_readdir
335#define closedir adb_closedir
336#define rewinddir rewinddir_utf8_not_yet_implemented
337#define telldir telldir_utf8_not_yet_implemented
Spencer Low363af562015-11-07 18:51:54 -0800338// Some compiler's C++ headers have members named seekdir, so we can't do the
339// macro technique and instead cause a link error if seekdir is called.
340inline void seekdir(DIR*, long) {
341 extern int seekdir_utf8_not_yet_implemented;
342 seekdir_utf8_not_yet_implemented = 1;
343}
Spencer Lowcf4ff642015-05-11 01:08:48 -0700344
345#define utime adb_utime
346#define chmod adb_chmod
347
348#define vfprintf adb_vfprintf
Spencer Lowa30b79a2015-11-15 16:29:36 -0800349#define vprintf adb_vprintf
Spencer Lowcf4ff642015-05-11 01:08:48 -0700350#define fprintf adb_fprintf
351#define printf adb_printf
352#define fputs adb_fputs
353#define fputc adb_fputc
Spencer Lowa30b79a2015-11-15 16:29:36 -0800354// putc may be a macro, so if so, undefine it, so that we can redefine it.
355#undef putc
356#define putc(c, s) adb_fputc(c, s)
357#define putchar adb_putchar
358#define puts adb_puts
Spencer Lowcf4ff642015-05-11 01:08:48 -0700359#define fwrite adb_fwrite
360
361#define fopen adb_fopen
Spencer Lowa30b79a2015-11-15 16:29:36 -0800362#define freopen freopen_utf8_not_yet_implemented
Spencer Lowcf4ff642015-05-11 01:08:48 -0700363
364#define getenv adb_getenv
365#define putenv putenv_utf8_not_yet_implemented
366#define setenv setenv_utf8_not_yet_implemented
367#define unsetenv unsetenv_utf8_not_yet_implemented
368
369#define getcwd adb_getcwd
370
Spencer Low0a796002015-10-18 16:45:09 -0700371char* adb_strerror(int err);
372#define strerror adb_strerror
373
Spencer Lowcf4ff642015-05-11 01:08:48 -0700374// Helper class to convert UTF-16 argv from wmain() to UTF-8 args that can be
375// passed to main().
376class NarrowArgs {
377public:
378 NarrowArgs(int argc, wchar_t** argv);
379 ~NarrowArgs();
380
381 inline char** data() {
382 return narrow_args;
383 }
384
385private:
386 char** narrow_args;
387};
388
Spencer Low5c398d22015-08-08 15:07:07 -0700389// Windows HANDLE values only use 32-bits of the type, even on 64-bit machines,
390// so they can fit in an int. To convert back, we just need to sign-extend.
391// https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203%28v=vs.85%29.aspx
392// Note that this does not make a HANDLE value work with APIs like open(), nor
393// does this make a value from open() passable to APIs taking a HANDLE. This
394// just lets you take a HANDLE, pass it around as an int, and then use it again
395// as a HANDLE.
396inline int cast_handle_to_int(const HANDLE h) {
397 // truncate
398 return static_cast<int>(reinterpret_cast<INT_PTR>(h));
399}
400
401inline HANDLE cast_int_to_handle(const int fd) {
402 // sign-extend
403 return reinterpret_cast<HANDLE>(static_cast<INT_PTR>(fd));
404}
405
Spencer Low2122c7a2015-08-26 18:46:09 -0700406// Deleter for unique_handle. Adapted from many sources, including:
407// http://stackoverflow.com/questions/14841396/stdunique-ptr-deleters-and-the-win32-api
408// https://visualstudiomagazine.com/articles/2013/09/01/get-a-handle-on-the-windows-api.aspx
409class handle_deleter {
410public:
411 typedef HANDLE pointer;
412
413 void operator()(HANDLE h);
414};
415
416// Like std::unique_ptr, but for Windows HANDLE objects that should be
417// CloseHandle()'d. Operator bool() only checks if the handle != nullptr,
418// but does not check if the handle != INVALID_HANDLE_VALUE.
419typedef std::unique_ptr<HANDLE, handle_deleter> unique_handle;
420
Spencer Lowa30b79a2015-11-15 16:29:36 -0800421namespace internal {
422
423size_t ParseCompleteUTF8(const char* first, const char* last, std::vector<char>* remaining_bytes);
424
425}
426
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800427#else /* !_WIN32 a.k.a. Unix */
428
Spencer Low5200c662015-07-30 23:07:55 -0700429#include <cutils/sockets.h>
Spencer Low8d8126a2015-07-21 02:06:26 -0700430#include <cutils/threads.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800431#include <fcntl.h>
Josh Gao3777d2e2016-02-16 17:34:53 -0800432#include <poll.h>
433#include <signal.h>
434#include <sys/stat.h>
435#include <sys/wait.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800436
437#include <pthread.h>
438#include <unistd.h>
439#include <fcntl.h>
440#include <stdarg.h>
Spencer Low5200c662015-07-30 23:07:55 -0700441#include <netdb.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800442#include <netinet/in.h>
443#include <netinet/tcp.h>
444#include <string.h>
Kenny Root73167412012-10-12 15:26:45 -0700445#include <unistd.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800446
Alex Vallée47d67c92015-05-06 16:26:00 -0400447#include <string>
448
Elliott Hughes5c742702015-07-30 17:42:01 -0700449#define OS_PATH_SEPARATORS "/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800450#define OS_PATH_SEPARATOR '/'
451#define OS_PATH_SEPARATOR_STR "/"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -0700452#define ENV_PATH_SEPARATOR_STR ":"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800453
Josh Gao07db1192015-11-07 15:38:19 -0800454static __inline__ bool adb_is_separator(char c) {
455 return c == '/';
456}
457
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800458static __inline__ void close_on_exec(int fd)
459{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200460 fcntl( fd, F_SETFD, FD_CLOEXEC );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800461}
462
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700463// Open a file and return a file descriptor that may be used with unix_read(),
464// unix_write(), unix_close(), but not adb_read(), adb_write(), adb_close().
465//
466// On Unix, this is based on open(), so the file descriptor is a real OS file
467// descriptor, but the Windows implementation (in sysdeps_win32.cpp) returns a
468// file descriptor that can only be used with C Runtime APIs (which are wrapped
469// by unix_read(), unix_write(), unix_close()). Also, the C Runtime has
470// configurable CR/LF translation which defaults to text mode, but is settable
471// with _setmode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800472static __inline__ int unix_open(const char* path, int options,...)
473{
474 if ((options & O_CREAT) == 0)
475 {
Kenny Root73167412012-10-12 15:26:45 -0700476 return TEMP_FAILURE_RETRY( open(path, options) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800477 }
478 else
479 {
480 int mode;
481 va_list args;
482 va_start( args, options );
483 mode = va_arg( args, int );
484 va_end( args );
Kenny Root73167412012-10-12 15:26:45 -0700485 return TEMP_FAILURE_RETRY( open( path, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800486 }
487}
488
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700489// Similar to the two-argument adb_open(), but takes a mode parameter for file
490// creation. See adb_open() for more info.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800491static __inline__ int adb_open_mode( const char* pathname, int options, int mode )
492{
Kenny Root73167412012-10-12 15:26:45 -0700493 return TEMP_FAILURE_RETRY( open( pathname, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800494}
495
496
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700497// Open a file and return a file descriptor that may be used with adb_read(),
498// adb_write(), adb_close(), but not unix_read(), unix_write(), unix_close().
499//
500// On Unix, this is based on open(), but the Windows implementation (in
501// sysdeps_win32.cpp) uses Windows native file I/O and bypasses the C Runtime
502// and its CR/LF translation. The returned file descriptor should be used with
503// adb_read(), adb_write(), adb_close(), etc.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800504static __inline__ int adb_open( const char* pathname, int options )
505{
Kenny Root73167412012-10-12 15:26:45 -0700506 int fd = TEMP_FAILURE_RETRY( open( pathname, options ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800507 if (fd < 0)
508 return -1;
509 close_on_exec( fd );
510 return fd;
511}
512#undef open
513#define open ___xxx_open
514
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400515static __inline__ int adb_shutdown(int fd)
516{
517 return shutdown(fd, SHUT_RDWR);
518}
David Pursell1ed57f02015-10-06 15:30:03 -0700519static __inline__ int adb_shutdown(int fd, int direction)
520{
521 return shutdown(fd, direction);
522}
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400523#undef shutdown
524#define shutdown ____xxx_shutdown
525
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700526// Closes a file descriptor that came from adb_open() or adb_open_mode(), but
527// not designed to take a file descriptor from unix_open(). See the comments
528// for adb_open() for more info.
Josh Gaof0d3b4f2016-03-04 15:15:56 -0800529__inline__ int adb_close(int fd) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800530 return close(fd);
531}
532#undef close
533#define close ____xxx_close
534
535
536static __inline__ int adb_read(int fd, void* buf, size_t len)
537{
Kenny Root73167412012-10-12 15:26:45 -0700538 return TEMP_FAILURE_RETRY( read( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800539}
540
Spencer Low2e02dc62015-11-07 17:34:39 -0800541// Like unix_read(), but does not handle EINTR.
542static __inline__ int unix_read_interruptible(int fd, void* buf, size_t len) {
543 return read(fd, buf, len);
544}
545
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800546#undef read
547#define read ___xxx_read
548
549static __inline__ int adb_write(int fd, const void* buf, size_t len)
550{
Kenny Root73167412012-10-12 15:26:45 -0700551 return TEMP_FAILURE_RETRY( write( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800552}
553#undef write
554#define write ___xxx_write
555
556static __inline__ int adb_lseek(int fd, int pos, int where)
557{
558 return lseek(fd, pos, where);
559}
560#undef lseek
561#define lseek ___xxx_lseek
562
563static __inline__ int adb_unlink(const char* path)
564{
565 return unlink(path);
566}
567#undef unlink
568#define unlink ___xxx_unlink
569
570static __inline__ int adb_creat(const char* path, int mode)
571{
Kenny Root73167412012-10-12 15:26:45 -0700572 int fd = TEMP_FAILURE_RETRY( creat( path, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800573
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200574 if ( fd < 0 )
575 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800576
577 close_on_exec(fd);
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200578 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800579}
580#undef creat
581#define creat ___xxx_creat
582
David Pursellc5b8ad82015-10-28 14:29:51 -0700583static __inline__ int unix_isatty(int fd) {
584 return isatty(fd);
585}
586#define isatty ___xxx_isatty
587
Spencer Low5200c662015-07-30 23:07:55 -0700588// Helper for network_* functions.
589inline int _fd_set_error_str(int fd, std::string* error) {
590 if (fd == -1) {
591 *error = strerror(errno);
592 }
593 return fd;
594}
595
596inline int network_loopback_client(int port, int type, std::string* error) {
Elliott Hughes139b3722016-10-11 13:45:03 -0700597 return _fd_set_error_str(socket_network_client("localhost", port, type), error);
Spencer Low5200c662015-07-30 23:07:55 -0700598}
599
600inline int network_loopback_server(int port, int type, std::string* error) {
601 return _fd_set_error_str(socket_loopback_server(port, type), error);
602}
603
604inline int network_inaddr_any_server(int port, int type, std::string* error) {
605 return _fd_set_error_str(socket_inaddr_any_server(port, type), error);
606}
607
Josh Gaocfb21412016-08-24 18:38:44 -0700608inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
609 return _fd_set_error_str(socket_local_client(name, namespace_id, type), error);
610}
611
612inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
613 return _fd_set_error_str(socket_local_server(name, namespace_id, type), error);
Spencer Low5200c662015-07-30 23:07:55 -0700614}
615
616inline int network_connect(const std::string& host, int port, int type,
617 int timeout, std::string* error) {
618 int getaddrinfo_error = 0;
619 int fd = socket_network_client_timeout(host.c_str(), port, type, timeout,
620 &getaddrinfo_error);
621 if (fd != -1) {
622 return fd;
623 }
624 if (getaddrinfo_error != 0) {
625 *error = gai_strerror(getaddrinfo_error);
626 } else {
627 *error = strerror(errno);
628 }
629 return -1;
630}
631
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800632static __inline__ int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen)
633{
Benoit Goby95ef8282011-02-01 18:57:41 -0800634 int fd;
635
Kenny Root73167412012-10-12 15:26:45 -0700636 fd = TEMP_FAILURE_RETRY( accept( serverfd, addr, addrlen ) );
Benoit Goby95ef8282011-02-01 18:57:41 -0800637 if (fd >= 0)
638 close_on_exec(fd);
639
640 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800641}
642
643#undef accept
644#define accept ___xxx_accept
645
David Purselleaae97e2016-04-07 11:25:48 -0700646inline int adb_socket_get_local_port(int fd) {
647 return socket_get_local_port(fd);
648}
649
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700650// Operate on a file descriptor returned from unix_open() or a well-known file
651// descriptor such as STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
652//
653// On Unix, unix_read(), unix_write(), unix_close() map to adb_read(),
654// adb_write(), adb_close() (which all map to Unix system calls), but the
655// Windows implementations (in the ifdef above and in sysdeps_win32.cpp) call
656// into the C Runtime and its configurable CR/LF translation (which is settable
657// via _setmode()).
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800658#define unix_read adb_read
659#define unix_write adb_write
660#define unix_close adb_close
661
Josh Gaob5fea142016-02-12 14:31:15 -0800662// Win32 is limited to DWORDs for thread return values; limit the POSIX systems to this as well to
663// ensure compatibility.
664typedef void (*adb_thread_func_t)(void* arg);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800665typedef pthread_t adb_thread_t;
666
Josh Gaob5fea142016-02-12 14:31:15 -0800667struct adb_pthread_args {
668 adb_thread_func_t func;
669 void* arg;
670};
671
672static void* adb_pthread_wrapper(void* heap_args) {
673 // Move the arguments from the heap onto the thread's stack.
674 adb_pthread_args thread_args = *reinterpret_cast<adb_pthread_args*>(heap_args);
675 delete static_cast<adb_pthread_args*>(heap_args);
676 thread_args.func(thread_args.arg);
677 return nullptr;
678}
679
Josh Gao3b3e10d2016-02-09 14:59:09 -0800680static __inline__ bool adb_thread_create(adb_thread_func_t start, void* arg,
681 adb_thread_t* thread = nullptr) {
682 pthread_t temp;
Elliott Hughes9b0f3542015-05-05 13:41:21 -0700683 pthread_attr_t attr;
684 pthread_attr_init(&attr);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800685 pthread_attr_setdetachstate(&attr, thread ? PTHREAD_CREATE_JOINABLE : PTHREAD_CREATE_DETACHED);
Josh Gaob5fea142016-02-12 14:31:15 -0800686 auto* pthread_args = new adb_pthread_args{.func = start, .arg = arg};
687 errno = pthread_create(&temp, &attr, adb_pthread_wrapper, pthread_args);
Josh Gao3b3e10d2016-02-09 14:59:09 -0800688 if (errno == 0) {
689 if (thread) {
690 *thread = temp;
691 }
692 return true;
693 }
694 return false;
695}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800696
Josh Gao3b3e10d2016-02-09 14:59:09 -0800697static __inline__ bool adb_thread_join(adb_thread_t thread) {
698 errno = pthread_join(thread, nullptr);
699 return errno == 0;
700}
701
702static __inline__ bool adb_thread_detach(adb_thread_t thread) {
703 errno = pthread_detach(thread);
704 return errno == 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800705}
706
Josh Gaob5fea142016-02-12 14:31:15 -0800707static __inline__ void __attribute__((noreturn)) adb_thread_exit() {
708 pthread_exit(nullptr);
709}
710
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700711static __inline__ int adb_thread_setname(const std::string& name) {
712#ifdef __APPLE__
713 return pthread_setname_np(name.c_str());
714#else
715 const char *s = name.c_str();
716
717 // pthread_setname_np fails rather than truncating long strings.
718 const int max_task_comm_len = 16; // including the null terminator
719 if (name.length() > (max_task_comm_len - 1)) {
720 char buf[max_task_comm_len];
721 strncpy(buf, name.c_str(), sizeof(buf) - 1);
722 buf[sizeof(buf) - 1] = '\0';
723 s = buf;
724 }
725
726 return pthread_setname_np(pthread_self(), s) ;
727#endif
728}
729
Spencer Lowf055c192015-01-25 14:40:16 -0800730static __inline__ int adb_setsockopt( int fd, int level, int optname, const void* optval, socklen_t optlen )
731{
732 return setsockopt( fd, level, optname, optval, optlen );
733}
734
735#undef setsockopt
736#define setsockopt ___xxx_setsockopt
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800737
738static __inline__ int unix_socketpair( int d, int type, int protocol, int sv[2] )
739{
740 return socketpair( d, type, protocol, sv );
741}
742
743static __inline__ int adb_socketpair( int sv[2] )
744{
745 int rc;
746
747 rc = unix_socketpair( AF_UNIX, SOCK_STREAM, 0, sv );
748 if (rc < 0)
749 return -1;
750
751 close_on_exec( sv[0] );
752 close_on_exec( sv[1] );
753 return 0;
754}
755
756#undef socketpair
757#define socketpair ___xxx_socketpair
758
Josh Gao3777d2e2016-02-16 17:34:53 -0800759typedef struct pollfd adb_pollfd;
760static __inline__ int adb_poll(adb_pollfd* fds, size_t nfds, int timeout) {
761 return TEMP_FAILURE_RETRY(poll(fds, nfds, timeout));
762}
763
764#define poll ___xxx_poll
765
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800766static __inline__ void adb_sleep_ms( int mseconds )
767{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200768 usleep( mseconds*1000 );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800769}
770
Alex Vallée47d67c92015-05-06 16:26:00 -0400771static __inline__ int adb_mkdir(const std::string& path, int mode)
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800772{
Alex Vallée47d67c92015-05-06 16:26:00 -0400773 return mkdir(path.c_str(), mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800774}
Alex Vallée47d67c92015-05-06 16:26:00 -0400775
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800776#undef mkdir
777#define mkdir ___xxx_mkdir
778
Alex Vallée47d67c92015-05-06 16:26:00 -0400779static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800780 return path[0] == '/';
781}
782
leozwangcbf02672014-08-15 09:51:27 -0700783static __inline__ unsigned long adb_thread_id()
784{
Spencer Low8d8126a2015-07-21 02:06:26 -0700785 return (unsigned long)gettid();
leozwangcbf02672014-08-15 09:51:27 -0700786}
787
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800788#endif /* !_WIN32 */
789
Elliott Hughescc65c3b2015-11-20 22:01:06 -0800790static inline void disable_tcp_nagle(int fd) {
791 int off = 1;
792 adb_setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &off, sizeof(off));
793}
794
David Pursellbfd95032016-02-22 14:27:23 -0800795// Sets TCP socket |fd| to send a keepalive TCP message every |interval_sec| seconds. Set
796// |interval_sec| to 0 to disable keepalives. If keepalives are enabled, the connection will be
797// configured to drop after 10 missed keepalives. Returns true on success.
798bool set_tcp_keepalive(int fd, int interval_sec);
799
Elliott Hughes0aeb5052016-06-29 17:42:01 -0700800#if defined(_WIN32)
801// Win32 defines ERROR, which we don't need, but which conflicts with google3 logging.
802#undef ERROR
803#endif
804
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800805#endif /* _ADB_SYSDEPS_H */