규칙 작성의 어려움

문제 신고 소스 보기

이 페이지에서는 효율적인 Bazel 규칙을 작성하는 구체적인 문제와 도전과제를 개략적으로 설명합니다.

요약 요구사항

  • 가정: 정확성, 처리량, 사용 편의성, 지연 시간 목표
  • 가정: 대규모 저장소
  • 가정: BUILD와 유사한 설명 언어
  • 기존: 로드, 분석, 실행 간의 하드 분리는 오래되었지만 API에 영향을 미칩니다.
  • 내장: 원격 실행과 캐싱이 어려움
  • Intrinsic: 올바르고 빠른 증분 빌드에 변경 정보를 사용하려면 비정상적인 코딩 패턴이 필요합니다.
  • 내장: 2차 시간 및 메모리 소비를 피하기가 어려움

가정

정확성, 사용 편의성, 처리량, 대규모 저장소 등 빌드 시스템에 관한 몇 가지 가정은 다음과 같습니다. 다음 섹션에서는 이러한 가정을 설명하고 규칙을 효과적으로 작성하기 위한 가이드라인을 제공합니다.

정확성, 처리량, 사용 편의성, 지연 시간 목표

증분 빌드와 관련하여 빌드 시스템이 가장 정확해야 한다고 가정합니다. 특정 소스 트리의 경우 동일한 빌드의 출력은 출력 트리의 모양과 관계없이 항상 동일해야 합니다. 첫 번째 근사값에서 이는 Bazel이 특정 빌드 단계에 들어가는 모든 입력 하나하나를 알아야 한다는 것을 의미합니다. 그래야 입력이 변경되면 Bazel이 해당 단계를 다시 실행할 수 있기 때문입니다. Bazel이 빌드 날짜 / 시간과 같은 일부 정보를 유출하고 파일 속성 변경과 같은 특정 유형의 변경을 무시하기 때문에 Bazel의 정확성에는 제한이 있습니다. 샌드박스는 선언되지 않은 입력 파일에 대한 읽기를 방지하여 정확성을 보장하는 데 도움이 됩니다. 시스템의 근본적인 제한 외에도 몇 가지 알려진 정확성 문제가 있습니다. 대부분은 파일 세트 또는 C++ 규칙과 관련이 있으며 둘 다 어려운 문제입니다. Google은 이 문제를 해결하기 위해 장기적인 노력을 기울이고 있습니다.

빌드 시스템의 두 번째 목표는 높은 처리량을 확보하는 것입니다. Google은 원격 실행 서비스에 대해 현재 머신 할당 내에서 할 수 있는 작업 범위를 영구적으로 넓히고 있습니다. 원격 실행 서비스에 과부하가 발생하면 아무도 작업을 완료할 수 없습니다.

사용 편의성은 그 다음입니다 원격 실행 서비스와 동일하거나 유사한 공간을 갖는 여러 가지 접근 방식 중에서 사용하기 쉬운 접근 방식을 선택합니다.

지연 시간은 빌드를 시작한 후 의도한 결과를 얻기까지 걸리는 시간을 나타냅니다. 즉, 통과 또는 실패 테스트의 테스트 로그이거나 BUILD 파일에 오타가 있다는 오류 메시지가 표시됩니다.

이러한 목표는 겹치는 경우가 많습니다. 지연 시간은 사용 편의성과 관련된 정확성만큼이나 원격 실행 서비스의 처리량에 따라 달라집니다.

대규모 저장소

빌드 시스템은 대규모 저장소 규모에서 작동해야 하는데, 규모가 크다는 것은 단일 하드 드라이브에 적합하지 않으므로, 거의 모든 개발자 시스템에서 전체 결제를 할 수 없다는 의미입니다. 중간 크기의 빌드는 수만 개의 BUILD 파일을 읽고 파싱하고 수십만 개의 glob을 평가해야 합니다. 이론적으로는 단일 머신에서 모든 BUILD 파일을 읽을 수 있지만 상당한 시간과 메모리 내에 아직 그렇게 할 수 없었습니다. 따라서 BUILD 파일을 독립적으로 로드하고 파싱할 수 있어야 합니다.

BUILD와 유사한 설명 언어

이 컨텍스트에서는 라이브러리 및 바이너리 규칙 및 상호 종속 항목을 선언할 때 대략 BUILD 파일과 유사한 구성 언어를 가정합니다. BUILD 파일은 독립적으로 읽고 파싱할 수 있으며, 가능할 때마다 소스 파일을 보지 않습니다 (존재하는 경우 제외).

유적지

문제를 야기하는 Bazel 버전 간에는 차이점이 있으며, 그 중 일부는 다음 섹션에 설명되어 있습니다.

로드, 분석, 실행 간의 엄격한 분리는 오래되었지만 API에 영향을 미칩니다.

