Xây dựng chương trình với Bazel

Báo cáo sự cố Xem nguồn

Trang này trình bày cách xây dựng chương trình bằng Bazel, cú pháp lệnh tạo và cú pháp mẫu mục tiêu.

Bắt đầu nhanh

Để chạy Bazel, hãy chuyển đến thư mục workspace cơ sở hoặc bất kỳ thư mục con nào trong đó và nhập bazel. Xem bản dựng nếu bạn cần tạo một không gian làm việc mới.

bazel help
                             [Bazel release bazel version]
Usage: bazel command options ...

Các lệnh có sẵn

  • analyze-profile: Phân tích dữ liệu hồ sơ bản dựng.
  • aquery: Thực thi truy vấn trên biểu đồ hành động sau khi phân tích.
  • build: Tạo mục tiêu đã chỉ định.
  • canonicalize-flags: Chuẩn hoá cờ Bazel.
  • clean: Xoá tệp đầu ra và dừng máy chủ nếu muốn.
  • cquery: Thực thi truy vấn biểu đồ phần phụ thuộc sau khi phân tích.
  • dump: Kết xuất trạng thái nội bộ của quy trình máy chủ Bazel.
  • help: In trợ giúp cho các lệnh hoặc chỉ mục.
  • info: Hiển thị thông tin thời gian chạy về máy chủ bazel.
  • fetch: Tìm nạp tất cả phần phụ thuộc bên ngoài của một mục tiêu.
  • mobile-install: Cài đặt các ứng dụng trên thiết bị di động.
  • query: Thực thi truy vấn biểu đồ phần phụ thuộc.
  • run: Chạy mục tiêu đã chỉ định.
  • shutdown: Dừng máy chủ Bazel.
  • test: Xây dựng và chạy mục tiêu kiểm thử được chỉ định.
  • version: In thông tin phiên bản của Bazel.

Nhận trợ giúp

  • bazel help command: In trợ giúp và các tùy chọn cho command.
  • bazel helpstartup_options: Các tuỳ chọn cho JVM lưu trữ Bazel.
  • bazel helptarget-syntax: Giải thích cú pháp để chỉ định mục tiêu.
  • bazel help info-keys: Hiển thị danh sách các khoá mà lệnh thông tin sử dụng.

Công cụ bazel thực hiện nhiều hàm, gọi là lệnh. Các hàm được dùng phổ biến nhất là bazel build và bazel test. Bạn có thể duyệt qua các thông báo trợ giúp trực tuyến bằng cách sử dụng bazel help.

Xây dựng một mục tiêu

Trước khi có thể bắt đầu xây dựng, bạn cần có một không gian làm việc. Không gian làm việc là cây thư mục chứa tất cả các tệp nguồn cần thiết để tạo ứng dụng. Bazel cho phép bạn thực hiện bản dựng từ ổ đĩa chỉ đọc hoàn toàn.

Để tạo một chương trình bằng Bazel, hãy nhập bazel build theo sau là mục tiêu bạn muốn tạo.

bazel build //foo

Sau khi tạo lệnh để tạo //foo, bạn sẽ thấy kết quả tương tự như sau:

INFO: Analyzed target //foo:foo (14 packages loaded, 48 targets configured).
INFO: Found 1 target...
Target //foo:foo up-to-date:
  bazel-bin/foo/foo
INFO: Elapsed time: 9.905s, Critical Path: 3.25s
INFO: Build completed successfully, 6 total actions

Trước tiên, Bazel tải tất cả các gói trong biểu đồ phần phụ thuộc của mục tiêu. Tệp này bao gồm các phần phụ thuộc đã khai báo, các tệp được liệt kê trực tiếp trong tệp BUILD của mục tiêu và các phần phụ thuộc bắc cầu, các tệp được liệt kê trong các tệp BUILD của phần phụ thuộc mục tiêu. Sau khi xác định tất cả các phần phụ thuộc, Bazel sẽ phân tích chúng để đảm bảo tính chính xác và tạo thao tác với bản dựng. Cuối cùng, Bazel thực thi trình biên dịch và các công cụ khác của bản dựng.

Trong giai đoạn thực thi bản dựng, Bazel sẽ in thông báo tiến trình. Thông báo tiến trình bao gồm bước tạo bản dựng hiện tại (chẳng hạn như trình biên dịch hoặc trình liên kết) khi bước này bắt đầu và số đã hoàn thành trên tổng số hành động tạo bản dựng. Khi quá trình tạo bắt đầu, tổng số hành động thường tăng khi Bazel khám phá toàn bộ biểu đồ hành động, nhưng con số này ổn định trong vòng vài giây.

