영구 작업자 만들기

문제 신고 소스 보기

영구 작업자를 사용하면 빌드 속도가 빨라집니다. 빌드에 시작 비용이 높거나 교차 작업 캐싱의 이점을 누릴 수 있는 반복되는 작업이 있는 경우 이러한 작업을 수행하도록 자체 영구 작업자를 구현하는 것이 좋습니다.

Bazel 서버는 stdin/stdout를 사용하여 작업자와 통신합니다. 프로토콜 버퍼 또는 JSON 문자열 사용을 지원합니다.

작업자 구현은 다음 두 부분으로 구성됩니다.

작업자.
작업자를 사용하는 규칙.

작업자 만들기

영구 작업자에는 다음과 같은 요구사항이 있습니다.

stdin에서 WorkRequests를 읽습니다.
이 메서드는 WorkResponses(및 WorkResponse만)를 stdout에 씁니다.
--persistent_worker 플래그를 허용합니다. 래퍼는 --persistent_worker 명령줄 플래그를 인식하고 플래그가 전달된 경우에만 지속되도록 해야 합니다. 그렇지 않으면 원샷 컴파일을 실행하고 종료해야 합니다.

프로그램이 이러한 요구사항을 준수하면 영구 작업자로 사용될 수 있습니다.

작업 요청

WorkRequest에는 작업자의 인수 목록, 작업자가 액세스할 수 있는 입력을 나타내는 경로 다이제스트 쌍 (이는 적용되지 않지만 캐싱에 이 정보를 사용할 수 있음), 싱글플렉스 작업자의 경우 0인 요청 ID가 포함됩니다.

참고: 프로토콜 버퍼 사양은 '스네이크 케이스'(request_id)를 사용하지만 JSON 프로토콜은 '카멜 표기법'(requestId)을 사용합니다. 이 문서에서는 JSON 예시에서 카멜 표기법을 사용하지만 프로토콜에 관계없이 필드에 관해 이야기할 때는 스네이크 사례를 사용합니다.

{
  "arguments" : ["--some_argument"],
  "inputs" : [
    { "path": "/path/to/my/file/1", "digest": "fdk3e2ml23d"},
    { "path": "/path/to/my/file/2", "digest": "1fwqd4qdd" }
 ],
  "requestId" : 12
}

선택사항인 verbosity 필드를 사용하여 작업자로부터 추가 디버깅 출력을 요청할 수 있습니다. 무엇을 어떻게 출력할지는 전적으로 작업자가 결정합니다. 값이 클수록 상세 출력이 표시됩니다. --worker_verbose 플래그를 Bazel에 전달하면 verbosity 필드가 10으로 설정되지만, 더 크거나 작은 값을 다양한 출력에 수동으로 사용할 수 있습니다.

선택사항인 sandbox_dir 필드는 멀티플렉스 샌드박스를 지원하는 작업자에서만 사용됩니다.

작업 응답

WorkResponse에는 요청 ID, 0 또는 0이 아닌 종료 코드, 요청을 처리하거나 실행할 때 발생하는 모든 오류를 설명하는 출력 문자열이 포함되어 있습니다. output 필드에는 간단한 설명이 포함됩니다. 전체 로그가 작업자의 stderr에 작성될 수 있습니다. 작업자는 WorkResponses를 stdout에만 쓸 수 있으므로 작업자는 사용하는 도구의 stdout를 stderr로 리디렉션하는 것이 일반적입니다.

{
  "exitCode" : 1,
  "output" : "Action failed with the following message:\nCould not find input
    file \"/path/to/my/file/1\"",
  "requestId" : 12
}

protobuf의 표준에 따라 모든 필드는 선택사항입니다. 하지만 Bazel은 WorkRequest 및 해당 WorkResponse에 동일한 요청 ID가 있어야 하므로 0이 아닌 경우 요청 ID를 지정해야 합니다. 유효한 WorkResponse입니다.

{
  "requestId" : 12,
}

request_id가 0이면 이 요청을 다른 요청과 동시에 처리할 수 없을 때 사용되는 'singleplex' 요청을 나타냅니다. 서버는 지정된 작업자가 request_id 0 또는 0보다 큰 request_id만 포함된 요청을 수신하도록 보장합니다. 단일 플렉스 요청은 순차적으로 전송됩니다. 예를 들어 서버가 응답을 받을 때까지 다른 요청을 보내지 않는 경우가 있습니다 (취소 요청 제외, 아래 참고).

참고

각 프로토콜 버퍼는 앞에 varint 형식으로 표시됩니다 (MessageLite.writeDelimitedTo() 참고).
JSON 요청 및 응답 앞에는 크기 표시기가 없습니다.
JSON 요청은 protobuf와 동일한 구조를 유지하지만 표준 JSON을 사용하고 모든 필드 이름에 카멜 표기법을 사용합니다.
protobuf와 이전 버전과의 호환성 속성을 동일하게 유지하려면 JSON 작업자가 이러한 메시지에서 알 수 없는 필드를 허용하고 누락된 값에 protobuf 기본값을 사용해야 합니다.
Bazel은 요청을 protobuf로 저장하고 protobuf의 JSON 형식을 사용하여 JSON으로 변환합니다.

취소

원하는 경우 작업자가 작업을 완료하기 전에 작업 요청이 취소되도록 허용할 수 있습니다. 이는 더 빠른 원격 실행으로 인해 로컬 실행이 주기적으로 중단될 수 있는 동적 실행과 특히 유용합니다. 취소를 허용하려면 supports-worker-cancellation: 1를 execution-requirements 필드에 추가하고 (아래 참고) --experimental_worker_cancellation 플래그를 설정합니다.