기술적으로는 작업이 원격 실행으로 전송되기 직전에 작업의 입력 및 출력 파일을 아는 것만으로 충분합니다. 그러나 원래 Bazel 코드베이스는 패키지 로드, 구성 (기본적으로 명령줄 플래그를 사용하여 규칙 분석)을 사용한 규칙 분석, 모든 작업 실행만 엄격하게 분리되어 있었습니다. 이러한 구분은 Bazel의 핵심에서 더 이상 필요하지 않지만 오늘날 규칙 API의 일부입니다 (자세한 내용은 아래 참고).

즉, Rules API에는 규칙 인터페이스에 대한 선언적 설명 (포함된 속성, 속성 유형)이 필요합니다. API를 사용하면 로드 단계에서 커스텀 코드를 실행하여 출력 파일의 암시적 이름과 속성의 암시적 값을 계산할 수 있습니다. 예를 들어 'foo'라는 java_library 규칙은 암시적으로 'libfoo.jar'라는 출력을 생성하며, 이 출력은 빌드 그래프의 다른 규칙에서 참조할 수 있습니다.

또한 규칙 분석은 소스 파일을 읽거나 작업의 출력을 검사할 수 없습니다. 대신 규칙 자체와 종속 항목에서만 결정되는 빌드 단계와 출력 파일 이름의 부분 방향 이분 그래프를 생성해야 합니다.

내장 기능

내재된 속성 중에는 규칙 작성을 어렵게 만들기도 하며, 가장 일반적인 속성은 다음 섹션에서 설명합니다.

원격 실행 및 캐싱은 어렵습니다.

원격 실행 및 캐싱을 사용하면 대규모 저장소에서 빌드를 단일 머신에서 실행할 때보다 약 두 배 더 큰 빌드 시간이 단축됩니다. 하지만 실행에 필요한 규모는 엄청납니다. Google의 원격 실행 서비스는 초당 엄청난 수의 요청을 처리하도록 설계되었으며 프로토콜은 불필요한 왕복과 서비스 측의 불필요한 작업을 신중하게 방지합니다.

이 시점에서 프로토콜은 특정 작업에 대한 모든 입력을 미리 알고 있어야 한다고 규정합니다. 그러면 빌드 시스템이 고유한 작업 지문을 계산하고 스케줄러에 캐시 적중을 요청합니다. 캐시 적중이 발견되면 스케줄러는 출력 파일의 다이제스트로 응답합니다. 파일 자체는 나중에 다이제스트에 의해 처리됩니다. 그러나 이로 인해 모든 입력 파일을 미리 선언해야 하는 Bazel 규칙에 제한이 적용됩니다.

올바르고 빠른 증분 빌드에 변경 정보를 사용하려면 비정상적인 코딩 패턴이 필요함

위에서는 정확성을 위해 Bazel이 빌드 단계가 여전히 최신 상태인지 감지하기 위해 빌드 단계에 들어가는 모든 입력 파일을 알아야 한다고 주장했습니다. 패키지 로드 및 규칙 분석도 마찬가지입니다. Google은 일반적으로 이를 처리하도록 Skyframe을 설계했습니다. Skyframe은 그래프 라이브러리 및 평가 프레임워크로, 목표 노드 (예: '이러한 옵션을 사용하여 //foo 빌드')를 구성 부분으로 분할한 다음 평가 및 결합하여 이 결과를 산출합니다. 이 프로세스의 일부로 Skyframe이 패키지를 읽고 규칙을 분석하고 작업을 실행합니다.

Skyframe은 목표 노드에서 입력 파일 (Skyframe 노드)에 이르기까지 각 노드에서 특정 노드가 자체 출력을 계산하는 데 사용된 노드를 정확하게 추적합니다. 이 그래프를 메모리에 명시적으로 표현하면 빌드 시스템에서 입력 파일의 특정 변경사항 (입력 파일 생성 또는 삭제 포함)에 영향을 받는 노드를 정확히 식별하여 출력 트리를 의도한 상태로 복원하는 최소한의 작업만 수행할 수 있습니다.

이 과정에서 각 노드는 종속 항목 검색 프로세스를 실행합니다. 각 노드는 종속 항목을 선언하고 이러한 종속 항목의 콘텐츠를 사용하여 추가 종속 항목을 선언할 수 있습니다. 원칙적으로 이는 노드당 스레드 모델에 잘 매핑됩니다. 그러나 중간 규모의 빌드에는 수십만 개의 Skyframe 노드가 포함되어 있으며 이는 최신 자바 기술로는 쉽게 불가능하며, 역사적 이유로 Google은 현재 자바를 사용해야 하므로 가벼운 스레드 및 연속성이 없습니다.

대신 Bazel은 고정 크기 스레드 풀을 사용합니다. 하지만 즉, 노드가 아직 사용할 수 없는 종속 항목을 선언하는 경우, 종속 항목을 사용할 수 있을 때 평가를 취소하고 다른 스레드에서 다시 시작해야 할 수도 있습니다. 따라서 노드는 이 작업을 과도하게 실행해서는 안 됩니다. N개의 종속 항목을 순차적으로 선언하는 노드는 N번 다시 시작되어 O(N^2) 시간이 걸릴 수 있습니다. 대신 종속 항목을 미리 일괄 선언하는 것을 목표로 합니다. 이 경우 코드를 재구성하거나 노드를 여러 노드로 분할하여 재시작 횟수를 제한해야 합니다.