Khi kết thúc bản dựng, Bazel sẽ in các mục tiêu đã được yêu cầu, liệu các mục tiêu đó có được tạo thành công hay không và nếu có, thì bạn có thể tìm thấy các tệp đầu ra. Các tập lệnh chạy bản dựng có thể phân tích cú pháp kết quả này một cách đáng tin cậy; xem --show_result để biết thêm thông tin chi tiết.

Nếu bạn nhập lại lệnh tương tự, bản dựng sẽ hoàn tất nhanh hơn nhiều.

bazel build //foo
INFO: Analyzed target //foo:foo (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //foo:foo up-to-date:
  bazel-bin/foo/foo
INFO: Elapsed time: 0.144s, Critical Path: 0.00s
INFO: Build completed successfully, 1 total action

Đây là bản dựng rỗng. Vì không có gì thay đổi, nên không có gói nào để tải lại và không có bước xây dựng nào để thực thi. Nếu có thay đổi nào đó trong 'foo' hoặc các phần phụ thuộc của nó, Bazel sẽ thực thi lại một số hành động xây dựng hoặc hoàn thành một bản dựng tăng dần.

Xây dựng nhiều mục tiêu

Bazel cho phép một số cách để chỉ định các mục tiêu sẽ được xây dựng. Nói chung, đây được gọi là mẫu mục tiêu. Cú pháp này được sử dụng trong các lệnh như build, test hoặc query.

Trong khi nhãn được dùng để chỉ định các mục tiêu riêng lẻ, chẳng hạn như để khai báo phần phụ thuộc trong tệp BUILD, thì mẫu mục tiêu của Bazel lại chỉ định nhiều mục tiêu. Mẫu mục tiêu là sự khái quát hoá cú pháp nhãn cho các bộ mục tiêu, bằng cách sử dụng ký tự đại diện. Trong trường hợp đơn giản nhất, mọi nhãn hợp lệ cũng là một mẫu mục tiêu hợp lệ, xác định một tập hợp chính xác một mục tiêu.

Tất cả mẫu mục tiêu bắt đầu bằng // được phân giải tương ứng với không gian làm việc hiện tại.

//foo/bar:wiz Chỉ mục tiêu duy nhất //foo/bar:wiz.
//foo/bar Tương đương với //foo/bar:bar.
//foo/bar:all Tất cả mục tiêu quy tắc trong gói foo/bar.
//foo/... Tất cả mục tiêu quy tắc trong tất cả các gói bên dưới thư mục foo.
//foo/...:all Tất cả mục tiêu quy tắc trong tất cả các gói bên dưới thư mục foo.
//foo/...:* Tất cả mục tiêu (quy tắc và tệp) trong tất cả các gói bên dưới thư mục foo.
//foo/...:all-targets Tất cả mục tiêu (quy tắc và tệp) trong tất cả các gói bên dưới thư mục foo.
//... Tất cả mục tiêu trong gói trong không gian làm việc. Số liệu này không bao gồm các mục tiêu từ kho lưu trữ bên ngoài.
//:all Tất cả mục tiêu trong gói cấp cao nhất nếu có tệp `BUILD` tại thư mục gốc của không gian làm việc.

Các mẫu mục tiêu không bắt đầu bằng // được phân giải tương ứng với thư mục hoạt động hiện tại. Những ví dụ sau đây giả định là một thư mục đang hoạt động của foo:

:foo Tương đương với //foo:foo.
bar:wiz Tương đương với //foo/bar:wiz.
bar/wiz Tương đương với:
  • //foo/bar/wiz:wiz nếu foo/bar/wiz là một gói
  • //foo/bar:wiz nếu foo/bar là một gói
  • Nếu không thì //foo:bar/wiz
bar:all Tương đương với //foo/bar:all.
:all Tương đương với //foo:all.
...:all Tương đương với //foo/...:all.
... Tương đương với //foo/...:all.
bar/...:all Tương đương với //foo/bar/...:all.

Theo mặc định, hệ thống sẽ tuân theo các đường liên kết tượng trưng thư mục đối với các mẫu mục tiêu đệ quy, ngoại trừ các đường liên kết trỏ đến cơ sở đầu ra, chẳng hạn như các đường liên kết tượng trưng thuận tiện được tạo trong thư mục gốc của không gian làm việc.

Ngoài ra, Bazel không đi theo các đường liên kết tượng trưng khi đánh giá các mẫu mục tiêu đệ quy trong mọi thư mục chứa tệp có tên như sau: DONT_FOLLOW_SYMLINKS_WHEN_TRAVERSING_THIS_DIRECTORY_VIA_A_RECURSIVE_TARGET_PATTERN

foo/... là ký tự đại diện trên các gói, cho biết tất cả các gói đệ quy bên dưới thư mục foo (cho tất cả thư mục gốc của đường dẫn gói). :all là một ký tự đại diện cho mục tiêu, khớp với tất cả các quy tắc trong một gói. Bạn có thể kết hợp hai ký tự này như trong foo/...:all, và khi sử dụng cả hai ký tự đại diện, chúng có thể được viết tắt là foo/....

