영구 작업자

이 페이지에서는 영구 작업자 사용 방법, 이점, 요구사항, 작업자가 샌드박스에 미치는 영향을 설명합니다.

영구 작업자는 Bazel 서버에서 시작한 장기 실행 프로세스로, 실제 도구 (일반적으로 컴파일러) 주위의 래퍼로 작동하거나 도구 자체입니다. 영구 작업자의 이점을 활용하려면 도구가 일련의 컴파일을 지원해야 하며 래퍼는 도구의 API와 아래에 설명된 요청/응답 형식 간에 변환해야 합니다. 동일한 작업자가 동일한 빌드에서 --persistent_worker 플래그 유무와 관계없이 호출될 수 있으며, 도구를 적절하게 시작하고 도구와 통신하는 것뿐만 아니라 종료 시 작업자를 종료하는 작업을 담당합니다. 각 작업자 인스턴스에는 <outputBase>/bazel-workers 아래에 별도의 작업 디렉터리가 할당되지만 chroot로 처리되지는 않습니다.

영구 작업자를 사용하는 것은 시작 오버헤드를 줄이고, 더 많은 JIT 컴파일을 허용하며, 예를 들어 작업 실행에서 추상 문법 트리를 캐시할 수 있는 실행 전략입니다. 이 전략은 장기 실행 프로세스에 여러 요청을 전송하여 이러한 개선을 실행합니다.

영구 작업자는 Java, Scala, Kotlin 등 여러 언어로 구현됩니다.

NodeJS 런타임을 사용하는 프로그램은 @bazel/worker 도우미 라이브러리를 사용하여 작업자 프로토콜을 구현할 수 있습니다.

영구 작업자 사용

Bazel 0.27 이상은 빌드를 실행할 때 기본적으로 영구 작업자를 사용하지만 원격 실행이 우선 적용됩니다. 지속적인 작업자를 지원하지 않는 작업의 경우 Bazel은 각 작업에 대해 도구 인스턴스를 시작하는 것으로 대체합니다. 관련 도구 니모닉의 worker 전략을 설정하여 영구 작업자를 사용하도록 빌드를 명시적으로 설정할 수 있습니다. 권장사항에 따라 이 예에서는 local를 worker 전략의 대체 전략으로 지정합니다.

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

로컬 전략 대신 작업자 전략을 사용하면 구현에 따라 컴파일 속도가 크게 향상될 수 있습니다. Java의 경우 빌드 속도가 2~4배 더 빠를 수 있으며 증분 컴파일의 경우 더 빨라질 수 있습니다. 작업자를 사용하면 Bazel 컴파일이 약 2.5배 더 빨라집니다. 자세한 내용은 '작업자 수 선택' 섹션을 참고하세요.

로컬 빌드 환경과 일치하는 원격 빌드 환경도 있는 경우 원격 실행과 작업자 실행을 경합하는 실험용 동적 전략을 사용할 수 있습니다. 동적 전략을 사용 설정하려면 --experimental_spawn_scheduler 플래그를 전달합니다. 이 전략은 작업자를 자동으로 사용 설정하므로 worker 전략을 지정할 필요가 없지만 local 또는 sandboxed를 대체로 사용할 수는 있습니다.

작업자 수 선택

