1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793
|
/*
* Copyright (C) 2007 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "client/file_sync_client.h"
#include <dirent.h>
#include <inttypes.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
#include <utime.h>
#include <chrono>
#include <deque>
#include <functional>
#include <memory>
#include <sstream>
#include <string>
#include <variant>
#include <vector>
#include "sysdeps.h"
#include "adb.h"
#include "adb_client.h"
#include "adb_io.h"
#include "adb_utils.h"
#include "compression_utils.h"
#include "file_sync_protocol.h"
#include "line_printer.h"
#include "sysdeps/errno.h"
#include "sysdeps/stat.h"
#include "client/commandline.h"
#include <android-base/file.h>
#include <android-base/strings.h>
#include <android-base/stringprintf.h>
using namespace std::literals;
typedef void(sync_ls_cb)(unsigned mode, uint64_t size, uint64_t time, const char* name);
struct syncsendbuf {
unsigned id;
unsigned size;
char data[SYNC_DATA_MAX];
};
static void ensure_trailing_separators(std::string& local_path, std::string& remote_path) {
if (!adb_is_separator(local_path.back())) {
local_path.push_back(OS_PATH_SEPARATOR);
}
if (remote_path.back() != '/') {
remote_path.push_back('/');
}
}
static bool should_pull_file(mode_t mode) {
return S_ISREG(mode) || S_ISBLK(mode) || S_ISCHR(mode);
}
static bool should_push_file(mode_t mode) {
return S_ISREG(mode) || S_ISLNK(mode);
}
struct copyinfo {
std::string lpath;
std::string rpath;
int64_t time = 0;
uint32_t mode;
uint64_t size = 0;
bool skip = false;
copyinfo(const std::string& local_path,
const std::string& remote_path,
const std::string& name,
unsigned int mode)
: lpath(local_path), rpath(remote_path), mode(mode) {
ensure_trailing_separators(lpath, rpath);
lpath.append(name);
rpath.append(name);
if (S_ISDIR(mode)) {
ensure_trailing_separators(lpath, rpath);
}
}
};
enum class TransferDirection {
push,
pull,
};
struct TransferLedger {
std::chrono::steady_clock::time_point start_time;
uint64_t files_transferred;
uint64_t files_skipped;
uint64_t bytes_transferred;
uint64_t bytes_expected;
bool expect_multiple_files;
private:
std::string last_progress_str;
std::chrono::steady_clock::time_point last_progress_time;
public:
TransferLedger() {
Reset();
}
bool operator==(const TransferLedger& other) const {
return files_transferred == other.files_transferred &&
files_skipped == other.files_skipped && bytes_transferred == other.bytes_transferred;
}
bool operator!=(const TransferLedger& other) const {
return !(*this == other);
}
void Reset() {
start_time = std::chrono::steady_clock::now();
files_transferred = 0;
files_skipped = 0;
bytes_transferred = 0;
bytes_expected = 0;
last_progress_str.clear();
last_progress_time = {};
}
std::string TransferRate() {
if (bytes_transferred == 0) return "";
std::chrono::duration<double> duration;
duration = std::chrono::steady_clock::now() - start_time;
double s = duration.count();
if (s == 0) {
return "";
}
double rate = (static_cast<double>(bytes_transferred) / s) / (1024 * 1024);
return android::base::StringPrintf(" %.1f MB/s (%" PRIu64 " bytes in %.3fs)", rate,
bytes_transferred, s);
}
void ReportProgress(LinePrinter& lp, const std::string& file, uint64_t file_copied_bytes,
uint64_t file_total_bytes) {
static constexpr auto kProgressReportInterval = 100ms;
auto now = std::chrono::steady_clock::now();
if (now < last_progress_time + kProgressReportInterval) {
return;
}
char overall_percentage_str[5] = "?";
if (bytes_expected != 0 && bytes_transferred <= bytes_expected) {
int overall_percentage = static_cast<int>(bytes_transferred * 100 / bytes_expected);
// If we're pulling symbolic links, we'll pull the target of the link rather than
// just create a local link, and that will cause us to go over 100%.
if (overall_percentage <= 100) {
snprintf(overall_percentage_str, sizeof(overall_percentage_str), "%d%%",
overall_percentage);
}
}
std::string output;
if (file_copied_bytes > file_total_bytes || file_total_bytes == 0) {
// This case can happen if we're racing against something that wrote to the file
// between our stat and our read, or if we're reading a magic file that lies about
// its size. Just show how much we've copied.
output = android::base::StringPrintf("[%4s] %s: %" PRId64 "/?", overall_percentage_str,
file.c_str(), file_copied_bytes);
} else {
// If we're transferring multiple files, we want to know how far through the current
// file we are, as well as the overall percentage.
if (expect_multiple_files) {
int file_percentage = static_cast<int>(file_copied_bytes * 100 / file_total_bytes);
output = android::base::StringPrintf("[%4s] %s: %d%%", overall_percentage_str,
file.c_str(), file_percentage);
} else {
output =
android::base::StringPrintf("[%4s] %s", overall_percentage_str, file.c_str());
}
}
if (output != last_progress_str) {
lp.Print(output, LinePrinter::LineType::INFO);
last_progress_str = std::move(output);
last_progress_time = now;
}
}
void ReportTransferRate(LinePrinter& lp, const std::string& name, TransferDirection direction) {
const char* direction_str = (direction == TransferDirection::push) ? "pushed" : "pulled";
std::stringstream ss;
if (!name.empty()) {
std::string_view display_name(name);
char* out = getenv("ANDROID_PRODUCT_OUT");
if (out) android::base::ConsumePrefix(&display_name, out);
ss << display_name << ": ";
}
ss << files_transferred << " file" << ((files_transferred == 1) ? "" : "s") << " "
<< direction_str << ", " << files_skipped << " skipped.";
ss << TransferRate();
lp.Print(ss.str(), LinePrinter::LineType::INFO);
lp.KeepInfoLine();
}
};
class SyncConnection {
public:
SyncConnection() : acknowledgement_buffer_(sizeof(sync_status) + SYNC_DATA_MAX) {
acknowledgement_buffer_.resize(0);
max = SYNC_DATA_MAX; // TODO: decide at runtime.
std::string error;
auto&& features = adb_get_feature_set(&error);
if (!features) {
Error("failed to get feature set: %s", error.c_str());
} else {
features_ = &*features;
have_stat_v2_ = CanUseFeature(*features, kFeatureStat2);
have_ls_v2_ = CanUseFeature(*features, kFeatureLs2);
have_sendrecv_v2_ = CanUseFeature(*features, kFeatureSendRecv2);
have_sendrecv_v2_brotli_ = CanUseFeature(*features, kFeatureSendRecv2Brotli);
have_sendrecv_v2_lz4_ = CanUseFeature(*features, kFeatureSendRecv2LZ4);
have_sendrecv_v2_zstd_ = CanUseFeature(*features, kFeatureSendRecv2Zstd);
have_sendrecv_v2_dry_run_send_ = CanUseFeature(*features, kFeatureSendRecv2DryRunSend);
std::string error;
fd.reset(adb_connect("sync:", &error));
if (fd < 0) {
Error("connect failed: %s", error.c_str());
}
}
}
~SyncConnection() {
if (!IsValid()) return;
if (SendQuit()) {
// We sent a quit command, so the server should be doing orderly
// shutdown soon. But if we encountered an error while we were using
// the connection, the server might still be sending data (before
// doing orderly shutdown), in which case we won't wait for all of
// the data nor the coming orderly shutdown. In the common success
// case, this will wait for the server to do orderly shutdown.
ReadOrderlyShutdown(fd);
}
line_printer_.KeepInfoLine();
}
bool HaveSendRecv2() const { return have_sendrecv_v2_; }
bool HaveSendRecv2Brotli() const { return have_sendrecv_v2_brotli_; }
bool HaveSendRecv2LZ4() const { return have_sendrecv_v2_lz4_; }
bool HaveSendRecv2Zstd() const { return have_sendrecv_v2_zstd_; }
bool HaveSendRecv2DryRunSend() const { return have_sendrecv_v2_dry_run_send_; }
// Resolve a compression type which might be CompressionType::Any to a specific compression
// algorithm.
CompressionType ResolveCompressionType(CompressionType compression) const {
if (compression == CompressionType::Any) {
if (HaveSendRecv2Zstd()) {
return CompressionType::Zstd;
} else if (HaveSendRecv2LZ4()) {
return CompressionType::LZ4;
} else if (HaveSendRecv2Brotli()) {
return CompressionType::Brotli;
}
return CompressionType::None;
}
return compression;
}
const FeatureSet& Features() const { return *features_; }
bool IsValid() { return fd >= 0; }
void SetQuiet(bool quiet) {
line_printer_.quiet_ = quiet;
}
void NewTransfer() {
current_ledger_.Reset();
}
void RecordBytesTransferred(size_t bytes) {
current_ledger_.bytes_transferred += bytes;
global_ledger_.bytes_transferred += bytes;
}
void RecordFileSent(std::string from, std::string to) {
RecordFilesTransferred(1);
deferred_acknowledgements_.emplace_back(std::move(from), std::move(to));
}
void RecordFilesTransferred(size_t files) {
current_ledger_.files_transferred += files;
global_ledger_.files_transferred += files;
}
void RecordFilesSkipped(size_t files) {
current_ledger_.files_skipped += files;
global_ledger_.files_skipped += files;
}
void ReportProgress(const std::string& file, uint64_t file_copied_bytes,
uint64_t file_total_bytes) {
current_ledger_.ReportProgress(line_printer_, file, file_copied_bytes, file_total_bytes);
}
void ReportTransferRate(const std::string& file, TransferDirection direction) {
current_ledger_.ReportTransferRate(line_printer_, file, direction);
}
void ReportOverallTransferRate(TransferDirection direction) {
if (current_ledger_ != global_ledger_) {
global_ledger_.ReportTransferRate(line_printer_, "", direction);
}
}
bool SendRequest(int id, const std::string& path) {
if (path.length() > 1024) {
Error("SendRequest failed: path too long: %zu", path.length());
errno = ENAMETOOLONG;
return false;
}
// Sending header and payload in a single write makes a noticeable
// difference to "adb sync" performance.
std::vector<char> buf(sizeof(SyncRequest) + path.length());
SyncRequest* req = reinterpret_cast<SyncRequest*>(&buf[0]);
req->id = id;
req->path_length = path.length();
char* data = reinterpret_cast<char*>(req + 1);
memcpy(data, path.data(), path.length());
return WriteFdExactly(fd, buf.data(), buf.size());
}
bool SendSend2(std::string_view path, mode_t mode, CompressionType compression, bool dry_run) {
if (path.length() > 1024) {
Error("SendRequest failed: path too long: %zu", path.length());
errno = ENAMETOOLONG;
return false;
}
Block buf;
SyncRequest req;
req.id = ID_SEND_V2;
req.path_length = path.length();
syncmsg msg;
msg.send_v2_setup.id = ID_SEND_V2;
msg.send_v2_setup.mode = mode;
msg.send_v2_setup.flags = 0;
switch (compression) {
case CompressionType::None:
break;
case CompressionType::Brotli:
msg.send_v2_setup.flags = kSyncFlagBrotli;
break;
case CompressionType::LZ4:
msg.send_v2_setup.flags = kSyncFlagLZ4;
break;
case CompressionType::Zstd:
msg.send_v2_setup.flags = kSyncFlagZstd;
break;
case CompressionType::Any:
LOG(FATAL) << "unexpected CompressionType::Any";
}
if (dry_run) {
msg.send_v2_setup.flags |= kSyncFlagDryRun;
}
buf.resize(sizeof(SyncRequest) + path.length() + sizeof(msg.send_v2_setup));
void* p = buf.data();
p = mempcpy(p, &req, sizeof(SyncRequest));
p = mempcpy(p, path.data(), path.length());
p = mempcpy(p, &msg.send_v2_setup, sizeof(msg.send_v2_setup));
return WriteFdExactly(fd, buf.data(), buf.size());
}
bool SendRecv2(const std::string& path, CompressionType compression) {
if (path.length() > 1024) {
Error("SendRequest failed: path too long: %zu", path.length());
errno = ENAMETOOLONG;
return false;
}
Block buf;
SyncRequest req;
req.id = ID_RECV_V2;
req.path_length = path.length();
syncmsg msg;
msg.recv_v2_setup.id = ID_RECV_V2;
msg.recv_v2_setup.flags = 0;
switch (compression) {
case CompressionType::None:
break;
case CompressionType::Brotli:
msg.recv_v2_setup.flags |= kSyncFlagBrotli;
break;
case CompressionType::LZ4:
msg.recv_v2_setup.flags |= kSyncFlagLZ4;
break;
case CompressionType::Zstd:
msg.recv_v2_setup.flags |= kSyncFlagZstd;
break;
case CompressionType::Any:
LOG(FATAL) << "unexpected CompressionType::Any";
}
buf.resize(sizeof(SyncRequest) + path.length() + sizeof(msg.recv_v2_setup));
void* p = buf.data();
p = mempcpy(p, &req, sizeof(SyncRequest));
p = mempcpy(p, path.data(), path.length());
p = mempcpy(p, &msg.recv_v2_setup, sizeof(msg.recv_v2_setup));
return WriteFdExactly(fd, buf.data(), buf.size());
}
bool SendStat(const std::string& path) {
if (!have_stat_v2_) {
errno = ENOTSUP;
return false;
}
return SendRequest(ID_STAT_V2, path);
}
bool SendLstat(const std::string& path) {
if (have_stat_v2_) {
return SendRequest(ID_LSTAT_V2, path);
} else {
return SendRequest(ID_LSTAT_V1, path);
}
}
bool FinishStat(struct stat* st) {
syncmsg msg;
memset(st, 0, sizeof(*st));
if (have_stat_v2_) {
if (!ReadFdExactly(fd.get(), &msg.stat_v2, sizeof(msg.stat_v2))) {
PLOG(FATAL) << "protocol fault: failed to read stat response";
}
if (msg.stat_v2.id != ID_LSTAT_V2 && msg.stat_v2.id != ID_STAT_V2) {
PLOG(FATAL) << "protocol fault: stat response has wrong message id: "
<< msg.stat_v2.id;
}
if (msg.stat_v2.error != 0) {
errno = errno_from_wire(msg.stat_v2.error);
return false;
}
st->st_dev = msg.stat_v2.dev;
st->st_ino = msg.stat_v2.ino;
st->st_mode = msg.stat_v2.mode;
st->st_nlink = msg.stat_v2.nlink;
st->st_uid = msg.stat_v2.uid;
st->st_gid = msg.stat_v2.gid;
st->st_size = msg.stat_v2.size;
st->st_atime = msg.stat_v2.atime;
st->st_mtime = msg.stat_v2.mtime;
st->st_ctime = msg.stat_v2.ctime;
return true;
} else {
if (!ReadFdExactly(fd.get(), &msg.stat_v1, sizeof(msg.stat_v1))) {
PLOG(FATAL) << "protocol fault: failed to read stat response";
}
if (msg.stat_v1.id != ID_LSTAT_V1) {
LOG(FATAL) << "protocol fault: stat response has wrong message id: "
<< msg.stat_v1.id;
}
if (msg.stat_v1.mode == 0 && msg.stat_v1.size == 0 && msg.stat_v1.mtime == 0) {
// There's no way for us to know what the error was.
errno = ENOPROTOOPT;
return false;
}
st->st_mode = msg.stat_v1.mode;
st->st_size = msg.stat_v1.size;
st->st_ctime = msg.stat_v1.mtime;
st->st_mtime = msg.stat_v1.mtime;
}
return true;
}
bool SendLs(const std::string& path) {
return SendRequest(have_ls_v2_ ? ID_LIST_V2 : ID_LIST_V1, path);
}
private:
template <bool v2>
static bool FinishLsImpl(borrowed_fd fd, const std::function<sync_ls_cb>& callback) {
using dent_type =
std::conditional_t<v2, decltype(syncmsg::dent_v2), decltype(syncmsg::dent_v1)>;
while (true) {
dent_type dent;
if (!ReadFdExactly(fd, &dent, sizeof(dent))) return false;
uint32_t expected_id = v2 ? ID_DENT_V2 : ID_DENT_V1;
if (dent.id == ID_DONE) return true;
if (dent.id != expected_id) return false;
// Maximum length of a file name excluding null terminator (NAME_MAX) on Linux is 255.
char buf[256];
size_t len = dent.namelen;
if (len > 255) return false;
if (!ReadFdExactly(fd, buf, len)) return false;
buf[len] = 0;
// Address the unlikely scenario wherein a
// compromised device/service might be able to
// traverse across directories on the host. Let's
// shut that door!
if (strchr(buf, '/')
#if defined(_WIN32)
|| strchr(buf, '\\')
#endif
) {
return false;
}
callback(dent.mode, dent.size, dent.mtime, buf);
}
}
public:
bool FinishLs(const std::function<sync_ls_cb>& callback) {
if (have_ls_v2_) {
return FinishLsImpl<true>(this->fd, callback);
} else {
return FinishLsImpl<false>(this->fd, callback);
}
}
// Sending header, payload, and footer in a single write makes a huge
// difference to "adb sync" performance.
bool SendSmallFile(const std::string& path, mode_t mode, const std::string& lpath,
const std::string& rpath, unsigned mtime, const char* data,
size_t data_length, bool dry_run) {
if (dry_run) {
// We need to use send v2 for dry run.
return SendLargeFile(path, mode, lpath, rpath, mtime, CompressionType::None, dry_run);
}
std::string path_and_mode = android::base::StringPrintf("%s,%d", path.c_str(), mode);
if (path_and_mode.length() > 1024) {
Error("SendSmallFile failed: path too long: %zu", path_and_mode.length());
errno = ENAMETOOLONG;
return false;
}
std::vector<char> buf(sizeof(SyncRequest) + path_and_mode.length() + sizeof(SyncRequest) +
data_length + sizeof(SyncRequest));
char* p = &buf[0];
SyncRequest* req_send = reinterpret_cast<SyncRequest*>(p);
req_send->id = ID_SEND_V1;
req_send->path_length = path_and_mode.length();
p += sizeof(SyncRequest);
memcpy(p, path_and_mode.data(), path_and_mode.size());
p += path_and_mode.length();
SyncRequest* req_data = reinterpret_cast<SyncRequest*>(p);
req_data->id = ID_DATA;
req_data->path_length = data_length;
p += sizeof(SyncRequest);
memcpy(p, data, data_length);
p += data_length;
SyncRequest* req_done = reinterpret_cast<SyncRequest*>(p);
req_done->id = ID_DONE;
req_done->path_length = mtime;
p += sizeof(SyncRequest);
WriteOrDie(lpath, rpath, &buf[0], (p - &buf[0]));
RecordFileSent(lpath, rpath);
RecordBytesTransferred(data_length);
ReportProgress(rpath, data_length, data_length);
return true;
}
bool SendLargeFile(const std::string& path, mode_t mode, const std::string& lpath,
const std::string& rpath, unsigned mtime, CompressionType compression,
bool dry_run) {
if (dry_run && !HaveSendRecv2DryRunSend()) {
Error("dry-run not supported by the device");
return false;
}
if (!HaveSendRecv2()) {
return SendLargeFileLegacy(path, mode, lpath, rpath, mtime);
}
compression = ResolveCompressionType(compression);
if (!SendSend2(path, mode, compression, dry_run)) {
Error("failed to send ID_SEND_V2 message '%s': %s", path.c_str(), strerror(errno));
return false;
}
struct stat st;
if (stat(lpath.c_str(), &st) == -1) {
Error("cannot stat '%s': %s", lpath.c_str(), strerror(errno));
return false;
}
uint64_t total_size = st.st_size;
uint64_t bytes_copied = 0;
unique_fd lfd(adb_open(lpath.c_str(), O_RDONLY | O_CLOEXEC));
if (lfd < 0) {
Error("opening '%s' locally failed: %s", lpath.c_str(), strerror(errno));
return false;
}
syncsendbuf sbuf;
sbuf.id = ID_DATA;
std::variant<std::monostate, NullEncoder, BrotliEncoder, LZ4Encoder, ZstdEncoder>
encoder_storage;
Encoder* encoder = nullptr;
switch (compression) {
case CompressionType::None:
encoder = &encoder_storage.emplace<NullEncoder>(SYNC_DATA_MAX);
break;
case CompressionType::Brotli:
encoder = &encoder_storage.emplace<BrotliEncoder>(SYNC_DATA_MAX);
break;
case CompressionType::LZ4:
encoder = &encoder_storage.emplace<LZ4Encoder>(SYNC_DATA_MAX);
break;
case CompressionType::Zstd:
encoder = &encoder_storage.emplace<ZstdEncoder>(SYNC_DATA_MAX);
break;
case CompressionType::Any:
LOG(FATAL) << "unexpected CompressionType::Any";
}
bool sending = true;
while (sending) {
Block input(SYNC_DATA_MAX);
int r = adb_read(lfd.get(), input.data(), input.size());
if (r < 0) {
Error("reading '%s' locally failed: %s", lpath.c_str(), strerror(errno));
return false;
}
if (r == 0) {
encoder->Finish();
} else {
input.resize(r);
encoder->Append(std::move(input));
RecordBytesTransferred(r);
bytes_copied += r;
ReportProgress(rpath, bytes_copied, total_size);
}
while (true) {
Block output;
EncodeResult result = encoder->Encode(&output);
if (result == EncodeResult::Error) {
Error("compressing '%s' locally failed", lpath.c_str());
return false;
}
if (!output.empty()) {
sbuf.size = output.size();
memcpy(sbuf.data, output.data(), output.size());
WriteOrDie(lpath, rpath, &sbuf, sizeof(SyncRequest) + output.size());
}
if (result == EncodeResult::Done) {
sending = false;
break;
} else if (result == EncodeResult::NeedInput) {
break;
} else if (result == EncodeResult::MoreOutput) {
continue;
}
}
}
syncmsg msg;
msg.data.id = ID_DONE;
msg.data.size = mtime;
RecordFileSent(lpath, rpath);
return WriteOrDie(lpath, rpath, &msg.data, sizeof(msg.data));
}
bool SendLargeFileLegacy(const std::string& path, mode_t mode, const std::string& lpath,
const std::string& rpath, unsigned mtime) {
std::string path_and_mode = android::base::StringPrintf("%s,%d", path.c_str(), mode);
if (!SendRequest(ID_SEND_V1, path_and_mode)) {
Error("failed to send ID_SEND_V1 message '%s': %s", path_and_mode.c_str(),
strerror(errno));
return false;
}
struct stat st;
if (stat(lpath.c_str(), &st) == -1) {
Error("cannot stat '%s': %s", lpath.c_str(), strerror(errno));
return false;
}
uint64_t total_size = st.st_size;
uint64_t bytes_copied = 0;
unique_fd lfd(adb_open(lpath.c_str(), O_RDONLY | O_CLOEXEC));
if (lfd < 0) {
Error("opening '%s' locally failed: %s", lpath.c_str(), strerror(errno));
return false;
}
syncsendbuf sbuf;
sbuf.id = ID_DATA;
while (true) {
int bytes_read = adb_read(lfd, sbuf.data, max);
if (bytes_read == -1) {
Error("reading '%s' locally failed: %s", lpath.c_str(), strerror(errno));
return false;
} else if (bytes_read == 0) {
break;
}
sbuf.size = bytes_read;
WriteOrDie(lpath, rpath, &sbuf, sizeof(SyncRequest) + bytes_read);
RecordBytesTransferred(bytes_read);
bytes_copied += bytes_read;
ReportProgress(rpath, bytes_copied, total_size);
}
syncmsg msg;
msg.data.id = ID_DONE;
msg.data.size = mtime;
RecordFileSent(lpath, rpath);
return WriteOrDie(lpath, rpath, &msg.data, sizeof(msg.data));
}
bool ReportCopyFailure(const std::string& from, const std::string& to, const syncmsg& msg) {
std::vector<char> buf(msg.status.msglen + 1);
if (!ReadFdExactly(fd, &buf[0], msg.status.msglen)) {
Error("failed to copy '%s' to '%s'; failed to read reason (!): %s", from.c_str(),
to.c_str(), strerror(errno));
return false;
}
buf[msg.status.msglen] = 0;
Error("failed to copy '%s' to '%s': remote %s", from.c_str(), to.c_str(), &buf[0]);
return false;
}
void CopyDone() { deferred_acknowledgements_.pop_front(); }
void ReportDeferredCopyFailure(const std::string& msg) {
auto& [from, to] = deferred_acknowledgements_.front();
Error("failed to copy '%s' to '%s': remote %s", from.c_str(), to.c_str(), msg.c_str());
deferred_acknowledgements_.pop_front();
}
bool ReadAcknowledgements(bool read_all = false) {
// We need to read enough such that adbd's intermediate socket's write buffer can't be
// full. The default buffer on Linux is 212992 bytes, but there's 576 bytes of bookkeeping
// overhead per write. The worst case scenario is a continuous string of failures, since
// each logical packet is divided into two writes. If our packet size if conservatively 512
// bytes long, this leaves us with space for 128 responses.
constexpr size_t max_deferred_acks = 128;
auto& buf = acknowledgement_buffer_;
adb_pollfd pfd = {.fd = fd.get(), .events = POLLIN};
while (!deferred_acknowledgements_.empty()) {
bool should_block = read_all || deferred_acknowledgements_.size() >= max_deferred_acks;
enum class ReadStatus {
Success,
Failure,
TryLater,
};
// Read until the acknowledgement buffer has at least `amount` bytes in it (or there is
// an I/O error, or the socket has no data ready to read).
auto read_until_amount = [&](size_t amount) -> ReadStatus {
while (buf.size() < amount) {
// The fd is blocking, so if we want to avoid blocking in this function, we must
// poll first to verify that some data is available before trying to read it.
if (!should_block) {
ssize_t rc = adb_poll(&pfd, 1, 0);
if (rc == 0) {
return ReadStatus::TryLater;
}
}
const ssize_t bytes_left = amount - buf.size();
ssize_t rc = adb_read(fd, buf.end(), bytes_left);
if (rc <= 0) {
Error("failed to read copy response");
return ReadStatus::Failure;
}
buf.resize(buf.size() + rc);
if (!should_block && buf.size() < amount) {
return ReadStatus::TryLater;
}
}
return ReadStatus::Success;
};
switch (read_until_amount(sizeof(sync_status))) {
case ReadStatus::TryLater:
return true;
case ReadStatus::Failure:
return false;
case ReadStatus::Success:
break;
}
auto* hdr = reinterpret_cast<sync_status*>(buf.data());
if (hdr->id == ID_OKAY) {
buf.resize(0);
if (hdr->msglen != 0) {
Error("received ID_OKAY with msg_len (%" PRIu32 " != 0", hdr->msglen);
return false;
}
CopyDone();
continue;
} else if (hdr->id != ID_FAIL) {
Error("unexpected response from daemon: id = %#" PRIx32, hdr->id);
return false;
} else if (hdr->msglen > SYNC_DATA_MAX) {
Error("too-long message length from daemon: msglen = %" PRIu32, hdr->msglen);
return false;
}
switch (read_until_amount(sizeof(sync_status) + hdr->msglen)) {
case ReadStatus::TryLater:
return true;
case ReadStatus::Failure:
return false;
case ReadStatus::Success:
break;
}
std::string msg(buf.begin() + sizeof(sync_status), buf.end());
ReportDeferredCopyFailure(msg);
buf.resize(0);
return false;
}
return true;
}
void Printf(const char* fmt, ...) __attribute__((__format__(__printf__, 2, 3))) {
std::string s;
va_list ap;
va_start(ap, fmt);
android::base::StringAppendV(&s, fmt, ap);
va_end(ap);
line_printer_.Print(s, LinePrinter::INFO);
}
void Println(const char* fmt, ...) __attribute__((__format__(__printf__, 2, 3))) {
std::string s;
va_list ap;
va_start(ap, fmt);
android::base::StringAppendV(&s, fmt, ap);
va_end(ap);
line_printer_.Print(s, LinePrinter::INFO);
line_printer_.KeepInfoLine();
}
void Error(const char* fmt, ...) __attribute__((__format__(__printf__, 2, 3))) {
std::string s = "adb: error: ";
va_list ap;
va_start(ap, fmt);
android::base::StringAppendV(&s, fmt, ap);
va_end(ap);
line_printer_.Print(s, LinePrinter::ERROR);
}
void Warning(const char* fmt, ...) __attribute__((__format__(__printf__, 2, 3))) {
std::string s = "adb: warning: ";
va_list ap;
va_start(ap, fmt);
android::base::StringAppendV(&s, fmt, ap);
va_end(ap);
line_printer_.Print(s, LinePrinter::WARNING);
}
void ComputeExpectedTotalBytes(const std::vector<copyinfo>& file_list) {
current_ledger_.bytes_expected = 0;
for (const copyinfo& ci : file_list) {
// Unfortunately, this doesn't work for symbolic links, because we'll copy the
// target of the link rather than just creating a link. (But ci.size is the link size.)
if (!ci.skip) current_ledger_.bytes_expected += ci.size;
}
current_ledger_.expect_multiple_files = true;
}
void SetExpectedTotalBytes(uint64_t expected_total_bytes) {
current_ledger_.bytes_expected = expected_total_bytes;
current_ledger_.expect_multiple_files = false;
}
// TODO: add a char[max] buffer here, to replace syncsendbuf...
unique_fd fd;
size_t max;
private:
std::deque<std::pair<std::string, std::string>> deferred_acknowledgements_;
Block acknowledgement_buffer_;
const FeatureSet* features_ = nullptr;
bool have_stat_v2_;
bool have_ls_v2_;
bool have_sendrecv_v2_;
bool have_sendrecv_v2_brotli_;
bool have_sendrecv_v2_lz4_;
bool have_sendrecv_v2_zstd_;
bool have_sendrecv_v2_dry_run_send_;
TransferLedger global_ledger_;
TransferLedger current_ledger_;
LinePrinter line_printer_;
bool SendQuit() {
return SendRequest(ID_QUIT, ""); // TODO: add a SendResponse?
}
bool WriteOrDie(const std::string& from, const std::string& to, const void* data,
size_t data_length) {
if (!WriteFdExactly(fd, data, data_length)) {
if (errno == ECONNRESET) {
// Assume adbd told us why it was closing the connection, and
// try to read failure reason from adbd.
syncmsg msg;
if (!ReadFdExactly(fd, &msg.status, sizeof(msg.status))) {
Error("failed to copy '%s' to '%s': no response: %s", from.c_str(), to.c_str(),
strerror(errno));
} else if (msg.status.id != ID_FAIL) {
Error("failed to copy '%s' to '%s': not ID_FAIL: %d", from.c_str(), to.c_str(),
msg.status.id);
} else {
ReportCopyFailure(from, to, msg);
}
} else {
Error("%zu-byte write failed: %s", data_length, strerror(errno));
}
_exit(1);
}
return true;
}
};
static bool sync_ls(SyncConnection& sc, const std::string& path,
const std::function<sync_ls_cb>& func) {
return sc.SendLs(path) && sc.FinishLs(func);
}
static bool sync_stat(SyncConnection& sc, const std::string& path, struct stat* st) {
return sc.SendStat(path) && sc.FinishStat(st);
}
static bool sync_lstat(SyncConnection& sc, const std::string& path, struct stat* st) {
return sc.SendLstat(path) && sc.FinishStat(st);
}
static bool sync_stat_fallback(SyncConnection& sc, const std::string& path, struct stat* st) {
if (sync_stat(sc, path, st)) {
return true;
}
if (errno != ENOTSUP) {
return false;
}
// Try to emulate the parts we can when talking to older adbds.
bool lstat_result = sync_lstat(sc, path, st);
if (!lstat_result) {
return false;
}
if (S_ISLNK(st->st_mode)) {
// If the target is a symlink, figure out whether it's a file or a directory.
// Also, zero out the st_size field, since no one actually cares what the path length is.
st->st_size = 0;
std::string dir_path = path;
dir_path.push_back('/');
struct stat tmp_st;
st->st_mode &= ~S_IFMT;
if (sync_lstat(sc, dir_path, &tmp_st)) {
st->st_mode |= S_IFDIR;
} else {
st->st_mode |= S_IFREG;
}
}
return true;
}
static bool sync_send(SyncConnection& sc, const std::string& lpath, const std::string& rpath,
unsigned mtime, mode_t mode, bool sync, CompressionType compression,
bool dry_run) {
if (sync) {
struct stat st;
if (sync_lstat(sc, rpath, &st)) {
if (st.st_mtime == static_cast<time_t>(mtime)) {
sc.RecordFilesSkipped(1);
return true;
}
}
}
if (S_ISLNK(mode)) {
#if !defined(_WIN32)
char buf[PATH_MAX];
ssize_t data_length = readlink(lpath.c_str(), buf, PATH_MAX - 1);
if (data_length == -1) {
sc.Error("readlink '%s' failed: %s", lpath.c_str(), strerror(errno));
return false;
}
buf[data_length++] = '\0';
if (!sc.SendSmallFile(rpath, mode, lpath, rpath, mtime, buf, data_length, dry_run)) {
return false;
}
return sc.ReadAcknowledgements(sync);
#endif
}
struct stat st;
if (stat(lpath.c_str(), &st) == -1) {
sc.Error("failed to stat local file '%s': %s", lpath.c_str(), strerror(errno));
return false;
}
if (st.st_size < SYNC_DATA_MAX) {
std::string data;
if (!android::base::ReadFileToString(lpath, &data, true)) {
sc.Error("failed to read all of '%s': %s", lpath.c_str(), strerror(errno));
return false;
}
if (!sc.SendSmallFile(rpath, mode, lpath, rpath, mtime, data.data(), data.size(),
dry_run)) {
return false;
}
} else {
if (!sc.SendLargeFile(rpath, mode, lpath, rpath, mtime, compression, dry_run)) {
return false;
}
}
return sc.ReadAcknowledgements(sync);
}
static bool sync_recv_v1(SyncConnection& sc, const char* rpath, const char* lpath, const char* name,
uint64_t expected_size) {
if (!sc.SendRequest(ID_RECV_V1, rpath)) return false;
adb_unlink(lpath);
unique_fd lfd(adb_creat(lpath, 0644));
if (lfd < 0) {
sc.Error("cannot create '%s': %s", lpath, strerror(errno));
return false;
}
uint64_t bytes_copied = 0;
while (true) {
syncmsg msg;
if (!ReadFdExactly(sc.fd, &msg.data, sizeof(msg.data))) {
adb_unlink(lpath);
return false;
}
if (msg.data.id == ID_DONE) break;
if (msg.data.id != ID_DATA) {
adb_unlink(lpath);
sc.ReportCopyFailure(rpath, lpath, msg);
return false;
}
if (msg.data.size > sc.max) {
sc.Error("msg.data.size too large: %u (max %zu)", msg.data.size, sc.max);
adb_unlink(lpath);
return false;
}
char buffer[SYNC_DATA_MAX];
if (!ReadFdExactly(sc.fd, buffer, msg.data.size)) {
adb_unlink(lpath);
return false;
}
if (!WriteFdExactly(lfd, buffer, msg.data.size)) {
sc.Error("cannot write '%s': %s", lpath, strerror(errno));
adb_unlink(lpath);
return false;
}
bytes_copied += msg.data.size;
sc.RecordBytesTransferred(msg.data.size);
sc.ReportProgress(name != nullptr ? name : rpath, bytes_copied, expected_size);
}
sc.RecordFilesTransferred(1);
return true;
}
static bool sync_recv_v2(SyncConnection& sc, const char* rpath, const char* lpath, const char* name,
uint64_t expected_size, CompressionType compression) {
compression = sc.ResolveCompressionType(compression);
if (!sc.SendRecv2(rpath, compression)) return false;
adb_unlink(lpath);
unique_fd lfd(adb_creat(lpath, 0644));
if (lfd < 0) {
sc.Error("cannot create '%s': %s", lpath, strerror(errno));
return false;
}
uint64_t bytes_copied = 0;
Block buffer(SYNC_DATA_MAX);
std::variant<std::monostate, NullDecoder, BrotliDecoder, LZ4Decoder, ZstdDecoder>
decoder_storage;
Decoder* decoder = nullptr;
std::span buffer_span(buffer.data(), buffer.size());
switch (compression) {
case CompressionType::None:
decoder = &decoder_storage.emplace<NullDecoder>(buffer_span);
break;
case CompressionType::Brotli:
decoder = &decoder_storage.emplace<BrotliDecoder>(buffer_span);
break;
case CompressionType::LZ4:
decoder = &decoder_storage.emplace<LZ4Decoder>(buffer_span);
break;
case CompressionType::Zstd:
decoder = &decoder_storage.emplace<ZstdDecoder>(buffer_span);
break;
case CompressionType::Any:
LOG(FATAL) << "unexpected CompressionType::Any";
}
while (true) {
syncmsg msg;
if (!ReadFdExactly(sc.fd, &msg.data, sizeof(msg.data))) {
adb_unlink(lpath);
return false;
}
if (msg.data.id == ID_DONE) {
if (!decoder->Finish()) {
sc.Error("unexpected ID_DONE");
return false;
}
} else if (msg.data.id != ID_DATA) {
adb_unlink(lpath);
sc.ReportCopyFailure(rpath, lpath, msg);
return false;
} else {
if (msg.data.size > sc.max) {
sc.Error("msg.data.size too large: %u (max %zu)", msg.data.size, sc.max);
adb_unlink(lpath);
return false;
}
Block block(msg.data.size);
if (!ReadFdExactly(sc.fd, block.data(), msg.data.size)) {
adb_unlink(lpath);
return false;
}
decoder->Append(std::move(block));
}
while (true) {
std::span<char> output;
DecodeResult result = decoder->Decode(&output);
if (result == DecodeResult::Error) {
sc.Error("decompress failed");
adb_unlink(lpath);
return false;
}
if (!output.empty()) {
if (!WriteFdExactly(lfd, output.data(), output.size())) {
sc.Error("cannot write '%s': %s", lpath, strerror(errno));
adb_unlink(lpath);
return false;
}
}
bytes_copied += output.size();
sc.RecordBytesTransferred(output.size());
sc.ReportProgress(name != nullptr ? name : rpath, bytes_copied, expected_size);
if (result == DecodeResult::NeedInput) {
break;
} else if (result == DecodeResult::MoreOutput) {
continue;
} else if (result == DecodeResult::Done) {
sc.RecordFilesTransferred(1);
return true;
} else {
LOG(FATAL) << "invalid DecodeResult: " << static_cast<int>(result);
}
}
}
}
static bool sync_recv(SyncConnection& sc, const char* rpath, const char* lpath, const char* name,
uint64_t expected_size, CompressionType compression) {
if (sc.HaveSendRecv2()) {
return sync_recv_v2(sc, rpath, lpath, name, expected_size, compression);
} else {
return sync_recv_v1(sc, rpath, lpath, name, expected_size);
}
}
bool do_sync_ls(const char* path) {
SyncConnection sc;
if (!sc.IsValid()) return false;
return sync_ls(sc, path, [](unsigned mode, uint64_t size, uint64_t time, const char* name) {
printf("%08x %08" PRIx64 " %08" PRIx64 " %s\n", mode, size, time, name);
});
}
static bool IsDotOrDotDot(const char* name) {
return name[0] == '.' && (name[1] == '\0' || (name[1] == '.' && name[2] == '\0'));
}
static bool local_build_list(SyncConnection& sc, std::vector<copyinfo>* file_list,
std::vector<std::string>* directory_list, const std::string& lpath,
const std::string& rpath) {
std::vector<copyinfo> dirlist;
std::unique_ptr<DIR, int (*)(DIR*)> dir(opendir(lpath.c_str()), closedir);
if (!dir) {
sc.Error("cannot open '%s': %s", lpath.c_str(), strerror(errno));
return false;
}
dirent* de;
while ((de = readdir(dir.get()))) {
if (IsDotOrDotDot(de->d_name)) {
continue;
}
std::string stat_path = lpath + de->d_name;
struct stat st;
if (lstat(stat_path.c_str(), &st) == -1) {
sc.Error("cannot lstat '%s': %s", stat_path.c_str(),
strerror(errno));
continue;
}
copyinfo ci(lpath, rpath, de->d_name, st.st_mode);
if (S_ISDIR(st.st_mode)) {
dirlist.push_back(ci);
} else {
if (!should_push_file(st.st_mode)) {
sc.Warning("skipping special file '%s' (mode = 0o%o)", lpath.c_str(), st.st_mode);
ci.skip = true;
}
ci.time = st.st_mtime;
ci.size = st.st_size;
file_list->push_back(ci);
}
}
// Close this directory and recurse.
dir.reset();
for (const copyinfo& ci : dirlist) {
directory_list->push_back(ci.rpath);
local_build_list(sc, file_list, directory_list, ci.lpath, ci.rpath);
}
return true;
}
// dirname("//foo") returns "//", so we can't do the obvious `path == "/"`.
static bool is_root_dir(std::string_view path) {
for (char c : path) {
if (c != '/') {
return false;
}
}
return true;
}
static bool copy_local_dir_remote(SyncConnection& sc, std::string lpath, std::string rpath,
bool check_timestamps, bool list_only,
CompressionType compression, bool dry_run) {
sc.NewTransfer();
// Make sure that both directory paths end in a slash.
// Both paths are known to be nonempty, so we don't need to check.
ensure_trailing_separators(lpath, rpath);
// Recursively build the list of files to copy.
std::vector<copyinfo> file_list;
std::vector<std::string> directory_list;
for (std::string path = rpath; !is_root_dir(path); path = android::base::Dirname(path)) {
directory_list.push_back(path);
}
std::reverse(directory_list.begin(), directory_list.end());
int skipped = 0;
if (!local_build_list(sc, &file_list, &directory_list, lpath, rpath)) {
return false;
}
// b/110953234:
// P shipped with a bug that causes directory creation as a side-effect of a push to fail.
// Work around this by explicitly doing a mkdir via shell.
//
// Devices that don't support shell_v2 are unhappy if we try to send a too-long packet to them,
// but they're not affected by this bug, so only apply the workaround if we have shell_v2.
//
// TODO(b/25457350): We don't preserve permissions on directories.
// TODO: Find all of the leaves and `mkdir -p` them instead?
if (!CanUseFeature(sc.Features(), kFeatureFixedPushMkdir) &&
CanUseFeature(sc.Features(), kFeatureShell2)) {
SilentStandardStreamsCallbackInterface cb;
std::string cmd = "mkdir";
for (const auto& dir : directory_list) {
std::string escaped_path = escape_arg(dir);
if (escaped_path.size() > 16384) {
// Somewhat arbitrarily limit that probably won't ever happen.
sc.Error("path too long: %s", escaped_path.c_str());
return false;
}
// The maximum should be 64kiB, but that's not including other stuff that gets tacked
// onto the command line, so let's be a bit conservative.
if (cmd.size() + escaped_path.size() > 32768) {
// Dispatch the command, ignoring failure (since the directory might already exist).
send_shell_command(cmd, false, &cb);
cmd = "mkdir";
}
cmd += " ";
cmd += escaped_path;
}
if (cmd != "mkdir") {
send_shell_command(cmd, false, &cb);
}
}
if (check_timestamps) {
for (const copyinfo& ci : file_list) {
if (!sc.SendLstat(ci.rpath)) {
sc.Error("failed to send lstat");
return false;
}
}
for (copyinfo& ci : file_list) {
struct stat st;
if (sc.FinishStat(&st)) {
if (st.st_size == static_cast<off_t>(ci.size) && st.st_mtime == ci.time) {
ci.skip = true;
}
}
}
}
sc.ComputeExpectedTotalBytes(file_list);
for (const copyinfo& ci : file_list) {
if (!ci.skip) {
if (list_only) {
sc.Println("would push: %s -> %s", ci.lpath.c_str(), ci.rpath.c_str());
} else {
if (!sync_send(sc, ci.lpath, ci.rpath, ci.time, ci.mode, false, compression,
dry_run)) {
return false;
}
}
} else {
skipped++;
}
}
sc.RecordFilesSkipped(skipped);
bool success = sc.ReadAcknowledgements(true);
sc.ReportTransferRate(lpath, TransferDirection::push);
return success;
}
bool do_sync_push(const std::vector<const char*>& srcs, const char* dst, bool sync,
CompressionType compression, bool dry_run, bool quiet) {
SyncConnection sc;
if (!sc.IsValid()) return false;
sc.SetQuiet(quiet);
bool success = true;
bool dst_exists;
bool dst_isdir;
struct stat st;
if (sync_stat_fallback(sc, dst, &st)) {
dst_exists = true;
dst_isdir = S_ISDIR(st.st_mode);
} else {
if (errno == ENOENT || errno == ENOPROTOOPT) {
dst_exists = false;
dst_isdir = false;
} else {
sc.Error("stat failed when trying to push to %s: %s", dst, strerror(errno));
return false;
}
}
if (!dst_isdir) {
if (srcs.size() > 1) {
sc.Error("target '%s' is not a directory", dst);
return false;
} else {
size_t dst_len = strlen(dst);
// A path that ends with a slash doesn't have to be a directory if
// it doesn't exist yet.
if (dst[dst_len - 1] == '/' && dst_exists) {
sc.Error("failed to access '%s': Not a directory", dst);
return false;
}
}
}
for (const char* src_path : srcs) {
const char* dst_path = dst;
struct stat st;
if (stat(src_path, &st) == -1) {
sc.Error("cannot stat '%s': %s", src_path, strerror(errno));
success = false;
continue;
}
if (S_ISDIR(st.st_mode)) {
std::string dst_dir = dst;
// If the destination path existed originally, the source directory
// should be copied as a child of the destination.
if (dst_exists) {
if (!dst_isdir) {
sc.Error("target '%s' is not a directory", dst);
return false;
}
// dst is a POSIX path, so we don't want to use the sysdeps
// helpers here.
if (dst_dir.back() != '/') {
dst_dir.push_back('/');
}
dst_dir.append(android::base::Basename(src_path));
}
success &=
copy_local_dir_remote(sc, src_path, dst_dir, sync, false, compression, dry_run);
continue;
} else if (!should_push_file(st.st_mode)) {
sc.Warning("skipping special file '%s' (mode = 0o%o)", src_path, st.st_mode);
continue;
}
std::string path_holder;
if (dst_isdir) {
// If we're copying a local file to a remote directory,
// we really want to copy to remote_dir + "/" + local_filename.
path_holder = dst_path;
if (path_holder.back() != '/') {
path_holder.push_back('/');
}
path_holder += android::base::Basename(src_path);
dst_path = path_holder.c_str();
}
sc.NewTransfer();
sc.SetExpectedTotalBytes(st.st_size);
success &= sync_send(sc, src_path, dst_path, st.st_mtime, st.st_mode, sync, compression,
dry_run);
sc.ReportTransferRate(src_path, TransferDirection::push);
}
success &= sc.ReadAcknowledgements(true);
sc.ReportOverallTransferRate(TransferDirection::push);
return success;
}
static bool remote_build_list(SyncConnection& sc, std::vector<copyinfo>* file_list,
const std::string& rpath, const std::string& lpath) {
std::vector<copyinfo> dirlist;
std::vector<copyinfo> linklist;
// Add an entry for the current directory to ensure it gets created before pulling its contents.
copyinfo ci(android::base::Dirname(lpath), android::base::Dirname(rpath),
android::base::Basename(lpath), S_IFDIR);
file_list->push_back(ci);
// Put the files/dirs in rpath on the lists.
auto callback = [&](unsigned mode, uint64_t size, uint64_t time, const char* name) {
if (IsDotOrDotDot(name)) {
return;
}
copyinfo ci(lpath, rpath, name, mode);
if (S_ISDIR(mode)) {
dirlist.push_back(ci);
} else if (S_ISLNK(mode)) {
linklist.push_back(ci);
} else {
if (!should_pull_file(ci.mode)) {
sc.Warning("skipping special file '%s' (mode = 0o%o)", ci.rpath.c_str(), ci.mode);
ci.skip = true;
}
ci.time = time;
ci.size = size;
file_list->push_back(ci);
}
};
if (!sync_ls(sc, rpath, callback)) {
return false;
}
// Check each symlink we found to see whether it's a file or directory.
for (copyinfo& link_ci : linklist) {
struct stat st;
if (!sync_stat_fallback(sc, link_ci.rpath, &st)) {
sc.Warning("stat failed for path %s: %s", link_ci.rpath.c_str(), strerror(errno));
continue;
}
if (S_ISDIR(st.st_mode)) {
dirlist.emplace_back(std::move(link_ci));
} else {
file_list->emplace_back(std::move(link_ci));
}
}
// Recurse into each directory we found.
while (!dirlist.empty()) {
copyinfo current = dirlist.back();
dirlist.pop_back();
if (!remote_build_list(sc, file_list, current.rpath, current.lpath)) {
return false;
}
}
return true;
}
static int set_time_and_mode(const std::string& lpath, time_t time,
unsigned int mode) {
struct utimbuf times = { time, time };
int r1 = utime(lpath.c_str(), ×);
/* use umask for permissions */
mode_t mask = umask(0000);
umask(mask);
int r2 = chmod(lpath.c_str(), mode & ~mask);
return r1 ? r1 : r2;
}
static bool copy_remote_dir_local(SyncConnection& sc, std::string rpath, std::string lpath,
bool copy_attrs, CompressionType compression) {
sc.NewTransfer();
// Make sure that both directory paths end in a slash.
// Both paths are known to be nonempty, so we don't need to check.
ensure_trailing_separators(lpath, rpath);
// Recursively build the list of files to copy.
sc.Printf("pull: building file list...");
std::vector<copyinfo> file_list;
if (!remote_build_list(sc, &file_list, rpath, lpath)) {
return false;
}
sc.ComputeExpectedTotalBytes(file_list);
int skipped = 0;
for (const copyinfo &ci : file_list) {
if (!ci.skip) {
if (S_ISDIR(ci.mode)) {
// Entry is for an empty directory, create it and continue.
// TODO(b/25457350): We don't preserve permissions on directories.
if (!mkdirs(ci.lpath)) {
sc.Error("failed to create directory '%s': %s",
ci.lpath.c_str(), strerror(errno));
return false;
}
continue;
}
if (!sync_recv(sc, ci.rpath.c_str(), ci.lpath.c_str(), nullptr, ci.size, compression)) {
return false;
}
if (copy_attrs && set_time_and_mode(ci.lpath, ci.time, ci.mode)) {
return false;
}
} else {
skipped++;
}
}
sc.RecordFilesSkipped(skipped);
sc.ReportTransferRate(rpath, TransferDirection::pull);
return true;
}
bool do_sync_pull(const std::vector<const char*>& srcs, const char* dst, bool copy_attrs,
CompressionType compression, const char* name, bool quiet) {
SyncConnection sc;
if (!sc.IsValid()) return false;
sc.SetQuiet(quiet);
bool success = true;
struct stat st;
bool dst_exists = true;
if (stat(dst, &st) == -1) {
dst_exists = false;
// If we're only pulling one path, the destination path might point to
// a path that doesn't exist yet.
if (srcs.size() == 1 && errno == ENOENT) {
// However, its parent must exist.
struct stat parent_st;
if (stat(android::base::Dirname(dst).c_str(), &parent_st) == -1) {
sc.Error("cannot create file/directory '%s': %s", dst, strerror(errno));
return false;
}
} else {
sc.Error("failed to access '%s': %s", dst, strerror(errno));
return false;
}
}
bool dst_isdir = dst_exists && S_ISDIR(st.st_mode);
if (!dst_isdir) {
if (srcs.size() > 1) {
sc.Error("target '%s' is not a directory", dst);
return false;
} else {
size_t dst_len = strlen(dst);
// A path that ends with a slash doesn't have to be a directory if
// it doesn't exist yet.
if (adb_is_separator(dst[dst_len - 1]) && dst_exists) {
sc.Error("failed to access '%s': Not a directory", dst);
return false;
}
}
}
for (const char* src_path : srcs) {
const char* dst_path = dst;
struct stat src_st;
if (!sync_stat_fallback(sc, src_path, &src_st)) {
if (errno == ENOPROTOOPT) {
sc.Error("remote object '%s' does not exist", src_path);
} else {
sc.Error("failed to stat remote object '%s': %s", src_path, strerror(errno));
}
success = false;
continue;
}
bool src_isdir = S_ISDIR(src_st.st_mode);
if (src_isdir) {
std::string dst_dir = dst;
// If the destination path existed originally, the source directory
// should be copied as a child of the destination.
if (dst_exists) {
if (!dst_isdir) {
sc.Error("target '%s' is not a directory", dst);
return false;
}
if (!adb_is_separator(dst_dir.back())) {
dst_dir.push_back(OS_PATH_SEPARATOR);
}
dst_dir.append(android::base::Basename(src_path));
}
success &= copy_remote_dir_local(sc, src_path, dst_dir, copy_attrs, compression);
continue;
} else if (!should_pull_file(src_st.st_mode)) {
sc.Warning("skipping special file '%s' (mode = 0o%o)", src_path, src_st.st_mode);
continue;
}
std::string path_holder;
if (dst_isdir) {
// If we're copying a remote file to a local directory, we
// really want to copy to local_dir + OS_PATH_SEPARATOR +
// basename(remote).
path_holder = android::base::StringPrintf("%s%c%s", dst_path, OS_PATH_SEPARATOR,
android::base::Basename(src_path).c_str());
dst_path = path_holder.c_str();
}
sc.NewTransfer();
sc.SetExpectedTotalBytes(src_st.st_size);
if (!sync_recv(sc, src_path, dst_path, name, src_st.st_size, compression)) {
success = false;
continue;
}
if (copy_attrs && set_time_and_mode(dst_path, src_st.st_mtime, src_st.st_mode) != 0) {
success = false;
continue;
}
sc.ReportTransferRate(src_path, TransferDirection::pull);
}
sc.ReportOverallTransferRate(TransferDirection::pull);
return success;
}
bool do_sync_sync(const std::string& lpath, const std::string& rpath, bool list_only,
CompressionType compression, bool dry_run, bool quiet) {
SyncConnection sc;
if (!sc.IsValid()) return false;
sc.SetQuiet(quiet);
bool success = copy_local_dir_remote(sc, lpath, rpath, true, list_only, compression, dry_run);
if (!list_only) {
sc.ReportOverallTransferRate(TransferDirection::push);
}
return success;
}
|