Ngoài ra, :* (hoặc :all-targets) là một ký tự đại diện phù hợp với mọi mục tiêu trong các gói phù hợp, bao gồm các tệp thường không được tạo bởi bất kỳ quy tắc nào, chẳng hạn như các tệp _deploy.jar được liên kết với các quy tắc java_binary.

Điều này có nghĩa là :* biểu thị một tập hợp mẹ của :all; mặc dù có thể gây nhầm lẫn, cú pháp này cho phép sử dụng ký tự đại diện :all quen thuộc cho các bản dựng thông thường, trong đó bạn không muốn các mục tiêu xây dựng như _deploy.jar.

Ngoài ra, Bazel cho phép sử dụng dấu gạch chéo thay vì dấu hai chấm theo yêu cầu của cú pháp nhãn; điều này thường thuận tiện khi sử dụng tính năng mở rộng tên tệp Bash. Ví dụ: foo/bar/wiz tương đương với //foo/bar:wiz (nếu có gói foo/bar) hoặc đến //foo:bar/wiz (nếu có gói foo).

Nhiều lệnh Bazel chấp nhận danh sách các mẫu mục tiêu làm đối số và tất cả đều tuân theo toán tử phủ định tiền tố -. Bạn có thể sử dụng phương pháp này để trừ một tập hợp mục tiêu khỏi tập hợp đã chỉ định bởi các đối số trước đó. Xin lưu ý rằng điều này có nghĩa là đơn đặt hàng đóng vai trò quan trọng. Ví dụ:

bazel build foo/... bar/...

có nghĩa là "xây dựng tất cả mục tiêu bên dưới foo và tất cả mục tiêu bên dưới bar", trong khi

bazel build -- foo/... -foo/bar/...

có nghĩa là "tạo tất cả mục tiêu bên dưới foo ngoại trừ các mục tiêu bên dưới foo/bar". (Đối số -- là bắt buộc để ngăn các đối số tiếp theo bắt đầu bằng - được diễn giải là các tùy chọn bổ sung.)

Quan trọng là bạn phải chỉ ra rằng việc trừ các mục tiêu theo cách này sẽ không đảm bảo rằng các mục tiêu đó không được tạo vì chúng có thể là phần phụ thuộc của các mục tiêu không bị trừ. Ví dụ: nếu có một mục tiêu //foo:all-apis mà trong số những mục tiêu khác phụ thuộc vào //foo/bar:api, thì phần sau sẽ được xây dựng trong quá trình xây dựng phần tử cũ.

Các mục tiêu có tags = ["manual"] không được đưa vào mẫu mục tiêu ký tự đại diện (..., :*, :all, v.v.) khi được chỉ định trong các lệnh như bazel build và bazel test (nhưng được đưa vào mẫu mục tiêu ký tự đại diện phủ định, nghĩa là chúng sẽ bị trừ đi). Bạn nên chỉ định các mục tiêu kiểm thử đó bằng các mẫu mục tiêu rõ ràng trên dòng lệnh nếu bạn muốn Bazel tạo/kiểm thử các mục tiêu đó. Ngược lại, bazel query không tự động thực hiện bất kỳ bộ lọc nào như vậy (điều đó sẽ đánh bại mục đích của bazel query).

Tìm nạp phần phụ thuộc bên ngoài

Theo mặc định, Bazel sẽ tải xuống và liên kết các phần phụ thuộc bên ngoài trong quá trình xây dựng. Tuy nhiên, điều này có thể không mong muốn, vì bạn muốn biết khi nào các phần phụ thuộc bên ngoài mới được thêm vào hoặc vì bạn muốn "tìm nạp trước các phần phụ thuộc" (giả sử trước một chuyến bay mà bạn sẽ không có kết nối mạng). Nếu muốn ngăn việc thêm các phần phụ thuộc mới trong các bản dựng, bạn có thể chỉ định cờ --fetch=false. Lưu ý rằng cờ này chỉ áp dụng cho các quy tắc kho lưu trữ không trỏ đến thư mục trong hệ thống tệp cục bộ. Ví dụ: Các thay đổi đối với local_repository, new_local_repository, các quy tắc đối với kho lưu trữ SDK Android và NDK sẽ luôn có hiệu lực bất kể giá trị --fetch .

Nếu bạn không cho phép tìm nạp trong các bản dựng và Bazel tìm thấy các phần phụ thuộc bên ngoài mới, thì bản dựng của bạn sẽ không hoạt động.