취소 요청은 cancel 필드가 설정된 WorkRequest이며, 취소 응답은 was_cancelled 필드가 설정된 WorkResponse입니다. 취소 요청 또는 취소 응답에 있어야 하는 유일한 필드는 취소하려는 요청을 나타내는 request_id입니다. request_id 필드는 싱글플렉스 작업자의 경우 0이고, 이전에 전송된 WorkRequest의 멀티플렉스 작업자의 경우 0이 아닌 request_id입니다. 서버는 작업자가 이미 응답한 요청에 대해 취소 요청을 보낼 수 있으며, 이 경우 취소 요청은 무시해야 합니다.

취소되지 않은 각 WorkRequest 메시지는 취소 여부와 관계없이 정확히 한 번만 응답해야 합니다. 서버가 취소 요청을 보내면 작업자는 request_id가 설정되고 was_cancelled 필드가 true로 설정된 WorkResponse로 응답할 수 있습니다. 일반 WorkResponse 전송도 허용되지만 output 및 exit_code 필드는 무시됩니다.

WorkRequest에 대한 응답이 전송되면 작업자는 작업 디렉터리의 파일을 터치해서는 안 됩니다. 임시 파일을 비롯한 파일을 자유롭게 정리할 수 있습니다.

작업자를 사용하는 규칙 만들기

또한 작업자가 수행할 작업을 생성하는 규칙을 만들어야 합니다. 작업자를 사용하는 Starlark 규칙을 만드는 것은 다른 규칙을 만드는 것과 같습니다.

또한 규칙은 작업자 자체에 대한 참조를 포함해야 하며 작업자가 생성하는 작업에 대한 몇 가지 요구사항이 있습니다.

작업자 참조

작업자를 사용하는 규칙에는 작업자 자체를 참조하는 필드가 포함되어야 하므로 \*\_binary 규칙의 인스턴스를 만들어 작업자를 정의해야 합니다. 작업자의 이름이 MyWorker.Java이면 연결된 규칙일 수 있습니다.

java_binary(
    name = "worker",
    srcs = ["MyWorker.Java"],
)

이렇게 하면 작업자 바이너리를 참조하는 'worker' 라벨이 생성됩니다. 그런 다음 작업자를 사용하는 규칙을 정의합니다. 이 규칙은 작업자 바이너리를 참조하는 속성을 정의해야 합니다.

빌드한 작업자 바이너리가 빌드의 최상위 수준에 있는 'work'라는 패키지에 있는 경우 속성 정의는 다음과 같습니다.

"worker": attr.label(
    default = Label("//work:worker"),
    executable = True,
    cfg = "exec",
)

cfg = "exec"는 작업자가 대상 플랫폼이 아닌 실행 플랫폼에서 실행되도록 빌드되어야 함을 나타냅니다 (즉, 빌드 중에 작업자가 도구로 사용됨).

작업 관련 작업 요구사항

작업자를 사용하는 규칙은 작업자가 실행할 작업을 만듭니다. 이러한 작업에는 몇 가지 요구사항이 있습니다.

"인수" 필드. 문자열 목록을 취하며, 마지막 목록은 제외하고 시작 시 작업자에 전달되는 인수입니다. '인수' 목록의 마지막 요소는 flag-file(@-preceded) 인수입니다. 작업자는 WorkRequest별로 지정된 플래그 파일에서 인수를 읽습니다. 규칙에서 작업자의 비 시작 인수를 이 플래그 파일에 작성할 수 있습니다.
"execution-requirements" 필드: "supports-workers" : "1", "supports-multiplex-workers" : "1" 또는 둘 다를 포함하는 사전을 가져옵니다.

'인수' 및 '실행 요구사항' 필드는 작업자로 전송되는 모든 작업에 필요합니다. 또한 JSON 작업자가 실행해야 하는 작업에는 실행 요구사항 필드에 "requires-worker-protocol" : "json"를 포함해야 합니다. "requires-worker-protocol" : "proto"도 유효한 실행 요구사항이지만 proto 작업자에는 필요하지 않지만 기본값이므로 proto 작업자에는 필요하지 않습니다.

실행 요구사항에서 worker-key-mnemonic를 설정할 수도 있습니다. 이는 실행 파일을 여러 작업 유형에 재사용하고 이 작업자의 작업을 구분하려는 경우에 유용할 수 있습니다.
작업 중에 생성된 임시 파일은 작업자의 디렉터리에 저장해야 합니다. 이렇게 하면 샌드박스가 사용 설정됩니다.

위에서 설명한 'worker' 속성이 있는 규칙 정의와 입력을 나타내는 'srcs' 속성, 출력을 나타내는 'output' 속성, 작업자 시작 인수를 나타내는 'args' 속성에 더해 ctx.actions.run 호출은 다음과 같을 수 있습니다.

ctx.actions.run(
  inputs=ctx.files.srcs,
  outputs=[ctx.outputs.output],
  executable=ctx.executable.worker,
  mnemonic="someMnemonic",
  execution_requirements={
    "supports-workers" : "1",
    "requires-worker-protocol" : "json"},
  arguments=ctx.attr.args + ["@flagfile"]
 )

다른 예는 영구 작업자 구현을 참조하세요.

예

Bazel 코드베이스는 통합 테스트에 사용되는 JSON 작업자 예시와 함께 자바 컴파일러 작업자를 사용합니다.

올바른 콜백을 전달하여 scaffolding을 사용하여 자바 기반 도구를 작업자로 만들 수 있습니다.

작업자를 사용하는 규칙의 예는 Bazel의 작업자 통합 테스트를 참고하세요.

외부 기여자는 작업자를 다양한 언어로 구현했습니다. Bazel 영구 작업자의 Polyglot 구현을 살펴보세요. GitHub에서 더 많은 예를 확인할 수 있습니다.