이 기술은 현재 규칙 API에서 사용할 수 없습니다. 대신 규칙 API는 여전히 로드, 분석, 실행 단계의 기존 개념을 사용하여 정의됩니다. 하지만 다른 노드에 대한 모든 액세스는 프레임워크를 통과해야 상응하는 종속 항목을 추적할 수 있습니다. 빌드 시스템이 구현되는 언어와 규칙이 작성되는 언어에 관계없이 (동일하지 않아도 됨) 규칙 작성자는 Skyframe을 우회하는 표준 라이브러리나 패턴을 사용해서는 안 됩니다. 즉, Java의 경우 java.io.File 및 모든 형태의 리플렉션, 그리고 둘을 수행하는 모든 라이브러리를 피해야 합니다. 이러한 하위 수준 인터페이스의 종속 항목 삽입을 지원하는 라이브러리도 Skyframe에 맞게 올바르게 설정해야 합니다.

따라서 애초에 규칙 작성자를 전체 언어 런타임에 노출하지 않는 것이 좋습니다. 이러한 API를 실수로 사용할 경우의 위험성은 너무 큽니다. Bazel팀이나 다른 도메인 전문가가 규칙을 작성했음에도 이전에 Bazel 버그는 안전하지 않은 API를 사용하는 규칙으로 인해 발생했습니다.

2차 시간과 메모리 소비를 피하기가 어렵습니다.

더 심각한 문제는 Skyframe이 요구하는 요구사항, 자바 사용에 따른 과거의 제약, 규칙 API의 오래된 정도를 제외하면 라이브러리 및 바이너리 규칙을 기반으로 하는 빌드 시스템에서 실수로 이차적인 시간이나 메모리 소비를 도입하는 것은 근본적인 문제입니다. 2차 메모리 소비 (즉, 2차 시간 소비)를 유발하는 매우 일반적인 두 가지 패턴이 있습니다.

  1. 라이브러리 규칙 체인 - A는 B에 종속되고 C에 종속되는 식으로 라이브러리 규칙 체인이 있는 경우를 생각해 보세요. 그런 다음 이러한 규칙의 전이 닫힘에 대한 일부 속성(예: 자바 런타임 클래스 경로 또는 각 라이브러리의 C++ 링커 명령어)을 계산하려고 합니다. 단순하게 표준 목록 구현을 사용할 수 있습니다. 하지만 이미 이차 메모리 소비가 발생합니다. 첫 번째 라이브러리에는 클래스 경로에 항목 1개, 두 번째 항목, 세 번째 항목 3개가 포함되며 총 1+2+3+...+N = O(N^2)개의 항목이 포함됩니다.

  2. 동일한 라이브러리 규칙에 따른 바이너리 규칙 - 동일한 라이브러리 규칙에 종속되는 바이너리 집합이 있는 경우를 고려하세요(예: 같은 라이브러리 코드를 테스트하는 테스트 규칙이 여러 개 있는 경우). N개의 규칙 중 절반은 바이너리 규칙, 나머지 절반은 라이브러리 규칙이라고 가정해 보겠습니다. 이제 각 바이너리가 자바 런타임 클래스 경로 또는 C++ 링커 명령줄과 같은 라이브러리 규칙의 전이적 클로저를 통해 계산된 일부 속성의 사본을 만든다고 가정해 보겠습니다. 예를 들어 C++ 링크 작업의 명령줄 문자열 표현을 확장할 수 있습니다. N/2 요소의 N/2 사본은 O(N^2) 메모리입니다.

2차 복잡성 방지를 위한 맞춤 컬렉션 클래스

Bazel은 이 두 시나리오의 영향을 많이 받기 때문에 각 단계에서 복사를 피하여 메모리의 정보를 효과적으로 압축하는 일련의 맞춤 컬렉션 클래스를 도입했습니다. 이러한 데이터 구조 중 거의 모두 시맨틱이 설정되어 있으므로 이를 depset(내부 구현에서는 NestedSet라고도 함)이라고 했습니다. 지난 몇 년 동안 Bazel의 메모리 소비를 줄이기 위한 대부분의 변경사항은 이전에 사용된 것이 아닌 depset을 사용하도록 변경된 것이었습니다.

안타깝게도 depset을 사용한다고 해서 모든 문제가 자동으로 해결되지는 않습니다. 특히 각 규칙에서 depset을 반복하는 것만으로도 2차 시간 소모가 다시 발생합니다. 내부적으로 NestedSets에는 일반 컬렉션 클래스와의 상호 운용성을 위한 도우미 메서드도 있습니다. 안타깝게도 실수로 이러한 메서드 중 하나에 NestedSet를 전달하면 복사 동작이 발생하고 2차 메모리 소비가 다시 발생합니다.