Bạn có thể tìm nạp các phần phụ thuộc theo cách thủ công bằng cách chạy bazel fetch. Nếu không cho phép tìm nạp trong quá trình tạo bản dựng, bạn sẽ cần chạy bazel fetch:

  • Trước khi bạn xây dựng lần đầu tiên.
  • Sau khi bạn thêm phần phụ thuộc bên ngoài mới.

Sau khi chạy, bạn không cần chạy lại cho đến khi tệp WORKSPACE thay đổi.

fetch lấy danh sách mục tiêu để tìm nạp các phần phụ thuộc. Ví dụ: phần này sẽ tìm nạp các phần phụ thuộc cần thiết để tạo //foo:bar và //bar:baz:

bazel fetch //foo:bar //bar:baz

Để tìm nạp tất cả phần phụ thuộc bên ngoài cho một không gian làm việc, hãy chạy:

bazel fetch //...

Bạn không cần phải chạy tính năng tìm nạp bazel nếu có tất cả các công cụ bạn đang sử dụng (từ jar thư viện đến chính JDK) trong thư mục gốc của không gian làm việc. Tuy nhiên, nếu bạn đang sử dụng phần mềm bên ngoài thư mục không gian làm việc, thì Bazel sẽ tự động chạy bazel fetch trước khi chạy bazel build.

Bộ nhớ đệm của kho lưu trữ

Bazel cố gắng tránh tìm nạp cùng một tệp nhiều lần, ngay cả khi cần cùng một tệp trong các không gian làm việc khác nhau hoặc nếu định nghĩa của một kho lưu trữ bên ngoài thay đổi nhưng tệp đó vẫn cần cùng một tệp để tải xuống. Để làm điều này, bazel lưu tất cả các tệp đã tải xuống vào bộ nhớ đệm trong kho lưu trữ (theo mặc định), được đặt tại ~/.cache/bazel/_bazel_$USER/cache/repos/v1/. Bạn có thể thay đổi vị trí bằng tuỳ chọn --repository_cache. Bộ nhớ đệm được chia sẻ giữa tất cả không gian làm việc và các phiên bản bazel đã cài đặt. Một mục được lấy từ bộ nhớ đệm nếu Bazel biết chắc rằng bản sao đó có một bản sao của tệp chính xác, tức là nếu yêu cầu tải xuống có tổng SHA256 của tệp được chỉ định và một tệp có hash đó nằm trong bộ nhớ đệm. Vì vậy, việc chỉ định một hàm băm cho mỗi tệp bên ngoài không chỉ là một ý tưởng hay từ góc độ bảo mật; nó còn giúp tránh các tệp tải xuống không cần thiết.

Mỗi lần truy cập vào bộ nhớ đệm, thời gian sửa đổi của tệp trong bộ nhớ đệm sẽ được cập nhật. Bằng cách này, bạn có thể dễ dàng xác định lần sử dụng cuối cùng của một tệp trong thư mục bộ nhớ đệm, chẳng hạn như để dọn dẹp bộ nhớ đệm theo cách thủ công. Bộ nhớ đệm không bao giờ được tự động xoá vì bộ nhớ này có thể chứa một bản sao của tệp không còn có sẵn ở trên.

Thư mục tệp phân phối

Thư mục phân phối là một cơ chế Bazel khác để tránh tải xuống không cần thiết. Bazel tìm kiếm các thư mục phân phối trước bộ nhớ đệm của kho lưu trữ. Điểm khác biệt chính là thư mục phân phối yêu cầu chuẩn bị thủ công.

Khi sử dụng tuỳ chọn --distdir=/path/to-directory, bạn có thể chỉ định thêm các thư mục chỉ có thể đọc để tìm tệp thay vì tìm nạp các tệp đó. Một tệp được lấy từ một thư mục như vậy nếu tên tệp bằng với tên cơ sở của URL và thêm hàm băm của tệp bằng với tên chỉ định trong yêu cầu tải xuống. Tính năng này chỉ hoạt động nếu hàm băm tệp được chỉ định trong khai báo WORKSPACE.

Mặc dù điều kiện trên tên tệp không cần thiết cho tính chính xác, nhưng nó giúp giảm số lượng tệp đề xuất xuống còn một tệp cho mỗi thư mục được chỉ định. Bằng cách này, việc chỉ định thư mục tệp phân phối sẽ vẫn có hiệu quả, ngay cả khi số lượng tệp trong một thư mục như vậy tăng lên.

Chạy Bazel trong môi trường không khí

Để duy trì kích thước nhị phân của Bazel nhỏ, các phần phụ thuộc ngầm của Bazel được tìm nạp qua mạng trong khi chạy lần đầu tiên. Những phần phụ thuộc ngầm ẩn này chứa các chuỗi công cụ và quy tắc có thể không cần thiết với tất cả mọi người. Ví dụ: các công cụ Android không được nhóm và chỉ tìm nạp khi tạo dự án Android.

