Nhân viên liên tục

Báo cáo vấn đề Xem nguồn Hằng đêm · 7,4 của Google. 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Trang này trình bày cách sử dụng worker ổn định, các lợi ích, yêu cầu và cách worker ảnh hưởng đến hộp cát.

Worker ổn định là một quy trình chạy trong thời gian dài do máy chủ Bazel khởi động, đóng vai trò là trình bao bọc xung quanh công cụ thực tế (thường là trình biên dịch) hoặc chính là công cụ đó. Để hưởng lợi từ trình thực thi liên tục, công cụ này phải hỗ trợ thực hiện một trình tự biên dịch và trình bao bọc cần dịch giữa API của công cụ và định dạng yêu cầu/phản hồi được mô tả bên dưới. Điều tương tự worker có thể được gọi có và không có cờ --persistent_worker trong phần tử cùng một bản dựng và chịu trách nhiệm bắt đầu và trao đổi một cách thích hợp với cũng như tắt trình thực thi khi thoát. Mỗi thực thể worker được chỉ định (nhưng không được chuyển đến) một thư mục làm việc riêng biệt trong <outputBase>/bazel-workers.

Việc sử dụng worker ổn định là một chiến lược thực thi giúp giảm hao tổn khi khởi động, cho phép biên dịch JIT nhiều hơn và cho phép lưu vào bộ nhớ đệm, chẳng hạn như cây cú pháp trừu tượng trong quá trình thực thi hành động. Chiến lược này đạt được những điểm cải tiến này bằng cách gửi nhiều yêu cầu đến một quy trình chạy trong thời gian dài.

Worker ổn định được triển khai cho nhiều ngôn ngữ, bao gồm Java, Scala, Kotlin và nhiều ngôn ngữ khác.

Các chương trình sử dụng môi trường thời gian chạy NodeJS có thể sử dụng thư viện trình trợ giúp @bazel/worker để triển khai giao thức worker.

Sử dụng worker liên tục

Bazel 0.27 trở lên sử dụng worker ổn định theo mặc định khi thực thi bản dựng, mặc dù việc thực thi từ xa được ưu tiên. Đối với các thao tác không hỗ trợ worker ổn định, Bazel sẽ quay lại việc khởi động một thực thể công cụ cho mỗi thao tác. Bạn có thể đặt rõ ràng bản dựng để sử dụng worker ổn định bằng cách đặt chiến lược worker cho các từ viết tắt công cụ hiện hành. Cách hay nhất là trong ví dụ này, bạn nên chỉ định local làm một dự phòng cho chiến lược worker:

bazel build //my:target --strategy=Javac=worker,local

Việc sử dụng chiến lược worker thay vì chiến lược cục bộ có thể làm tăng đáng kể tốc độ biên dịch, tuỳ thuộc vào cách triển khai. Đối với Java, bản dựng có thể có từ 2 đến 4 nhanh hơn, đôi khi cao hơn để biên dịch gia tăng. Việc biên dịch Bazel nhanh hơn khoảng 2,5 lần so với worker. Để biết thêm thông tin, hãy xem "Chọn số lượng nhân viên" .

Nếu cũng có môi trường bản dựng từ xa phù hợp với môi trường bản dựng cục bộ, bạn có thể sử dụng chiến lược động thử nghiệm. Chiến lược này sẽ chạy song song một quá trình thực thi từ xa và một quá trình thực thi worker. Để bật chiến lược động, hãy truyền cờ --experimental_spawn_scheduler. Chiến lược này tự động bật worker, vì vậy, bạn không cần chỉ định chiến lược worker, nhưng vẫn có thể sử dụng local hoặc sandboxed làm phương án dự phòng.

Chọn số lượng worker

