Nhóm thực thi tự động (AEG)

Nhóm thực thi tự động chọn một nền tảng thực thi cho mỗi loại chuỗi công cụ. Nói cách khác, một mục tiêu có thể có nhiều nền tảng thực thi mà không cần xác định nhóm thực thi.

Tóm tắt nhanh

Nhóm thực thi tự động được kết nối chặt chẽ với chuỗi công cụ. Nếu đang sử dụng chuỗi công cụ, bạn cần đặt chuỗi công cụ đó trên các hành động bị ảnh hưởng (các hành động sử dụng tệp thực thi hoặc công cụ từ chuỗi công cụ) bằng cách thêm tham số toolchain. Ví dụ:

ctx.actions.run(
    ...,
    executable = ctx.toolchain['@bazel_tools//tools/jdk:toolchain_type'].tool,
    ...,
    toolchain = '@bazel_tools//tools/jdk:toolchain_type',
)

Nếu hành động không sử dụng công cụ hoặc tệp thực thi từ một chuỗi công cụ và Blaze không phát hiện được điều đó (lỗi được đưa ra), bạn có thể đặt toolchain = None.

Nếu cần sử dụng nhiều chuỗi công cụ trên một nền tảng thực thi (một thao tác sử dụng tệp thực thi hoặc công cụ từ hai chuỗi công cụ trở lên), bạn cần xác định exec_groups theo cách thủ công (xem phần Khi nào tôi nên sử dụng exec_group tuỳ chỉnh?).

Cập nhật trước đây

Trước AEG, nền tảng thực thi được chọn ở cấp quy tắc. Ví dụ:

my_rule = rule(
    _impl,
    toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
)

Quy tắc my_rule đăng ký hai loại chuỗi công cụ. Điều này có nghĩa là Toolchain Resolution (Độ phân giải chuỗi công cụ) được dùng để tìm một nền tảng thực thi hỗ trợ cả hai loại chuỗi công cụ. Nền tảng thực thi được chọn được dùng cho từng hành động đã đăng ký bên trong quy tắc, trừ trường hợp được chỉ định khác với exec_groups. Nói cách khác, tất cả các hành động bên trong quy tắc đều có một nền tảng thực thi duy nhất ngay cả khi các hành động đó sử dụng các công cụ từ các chuỗi công cụ khác nhau (nền tảng thực thi được chọn cho từng mục tiêu). Điều này dẫn đến lỗi khi không có nền tảng thực thi nào hỗ trợ tất cả các chuỗi công cụ.

Trạng thái hiện tại

Với AEG, nền tảng thực thi được chọn cho từng loại chuỗi công cụ. Hàm triển khai của ví dụ trước, my_rule, sẽ có dạng như sau:

def _impl(ctx):
    ctx.actions.run(
      mnemonic = "First action",
      executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
      toolchain = '//tools:toolchain_type_1',
    )

    ctx.actions.run(
      mnemonic = "Second action",
      executable = ctx.toolchain['//tools:toolchain_type_2'].tool,
      toolchain = '//tools:toolchain_type_2',
    )

Quy tắc này tạo ra hai hành động, First action sử dụng tệp thực thi từ //tools:toolchain_type_1 và Second action sử dụng tệp thực thi từ //tools:toolchain_type_2. Trước AEG, cả hai thao tác này sẽ được thực thi trên một nền tảng thực thi duy nhất hỗ trợ cả hai loại chuỗi công cụ. Với AEG, bằng cách thêm thông số toolchain vào bên trong các thao tác, mỗi thao tác sẽ thực thi trên nền tảng thực thi cung cấp chuỗi công cụ. Các hành động có thể được thực thi trên nhiều nền tảng thực thi.

Điều tương tự cũng áp dụng cho ctx.actions.run_shell, trong đó bạn phải thêm thông số toolchain khi tools là từ một chuỗi công cụ.

Sự khác biệt giữa nhóm thực thi tuỳ chỉnh và nhóm thực thi tự động