Tuy nhiên, những phần phụ thuộc ngầm ẩn này có thể gây ra sự cố khi chạy Bazel trong môi trường không dây, ngay cả khi bạn đã cung cấp tất cả phần phụ thuộc Workspace Để giải quyết vấn đề đó, bạn có thể chuẩn bị một thư mục phân phối chứa các phần phụ thuộc này trên một máy có quyền truy cập mạng, sau đó chuyển các phần phụ thuộc đó sang môi trường được tập trung vào không gian bằng phương pháp ngoại tuyến.

Để chuẩn bị thư mục phân phối, hãy sử dụng cờ --distdir. Bạn sẽ cần thực hiện việc này một lần cho mọi phiên bản nhị phân Bazel mới, vì các phần phụ thuộc ngầm ẩn có thể khác nhau cho mỗi bản phát hành.

Để xây dựng các phần phụ thuộc này bên ngoài môi trường không dây, trước tiên, hãy kiểm tra cây nguồn Bazel ở phiên bản phù hợp:

git clone https://github.com/bazelbuild/bazel "$BAZEL_DIR"
cd "$BAZEL_DIR"
git checkout "$BAZEL_VERSION"

Sau đó, hãy tạo tệp tar chứa các phần phụ thuộc thời gian chạy ngầm ẩn cho phiên bản Bazel cụ thể đó:

bazel build @additional_distfiles//:archives.tar

Xuất tệp tar này sang một thư mục có thể sao chép vào môi trường được chèn lên. Lưu ý cờ --strip-components vì --distdir có thể khá sắc nét với cấp lồng thư mục:

tar xvf bazel-bin/external/additional_distfiles/archives.tar \
  -C "$NEW_DIRECTORY" --strip-components=3

Cuối cùng, khi bạn sử dụng Bazel trong môi trường không dây, hãy chuyển cờ --distdir trỏ đến thư mục đó. Để thuận tiện, bạn có thể thêm mục này làm mục nhập .bazelrc:

build --distdir=path/to/directory

Cấu hình bản dựng và biên dịch chéo

Tất cả dữ liệu đầu vào chỉ định hành vi và kết quả của một bản dựng cụ thể có thể được chia thành hai danh mục riêng biệt. Loại đầu tiên là thông tin nội tại được lưu trữ trong các tệp BUILD của dự án: quy tắc xây dựng, giá trị của các thuộc tính và tập hợp đầy đủ các phần phụ thuộc bắc cầu của dự án. Loại thứ hai là dữ liệu bên ngoài hoặc môi trường, do người dùng hoặc công cụ xây dựng cung cấp: lựa chọn cấu trúc mục tiêu, tùy chọn biên dịch và liên kết và các tùy chọn cấu hình chuỗi công cụ khác. Chúng tôi gọi một tập dữ liệu môi trường hoàn chỉnh là cấu hình.

Trong một bản dựng bất kỳ, có thể có nhiều hơn một cấu hình. Cân nhắc việc biên dịch chéo, trong đó bạn tạo một tệp thực thi //foo:bin cho kiến trúc 64 bit, nhưng máy trạm là một máy 32 bit. Rõ ràng là bản dựng sẽ yêu cầu xây dựng //foo:bin bằng một chuỗi công cụ có khả năng tạo các tệp thực thi 64 bit, nhưng hệ thống xây dựng cũng phải tạo nhiều công cụ dùng trong chính bản dựng đó (ví dụ: các công cụ được tạo từ nguồn rồi sau đó được sử dụng trong genrule) và các công cụ này phải được tạo để chạy trên máy trạm của bạn. Do đó, chúng tôi có thể xác định hai cấu hình: cấu hình thực thi, được sử dụng cho các công cụ xây dựng chạy trong bản dựng và cấu hình mục tiêu (hoặc cấu hình yêu cầu, nhưng chúng tôi nói "cấu hình mục tiêu" thường xuyên hơn ngay cả khi từ đó đã có nhiều ý nghĩa), được dùng để xây dựng tệp nhị phân bạn cuối cùng đã yêu cầu.