Số lượng thực thể worker mặc định cho mỗi câu thần chú là 4, nhưng bạn có thể điều chỉnh bằng cờ worker_max_instances. Có một sự đánh đổi giữa việc sử dụng hiệu quả CPU có sẵn và số lượng truy cập biên dịch JIT và bộ nhớ đệm bạn nhận được. Với nhiều nhân viên hơn, nhiều hơn mục tiêu sẽ trả chi phí khởi động khi chạy mã không phải JITt và kết hợp bộ nhớ đệm. Nếu bạn có ít mục tiêu cần xây dựng, một nhân viên duy nhất có thể đưa ra sự cân bằng tốt nhất giữa tốc độ biên dịch và mức sử dụng tài nguyên (ví dụ: hãy xem vấn đề #8586. Cờ worker_max_instances đặt số lượng thực thể worker tối đa trên mỗi ghi nhớ và gắn cờ (xem bên dưới), vì vậy trong một hệ thống hỗn hợp, bạn có thể sử dụng khá nhiều bộ nhớ nếu bạn giữ giá trị mặc định. Đối với các bản dựng tăng dần, lợi ích của nhiều thực thể worker còn nhỏ hơn nữa.

Biểu đồ này cho thấy thời gian biên dịch từ đầu cho Bazel (mục tiêu //src:bazel) trên máy trạm Linux Intel Xeon 3.5 GHz 6 lõi siêu luồng với 64 GB RAM. Đối với mỗi cấu hình trình thực thi, 5 bản dựng sạch sẽ được chạy và giá trị trung bình của bốn giá trị cuối cùng được lấy.

Biểu đồ mức độ cải thiện hiệu suất của bản dựng sạch

Hình 1. Biểu đồ mức độ cải thiện hiệu suất của các bản dựng sạch.

Đối với cấu hình này, hai worker sẽ biên dịch nhanh nhất, mặc dù chỉ cải thiện được 14% so với một worker. Một worker là một lựa chọn phù hợp nếu bạn muốn sử dụng ít bộ nhớ hơn.

Quá trình biên dịch gia tăng thường mang lại nhiều lợi ích hơn nữa. Các bản dựng sạch tương đối hiếm, nhưng việc thay đổi một tệp duy nhất giữa các lần biên dịch là phổ biến, đặc biệt là trong quá trình phát triển do kiểm thử. Ví dụ ở trên cũng có một số mã không phải là Java đóng gói các hành động có thể làm lu mờ thời gian biên dịch gia tăng.

Chỉ biên dịch lại các nguồn Java (//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar) sau khi thay đổi một hằng số chuỗi nội bộ trong AbstractContainerizingSandboxedSpawn.java giúp tăng tốc độ gấp 3 lần (trung bình có 20 bản dựng tăng dần với một bản khởi động đã huỷ):

Biểu đồ về hiệu suất cải thiện của các bản dựng gia tăng

Hình 2. Biểu đồ cải thiện hiệu suất của các bản dựng tăng dần.

Việc tăng tốc độ phụ thuộc vào thay đổi đang được thực hiện. Tốc độ tăng lên gấp 6 lần được đo trong trường hợp trên khi một hằng số thường dùng được thay đổi.

Sửa đổi worker liên tục

Bạn có thể chuyển --worker_extra_flag để chỉ định cờ khởi động cho các worker, được khoá bằng ghi nhớ. Ví dụ: việc truyền --worker_extra_flag=javac=--debug sẽ chỉ bật tính năng gỡ lỗi cho Javac. Bạn chỉ có thể đặt một cờ worker cho mỗi lần sử dụng cờ này và chỉ cho một ghi nhớ. Worker không chỉ được tạo riêng cho từng ghi nhớ mà còn cho các biến thể khác nhau của cờ khởi động. Từng cách kết hợp giữa việc ghi nhớ và khởi động cờ được kết hợp thành một WorkerKey và đối với mỗi WorkerKey tối đa Bạn có thể tạo worker_max_instances worker. Xem phần tiếp theo để biết cách cấu hình thao tác cũng có thể chỉ định cờ thiết lập.

Bạn có thể sử dụng cờ --high_priority_workers để chỉ định một câu khẩu hiệu cần được chạy thay vì câu khẩu hiệu có mức độ ưu tiên thông thường. Điều này có thể giúp ưu tiên các hành động luôn nằm trong đường dẫn quan trọng. Nếu có hai hoặc nhiều worker có mức độ ưu tiên cao đang thực thi các yêu cầu, thì tất cả worker khác sẽ không được chạy. Bạn có thể sử dụng cờ này nhiều lần.

Việc truyền cờ --worker_sandboxing sẽ khiến mỗi yêu cầu của worker sử dụng một thư mục hộp cát riêng cho tất cả dữ liệu đầu vào. Việc thiết lập hộp cát sẽ mất thêm chút thời gian, đặc biệt là trên macOS, nhưng sẽ đảm bảo độ chính xác cao hơn.

Cờ --worker_quit_after_build chủ yếu hữu ích khi gỡ lỗi và lập hồ sơ. Cờ này buộc tất cả worker phải thoát sau khi bản dựng hoàn tất. Bạn cũng có thể chuyển --worker_verbose đến có được kết quả tốt hơn về những gì mà nhân viên đang làm. Cờ này được phản ánh trong Trường verbosity trong WorkRequest, cho phép các hoạt động triển khai trình thực thi chi tiết hơn.

Worker lưu trữ nhật ký trong thư mục <outputBase>/bazel-workers, đối với ví dụ /tmp/_bazel_larsrc/191013354bebe14fdddae77f2679c3ef/bazel-workers/worker-1-Javac.log. Tên tệp bao gồm mã trình thực thi và tên ghi nhớ. Vì có thể có thêm nhiều hơn một WorkerKey cho mỗi ghi nhớ, bạn có thể thấy nhiều hơn worker_max_instances tệp nhật ký cho một ghi nhớ nhất định.

Đối với các bản dựng Android, hãy xem chi tiết tại Trang Hiệu suất bản dựng Android.

Triển khai trình thực thi liên tục

Xem trang tạo trình thực thi liên tục để biết thêm thông tin thông tin về cách tạo ra một worker.

Ví dụ dưới đây cho thấy cấu hình Starlark cho một worker sử dụng JSON:

args_file = ctx.actions.declare_file(ctx.label.name + "_args_file")
ctx.actions.write(
    output = args_file,
    content = "\n".join(["-g", "-source", "1.5"] + ctx.files.srcs),
)
ctx.actions.run(
    mnemonic = "SomeCompiler",
    executable = "bin/some_compiler_wrapper",
    inputs = inputs,
    outputs = outputs,
    arguments = [ "-max_mem=4G",  "@%s" % args_file.path],
    execution_requirements = {
        "supports-workers" : "1", "requires-worker-protocol" : "json" }
)

Với định nghĩa này, lần sử dụng đầu tiên của hành động này sẽ bắt đầu bằng cách thực thi dòng lệnh /bin/some_compiler -max_mem=4G --persistent_worker. Một yêu cầu để biên dịch, Foo.java sẽ có dạng như sau:

LƯU Ý: Mặc dù thông số kỹ thuật vùng đệm giao thức sử dụng "cách viết hoa rắn" (request_id), giao thức JSON sử dụng "kiểu lạc đà" (requestId). Trong tài liệu này, chúng tôi sẽ sử dụng kiểu viết lạc đà trong các ví dụ về JSON, nhưng viết hoa kiểu rắn khi nói về trường bất kể giao thức là gì.

{
  "arguments": [ "-g", "-source", "1.5", "Foo.java" ]
  "inputs": [
    { "path": "symlinkfarm/input1", "digest": "d49a..." },
    { "path": "symlinkfarm/input2", "digest": "093d..." },
  ],
}

Worker nhận được thông tin này trên stdin ở định dạng JSON được phân tách bằng dòng mới (vì requires-worker-protocol được đặt thành JSON). Sau đó, worker này thực hiện hành động và gửi WorkResponse có định dạng JSON tới Bazel trên stdout. Sau đó là Bazel phân tích cú pháp phản hồi này và chuyển đổi phản hồi thành proto WorkResponse theo cách thủ công. Để giao tiếp với worker được liên kết bằng protobuf được mã hoá nhị phân thay vì JSON, requires-worker-protocol sẽ được đặt thành proto, như sau:

  execution_requirements = {
    "supports-workers" : "1" ,
    "requires-worker-protocol" : "proto"
  }

Nếu bạn không đưa requires-worker-protocol vào các yêu cầu thực thi, thì Bazel sẽ đặt mặc định giao tiếp của worker là sử dụng protobuf.

Bazel lấy WorkerKey từ câu thần chú và cờ dùng chung, vì vậy, nếu cấu hình này cho phép thay đổi tham số max_mem, thì một worker riêng sẽ được tạo cho mỗi giá trị được sử dụng. Điều này có thể dẫn đến mức tiêu thụ bộ nhớ quá mức nếu sử dụng quá nhiều biến thể.

Hiện tại, mỗi worker chỉ có thể xử lý một yêu cầu tại một thời điểm. Chương trình thử nghiệm Tính năng multix worker cho phép sử dụng nhiều các luồng, nếu công cụ cơ bản là đa luồng và trình bao bọc được thiết lập để hiểu điều này.

Trong kho lưu trữ GitHub này, bạn có thể xem các trình bao bọc worker mẫu được viết bằng Java cũng như Python. Nếu bạn đang xử lý JavaScript hoặc TypeScript, @bazel/worker package và ví dụ về trình thực thinodejs có thể hữu ích.

Trình thực thi ảnh hưởng như thế nào đến hộp cát?

Theo mặc định, việc sử dụng chiến lược worker sẽ không chạy hành động trong hộp cát, tương tự như chiến lược local. Bạn có thể đặt cờ --worker_sandboxing để chạy tất cả worker bên trong hộp cát, đảm bảo mỗi lần thực thi công cụ chỉ thấy các tệp đầu vào mà công cụ đó dự kiến sẽ có. Công cụ này vẫn có thể rò rỉ thông tin giữa các yêu cầu nội bộ, chẳng hạn như thông qua bộ nhớ đệm. Việc sử dụng chiến lược dynamic yêu cầu các worker phải được đưa vào hộp cát.

Để cho phép sử dụng chính xác bộ nhớ đệm của trình biên dịch với các worker, một chuỗi đại diện sẽ được truyền cùng với mỗi tệp đầu vào. Do đó, trình biên dịch hoặc trình bao bọc có thể kiểm tra xem dữ liệu đầu vào có vẫn hợp lệ mà không phải đọc tệp.

Ngay cả khi sử dụng chuỗi đại diện đầu vào để bảo vệ khỏi hoạt động lưu vào bộ nhớ đệm không mong muốn, tính năng này được đặt trong hộp cát worker cung cấp hộp cát ít nghiêm ngặt hơn so với hộp cát thuần tuý vì công cụ này có thể giữ lại trạng thái nội bộ khác đã bị ảnh hưởng bởi những yêu cầu trước đó.

Bạn chỉ có thể đưa trình chạy Multiplex vào hộp cát nếu quá trình triển khai trình chạy hỗ trợ việc này, đồng thời bạn phải bật hộp cát này riêng biệt bằng cờ --experimental_worker_multiplex_sandboxing. Xem thêm chi tiết trong tài liệu thiết kế).

Tài liệu đọc thêm

Để biết thêm thông tin về trình thực thi liên tục, hãy xem: