blob: f764a0eea7fbfb63763d1e76e3ec9ea55153c5e8 [file] [log] [blame]
Elliott Hughes38104452015-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
17#ifndef _ADB_UTILS_H_
18#define _ADB_UTILS_H_
19
Josh Gao4b640842017-05-31 11:54:56 -070020#include <condition_variable>
21#include <mutex>
Elliott Hughes38104452015-04-17 13:57:15 -070022#include <string>
Josh Gao4b640842017-05-31 11:54:56 -070023#include <vector>
Elliott Hughes38104452015-04-17 13:57:15 -070024
Josh Gao1b533c82016-03-04 15:15:56 -080025#include <android-base/macros.h>
26
Elliott Hughes65bc2272017-04-18 14:34:16 -070027int syntax_error(const char*, ...);
Elliott Hughes97e74bb2017-02-06 16:20:30 -080028
Josh Gao1eef4782015-11-20 15:37:31 -080029void close_stdin();
30
Elliott Hughes7cf35752015-04-17 17:03:59 -070031bool getcwd(std::string* cwd);
Elliott Hughes38104452015-04-17 13:57:15 -070032bool directory_exists(const std::string& path);
Spencer Low939d0002015-08-01 17:29:23 -070033
Yurii Zubrytskyi70ae70a2016-05-25 15:17:10 -070034// Return the user's home directory.
Josh Gao62ff9d42016-08-30 15:23:35 -070035std::string adb_get_homedir_path();
36
37// Return the adb user directory.
38std::string adb_get_android_dir_path();
Yurii Zubrytskyi70ae70a2016-05-25 15:17:10 -070039
Alex Vallée28d1f8d2015-05-06 16:26:00 -040040bool mkdirs(const std::string& path);
Alex Valléee9163152015-05-06 17:22:25 -040041
Elliott Hughes38104452015-04-17 13:57:15 -070042std::string escape_arg(const std::string& s);
43
Yabin Cui19bec5b2015-09-22 15:52:57 -070044std::string dump_hex(const void* ptr, size_t byte_count);
Elliott Hughes88b4c852015-04-30 17:32:03 -070045
Elliott Hughesb628cb12015-08-03 10:38:08 -070046std::string perror_str(const char* msg);
47
Yabin Cui5fc22312015-10-06 15:10:05 -070048bool set_file_block_mode(int fd, bool block);
49
Josh Gao1b533c82016-03-04 15:15:56 -080050extern int adb_close(int fd);
51
David Pursell19d0c232016-04-07 11:25:48 -070052// Given forward/reverse targets, returns true if they look sane. If an error is found, fills
53// |error| and returns false.
54// Currently this only checks "tcp:" targets. Additional checking could be added for other targets
55// if needed.
56bool forward_targets_are_valid(const std::string& source, const std::string& dest,
57 std::string* error);
58
Josh Gao4b640842017-05-31 11:54:56 -070059// A thread-safe blocking queue.
60template <typename T>
61class BlockingQueue {
62 std::mutex mutex;
63 std::condition_variable cv;
64 std::vector<T> queue;
65
66 public:
67 void Push(const T& t) {
68 {
69 std::unique_lock<std::mutex> lock(mutex);
70 queue.push_back(t);
71 }
72 cv.notify_one();
73 }
74
75 template <typename Fn>
76 void PopAll(Fn fn) {
Josh Gao772d8352017-06-05 14:54:45 -070077 std::vector<T> popped;
Josh Gao4b640842017-05-31 11:54:56 -070078
Josh Gao772d8352017-06-05 14:54:45 -070079 {
80 std::unique_lock<std::mutex> lock(mutex);
81 cv.wait(lock, [this]() { return !queue.empty(); });
82 popped = std::move(queue);
83 queue.clear();
84 }
85
86 for (const T& t : popped) {
Josh Gao4b640842017-05-31 11:54:56 -070087 fn(t);
88 }
Josh Gao4b640842017-05-31 11:54:56 -070089 }
90};
91
Elliott Hughescd61ae32017-06-15 08:35:24 -070092std::string GetLogFilePath();
93
Elliott Hughes38104452015-04-17 13:57:15 -070094#endif