blob: 8b0dcee83ac1896f9bea58eade1d4ac67c5b55e9 [file] [log] [blame]
Elliott Hughes58305772015-04-17 13:57:15 -07001/*
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
Elliott Hughesd2aaede2018-10-22 17:02:51 -070017#pragma once
Elliott Hughes58305772015-04-17 13:57:15 -070018
Josh Gao0b13c892017-05-31 11:54:56 -070019#include <condition_variable>
20#include <mutex>
Elliott Hughes58305772015-04-17 13:57:15 -070021#include <string>
Josh Gao3add0c42018-12-20 13:17:04 -080022#include <string_view>
23#include <type_traits>
Josh Gao0b13c892017-05-31 11:54:56 -070024#include <vector>
Elliott Hughes58305772015-04-17 13:57:15 -070025
Josh Gaof0d3b4f2016-03-04 15:15:56 -080026#include <android-base/macros.h>
27
Josh Gao99d3d702018-10-11 13:49:24 -070028#include "adb.h"
29
Josh Gao7d586072015-11-20 15:37:31 -080030void close_stdin();
31
Elliott Hughesa7090b92015-04-17 17:03:59 -070032bool getcwd(std::string* cwd);
Elliott Hughes58305772015-04-17 13:57:15 -070033bool directory_exists(const std::string& path);
Spencer Low22191c32015-08-01 17:29:23 -070034
Yurii Zubrytskyi376b2752016-05-25 15:17:10 -070035// Return the user's home directory.
Josh Gaoe0b75022016-08-30 15:23:35 -070036std::string adb_get_homedir_path();
37
38// Return the adb user directory.
39std::string adb_get_android_dir_path();
Yurii Zubrytskyi376b2752016-05-25 15:17:10 -070040
Alex Vallée47d67c92015-05-06 16:26:00 -040041bool mkdirs(const std::string& path);
Alex Vallée14216142015-05-06 17:22:25 -040042
Elliott Hughes58305772015-04-17 13:57:15 -070043std::string escape_arg(const std::string& s);
44
Yabin Cuiaed3c612015-09-22 15:52:57 -070045std::string dump_hex(const void* ptr, size_t byte_count);
Josh Gao99d3d702018-10-11 13:49:24 -070046std::string dump_header(const amessage* msg);
47std::string dump_packet(const char* name, const char* func, const apacket* p);
Elliott Hughese67f1f82015-04-30 17:32:03 -070048
Elliott Hughesaa245492015-08-03 10:38:08 -070049std::string perror_str(const char* msg);
50
Elliott Hughesd2aaede2018-10-22 17:02:51 -070051[[noreturn]] void error_exit(const char* fmt, ...) __attribute__((__format__(__printf__, 1, 2)));
52[[noreturn]] void perror_exit(const char* fmt, ...) __attribute__((__format__(__printf__, 1, 2)));
53
Yabin Cui6dfef252015-10-06 15:10:05 -070054bool set_file_block_mode(int fd, bool block);
55
David Purselleaae97e2016-04-07 11:25:48 -070056// Given forward/reverse targets, returns true if they look sane. If an error is found, fills
57// |error| and returns false.
58// Currently this only checks "tcp:" targets. Additional checking could be added for other targets
59// if needed.
60bool forward_targets_are_valid(const std::string& source, const std::string& dest,
61 std::string* error);
62
Josh Gao0b13c892017-05-31 11:54:56 -070063// A thread-safe blocking queue.
64template <typename T>
65class BlockingQueue {
66 std::mutex mutex;
67 std::condition_variable cv;
68 std::vector<T> queue;
69
70 public:
71 void Push(const T& t) {
72 {
73 std::unique_lock<std::mutex> lock(mutex);
74 queue.push_back(t);
75 }
76 cv.notify_one();
77 }
78
79 template <typename Fn>
80 void PopAll(Fn fn) {
Josh Gao664a6182017-06-05 14:54:45 -070081 std::vector<T> popped;
Josh Gao0b13c892017-05-31 11:54:56 -070082
Josh Gao664a6182017-06-05 14:54:45 -070083 {
84 std::unique_lock<std::mutex> lock(mutex);
85 cv.wait(lock, [this]() { return !queue.empty(); });
86 popped = std::move(queue);
87 queue.clear();
88 }
89
90 for (const T& t : popped) {
Josh Gao0b13c892017-05-31 11:54:56 -070091 fn(t);
92 }
Josh Gao0b13c892017-05-31 11:54:56 -070093 }
94};
95
Elliott Hughes6eadee82017-06-15 08:35:24 -070096std::string GetLogFilePath();
Josh Gaoe2615412018-12-13 13:06:03 -080097
98inline std::string_view StripTrailingNulls(std::string_view str) {
99 size_t n = 0;
100 for (auto it = str.rbegin(); it != str.rend(); ++it) {
101 if (*it != '\0') {
102 break;
103 }
104 ++n;
105 }
106
107 str.remove_suffix(n);
108 return str;
109}
Josh Gao3add0c42018-12-20 13:17:04 -0800110
111// Base-10 stroll on a string_view.
112template <typename T>
Josh Gaoaeca2082019-02-20 19:46:26 -0800113inline bool ParseUint(T* result, std::string_view str, std::string_view* remaining = nullptr) {
Josh Gao3add0c42018-12-20 13:17:04 -0800114 if (str.empty() || !isdigit(str[0])) {
115 return false;
116 }
117
118 T value = 0;
119 std::string_view::iterator it;
120 constexpr T max = std::numeric_limits<T>::max();
121 for (it = str.begin(); it != str.end() && isdigit(*it); ++it) {
122 if (value > max / 10) {
123 return false;
124 }
125
126 value *= 10;
127
128 T digit = *it - '0';
129 if (value > max - digit) {
130 return false;
131 }
132
133 value += digit;
134 }
135 *result = value;
136 if (remaining) {
137 *remaining = str.substr(it - str.begin());
Josh Gaoaeca2082019-02-20 19:46:26 -0800138 } else {
139 return it == str.end();
Josh Gao3add0c42018-12-20 13:17:04 -0800140 }
Josh Gaoaeca2082019-02-20 19:46:26 -0800141
Josh Gao3add0c42018-12-20 13:17:04 -0800142 return true;
143}