Thông thường, có nhiều thư viện là điều kiện tiên quyết để thực hiện cả mục tiêu bản dựng được yêu cầu (//foo:bin) và một hoặc nhiều công cụ thực thi, chẳng hạn như một số thư viện cơ sở. Bạn phải xây dựng hai thư viện như vậy hai lần, một lần cho cấu hình thực thi và một lần cho cấu hình mục tiêu. Bazel quan tâm đến việc đảm bảo rằng cả hai biến thể đều được xây dựng và các tệp thu được được lưu trữ riêng biệt để tránh bị can thiệp; thường thì các mục tiêu như vậy có thể được tạo đồng thời, vì chúng độc lập với nhau. Nếu bạn thấy thông báo tiến trình cho biết rằng một mục tiêu nhất định đang được tạo hai lần, thì đó rất có thể là việc giải thích.

Cấu hình thực thi được lấy từ cấu hình mục tiêu như sau:

  • Sử dụng cùng một phiên bản Crosstool (--crosstool_top) như đã chỉ định trong cấu hình yêu cầu, trừ khi --host_crosstool_top được chỉ định.
  • Sử dụng giá trị của --host_cpu cho --cpu (mặc định: k8).
  • Sử dụng cùng các giá trị của các tùy chọn này như được chỉ định trong cấu hình yêu cầu: --compiler, --use_ijars và nếu bạn sử dụng --host_crosstool_top, thì giá trị của --host_cpu sẽ được dùng để tra cứu default_toolchain trong Crosstool (bỏ qua --compiler) cho cấu hình thực thi.
  • Sử dụng giá trị của --host_javabase cho --javabase
  • Sử dụng giá trị của --host_java_toolchain cho --java_toolchain
  • Sử dụng bản dựng được tối ưu hóa cho mã C++ (-c opt).
  • Không tạo thông tin gỡ lỗi (--copt=-g0).
  • Xoá thông tin gỡ lỗi khỏi các tệp thực thi và thư viện dùng chung (--strip=always).
  • Đặt tất cả tệp bắt nguồn ở một vị trí đặc biệt, khác với vị trí mà mọi cấu hình yêu cầu có thể sử dụng.
  • Loại bỏ việc đóng dấu tệp nhị phân bằng dữ liệu bản dựng (xem tùy chọn --embed_*).
  • Tất cả các giá trị khác vẫn ở chế độ mặc định.

Có nhiều lý do khiến bạn nên chọn một cấu hình thực thi riêng biệt cho cấu hình yêu cầu. Quan trọng nhất:

Thứ nhất, bằng cách sử dụng tệp nhị phân được tối ưu hoá, loại bỏ, bạn giảm thời gian liên kết và thực thi các công cụ, dung lượng ổ đĩa chiếm dụng các công cụ và thời gian I/O mạng trong các bản dựng được phân phối.

Thứ hai, bằng cách tách riêng exec và các cấu hình yêu cầu trong mọi bản dựng, bạn tránh những bản dựng lại rất tốn kém sẽ dẫn đến những thay đổi nhỏ đối với cấu hình yêu cầu (chẳng hạn như thay đổi các tuỳ chọn của trình liên kết), như đã mô tả trước đó.

Chỉnh sửa bản dựng tăng dần

Một trong những mục tiêu chính của dự án Bazel là đảm bảo tạo lại bản dựng gia tăng chính xác. Các công cụ xây dựng trước đây, đặc biệt là những công cụ dựa trên Make, đưa ra một số giả định không rõ ràng trong việc triển khai các bản dựng tăng dần.

Thứ nhất, dấu thời gian của các tệp tăng đơn điệu. Mặc dù đây là trường hợp điển hình, nhưng chúng ta rất dễ vi phạm giả định này; việc đồng bộ hoá với bản sửa đổi trước đó của tệp sẽ làm giảm thời gian sửa đổi của tệp; Hệ thống dựa trên mạng sẽ không tạo lại.

Nói chung, trong khi tính năng Make phát hiện các thay đổi đối với tệp, thì tính năng này sẽ không phát hiện các thay đổi đối với lệnh. Nếu bạn thay đổi các tùy chọn được truyền đến trình biên dịch trong một bước xây dựng nhất định, Make sẽ không chạy lại trình biên dịch và cần loại bỏ các kết quả không hợp lệ của bản dựng trước đó bằng cách sử dụng make clean theo cách thủ công.

Ngoài ra, Make không có hiệu quả đối với việc chấm dứt không thành công một trong các quy trình phụ của nó sau khi quy trình phụ đó bắt đầu ghi vào tệp đầu ra. Mặc dù việc thực thi Make hiện tại sẽ không thành công, lệnh gọi tiếp theo của Make sẽ ngầm giả định rằng tệp đầu ra bị cắt ngắn là hợp lệ (vì tệp này mới hơn dữ liệu đầu vào) và tệp sẽ không được tạo lại. Tương tự, nếu quá trình Make bị loại bỏ, thì trường hợp tương tự có thể xảy ra.

Bazel tránh những giả định này và những giả định khác. Bazel duy trì cơ sở dữ liệu của tất cả công việc đã thực hiện trước đó và sẽ chỉ bỏ qua một bước xây dựng nếu thấy tập hợp các tệp đầu vào (và dấu thời gian của các tệp đó) ở bước bản dựng đó và lệnh biên dịch cho bước xây dựng đó sẽ khớp chính xác một bước trong cơ sở dữ liệu và tập hợp các tệp đầu ra (và dấu thời gian của chúng) cho mục nhập cơ sở dữ liệu khớp chính xác với dấu thời gian của các tệp trên đĩa. Bất kỳ thay đổi nào đối với tệp đầu vào hoặc tệp đầu ra hoặc đối với chính lệnh này sẽ dẫn đến việc thực thi lại bước xây dựng.

Lợi ích cho người dùng của các bản dựng gia tăng chính xác là: ít lãng phí thời gian hơn do sự nhầm lẫn. (Ngoài ra, thời gian chờ xây dựng lại do sử dụng make clean ít hơn, dù là cần thiết hay trước.)

Xây dựng tính nhất quán và bản dựng gia tăng

Về mặt chính thức, chúng tôi xác định trạng thái của bản dựng là nhất quán khi tất cả các tệp đầu ra dự kiến tồn tại và nội dung của các tệp đó là chính xác, như được chỉ định bằng các bước hoặc quy tắc cần thiết để tạo các tệp đó. Khi bạn chỉnh sửa một tệp nguồn, trạng thái của bản dựng được cho là không nhất quán và vẫn không nhất quán cho đến khi bạn chạy công cụ xây dựng tiếp theo để hoàn tất thành công. Chúng tôi mô tả tình huống này là không nhất quán, vì đó chỉ là tạm thời và tính nhất quán được khôi phục bằng cách chạy công cụ xây dựng.

Có một loại tính không nhất quán khác gây hại: không nhất quán. Nếu bản dựng đạt đến trạng thái không nhất quán ổn định, thì lệnh gọi thành công nhiều lần của công cụ bản dựng sẽ không khôi phục được tính nhất quán: bản dựng bị "lỗi" và kết quả vẫn không chính xác. Trạng thái không nhất quán ổn định là lý do chính khiến người dùng Make (và các công cụ xây dựng khác) nhập make clean. Việc phát hiện công cụ xây dựng không thành công theo cách này (và sau đó khôi phục từ đó) có thể tốn thời gian và gây khó chịu.

Về mặt lý thuyết, cách đơn giản nhất để đạt được bản dựng nhất quán là xoá bỏ tất cả kết quả bản dựng trước đó và bắt đầu lại: tạo mọi bản dựng sạch. Phương pháp này rõ ràng sẽ tốn thời gian thực tế (ngoại trừ có thể dành cho các kỹ sư phát hành). Do đó, để hữu ích, công cụ tạo bản dựng phải có khả năng thực hiện các bản dựng tăng dần mà không ảnh hưởng đến tính nhất quán.

Việc phân tích phần phụ thuộc gia tăng đúng cách rất khó và như mô tả ở trên, nhiều công cụ xây dựng khác hoạt động kém hiệu quả trong việc tránh các trạng thái không nhất quán ổn định trong quá trình xây dựng tăng dần. Ngược lại, Bazel đưa ra đảm bảo sau: sau khi gọi thành công công cụ bản dựng mà trong đó bạn không chỉnh sửa, bản dựng sẽ ở trạng thái nhất quán. (Nếu bạn chỉnh sửa tệp nguồn trong quá trình tạo bản dựng, Bazel không đảm bảo tính nhất quán của kết quả của bản dựng hiện tại. Tuy nhiên, điều này đảm bảo rằng kết quả của bản dựng tiếp theo sẽ khôi phục tính nhất quán.)

Như tất cả các bảo đảm, có một số ảnh in nhỏ: có một số cách để biết trạng thái không nhất quán với Bazel. Chúng tôi sẽ không đảm bảo điều tra các vấn đề phát sinh từ việc cố ý tìm lỗi trong quá trình phân tích phần phụ thuộc gia tăng, nhưng chúng tôi sẽ điều tra và cố gắng hết sức để khắc phục tất cả các trạng thái không nhất quán phát sinh khi sử dụng công cụ xây dựng thông thường hoặc "hợp lý".

Nếu bạn phát hiện trạng thái không nhất quán ổn định với Bazel, vui lòng báo cáo lỗi.

Thực thi hộp cát

Bazel sử dụng hộp cát để đảm bảo rằng các thao tác sẽ chạy một cách bí mật và chính xác. Bazel chạy các ảnh (thường xuyên: hành động) trong hộp cát chỉ chứa tập hợp tệp tối thiểu mà công cụ yêu cầu để thực hiện công việc của nó. Hiện tại, hộp cát hoạt động trên Linux 3.12 trở lên với tùy chọn CONFIG_USER_NS được bật, cũng như trên macOS 10.11 trở lên.

Bazel sẽ in một cảnh báo nếu hệ thống của bạn không hỗ trợ hộp cát để cảnh báo bạn về việc các bản dựng không được đảm bảo mang tính khép kín và có thể ảnh hưởng đến hệ thống máy chủ theo những cách không xác định. Để tắt cảnh báo này, bạn có thể truyền cờ --ignore_unsupported_sandboxing đến Bazel.

Trên một số nền tảng như các nút cụm Google Kubernetes Engine hoặc Debian, không gian tên người dùng bị huỷ kích hoạt theo mặc định do những lo ngại về tính bảo mật. Bạn có thể kiểm tra điều này bằng cách xem tệp /proc/sys/kernel/unprivileged_userns_clone: nếu tệp đó tồn tại và chứa giá trị 0, thì bạn có thể kích hoạt vùng chứa tên người dùng bằng sudo sysctl kernel.unprivileged_userns_clone=1.

Trong một số trường hợp, hộp cát Bazel không thể thực thi các quy tắc do việc thiết lập hệ thống. Dấu hiệu này thường là lỗi khi phát ra thông báo tương tự như namespace-sandbox.c:633: execvp(argv[0], argv): No such file or directory. Trong trường hợp đó, hãy cố gắng tắt hộp cát cho các quy tắc tạo bằng --strategy=Genrule=standalone và cho các quy tắc khác bằng --spawn_strategy=standalone. Ngoài ra, vui lòng báo cáo lỗi trên công cụ theo dõi lỗi của chúng tôi và đề cập đến bản phân phối Linux bạn đang sử dụng để chúng tôi có thể điều tra và khắc phục trong một bản phát hành tiếp theo.

Các giai đoạn của bản dựng

Trong Bazel, bản dựng xảy ra trong 3 giai đoạn riêng biệt; với tư cách là người dùng, việc hiểu sự khác biệt giữa chúng sẽ cung cấp thông tin chi tiết về các tùy chọn kiểm soát bản dựng (xem bên dưới).

Giai đoạn tải

Tệp đầu tiên là tải trong đó tất cả các tệp BUILD cần thiết cho các mục tiêu ban đầu và đóng các phần phụ thuộc bắc cầu, được tải, phân tích cú pháp, đánh giá và lưu vào bộ nhớ đệm.

Đối với bản dựng đầu tiên sau khi máy chủ Bazel được khởi động, giai đoạn tải thường mất nhiều giây để nhiều tệp BUILD được tải từ hệ thống tệp. Trong các bản dựng sau đó, đặc biệt nếu không có tệp BUILD nào thay đổi, việc tải xảy ra rất nhanh.

Các lỗi được báo cáo trong giai đoạn này bao gồm: không tìm thấy gói, không tìm thấy mục tiêu, lỗi ngữ pháp và ngữ pháp trong tệp BUILD và các lỗi đánh giá.

Giai đoạn phân tích

Giai đoạn thứ hai, phân tích, bao gồm phân tích ngữ nghĩa và xác thực từng quy tắc xây dựng, xây dựng biểu đồ phần phụ thuộc của bản dựng và xác định chính xác công việc cần thực hiện trong mỗi bước của bản dựng.

Giống như việc tải, quá trình phân tích cũng mất vài giây khi được tính toàn bộ. Tuy nhiên, Bazel sẽ lưu biểu đồ phần phụ thuộc này vào bộ nhớ đệm từ một bản dựng tiếp theo và chỉ phân tích lại nội dung của bản dựng đó, điều này có thể làm cho các bản dựng gia tăng hoạt động cực kỳ nhanh chóng trong trường hợp các gói không thay đổi kể từ bản dựng trước đó.

Các lỗi được báo cáo ở giai đoạn này bao gồm: phần phụ thuộc không phù hợp, dữ liệu đầu vào không hợp lệ cho một quy tắc và tất cả thông báo lỗi liên quan đến quy tắc.

Các giai đoạn tải và phân tích diễn ra nhanh chóng vì Bazel tránh các tệp I/O không cần thiết ở giai đoạn này, chỉ đọc các tệp BUILD để xác định công việc cần hoàn thành. Điều này là do thiết kế và khiến Bazel trở thành nền tảng tốt cho các công cụ phân tích, chẳng hạn như lệnh truy vấn của Bazel, được triển khai ở giai đoạn tải.

Giai đoạn thực thi

Giai đoạn thứ ba và cuối cùng của bản dựng là thực thi. Giai đoạn này đảm bảo rằng kết quả của mỗi bước trong bản dựng nhất quán với dữ liệu đầu vào, các công cụ biên dịch/liên kết lại, v.v. khi cần thiết. Bước này là nơi xây dựng hầu hết thời gian của bản dựng, từ vài giây đến hơn một giờ cho một bản dựng lớn. Các lỗi được báo cáo trong giai đoạn này bao gồm: thiếu tệp nguồn, lỗi trong một công cụ được thực thi bởi một số hành động xây dựng hoặc lỗi công cụ không thể tạo tập hợp đầu ra dự kiến.