blob: 49c7847795e7ddb8dc34d94ff8c780014c21070a [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 Gaoa3577e12016-12-05 13:24:48 -080037#include "sysdeps/errno.h"
Josh Gao46de1d72017-04-12 13:57:06 -070038#include "sysdeps/network.h"
Josh Gaof551ea02016-07-28 18:09:48 -070039#include "sysdeps/stat.h"
40
Dan Albertcc731cc2015-02-24 21:26:58 -080041/*
42 * TEMP_FAILURE_RETRY is defined by some, but not all, versions of
43 * <unistd.h>. (Alas, it is not as standard as we'd hoped!) So, if it's
44 * not already defined, then define it here.
45 */
46#ifndef TEMP_FAILURE_RETRY
47/* Used to retry syscalls that can return EINTR. */
48#define TEMP_FAILURE_RETRY(exp) ({ \
49 typeof (exp) _rc; \
50 do { \
51 _rc = (exp); \
52 } while (_rc == -1 && errno == EINTR); \
53 _rc; })
54#endif
55
Spencer Lowcf4ff642015-05-11 01:08:48 -070056// Some printf-like functions are implemented in terms of
57// android::base::StringAppendV, so they should use the same attribute for
58// compile-time format string checking. On Windows, if the mingw version of
59// vsnprintf is used in StringAppendV, use `gnu_printf' which allows z in %zd
60// and PRIu64 (and related) to be recognized by the compile-time checking.
61#define ADB_FORMAT_ARCHETYPE __printf__
62#ifdef __USE_MINGW_ANSI_STDIO
63#if __USE_MINGW_ANSI_STDIO
64#undef ADB_FORMAT_ARCHETYPE
65#define ADB_FORMAT_ARCHETYPE gnu_printf
66#endif
67#endif
68
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080069#ifdef _WIN32
70
Josh Gaoa166e712016-01-29 12:08:34 -080071// Clang-only nullability specifiers
72#define _Nonnull
73#define _Nullable
74
Dan Albert630b9af2014-11-24 23:34:35 -080075#include <ctype.h>
76#include <direct.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070077#include <dirent.h>
Dan Albert630b9af2014-11-24 23:34:35 -080078#include <errno.h>
79#include <fcntl.h>
80#include <io.h>
81#include <process.h>
82#include <sys/stat.h>
Spencer Lowcf4ff642015-05-11 01:08:48 -070083#include <utime.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080084#include <winsock2.h>
Stephen Hines2f431a82014-10-01 17:37:06 -070085#include <windows.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080086#include <ws2tcpip.h>
Dan Albert630b9af2014-11-24 23:34:35 -080087
Spencer Low2122c7a2015-08-26 18:46:09 -070088#include <memory> // unique_ptr
Spencer Lowd21dc822015-11-12 15:20:15 -080089#include <string>
Alex Vallée47d67c92015-05-06 16:26:00 -040090
Dan Albert630b9af2014-11-24 23:34:35 -080091#include "fdevent.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080092
Elliott Hughes5c742702015-07-30 17:42:01 -070093#define OS_PATH_SEPARATORS "\\/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080094#define OS_PATH_SEPARATOR '\\'
95#define OS_PATH_SEPARATOR_STR "\\"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -070096#define ENV_PATH_SEPARATOR_STR ";"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080097
Josh Gao07db1192015-11-07 15:38:19 -080098static __inline__ bool adb_is_separator(char c) {
99 return c == '\\' || c == '/';
100}
101
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700102static __inline__ int adb_thread_setname(const std::string& name) {
103 // TODO: See https://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx for how to set
104 // the thread name in Windows. Unfortunately, it only works during debugging, but
105 // our build process doesn't generate PDB files needed for debugging.
106 return 0;
107}
108
leozwangcbf02672014-08-15 09:51:27 -0700109static __inline__ unsigned long adb_thread_id()
110{
111 return GetCurrentThreadId();
112}
113
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800114static __inline__ void close_on_exec(int fd)
115{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200116 /* nothing really */
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800117}
118
Spencer Lowcf4ff642015-05-11 01:08:48 -0700119extern int adb_unlink(const char* path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800120#undef unlink
121#define unlink ___xxx_unlink
122
Spencer Lowcf4ff642015-05-11 01:08:48 -0700123extern int adb_mkdir(const std::string& path, int mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800124#undef mkdir
125#define mkdir ___xxx_mkdir
126
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700127// See the comments for the !defined(_WIN32) versions of adb_*().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800128extern int adb_open(const char* path, int options);
129extern int adb_creat(const char* path, int mode);
130extern int adb_read(int fd, void* buf, int len);
131extern int adb_write(int fd, const void* buf, int len);
132extern int adb_lseek(int fd, int pos, int where);
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400133extern int adb_shutdown(int fd);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800134extern int adb_close(int fd);
Casey Dahlin2fe9b602016-09-21 14:03:39 -0700135extern int adb_register_socket(SOCKET s);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800136
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700137// See the comments for the !defined(_WIN32) version of unix_close().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800138static __inline__ int unix_close(int fd)
139{
140 return close(fd);
141}
142#undef close
143#define close ____xxx_close
144
Spencer Low2e02dc62015-11-07 17:34:39 -0800145// Like unix_read(), but may return EINTR.
146extern int unix_read_interruptible(int fd, void* buf, size_t len);
147
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700148// See the comments for the !defined(_WIN32) version of unix_read().
Spencer Low2e02dc62015-11-07 17:34:39 -0800149static __inline__ int unix_read(int fd, void* buf, size_t len) {
150 return TEMP_FAILURE_RETRY(unix_read_interruptible(fd, buf, len));
151}
Spencer Low50184062015-03-01 15:06:21 -0800152
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800153#undef read
154#define read ___xxx_read
155
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700156// See the comments for the !defined(_WIN32) version of unix_write().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800157static __inline__ int unix_write(int fd, const void* buf, size_t len)
158{
159 return write(fd, buf, len);
160}
161#undef write
162#define write ___xxx_write
163
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700164// See the comments for the !defined(_WIN32) version of adb_open_mode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800165static __inline__ int adb_open_mode(const char* path, int options, int mode)
166{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200167 return adb_open(path, options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800168}
169
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700170// See the comments for the !defined(_WIN32) version of unix_open().
Spencer Lowcf4ff642015-05-11 01:08:48 -0700171extern int unix_open(const char* path, int options, ...);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800172#define open ___xxx_unix_open
173
David Pursellc5b8ad82015-10-28 14:29:51 -0700174// Checks if |fd| corresponds to a console.
175// Standard Windows isatty() returns 1 for both console FDs and character
176// devices like NUL. unix_isatty() performs some extra checking to only match
177// console FDs.
178// |fd| must be a real file descriptor, meaning STDxx_FILENO or unix_open() FDs
179// will work but adb_open() FDs will not. Additionally the OS handle associated
180// with |fd| must have GENERIC_READ access (which console FDs have by default).
181// Returns 1 if |fd| is a console FD, 0 otherwise. The value of errno after
182// calling this function is unreliable and should not be used.
183int unix_isatty(int fd);
184#define isatty ___xxx_isatty
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800185
Spencer Low5200c662015-07-30 23:07:55 -0700186int network_inaddr_any_server(int port, int type, std::string* error);
Josh Gaocfb21412016-08-24 18:38:44 -0700187
188inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
189 abort();
190}
191
192inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
193 abort();
194}
195
Spencer Low5200c662015-07-30 23:07:55 -0700196int network_connect(const std::string& host, int port, int type, int timeout,
197 std::string* error);
198
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800199extern int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen);
200
201#undef accept
202#define accept ___xxx_accept
203
David Purselleaae97e2016-04-07 11:25:48 -0700204// Returns the local port number of a bound socket, or -1 on failure.
205int adb_socket_get_local_port(int fd);
206
Spencer Lowf055c192015-01-25 14:40:16 -0800207extern int adb_setsockopt(int fd, int level, int optname, const void* optval, socklen_t optlen);
208
209#undef setsockopt
210#define setsockopt ___xxx_setsockopt
211
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800212extern int adb_socketpair( int sv[2] );
213
Josh Gao3777d2e2016-02-16 17:34:53 -0800214struct adb_pollfd {
215 int fd;
216 short events;
217 short revents;
218};
219extern int adb_poll(adb_pollfd* fds, size_t nfds, int timeout);
220#define poll ___xxx_poll
221
Elliott Hughes5c742702015-07-30 17:42:01 -0700222static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800223 return isalpha(path[0]) && path[1] == ':' && path[2] == '\\';
224}
225
Spencer Lowcf4ff642015-05-11 01:08:48 -0700226// UTF-8 versions of POSIX APIs.
227extern DIR* adb_opendir(const char* dirname);
228extern struct dirent* adb_readdir(DIR* dir);
229extern int adb_closedir(DIR* dir);
230
231extern int adb_utime(const char *, struct utimbuf *);
232extern int adb_chmod(const char *, int);
233
234extern int adb_vfprintf(FILE *stream, const char *format, va_list ap)
235 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 0)));
Spencer Lowa30b79a2015-11-15 16:29:36 -0800236extern int adb_vprintf(const char *format, va_list ap)
237 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 0)));
Spencer Lowcf4ff642015-05-11 01:08:48 -0700238extern int adb_fprintf(FILE *stream, const char *format, ...)
239 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 2, 3)));
240extern int adb_printf(const char *format, ...)
241 __attribute__((__format__(ADB_FORMAT_ARCHETYPE, 1, 2)));
242
243extern int adb_fputs(const char* buf, FILE* stream);
244extern int adb_fputc(int ch, FILE* stream);
Spencer Lowa30b79a2015-11-15 16:29:36 -0800245extern int adb_putchar(int ch);
246extern int adb_puts(const char* buf);
Spencer Lowcf4ff642015-05-11 01:08:48 -0700247extern size_t adb_fwrite(const void* ptr, size_t size, size_t nmemb,
248 FILE* stream);
249
250extern FILE* adb_fopen(const char* f, const char* m);
251
252extern char* adb_getenv(const char* name);
253
254extern char* adb_getcwd(char* buf, int size);
255
256// Remap calls to POSIX APIs to our UTF-8 versions.
257#define opendir adb_opendir
258#define readdir adb_readdir
259#define closedir adb_closedir
260#define rewinddir rewinddir_utf8_not_yet_implemented
261#define telldir telldir_utf8_not_yet_implemented
Spencer Low363af562015-11-07 18:51:54 -0800262// Some compiler's C++ headers have members named seekdir, so we can't do the
263// macro technique and instead cause a link error if seekdir is called.
264inline void seekdir(DIR*, long) {
265 extern int seekdir_utf8_not_yet_implemented;
266 seekdir_utf8_not_yet_implemented = 1;
267}
Spencer Lowcf4ff642015-05-11 01:08:48 -0700268
269#define utime adb_utime
270#define chmod adb_chmod
271
272#define vfprintf adb_vfprintf
Spencer Lowa30b79a2015-11-15 16:29:36 -0800273#define vprintf adb_vprintf
Spencer Lowcf4ff642015-05-11 01:08:48 -0700274#define fprintf adb_fprintf
275#define printf adb_printf
276#define fputs adb_fputs
277#define fputc adb_fputc
Spencer Lowa30b79a2015-11-15 16:29:36 -0800278// putc may be a macro, so if so, undefine it, so that we can redefine it.
279#undef putc
280#define putc(c, s) adb_fputc(c, s)
281#define putchar adb_putchar
282#define puts adb_puts
Spencer Lowcf4ff642015-05-11 01:08:48 -0700283#define fwrite adb_fwrite
284
285#define fopen adb_fopen
Spencer Lowa30b79a2015-11-15 16:29:36 -0800286#define freopen freopen_utf8_not_yet_implemented
Spencer Lowcf4ff642015-05-11 01:08:48 -0700287
288#define getenv adb_getenv
289#define putenv putenv_utf8_not_yet_implemented
290#define setenv setenv_utf8_not_yet_implemented
291#define unsetenv unsetenv_utf8_not_yet_implemented
292
293#define getcwd adb_getcwd
294
Spencer Lowcf4ff642015-05-11 01:08:48 -0700295// Helper class to convert UTF-16 argv from wmain() to UTF-8 args that can be
296// passed to main().
297class NarrowArgs {
298public:
299 NarrowArgs(int argc, wchar_t** argv);
300 ~NarrowArgs();
301
302 inline char** data() {
303 return narrow_args;
304 }
305
306private:
307 char** narrow_args;
308};
309
Spencer Low5c398d22015-08-08 15:07:07 -0700310// Windows HANDLE values only use 32-bits of the type, even on 64-bit machines,
311// so they can fit in an int. To convert back, we just need to sign-extend.
312// https://msdn.microsoft.com/en-us/library/windows/desktop/aa384203%28v=vs.85%29.aspx
313// Note that this does not make a HANDLE value work with APIs like open(), nor
314// does this make a value from open() passable to APIs taking a HANDLE. This
315// just lets you take a HANDLE, pass it around as an int, and then use it again
316// as a HANDLE.
317inline int cast_handle_to_int(const HANDLE h) {
318 // truncate
319 return static_cast<int>(reinterpret_cast<INT_PTR>(h));
320}
321
322inline HANDLE cast_int_to_handle(const int fd) {
323 // sign-extend
324 return reinterpret_cast<HANDLE>(static_cast<INT_PTR>(fd));
325}
326
Spencer Low2122c7a2015-08-26 18:46:09 -0700327// Deleter for unique_handle. Adapted from many sources, including:
328// http://stackoverflow.com/questions/14841396/stdunique-ptr-deleters-and-the-win32-api
329// https://visualstudiomagazine.com/articles/2013/09/01/get-a-handle-on-the-windows-api.aspx
330class handle_deleter {
331public:
332 typedef HANDLE pointer;
333
334 void operator()(HANDLE h);
335};
336
337// Like std::unique_ptr, but for Windows HANDLE objects that should be
338// CloseHandle()'d. Operator bool() only checks if the handle != nullptr,
339// but does not check if the handle != INVALID_HANDLE_VALUE.
340typedef std::unique_ptr<HANDLE, handle_deleter> unique_handle;
341
Spencer Lowa30b79a2015-11-15 16:29:36 -0800342namespace internal {
343
344size_t ParseCompleteUTF8(const char* first, const char* last, std::vector<char>* remaining_bytes);
345
346}
347
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800348#else /* !_WIN32 a.k.a. Unix */
349
Spencer Low5200c662015-07-30 23:07:55 -0700350#include <cutils/sockets.h>
Spencer Low8d8126a2015-07-21 02:06:26 -0700351#include <cutils/threads.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800352#include <fcntl.h>
Josh Gao3777d2e2016-02-16 17:34:53 -0800353#include <poll.h>
354#include <signal.h>
355#include <sys/stat.h>
356#include <sys/wait.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800357
358#include <pthread.h>
359#include <unistd.h>
360#include <fcntl.h>
361#include <stdarg.h>
Spencer Low5200c662015-07-30 23:07:55 -0700362#include <netdb.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800363#include <netinet/in.h>
364#include <netinet/tcp.h>
365#include <string.h>
Kenny Root73167412012-10-12 15:26:45 -0700366#include <unistd.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800367
Alex Vallée47d67c92015-05-06 16:26:00 -0400368#include <string>
369
Elliott Hughes5c742702015-07-30 17:42:01 -0700370#define OS_PATH_SEPARATORS "/"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800371#define OS_PATH_SEPARATOR '/'
372#define OS_PATH_SEPARATOR_STR "/"
Benoit Gobyd5fcafa2012-04-12 12:23:49 -0700373#define ENV_PATH_SEPARATOR_STR ":"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800374
Josh Gao07db1192015-11-07 15:38:19 -0800375static __inline__ bool adb_is_separator(char c) {
376 return c == '/';
377}
378
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800379static __inline__ void close_on_exec(int fd)
380{
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200381 fcntl( fd, F_SETFD, FD_CLOEXEC );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800382}
383
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700384// Open a file and return a file descriptor that may be used with unix_read(),
385// unix_write(), unix_close(), but not adb_read(), adb_write(), adb_close().
386//
387// On Unix, this is based on open(), so the file descriptor is a real OS file
388// descriptor, but the Windows implementation (in sysdeps_win32.cpp) returns a
389// file descriptor that can only be used with C Runtime APIs (which are wrapped
390// by unix_read(), unix_write(), unix_close()). Also, the C Runtime has
391// configurable CR/LF translation which defaults to text mode, but is settable
392// with _setmode().
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800393static __inline__ int unix_open(const char* path, int options,...)
394{
395 if ((options & O_CREAT) == 0)
396 {
Kenny Root73167412012-10-12 15:26:45 -0700397 return TEMP_FAILURE_RETRY( open(path, options) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800398 }
399 else
400 {
401 int mode;
402 va_list args;
403 va_start( args, options );
404 mode = va_arg( args, int );
405 va_end( args );
Kenny Root73167412012-10-12 15:26:45 -0700406 return TEMP_FAILURE_RETRY( open( path, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800407 }
408}
409
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700410// Similar to the two-argument adb_open(), but takes a mode parameter for file
411// creation. See adb_open() for more info.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800412static __inline__ int adb_open_mode( const char* pathname, int options, int mode )
413{
Kenny Root73167412012-10-12 15:26:45 -0700414 return TEMP_FAILURE_RETRY( open( pathname, options, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800415}
416
417
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700418// Open a file and return a file descriptor that may be used with adb_read(),
419// adb_write(), adb_close(), but not unix_read(), unix_write(), unix_close().
420//
421// On Unix, this is based on open(), but the Windows implementation (in
422// sysdeps_win32.cpp) uses Windows native file I/O and bypasses the C Runtime
423// and its CR/LF translation. The returned file descriptor should be used with
424// adb_read(), adb_write(), adb_close(), etc.
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800425static __inline__ int adb_open( const char* pathname, int options )
426{
Kenny Root73167412012-10-12 15:26:45 -0700427 int fd = TEMP_FAILURE_RETRY( open( pathname, options ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800428 if (fd < 0)
429 return -1;
430 close_on_exec( fd );
431 return fd;
432}
433#undef open
434#define open ___xxx_open
435
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400436static __inline__ int adb_shutdown(int fd)
437{
438 return shutdown(fd, SHUT_RDWR);
439}
David Pursell1ed57f02015-10-06 15:30:03 -0700440static __inline__ int adb_shutdown(int fd, int direction)
441{
442 return shutdown(fd, direction);
443}
Mike Lockwood8cf0d592009-10-11 23:04:18 -0400444#undef shutdown
445#define shutdown ____xxx_shutdown
446
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700447// Closes a file descriptor that came from adb_open() or adb_open_mode(), but
448// not designed to take a file descriptor from unix_open(). See the comments
449// for adb_open() for more info.
Josh Gaof0d3b4f2016-03-04 15:15:56 -0800450__inline__ int adb_close(int fd) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800451 return close(fd);
452}
453#undef close
454#define close ____xxx_close
455
Casey Dahlin2fe9b602016-09-21 14:03:39 -0700456// On Windows, ADB has an indirection layer for file descriptors. If we get a
457// Win32 SOCKET object from an external library, we have to map it in to that
458// indirection layer, which this does.
459__inline__ int adb_register_socket(int s) {
460 return s;
461}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800462
463static __inline__ int adb_read(int fd, void* buf, size_t len)
464{
Kenny Root73167412012-10-12 15:26:45 -0700465 return TEMP_FAILURE_RETRY( read( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800466}
467
Spencer Low2e02dc62015-11-07 17:34:39 -0800468// Like unix_read(), but does not handle EINTR.
469static __inline__ int unix_read_interruptible(int fd, void* buf, size_t len) {
470 return read(fd, buf, len);
471}
472
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800473#undef read
474#define read ___xxx_read
475
476static __inline__ int adb_write(int fd, const void* buf, size_t len)
477{
Kenny Root73167412012-10-12 15:26:45 -0700478 return TEMP_FAILURE_RETRY( write( fd, buf, len ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800479}
480#undef write
481#define write ___xxx_write
482
483static __inline__ int adb_lseek(int fd, int pos, int where)
484{
485 return lseek(fd, pos, where);
486}
487#undef lseek
488#define lseek ___xxx_lseek
489
490static __inline__ int adb_unlink(const char* path)
491{
492 return unlink(path);
493}
494#undef unlink
495#define unlink ___xxx_unlink
496
497static __inline__ int adb_creat(const char* path, int mode)
498{
Kenny Root73167412012-10-12 15:26:45 -0700499 int fd = TEMP_FAILURE_RETRY( creat( path, mode ) );
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800500
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200501 if ( fd < 0 )
502 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800503
504 close_on_exec(fd);
David 'Digit' Turnerf6330a22009-05-18 17:36:28 +0200505 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800506}
507#undef creat
508#define creat ___xxx_creat
509
David Pursellc5b8ad82015-10-28 14:29:51 -0700510static __inline__ int unix_isatty(int fd) {
511 return isatty(fd);
512}
513#define isatty ___xxx_isatty
514
Spencer Low5200c662015-07-30 23:07:55 -0700515// Helper for network_* functions.
516inline int _fd_set_error_str(int fd, std::string* error) {
517 if (fd == -1) {
518 *error = strerror(errno);
519 }
520 return fd;
521}
522
Spencer Low5200c662015-07-30 23:07:55 -0700523inline int network_inaddr_any_server(int port, int type, std::string* error) {
524 return _fd_set_error_str(socket_inaddr_any_server(port, type), error);
525}
526
Josh Gaocfb21412016-08-24 18:38:44 -0700527inline int network_local_client(const char* name, int namespace_id, int type, std::string* error) {
528 return _fd_set_error_str(socket_local_client(name, namespace_id, type), error);
529}
530
531inline int network_local_server(const char* name, int namespace_id, int type, std::string* error) {
532 return _fd_set_error_str(socket_local_server(name, namespace_id, type), error);
Spencer Low5200c662015-07-30 23:07:55 -0700533}
534
535inline int network_connect(const std::string& host, int port, int type,
536 int timeout, std::string* error) {
537 int getaddrinfo_error = 0;
538 int fd = socket_network_client_timeout(host.c_str(), port, type, timeout,
539 &getaddrinfo_error);
540 if (fd != -1) {
541 return fd;
542 }
543 if (getaddrinfo_error != 0) {
544 *error = gai_strerror(getaddrinfo_error);
545 } else {
546 *error = strerror(errno);
547 }
548 return -1;
549}
550
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800551static __inline__ int adb_socket_accept(int serverfd, struct sockaddr* addr, socklen_t *addrlen)
552{
Benoit Goby95ef8282011-02-01 18:57:41 -0800553 int fd;
554
Kenny Root73167412012-10-12 15:26:45 -0700555 fd = TEMP_FAILURE_RETRY( accept( serverfd, addr, addrlen ) );
Benoit Goby95ef8282011-02-01 18:57:41 -0800556 if (fd >= 0)
557 close_on_exec(fd);
558
559 return fd;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800560}
561
562#undef accept
563#define accept ___xxx_accept
564
David Purselleaae97e2016-04-07 11:25:48 -0700565inline int adb_socket_get_local_port(int fd) {
566 return socket_get_local_port(fd);
567}
568
Spencer Low6ac5d7d2015-05-22 20:09:06 -0700569// Operate on a file descriptor returned from unix_open() or a well-known file
570// descriptor such as STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
571//
572// On Unix, unix_read(), unix_write(), unix_close() map to adb_read(),
573// adb_write(), adb_close() (which all map to Unix system calls), but the
574// Windows implementations (in the ifdef above and in sysdeps_win32.cpp) call
575// into the C Runtime and its configurable CR/LF translation (which is settable
576// via _setmode()).
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800577#define unix_read adb_read
578#define unix_write adb_write
579#define unix_close adb_close
580
Siva Velusamy49ee7cf2015-08-28 16:37:29 -0700581static __inline__ int adb_thread_setname(const std::string& name) {
582#ifdef __APPLE__
583 return pthread_setname_np(name.c_str());
584#else
585 const char *s = name.c_str();
586
587 // pthread_setname_np fails rather than truncating long strings.
588 const int max_task_comm_len = 16; // including the null terminator
589 if (name.length() > (max_task_comm_len - 1)) {
590 char buf[max_task_comm_len];
591 strncpy(buf, name.c_str(), sizeof(buf) - 1);
592 buf[sizeof(buf) - 1] = '\0';
593 s = buf;
594 }
595
596 return pthread_setname_np(pthread_self(), s) ;
597#endif
598}
599
Spencer Lowf055c192015-01-25 14:40:16 -0800600static __inline__ int adb_setsockopt( int fd, int level, int optname, const void* optval, socklen_t optlen )
601{
602 return setsockopt( fd, level, optname, optval, optlen );
603}
604
605#undef setsockopt
606#define setsockopt ___xxx_setsockopt
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800607
608static __inline__ int unix_socketpair( int d, int type, int protocol, int sv[2] )
609{
610 return socketpair( d, type, protocol, sv );
611}
612
613static __inline__ int adb_socketpair( int sv[2] )
614{
615 int rc;
616
617 rc = unix_socketpair( AF_UNIX, SOCK_STREAM, 0, sv );
618 if (rc < 0)
619 return -1;
620
621 close_on_exec( sv[0] );
622 close_on_exec( sv[1] );
623 return 0;
624}
625
626#undef socketpair
627#define socketpair ___xxx_socketpair
628
Josh Gao3777d2e2016-02-16 17:34:53 -0800629typedef struct pollfd adb_pollfd;
630static __inline__ int adb_poll(adb_pollfd* fds, size_t nfds, int timeout) {
631 return TEMP_FAILURE_RETRY(poll(fds, nfds, timeout));
632}
633
634#define poll ___xxx_poll
635
Alex Vallée47d67c92015-05-06 16:26:00 -0400636static __inline__ int adb_mkdir(const std::string& path, int mode)
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800637{
Alex Vallée47d67c92015-05-06 16:26:00 -0400638 return mkdir(path.c_str(), mode);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800639}
Alex Vallée47d67c92015-05-06 16:26:00 -0400640
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800641#undef mkdir
642#define mkdir ___xxx_mkdir
643
Alex Vallée47d67c92015-05-06 16:26:00 -0400644static __inline__ int adb_is_absolute_host_path(const char* path) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800645 return path[0] == '/';
646}
647
leozwangcbf02672014-08-15 09:51:27 -0700648static __inline__ unsigned long adb_thread_id()
649{
Spencer Low8d8126a2015-07-21 02:06:26 -0700650 return (unsigned long)gettid();
leozwangcbf02672014-08-15 09:51:27 -0700651}
652
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800653#endif /* !_WIN32 */
654
Elliott Hughescc65c3b2015-11-20 22:01:06 -0800655static inline void disable_tcp_nagle(int fd) {
656 int off = 1;
657 adb_setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &off, sizeof(off));
658}
659
David Pursellbfd95032016-02-22 14:27:23 -0800660// Sets TCP socket |fd| to send a keepalive TCP message every |interval_sec| seconds. Set
661// |interval_sec| to 0 to disable keepalives. If keepalives are enabled, the connection will be
662// configured to drop after 10 missed keepalives. Returns true on success.
663bool set_tcp_keepalive(int fd, int interval_sec);
664
Elliott Hughes0aeb5052016-06-29 17:42:01 -0700665#if defined(_WIN32)
666// Win32 defines ERROR, which we don't need, but which conflicts with google3 logging.
667#undef ERROR
668#endif
669
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800670#endif /* _ADB_SYSDEPS_H */