1 /*
2 * Copyright (C) 2015 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 #pragma once
18
19 #include <charconv>
20 #include <condition_variable>
21 #include <mutex>
22 #include <string>
23 #include <string_view>
24 #include <type_traits>
25 #include <vector>
26
27 #include <android-base/macros.h>
28
29 #include "adb.h"
30 #include "adb_unique_fd.h"
31
32 void close_stdin();
33
34 bool getcwd(std::string* cwd);
35 bool directory_exists(const std::string& path);
36
37 // Return the user's home directory.
38 std::string adb_get_homedir_path();
39
40 // Return the adb user directory.
41 std::string adb_get_android_dir_path();
42
43 bool mkdirs(const std::string& path);
44
45 std::string escape_arg(const std::string& s);
46
47 std::string dump_hex(const void* ptr, size_t byte_count);
48 std::string dump_header(const amessage* msg);
49 std::string dump_packet(const char* name, const char* func, const apacket* p);
50
51 std::string perror_str(const char* msg);
52
53 [[noreturn]] void error_exit(const char* fmt, ...) __attribute__((__format__(__printf__, 1, 2)));
54 [[noreturn]] void perror_exit(const char* fmt, ...) __attribute__((__format__(__printf__, 1, 2)));
55
56 bool set_file_block_mode(borrowed_fd fd, bool block);
57
58 // Given forward/reverse targets, returns true if they look sane. If an error is found, fills
59 // |error| and returns false.
60 // Currently this only checks "tcp:" targets. Additional checking could be added for other targets
61 // if needed.
62 bool forward_targets_are_valid(const std::string& source, const std::string& dest,
63 std::string* error);
64
65 // A thread-safe blocking queue.
66 template <typename T>
67 class BlockingQueue {
68 std::mutex mutex;
69 std::condition_variable cv;
70 std::vector<T> queue;
71
72 public:
Push(const T & t)73 void Push(const T& t) {
74 {
75 std::unique_lock<std::mutex> lock(mutex);
76 queue.push_back(t);
77 }
78 cv.notify_one();
79 }
80
81 template <typename Fn>
PopAll(Fn fn)82 void PopAll(Fn fn) {
83 std::vector<T> popped;
84
85 {
86 std::unique_lock<std::mutex> lock(mutex);
87 cv.wait(lock, [this]() { return !queue.empty(); });
88 popped = std::move(queue);
89 queue.clear();
90 }
91
92 for (const T& t : popped) {
93 fn(t);
94 }
95 }
96 };
97
98 std::string GetLogFilePath();
99
StripTrailingNulls(std::string_view str)100 inline std::string_view StripTrailingNulls(std::string_view str) {
101 size_t n = 0;
102 for (auto it = str.rbegin(); it != str.rend(); ++it) {
103 if (*it != '\0') {
104 break;
105 }
106 ++n;
107 }
108
109 str.remove_suffix(n);
110 return str;
111 }
112
113 // Base-10 stroll on a string_view.
114 template <typename T>
115 inline bool ParseUint(T* result, std::string_view str, std::string_view* remaining = nullptr) {
116 T value;
117 const auto res = std::from_chars(str.begin(), str.end(), value);
118 if (res.ec != std::errc{}) {
119 return false;
120 }
121 if (res.ptr != str.end() && !remaining) {
122 return false;
123 }
124 if (remaining) {
125 *remaining = std::string_view(res.ptr, str.end() - res.ptr);
126 }
127 *result = value;
128 return true;
129 }
130