Bài viết này đề cập đến việc tạo hộp cát trong Bazel, cài đặt sandboxfs và gỡ lỗi
môi trường hộp cát của mình.
Hộp cát là một chiến lược hạn chế quyền giúp tách biệt các quy trình với với nhau hoặc từ các tài nguyên trong hệ thống. Đối với Bazel, điều này có nghĩa là hạn chế quyền truy cập vào hệ thống tệp.
Hộp cát hệ thống tệp của Bazel chạy các quy trình trong một thư mục đang hoạt động chỉ chứa các dữ liệu đầu vào đã biết, chẳng hạn như trình biên dịch và các công cụ khác không thấy các tệp nguồn mà chúng không được truy cập, trừ khi biết đường dẫn tuyệt đối đến các tệp đó.
Hộp cát không ẩn môi trường máy chủ theo bất kỳ cách nào. Các quy trình có thể tự do truy cập vào tất cả tệp trên hệ thống tệp. Tuy nhiên, trên các nền tảng hỗ trợ không gian tên của người dùng, các quy trình không thể sửa đổi bất kỳ tệp nào bên ngoài thư mục đang hoạt động của chúng. Điều này đảm bảo rằng biểu đồ bản dựng không có phần phụ thuộc ẩn có thể ảnh hưởng đến khả năng lặp lại của bản dựng.
Cụ thể hơn, Bazel tạo một thư mục execroot/ cho mỗi hành động, đóng vai trò là thư mục công việc của hành động tại thời điểm thực thi. execroot/ chứa tất cả tệp đầu vào cho thao tác và đóng vai trò là vùng chứa cho mọi đầu ra được tạo. Sau đó, Bazel sử dụng một kỹ thuật do hệ điều hành cung cấp, các vùng chứa trên Linux và sandbox-exec trên macOS, để ràng buộc hành động trong execroot/.
Lý do sử dụng hộp cát
Nếu không có hộp cát hành động, Bazel sẽ không biết liệu một công cụ có sử dụng các tệp đầu vào chưa khai báo hay không (các tệp không được liệt kê rõ ràng trong phần phụ thuộc của một hành động). Khi một trong các tệp đầu vào chưa khai báo thay đổi, Bazel vẫn cho rằng bản dựng đã được cập nhật và sẽ không tạo lại hành động. Điều này có thể dẫn đến bản dựng tăng dần không chính xác.
Việc sử dụng lại không chính xác các mục nhập bộ nhớ đệm sẽ gây ra sự cố trong quá trình lưu vào bộ nhớ đệm từ xa. Đáp không hợp lệ trong bộ nhớ đệm dùng chung ảnh hưởng đến mọi nhà phát triển của dự án, và việc xoá toàn bộ bộ nhớ đệm từ xa không phải là một giải pháp khả thi.
Môi trường hộp cát mô phỏng hành vi của quá trình thực thi từ xa – nếu một bản dựng hoạt động tốt với môi trường hộp cát, thì bản dựng đó cũng có thể hoạt động với quá trình thực thi từ xa. Bằng cách thực thi từ xa để tải tất cả tệp cần thiết lên (bao gồm cả các công cụ cục bộ), bạn có thể giảm đáng kể chi phí bảo trì cho các cụm biên dịch so với việc phải cài đặt các công cụ trên mọi máy trong cụm mỗi khi bạn muốn dùng thử một trình biên dịch mới hoặc thay đổi một công cụ hiện có.
Chiến lược hộp cát cần sử dụng
Bạn có thể chọn loại hộp cát để sử dụng, nếu có, với
cờ chiến lược. Sử dụng sandboxed
giúp Bazel chọn một trong những cách triển khai hộp cát được liệt kê dưới đây,
thích hộp cát dành riêng cho hệ điều hành hơn hộp cát chung ít khép kín hơn.
Worker liên tục sẽ chạy trong một hộp cát chung nếu bạn vượt qua
cờ --worker_sandboxing.
Chiến lược local (còn gọi là standalone) không thực hiện bất kỳ loại hộp cát nào.
Phương thức này chỉ thực thi dòng lệnh của thao tác với thư mục đang hoạt động được đặt thành thư mục thực thi của không gian làm việc.
processwrapper-sandbox là một chiến lược hộp cát không yêu cầu
"nâng cao" tính năng – nó sẽ hoạt động trên mọi hệ thống POSIX ngay từ đầu. Công cụ này tạo một thư mục hộp cát bao gồm các đường liên kết tượng trưng trỏ đến các tệp nguồn gốc, thực thi dòng lệnh của thao tác với thư mục đang hoạt động được đặt thành thư mục này thay vì thư mục execroot, sau đó di chuyển các cấu phần phần mềm đầu ra đã biết ra khỏi hộp cát vào thư mục execroot và xoá hộp cát. Điều này ngăn chặn
do vô tình sử dụng bất kỳ tệp đầu vào nào không được khai báo và
làm sạch execroot bằng các tệp đầu ra không xác định.
linux-sandbox tiến thêm một bước và xây dựng dựa trên processwrapper-sandbox. Tương tự như những tính năng nâng cao của Docker, công cụ này sử dụng
Không gian tên Linux (các không gian tên Người dùng, Gắn kết, PID, Mạng và IPC) để tách biệt vùng chứa
từ máy chủ. Điều này nghĩa là toàn bộ hệ thống tệp sẽ chuyển sang chế độ chỉ có thể đọc, ngoại trừ
cho thư mục hộp cát, để thao tác không thể vô tình sửa đổi bất kỳ nội dung nào
hệ thống tệp lưu trữ. Điều này giúp ngăn chặn các tình huống như kiểm thử lỗi vô tình rm -rf thư mục $HOME. Nếu muốn, bạn cũng có thể ngăn hành động này
truy cập mạng. linux-sandbox sử dụng không gian tên PID để ngăn hành động này
không nhìn thấy bất kỳ quy trình nào khác và loại bỏ tất cả quy trình một cách đáng tin cậy (kể cả trình nền)
tạo ra bởi hành động) ở cuối.
darwin-sandbox cũng tương tự, nhưng dành cho macOS. Công cụ này sử dụng công cụ sandbox-exec của Apple để đạt được hiệu quả gần giống như hộp cát Linux.
Cả linux-sandbox và darwin-sandbox đều không hoạt động trong phần "lồng nhau"
tình huống do các hạn chế trong các cơ chế do cơ quan điều hành cung cấp
hệ thống. Vì Docker cũng sử dụng không gian tên Linux cho vùng chứa của mình, nên bạn không thể dễ dàng chạy linux-sandbox bên trong vùng chứa Docker, trừ phi bạn sử dụng docker run --privileged. Trên macOS, bạn không thể chạy sandbox-exec bên trong một quy trình đã được đưa vào hộp cát. Do đó, trong những trường hợp này, Bazel sẽ tự động quay lại sử dụng processwrapper-sandbox.
Nếu bạn không muốn nhận lỗi bản dựng — chẳng hạn như để không vô tình tạo bằng một
chiến lược thực thi ít nghiêm ngặt hơn — sửa đổi danh sách thực thi một cách rõ ràng
mà Bazel cố gắng sử dụng (ví dụ: bazel build
--spawn_strategy=worker,linux-sandbox).
Quá trình thực thi động thường yêu cầu hộp cát để thực thi cục bộ. Cách làm như sau:
truyền cờ --experimental_local_lockfree_output. Thực thi động
hộp cát cho trình thực thi liên tục.
Nhược điểm của việc chạy trong môi trường hộp cát
Quá trình hộp cát phát sinh thêm chi phí thiết lập và chia nhỏ. Mức độ lớn của chi phí này phụ thuộc vào nhiều yếu tố, bao gồm cả hình dạng của bản dựng và hiệu suất của hệ điều hành lưu trữ. Đối với Linux, bản dựng dạng hộp cát hiếm khi có chậm hơn một vài phần trăm. Việc đặt
--reuse_sandbox_directoriescó thể giảm thiểu chi phí thiết lập và chia nhỏ.Chế độ hộp cát sẽ vô hiệu hoá hiệu quả mọi bộ nhớ đệm mà công cụ có thể có. Bạn có thể giảm thiểu vấn đề này bằng cách sử dụng worker ổn định, nhưng sẽ phải trả giá bằng việc giảm khả năng đảm bảo của hộp cát.
Nhiều worker yêu cầu hỗ trợ worker rõ ràng để được đưa vào hộp cát. Các worker không hỗ trợ hộp cát nhiều luồng chạy dưới dạng worker đơn luồng trong quá trình thực thi động, điều này có thể làm tiêu tốn thêm bộ nhớ.
sandboxfs
sandboxfs là một hệ thống tệp FUSE hiển thị một chế độ xem tuỳ ý của hệ thống tệp cơ bản mà không bị phạt thời gian. Bazel sử dụng sandboxfs để
tạo execroot/ ngay lập tức cho mỗi hành động, tránh chi phí
thực hiện hàng nghìn lệnh gọi hệ thống. Lưu ý rằng I/O sau này trong execroot/ có thể
chậm hơn do hao tổn FUSE.
Cài đặt Sandboxfs
Hãy làm theo các bước sau để cài đặt sandboxfs và tạo bản dựng Bazel bằng công cụ này:
Tải xuống
Tải xuống và cài đặt
sandboxfs để tệp nhị phân sandboxfs kết thúc trong PATH.
Chạy sandboxfs
- (chỉ dành cho MacOS) Cài đặt OSXFUSE.
(Chỉ dành cho macOS) Chạy:
sudo sysctl -w vfs.generic.osxfuse.tunables.allow_other=1Bạn cần thực hiện việc này sau khi cài đặt và sau mỗi lần khởi động lại để đảm bảo các dịch vụ hệ thống macOS cốt lõi hoạt động thông qua sandboxfs.
Chạy bản dựng Bazel bằng
--experimental_use_sandboxfs.bazel build target --experimental_use_sandboxfs
Khắc phục sự cố
Nếu bạn thấy local thay vì darwin-sandbox hoặc linux-sandbox dưới dạng
cho các hành động được thực thi, điều này có thể có nghĩa là hộp cát
tắt. Chuyển --genrule_strategy=sandboxed --spawn_strategy=sandboxed đến
bật tính năng đó.
Gỡ lỗi
Hãy làm theo các chiến lược dưới đây để gỡ lỗi các vấn đề liên quan đến hộp cát.
Không gian tên đã huỷ kích hoạt
Trên một số nền tảng, chẳng hạn như
Google Kubernetes Engine
nút cụm hoặc Debian, không gian tên của người dùng bị huỷ kích hoạt theo mặc định do
các mối lo ngại về bảo mật. Nếu tệp /proc/sys/kernel/unprivileged_userns_clone
tồn tại và chứa số 0, bạn có thể kích hoạt không gian tên người dùng bằng cách chạy:
sudo sysctl kernel.unprivileged_userns_clone=1
Không thực thi được quy tắc
Hộp cát có thể không thực thi được quy tắc do chế độ thiết lập hệ thống. Nếu bạn thấy một thông báo như namespace-sandbox.c:633: execvp(argv[0], argv): No such file or
directory, hãy thử huỷ kích hoạt hộp cát bằng --strategy=Genrule=local cho genrules và --spawn_strategy=local cho các quy tắc khác.
Gỡ lỗi chi tiết cho các lỗi bản dựng
Nếu bạn không tạo được, hãy sử dụng --verbose_failures và --sandbox_debug để tạo
Bazel cho thấy lệnh chính xác mà công cụ đã chạy khi bản dựng của bạn không thành công, bao gồm cả phần
để thiết lập hộp cát.
Ví dụ về thông báo lỗi:
ERROR: path/to/your/project/BUILD:1:1: compilation of rule
'//path/to/your/project:all' failed:
Sandboxed execution failed, which may be legitimate (such as a compiler error),
or due to missing dependencies. To enter the sandbox environment for easier
debugging, run the following command in parentheses. On command failure, a bash
shell running inside the sandbox will then automatically be spawned
namespace-sandbox failed: error executing command
(cd /some/path && \
exec env - \
LANG=en_US \
PATH=/some/path/bin:/bin:/usr/bin \
PYTHONPATH=/usr/local/some/path \
/some/path/namespace-sandbox @/sandbox/root/path/this-sandbox-name.params --
/some/path/to/your/some-compiler --some-params some-target)
Giờ đây, bạn có thể kiểm tra thư mục hộp cát đã tạo và xem những tệp nào mà Bazel đã tạo, sau đó chạy lại lệnh để xem cách hoạt động của thư mục đó.
Xin lưu ý rằng Bazel không xoá thư mục hộp cát khi bạn sử dụng --sandbox_debug. Nếu không chủ động gỡ lỗi, bạn nên tắt
--sandbox_debug vì dịch vụ này sẽ làm đầy ổ đĩa của bạn theo thời gian.