니모닉당 기본 작업자 인스턴스 수는 4개이지만 worker_max_instances 플래그로 조정할 수 있습니다. 사용 가능한 CPU를 잘 활용하는 것과 얻는 JIT 컴파일 및 캐시 히트의 양 사이에는 절충점이 있습니다. 작업자가 많을수록 더 많은 타겟이 JIT되지 않은 코드를 실행하고 콜드 캐시를 사용하는 시작 비용을 지불합니다. 빌드할 타겟이 적은 경우 단일 작업자가 컴파일 속도와 리소스 사용량 간에 가장 적절한 균형을 제공할 수 있습니다(예: 문제 #8586 참고). worker_max_instances 플래그는 니모닉 및 플래그 세트당 최대 작업자 인스턴스 수를 설정합니다 (아래 참고). 따라서 혼합 시스템에서 기본값을 유지하면 상당히 많은 메모리를 사용하게 될 수 있습니다. 증분 빌드의 경우 여러 작업자 인스턴스의 이점은 훨씬 더 작습니다.

이 그래프는 64GB RAM을 갖춘 6코어 하이퍼스레드 Intel Xeon 3.5GHz Linux 워크스테이션에서 Bazel(타겟 //src:bazel)의 처음부터 컴파일 시간을 보여줍니다. 각 작업자 구성에 대해 클린 빌드 5개를 실행하고 마지막 4개의 평균을 취합니다.

그림 1. 클린 빌드의 성능 개선 그래프

이 구성에서는 작업자 2명이 가장 빠른 컴파일을 제공하지만 작업자 1명에 비해 14%만 개선됩니다. 메모리를 적게 사용하려면 워커를 1개 사용하는 것이 좋습니다.

증분 컴파일은 일반적으로 훨씬 더 많은 이점을 제공합니다. 클린 빌드는 비교적 드물지만 컴파일 간에 단일 파일을 변경하는 것은 특히 테스트 주도 개발에서 일반적입니다. 위의 예에는 증분 컴파일 시간을 덮어쓸 수 있는 Java가 아닌 패키징 작업도 일부 있습니다.

AbstractContainerizingSandboxedSpawn.java에서 내부 문자열 상수를 변경한 후에 자바 소스(//src/main/java/com/google/devtools/build/lib/bazel:BazelServer_deploy.jar)만 다시 컴파일하면 속도가 3배 향상됩니다 (준비 빌드 1개가 삭제된 평균 증분 빌드 20개).

그림 2. 증분 빌드의 성능 개선 그래프

속도 향상은 변경사항에 따라 다릅니다. 일반적으로 사용되는 상수가 변경된 위의 상황에서 속도가 6배 빨라집니다.

영구 작업자 수정

--worker_extra_flag 플래그를 전달하여 니모닉으로 키가 지정된 시작 플래그를 작업자에 지정할 수 있습니다. 예를 들어 --worker_extra_flag=javac=--debug를 전달하면 Javac에만 디버깅이 사용 설정됩니다. 이 플래그를 사용할 때마다 하나의 작업자 플래그만 설정할 수 있으며, 하나의 니모닉에 대해서만 설정할 수 있습니다. 작업자는 각 니모닉에 대해 별도로 생성되는 것이 아니라 시작 플래그의 변형에 대해서도 생성됩니다. 각 니모닉과 시작 플래그 조합은 WorkerKey로 결합되며, 각 WorkerKey에 대해 최대 worker_max_instances개의 작업자가 생성될 수 있습니다. 작업 구성에서 설정 플래그를 지정하는 방법은 다음 섹션을 참고하세요.

--high_priority_workers 플래그를 사용하여 일반 우선순위 니모닉보다 먼저 실행해야 하는 니모닉을 지정할 수 있습니다. 이렇게 하면 항상 중요한 경로에 있는 작업의 우선순위를 지정하는 데 도움이 됩니다. 요청을 실행하는 우선순위가 높은 작업자가 2개 이상 있는 경우 다른 모든 작업자는 실행되지 않습니다. 이 플래그는 여러 번 사용할 수 있습니다.

--worker_sandboxing 플래그를 전달하면 각 작업자 요청이 모든 입력에 별도의 샌드박스 디렉터리를 사용합니다. 샌드박스를 설정하는 데는 특히 macOS에서 시간이 더 걸리지만 정확성을 더 잘 보장합니다.

--worker_quit_after_build 플래그는 주로 디버깅 및 프로파일링에 유용합니다. 이 플래그는 빌드가 완료되면 모든 작업자를 강제로 종료합니다. --worker_verbose를 전달하여 작업자가 실행 중인 작업에 관한 추가 출력을 얻을 수도 있습니다. 이 플래그는 WorkRequest의 verbosity 필드에 반영되므로 작업자 구현도 더 상세해질 수 있습니다.

작업자는 로그를 <outputBase>/bazel-workers 디렉터리(예: /tmp/_bazel_larsrc/191013354bebe14fdddae77f2679c3ef/bazel-workers/worker-1-Javac.log)에 저장합니다. 파일 이름에는 작업자 ID와 니모닉이 포함됩니다. mnemonic당 WorkerKey가 두 개 이상 있을 수 있으므로 특정 mnemonic에 대해 worker_max_instances 로그 파일이 두 개 이상 표시될 수 있습니다.

Android 빌드의 경우 Android 빌드 성능 페이지에서 세부정보를 확인하세요.

영구 작업자 구현

작업자를 만드는 방법에 관한 자세한 내용은 영구 작업자 만들기 페이지를 참고하세요.

이 예시에서는 JSON을 사용하는 작업자의 Starlark 구성을 보여줍니다.

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" }
)

이 정의에 따라 이 작업을 처음 사용하는 경우 명령줄 /bin/some_compiler -max_mem=4G --persistent_worker를 실행하는 것으로 시작됩니다. 그러면 Foo.java 컴파일 요청은 다음과 같습니다.

참고: 프로토콜 버퍼 사양은 '뱀 케이스' (request_id)를 사용하는 반면 JSON 프로토콜은 '낙타 케이스' (requestId)를 사용합니다. 이 문서에서는 JSON 예시에는 낙타 케이스를 사용하고 프로토콜과 관계없이 필드에 관해 이야기할 때는 뱀 케이스를 사용합니다.

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

작업자는 stdin에서 줄바꿈으로 구분된 JSON 형식으로 이를 수신합니다(requires-worker-protocol이 JSON으로 설정되어 있기 때문). 그러면 작업자가 작업을 실행하고 JSON 형식의 WorkResponse를 stdout에서 Bazel로 전송합니다. 그런 다음 Bazel은 이 응답을 파싱하고 수동으로 WorkResponse 프로토로 변환합니다. JSON 대신 바이너리 인코딩된 protobuf를 사용하여 연결된 작업자와 통신하려면 다음과 같이 requires-worker-protocol를 proto로 설정합니다.

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

실행 요구사항에 requires-worker-protocol를 포함하지 않으면 Bazel은 기본적으로 워커 통신에 protobuf을 사용합니다.

Bazel은 mnemoinc 및 공유 플래그에서 WorkerKey를 파생하므로 이 구성에서 max_mem 매개변수 변경을 허용하면 사용되는 각 값에 대해 별도의 작업자가 생성됩니다. 따라서 변형이 너무 많이 사용되면 메모리 소비가 과도해질 수 있습니다.

현재 각 작업자는 한 번에 하나의 요청만 처리할 수 있습니다. 기본 도구가 멀티스레드이고 래퍼가 이를 이해하도록 설정된 경우 실험용 멀티플렉스 작업자 기능에서는 여러 스레드를 사용할 수 있습니다.

이 GitHub 저장소에서 자바와 Python으로 작성된 작업자 래퍼 예를 확인할 수 있습니다. JavaScript 또는 TypeScript로 작업하는 경우 @bazel/worker 패키지 및 nodejs worker 예시가 유용할 수 있습니다.

작업자는 샌드박스에 어떤 영향을 미치나요?

기본적으로 worker 전략을 사용하면 local 전략과 마찬가지로 샌드박스에서 작업이 실행되지 않습니다. --worker_sandboxing 플래그를 설정하여 모든 작업자를 샌드박스 내에서 실행하여 도구를 실행할 때마다 있어야 하는 입력 파일만 표시되도록 할 수 있습니다. 도구는 여전히 캐시를 통해 요청 간에 내부적으로 정보를 유출할 수 있습니다. dynamic 전략을 사용하려면 작업자를 샌드박스 처리해야 합니다.

작업자와 함께 컴파일러 캐시를 올바르게 사용할 수 있도록 각 입력 파일과 함께 다이제스트가 전달됩니다. 따라서 컴파일러 또는 래퍼는 파일을 읽지 않고도 입력이 여전히 유효한지 확인할 수 있습니다.

입력 다이제스트를 사용하여 원치 않는 캐싱을 방지하는 경우에도 샌드박스화된 작업자는 순수 샌드박스보다 덜 엄격한 샌드박스를 제공합니다. 도구가 이전 요청의 영향을 받은 다른 내부 상태를 유지할 수 있기 때문입니다.

멀티플렉스 작업자는 작업자 구현에서 이를 지원하는 경우에만 샌드박스 처리할 수 있으며, 이 샌드박스 처리는 --experimental_worker_multiplex_sandboxing 플래그를 사용하여 별도로 사용 설정해야 합니다. 자세한 내용은 설계 문서를 참고하세요.

추가 자료

영구 작업자에 관한 자세한 내용은 다음을 참고하세요.

• 원래 영구 작업자 블로그 게시물
• Haskell 구현 설명
• 마이크 모어아티의 블로그 게시물
• Bazel을 사용한 프런트엔드 개발: Asana를 사용한 Angular/TypeScript 및 영구 작업자
• Bazel 전략 설명
• bazel-discuss 메일링 리스트에 관한 유용한 작업자 전략 토론