이 페이지에서는 효율적인 Bazel 규칙을 작성하는 데 따르는 구체적인 문제와 도전과제를 개략적으로 설명합니다.
요약 요구사항
- 가정: 정확성, 처리량, 사용 편의성, 지연 시간 목표
- 가정: 대규모 저장소
- 가정: BUILD와 유사한 설명 언어
- 기록: 로드, 분석, 실행 간의 명확한 구분이 오래되었지만 API에 여전히 영향을 미칩니다.
- 내장 기능: 원격 실행 및 캐싱이 어려움
- 내장: 정확하고 빠른 증분 빌드를 위해 변경 정보를 사용하려면 비정상적인 코딩 패턴이 필요함
- 내장 기능: 이차 시간 및 메모리 소비를 피하기 어려움
가정
다음은 정확성, 사용 편의성, 처리량, 대규모 저장소 등 빌드 시스템에 관한 몇 가지 가정입니다. 다음 섹션에서는 이러한 가정을 다루고 규칙을 효과적으로 작성하기 위한 가이드라인을 제공합니다.
정확성, 처리량, 사용 편의성, 지연 시간 목표
Google에서는 빌드 시스템이 증분 빌드에 관해 가장 우선하면서 가장 정확해야 한다고 가정합니다. 주어진 소스 트리의 경우 동일한 빌드의 출력은 출력 트리 형태와 관계없이 항상 동일해야 합니다. 첫 번째 근사치에서 이는 Bazel이 특정 빌드 단계로 이동하는 모든 입력을 알아야 하므로 입력이 변경되면 해당 단계를 다시 실행할 수 있습니다. Bazel이 빌드의 날짜 / 시간과 같은 일부 정보를 유출하고 파일 속성 변경과 같은 특정 유형의 변경사항을 무시하므로 올바른 Bazel을 얻을 수 있는 방법에 제한이 있습니다. 샌드박스는 선언되지 않은 입력 파일에 대한 읽기를 방지하여 정확성을 보장합니다. 시스템의 본질적인 제한 외에도 몇 가지 알려진 정확성 문제가 있으며, 대부분은 어려운 문제인 파일 세트 또는 C++ 규칙과 관련이 있습니다. Google에서는 이 문제를 해결하기 위해 장기적인 노력을 기울이고 있습니다.
빌드 시스템의 두 번째 목표는 높은 처리량입니다. Google은 원격 실행 서비스의 현재 머신 할당 내에서 할 수 있는 작업의 범위를 영구적으로 확대하고 있습니다. 원격 실행 서비스에 과부하가 걸리면 아무도 작업을 수행할 수 없습니다.
사용 편의성은 그 다음입니다. 원격 실행 서비스와 동일하거나 유사한 공간을 갖는 여러 올바른 접근 방식 중에서 사용하기 쉬운 접근 방식을 선택합니다.
지연 시간은 빌드 시작에서 의도한 결과를 얻는 데 걸리는 시간으로, 통과 또는 실패한 테스트의 테스트 로그든 BUILD 파일에 오타가 있는 오류 메시지든 마찬가지입니다.
이러한 목표는 종종 중복됩니다. 지연 시간은 사용 편의성과 관련된 정확성만큼이나 원격 실행 서비스 처리량의 함수입니다.
대규모 저장소
빌드 시스템은 단일 하드 드라이브에 맞지 않는 대규모 저장소의 규모에서 작동해야 하므로 거의 모든 개발자 컴퓨터에서 전체 체크아웃을 실행할 수 없습니다. 중간 크기의 빌드는 BUILD 파일을 수만 개 읽고 파싱해야 하며 수십만 개의 glob을 평가해야 합니다. 단일 머신에서 모든 BUILD 파일을 읽는 것이 이론적으로는 가능하지만 적절한 시간과 메모리 내에서는 아직 읽을 수 없습니다. 따라서 BUILD 파일을 독립적으로 로드하고 파싱할 수 있어야 합니다.
BUILD와 유사한 설명 언어
여기서는 라이브러리 규칙 및 바이너리 규칙 선언과 그 상호 종속 항목의 BUILD 파일과 대체로 유사한 구성 언어를 가정합니다. BUILD 파일은 독립적으로 읽고 파싱할 수 있으며, 존재할 경우를 제외하고는 소스 파일을 볼 수 있을 때마다 소스 파일을 보지 않습니다.
유적지
문제를 일으키는 Bazel 버전 간에는 차이점이 있으며 이 중 일부를 다음 섹션에서 설명합니다.
로드, 분석, 실행을 엄격하게 분리하는 것은 오래되었지만 API에 여전히 영향을 미칩니다.
기술적으로는 작업을 원격으로 실행하기 직전에 작업의 입력 및 출력 파일을 규칙으로 확인하는 것으로 충분합니다. 하지만 원래 Bazel 코드베이스는 패키지를 로드하고 구성을 사용하여 규칙을 분석 (기본적으로 명령줄 플래그)한 후 모든 작업을 실행하는 것을 엄격하게 분리했습니다. Bazel의 핵심 기능에서는 더 이상 이 구분이 필요하지 않지만 이러한 구분은 오늘날에도 규칙 API의 일부입니다. 자세한 내용은 아래를 참조하세요.
즉, 규칙 API에는 규칙 인터페이스에 대한 선언적 설명 (어떤 속성, 속성 유형)이 필요합니다. API가 로드 단계에서 출력 파일의 암시적 이름과 속성 값을 계산하기 위해 커스텀 코드를 실행하도록 허용하는 몇 가지 예외가 있습니다. 예를 들어 'foo'라는 java_library 규칙은 빌드 그래프의 다른 규칙에서 참조할 수 있는 'libfoo.jar'라는 출력을 암시적으로 생성합니다.
또한 규칙 분석은 소스 파일을 읽거나 작업의 출력을 검사할 수 없습니다. 대신 규칙 자체와 종속 항목에 의해서만 결정되는 빌드 단계와 출력 파일 이름의 부분 방향 두 파트 그래프를 생성해야 합니다.
내적
규칙 작성을 어렵게 만드는 몇 가지 고유한 속성이 있으며 다음 섹션에서는 가장 일반적인 몇 가지 속성을 설명합니다.
원격 실행 및 캐싱은 어려움
원격 실행 및 캐싱을 사용하면 단일 머신에서 빌드를 실행하는 경우에 비해 대규모 저장소의 빌드 시간이 대략 두 자릿수 향상됩니다. 하지만 수행해야 하는 작업은 엄청납니다. Google의 원격 실행 서비스는 초당 많은 수의 요청을 처리하도록 설계되었으며 이 프로토콜은 불필요한 왕복과 서비스 측의 불필요한 작업을 신중하게 방지합니다.
이 시점에서 이 프로토콜은 빌드 시스템이 지정된 작업의 모든 입력을 미리 알고 있어야 합니다. 그러면 빌드 시스템이 고유한 작업 지문을 계산하고 스케줄러에 캐시 적중을 요청합니다. 캐시 적중이 발견되면 스케줄러는 출력 파일의 다이제스트와 함께 응답합니다. 파일 자체는 나중에 다이제스트에 의해 처리됩니다. 하지만 이렇게 하면 Bazel 규칙에 제한이 적용되며, 이에 따라 모든 입력 파일을 미리 선언해야 합니다.
정확하고 빠른 증분 빌드를 위해 변경 정보를 사용하려면 비정상적인 코딩 패턴이 필요함
위에서는 Bazel이 빌드 단계가 여전히 최신 상태인지 감지하기 위해 빌드 단계로 들어가는 모든 입력 파일을 알아야 한다고 주장했습니다. 패키지 로드 및 규칙 분석도 마찬가지입니다. Google에서는 이를 일반적으로 처리하도록 Skyframe을 설계했습니다. Skyframe은 목표 노드 (예: 'build //foo with these options')를 취해 구성요소로 분할한 다음 평가 및 결합하여 이 결과를 생성하는 그래프 라이브러리 및 평가 프레임워크입니다. 이 과정에서 Skyframe은 패키지를 읽고 규칙을 분석하며 작업을 실행합니다.
Skyframe은 각 노드에서 특정 노드가 자체 출력을 계산하는 데 사용된 노드를 정확히 추적하여 목표 노드에서 입력 파일 (Skyframe 노드)에 이르기까지의 모든 과정을 추적합니다. 이 그래프를 메모리에 명시적으로 표현하면 빌드 시스템에서 입력 파일의 변경 (입력 파일 생성 또는 삭제 포함)에 의해 영향을 받는 노드를 정확히 식별할 수 있으며, 출력 트리를 의도한 상태로 복원하기 위한 최소한의 작업만 수행할 수 있습니다.
이 과정에서 각 노드는 종속 항목 검색 프로세스를 수행합니다. 각 노드는 종속 항목을 선언한 후 해당 종속 항목의 콘텐츠를 사용하여 추가 종속 항목을 선언할 수 있습니다. 원칙적으로 이는 노드당 스레드 모델에 잘 매핑됩니다. 그러나 중간 크기의 빌드에는 수십만 개의 Skyframe 노드가 포함되어 있습니다. 이는 현재 Java 기술로는 쉽지 않습니다. 과거의 이유로 현재 Java를 사용해야 하므로 경량 스레드와 연속성이 없습니다.
대신 Bazel은 고정 크기 스레드 풀을 사용합니다. 그러나 즉, 노드가 아직 사용할 수 없는 종속 항목을 선언하는 경우 종속 항목을 사용할 수 있을 때 평가를 취소하고 다른 스레드에서 다시 시작해야 할 수 있습니다. 따라서 노드는 이 작업을 과도하게 실행해서는 안 됩니다. 종속 항목을 순차적으로 선언하는 노드는 잠재적으로 N번 다시 시작할 수 있으므로 O(N^2) 시간이 소요됩니다. 대신 Google은 종속 항목의 사전 일괄 선언을 목표로 하며, 이를 위해서는 코드를 재구성하거나 노드를 여러 노드로 분할하여 재시작 횟수를 제한해야 할 수도 있습니다.
이 기술은 현재 Rules API에서 사용할 수 없습니다. 대신 Rules API는 여전히 로드, 분석, 실행 단계의 기존 개념을 사용하여 정의됩니다. 그러나 기본적인 제한사항은 다른 노드에 대한 모든 액세스가 해당 종속 항목을 추적할 수 있도록 프레임워크를 통과해야 한다는 것입니다. 빌드 시스템이 구현되는 언어나 규칙이 작성되는 언어와 상관없이 규칙 작성자는 Skyframe을 우회하는 표준 라이브러리나 패턴을 사용해서는 안 됩니다. Java의 경우 이는 java.io.File뿐만 아니라 모든 형태의 리플렉션과 이러한 리플렉션을 피하는 모든 라이브러리를 피하는 것을 의미합니다. 이러한 하위 수준 인터페이스의 종속 항목 삽입을 지원하는 라이브러리는 여전히 스카이프레임에 맞게 올바르게 설정되어야 합니다.
따라서 처음부터 규칙 작성자가 전체 언어 런타임에 노출되지 않도록 하는 것이 좋습니다. 이러한 API를 실수로 사용할 때의 위험은 너무 큽니다. 과거에 Bazel팀 또는 다른 도메인 전문가가 규칙을 작성했음에도 불구하고 안전하지 않은 API를 사용하는 규칙으로 인해 여러 Bazel 버그가 발생했습니다.
이차 시간 및 메모리 소비를 피하기는 어렵습니다.
설상가상으로, Skyframe에서 부과하는 요구사항, Java 사용에 대한 과거의 제약, 규칙 API의 구식을 제외하면 우연히 이차 시간 또는 메모리 소비가 라이브러리 및 바이너리 규칙을 기반으로 하는 빌드 시스템에서 근본적인 문제가 됩니다. 이차 메모리 소비 (및 이차 시간 소모)를 초래하는 매우 일반적인 패턴은 두 가지입니다.
라이브러리 규칙 체인 - 라이브러리 규칙 A가 B에 종속되고 C에 종속되는 식 등을 생각해 보겠습니다. 그런 다음 Java 런타임 클래스 경로 또는 각 라이브러리의 C++ 링커 명령어와 같은 규칙의 전이적 종료를 통해 일부 속성을 계산하려고 합니다. 단순히 표준 목록 구현을 사용할 수도 있지만, 이 경우 이미 이차 메모리 소비가 발생합니다. 첫 번째 라이브러리는 클래스 경로에 항목 하나를 포함하고, 두 번째는 두 번째, 세 번째는 3개 등으로 총 1+2+3+...+N = O(N^2) 항목을 포함합니다.
동일한 라이브러리 규칙에 따른 바이너리 규칙 - 동일한 라이브러리 규칙에 종속되는 바이너리 집합이 있는 경우를 생각해 보세요. 예를 들어 동일한 라이브러리 코드를 테스트하는 여러 테스트 규칙이 있는 경우가 있습니다. N개의 규칙 중 절반은 바이너리 규칙이고 나머지 절반은 라이브러리 규칙이라고 가정해 보겠습니다. 이제 각 바이너리가 Java 런타임 클래스 경로 또는 C++ 링커 명령줄과 같은 라이브러리 규칙의 전이적 클로저를 통해 계산된 일부 속성의 사본을 만든다고 가정해 보겠습니다. 예를 들어 C++ 링크 작업의 명령줄 문자열 표현을 확장할 수 있습니다. N/2 요소의 N/2 사본은 O(N^2) 메모리입니다.
이차 복잡성을 방지하는 맞춤 컬렉션 클래스
Bazel은 이 두 시나리오 모두의 영향을 많이 받습니다. 따라서 Google은 각 단계에서 복사를 방지하여 메모리의 정보를 효과적으로 압축하는 일련의 맞춤 컬렉션 클래스를 도입했습니다. 이러한 데이터 구조 대부분이 시맨틱스를 설정했으므로 Google에서는 이를 depset(내부 구현에서는 NestedSet라고도 함)이라고 했습니다. 지난 몇 년간 Bazel의 메모리 소비를 줄이기 위한 대부분의 변경사항은 이전에 사용된 것이 아닌 depset을 사용하도록 변경한 것입니다.
안타깝게도 depset을 사용하면 모든 문제가 자동으로 해결되지는 않습니다. 특히 각 규칙에서 depset을 반복하더라도 이차 시간 소비가 다시 발생합니다. 내부적으로 NestedSets에는 일반 컬렉션 클래스와의 상호 운용성을 용이하게 하는 도우미 메서드도 있습니다. 불행히도 실수로 이러한 메서드 중 하나에 NestedSet를 전달하면 동작이 복사되고 이차 메모리 소비가 다시 발생합니다.