규칙 작성의 어려움

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

요약 요구사항

• 가정: 정확성, 처리량, 사용 편의성, 지연 시간 목표
• 가정: 대규모 저장소
• 가정: BUILD와 유사한 설명 언어
• 기존: 로드, 분석, 실행 간의 엄격한 분리는 오래되었지만 여전히 API에 영향을 미침
• 내적: 원격 실행 및 캐싱은 어려움
• 내적: 정확하고 빠른 증분 빌드를 위해 변경 정보 사용에는 비정상적인 코딩 패턴이 필요함
• 내적: 이차 시간 및 메모리 소비 방지는 어려움

가정

정확성, 사용 편의성, 처리량, 대규모 저장소의 필요성과 같이 빌드 시스템에 관해 몇 가지 가정이 있습니다. 다음 섹션에서는 이러한 가정을 다루고 규칙이 효과적인 방식으로 작성되도록 가이드라인을 제공합니다.

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

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

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

사용 편의성이 그 다음입니다. 원격 실행 서비스의 동일한 (또는 유사한) 공간을 사용하는 여러 가지 올바른 접근 방식 중에서 사용하기 더 쉬운 접근 방식을 선택합니다.

지연 시간은 빌드를 시작하는 데 걸리는 시간부터 통과 또는 실패 테스트의 테스트 로그 또는 BUILD 파일에 오타가 있다는 오류 메시지와 같은 원하는 결과를 얻는 데 걸리는 시간을 나타냅니다.

이러한 목표는 종종 겹칩니다. 지연 시간은 사용 편의성과 관련된 정확성만큼 원격 실행 서비스의 처리량 의 함수입니다.

대규모 저장소

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

BUILD와 유사한 설명 언어

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

기존

Bazel 버전 간에는 문제를 일으키는 차이점이 있으며 이러한 차이점 중 일부 는 다음 섹션에 설명되어 있습니다.

로드, 분석, 실행 간의 엄격한 분리는 오래되었지만 여전히 API에 영향을 미침

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

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

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

내적

규칙 작성을 어렵게 만드는 몇 가지 내적 속성이 있으며 가장 일반적인 속성 중 일부는 다음 섹션에 설명되어 있습니다.

원격 실행 및 캐싱은 어려움

원격 실행 및 캐싱은 단일 머신에서 빌드를 실행하는 것과 비교하여 대규모 저장소의 빌드 시간을 대략 2배 정도 개선합니다. 그러나 수행해야 하는 규모는 엄청납니다. Google's 원격 실행 서비스는 초당 엄청난 수의 요청을 처리하도록 설계되었으며 프로토콜은 불필요한 왕복과 서비스 측의 불필요한 작업을 신중하게 방지합니다.

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

정확하고 빠른 증분 빌드를 위해 변경 정보 사용에는 비정상적인 코딩 패턴이 필요함

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

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

이 과정에서 각 노드는 종속 항목 검색 프로세스를 실행합니다. 각 노드는 종속 항목을 선언한 다음 이러한 종속 항목의 콘텐츠를 사용하여 더 많은 종속 항목을 선언할 수 있습니다. 원칙적으로 이는 a 노드당 스레드 모델에 잘 매핑됩니다. 그러나 중간 크기의 빌드에는 수십만 개의 Skyframe 노드가 포함되어 있으며 이는 현재 Java 기술로는 쉽게 불가능합니다 (그리고 과거의 이유로 인해 현재 Java 사용에 묶여 있으므로 경량 스레드와 연속이 없음).

대신 Bazel은 고정 크기 스레드 풀을 사용합니다. 그러나 이는 노드가 아직 사용할 수 없는 종속 항목을 선언하는 경우 종속 항목을 사용할 수 있을 때 해당 평가를 중단하고 다시 시작해야 할 수 있음을 의미합니다 (다른 스레드에서 가능). 이는 노드가 이를 과도하게 수행해서는 안 된다는 것을 의미합니다. a N개의 종속 항목을 순차적으로 선언하는 노드는 잠재적으로 N번 다시 시작될 수 있으며 O(N^2) 시간이 소요됩니다. 대신 종속 항목의 일괄 선언을 목표로 합니다. 이렇게 하려면 코드를 재구성하거나 다시 시작 횟수를 제한하기 위해 노드를 여러 노드로 분할해야 하는 경우도 있습니다.

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

이는 규칙 작성자가 처음부터 전체 언어 런타임 에 노출되지 않도록 하는 것이 좋습니다. 이러한 API를 실수로 사용할 위험은 너무 큽니다. 과거에 여러 Bazel 버그는 Bazel팀 또는 다른 도메인 전문가가 규칙을 작성했음에도 불구하고 안전하지 않은 API를 사용하는 규칙으로 인해 발생했습니다.

이차 시간 및 메모리 소비 방지는 어려움

설상가상으로 Skyframe에서 부과하는 요구사항, Java 사용의 기존 제약조건, 규칙 API의 오래됨 외에도 이차 시간 또는 메모리 소비를 실수로 도입하는 것은 라이브러리 및 바이너리 규칙을 기반으로 하는 모든 빌드 시스템의 근본적인 문제입니다. 이차 메모리 소비 (따라서 이차 시간 소비)를 도입하는 두 가지 매우 일반적인 패턴이 있습니다.

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

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

이차 복잡성을 방지하는 커스텀 컬렉션 클래스

Bazel은 이러한 두 시나리오 모두에 큰 영향을 받으므로 각 단계에서 복사를 방지하여 메모리의 정보를 효과적으로 압축하는 커스텀 컬렉션 클래스 집합을 도입했습니다. 이러한 데이터 구조는 거의 모두 집합 의미론을 가지고 있으므로 depset 이라고 했습니다(내부 구현에서 NestedSet이라고도 함). 지난 몇 년 동안 Bazel의 메모리 소비를 줄이기 위한 대부분의 변경사항은 이전에 사용된 항목 대신 depset을 사용하도록 변경한 것입니다.

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