Như tên gọi, AEG là các nhóm thực thi được tạo tự động cho từng loại chuỗi công cụ được đăng ký trên một quy tắc. Bạn không cần chỉ định các nhóm này theo cách thủ công, khác với các nhóm thực thi "cổ điển".

Khi nào tôi nên sử dụng exec_group tuỳ chỉnh?

Bạn chỉ cần exec_groups tuỳ chỉnh trong trường hợp nhiều chuỗi công cụ cần thực thi trên một nền tảng thực thi. Trong mọi trường hợp khác, bạn không cần xác định exec_groups tuỳ chỉnh. Ví dụ:

def _impl(ctx):
    ctx.actions.run(
      ...,
      executable = ctx.toolchain['//tools:toolchain_type_1'].tool,
      tools = [ctx.toolchain['//tools:toolchain_type_2'].tool],
      exec_group = 'two_toolchains',
    )

my_rule = rule(
    _impl,
    exec_groups = {
        "two_toolchains": exec_group(
            toolchains = ['//tools:toolchain_type_1', '//tools:toolchain_type_2'],
        ),
    }
)

Di chuyển AEG

Trong google3, Blaze đã sử dụng AEG. Đối với Bazel bên ngoài, quá trình di chuyển đang diễn ra. Một số quy tắc đã sử dụng tính năng này (ví dụ: quy tắc Java và C++).

Phiên bản Bazel nào hỗ trợ quá trình di chuyển này?

AEG được hỗ trợ đầy đủ từ Bazel 7.

Cách bật AEG?

Đặt --incompatible_auto_exec_groups thành true. Thông tin khác về cờ này trên vấn đề trên GitHub.

Làm cách nào để bật AEG bên trong một quy tắc cụ thể?

Đặt thuộc tính _use_auto_exec_groups trên một quy tắc.

my_rule = rule(
    _impl,
    attrs = {
      "_use_auto_exec_groups": attr.bool(default = True),
    }
)

Điều này chỉ cho phép AEG trong my_rule và các hành động của AEG bắt đầu sử dụng logic mới khi chọn nền tảng thực thi. Cờ không tương thích sẽ bị ghi đè bằng thuộc tính này.

Làm cách nào để tắt AEG trong trường hợp xảy ra lỗi?

Đặt --incompatible_auto_exec_groups thành false để tắt hoàn toàn AEG trong dự án (vấn đề về cờ trên GitHub) hoặc tắt một quy tắc cụ thể bằng cách đặt thuộc tính _use_auto_exec_groups thành False (thông tin chi tiết hơn về thuộc tính này).

Thông báo lỗi trong khi di chuyển sang AEG

Không xác định được liệu các công cụ có phải là từ các phần phụ thuộc ngầm ẩn hay một chuỗi công cụ. Vui lòng đặt tham số chuỗi công cụ. Nếu bạn không sử dụng chuỗi công cụ, hãy đặt chuỗi công cụ thành "None".

• Trong trường hợp này, bạn sẽ nhận được một ngăn xếp lệnh gọi trước khi lỗi xảy ra và bạn có thể thấy rõ hành động chính xác nào cần tham số chuỗi công cụ. Kiểm tra xem chuỗi công cụ nào được dùng cho thao tác và đặt chuỗi công cụ đó bằng tham số chuỗi công cụ. Nếu không có chuỗi công cụ nào được sử dụng bên trong thao tác cho các công cụ hoặc tệp thực thi, hãy đặt chuỗi công cụ đó thành None.

Hành động được khai báo cho chuỗi công cụ không tồn tại "[toolchain_type]".

• Điều này có nghĩa là bạn đã đặt tham số chuỗi công cụ trên hành động nhưng chưa đăng ký tham số đó trên quy tắc. Đăng ký chuỗi công cụ hoặc đặt None bên trong thao tác.

Tài liệu bổ sung

Để biết thêm thông tin, hãy xem tài liệu thiết kế: Nhóm thực thi tự động cho chuỗi công cụ.