Make Variables

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

"Make" 변수는 "Make 변수" 대체 대상으로 표시된 속성에 사용할 수 있는 확장 가능한 문자 변수의 특수한 클래스입니다.

예를 들어 이러한 변수를 사용하여 특정 도구 모음 경로를 사용자가 구성한 빌드 작업에 삽입할 수 있습니다.

Bazel은 모든 타겟에서 사용할 수 있는 사전 정의된 변수와 종속 항목 타겟 에 정의되어 있으며 종속 항목 타겟에 종속된 타겟에서만 사용할 수 있는 맞춤 변수를 모두 제공합니다.

'Make'라는 용어가 사용된 이유는 역사적입니다. 이러한 변수의 구문과 의미는 원래 GNU Make와 일치하도록 설계되었습니다.

사용

_'Make 변수' 대체 대상_으로 표시된 속성은 다음과 같이 'Make' 변수 FOO를 참조할 수 있습니다.

my_attr = "prefix $(FOO) suffix"

즉, $(FOO)와 일치하는 모든 하위 문자열이 FOO's 값으로 확장됩니다. 값이 "bar"이면 최종 문자열은 다음과 같이 됩니다.

my_attr = "prefix bar suffix"

FOO가 사용하는 타겟에 알려진 변수에 상응하지 않으면 Bazel이 오류와 함께 실패합니다.

이름이 @와 같은 문자가 아닌 기호인 "Make" 변수는 괄호 없이 달러 기호만 사용하여 참조할 수도 있습니다. 예를 들면 다음과 같습니다.

my_attr = "prefix $@ suffix"

$를 문자열 리터럴로 작성하려면 (즉, 변수 확장을 방지하려면) $$를 작성합니다.

사전 정의된 변수

사전 정의된 "Make" 변수는 모든 타겟에서 "Make 변수" 대체 대상" 으로 표시된 모든 속성에서 참조할 수 있습니다.

특정 빌드 옵션 집합에 대한 이러한 변수 및 값의 목록을 보려면 다음을 실행합니다.

bazel info --show_make_env [build options]

대문자가 포함된 상단 출력 줄을 확인합니다.

사전 정의된 변수의 예를 참고하세요.

도구 모음 옵션 변수

경로 변수

  • BINDIR: 타겟 아키텍처의 생성된 바이너리 트리의 기본입니다.

    교차 컴파일을 지원하기 위해 호스트 아키텍처에서 빌드 중에 실행되는 프로그램에 다른 트리가 사용될 수 있습니다.

    genrule 내에서 도구를 실행하려면 경로를 가져오는 권장 방법은 $(execpath toolname)입니다. 여기서 toolname은 genrule's tools 속성에 나열되어야 합니다.

  • GENDIR: 타겟 아키텍처의 생성된 코드 트리의 기본입니다.

머신 아키텍처 변수

  • TARGET_CPU: 타겟 아키텍처의 CPU(예: k8).

사전 정의된 genrule 변수

다음은 genrule's cmd 속성에 특별히 사용할 수 있으며 일반적으로 이 속성이 작동하도록 하는 데 중요합니다.

사전 정의된 genrule 변수의 예를 참고하세요.

  • OUTS: genrule의 outs 목록입니다. 출력 파일이 하나만 있는 경우 $@를 사용할 수도 있습니다.
  • SRCS: genrule의 srcs 목록입니다. 더 정확히 말하면 srcs 목록에 있는 라벨에 상응하는 파일의 경로 이름입니다. 소스 파일이 하나만 있는 경우 $<를 사용할 수도 있습니다.
  • <: 단일 파일인 경우 SRCS입니다. 그렇지 않으면 빌드 오류가 트리거됩니다.
  • @: 단일 파일인 경우 OUTS입니다. 그렇지 않으면 빌드 오류가 트리거됩니다.

  • RULEDIR: 타겟의 출력 디렉터리입니다. 즉, genfiles 또는 bin 트리 아래에 있는 타겟이 포함된 패키지의 이름에 상응하는 디렉터리입니다. //my/pkg:my_genrule의 출력이 하위 디렉터리에 있더라도 //my/pkg:my_genrule의 경우 항상 my/pkg로 끝납니다.

  • @D: 출력 디렉터리입니다. outs에 항목이 하나 있으면 이 항목은 해당 파일이 포함된 디렉터리로 확장됩니다. 항목이 여러 개 있으면 genfiles 트리의 패키지 루트 디렉터리로 확장됩니다. 모든 출력 파일이 동일한 하위 디렉터리에 있더라도!

    참고: RULEDIR은 출력 파일 수와 관계없이 동일한 방식으로 동작하고 의미가 더 간단하므로 @D 대신 RULEDIR을 사용하세요.

    genrule에서 임시 중간 파일을 생성해야 하는 경우 (예: 컴파일러와 같은 다른 도구를 사용한 결과) @D에 작성하고 (/tmp도 쓸 수 있지만) 완료하기 전에 삭제해야 합니다.

    특히 입력이 포함된 디렉터리에 쓰지 마세요. 읽기 전용 파일 시스템에 있을 수 있습니다. 그렇지 않더라도 이렇게 하면 소스 트리가 손상됩니다.

사전 정의된 소스/출력 경로 변수

사전 정의된 변수 execpath, execpaths, rootpath, rootpaths, location, 및 locations는 라벨 매개변수 (예: $(execpath //foo:bar))를 사용하고 해당 라벨로 표시된 파일 경로를 대체합니다.

소스 파일의 경우 작업공간 루트를 기준으로 한 경로입니다. 규칙의 출력인 파일의 경우 파일의 출력 경로 입니다(아래의 출력 파일 설명 참고).

사전 정의된 경로 변수의 예를 참고하세요.

  • execpath: Bazel이 빌드 작업을 실행하는 execroot 아래의 경로를 나타냅니다.

    위의 예에서 Bazel은 작업공간 루트의 bazel-myproject 심볼릭 링크로 연결된 디렉터리에서 모든 빌드 작업을 실행합니다. 소스 파일 empty.source는 경로 bazel-myproject/testapp/empty.source에 연결됩니다. 따라서 실행 경로 (루트 아래의 하위 경로)는 testapp/empty.source입니다. 빌드 작업에서 파일을 찾는 데 사용할 수 있는 경로입니다.

    출력 파일은 비슷하게 스테이징되지만 하위 경로 bazel-out/cpu-compilation_mode/bin(또는 도구의 출력의 경우 bazel-out/cpu-opt-exec-hash/bin)도 접두사로 붙습니다. 위의 예에서 //testapp:app은(는) show_app_output'의 tools 속성에 표시되므로 도구입니다. 따라서 출력 파일 app은 bazel-myproject/bazel-out/cpu-opt-exec-hash/bin/testapp/app에 작성됩니다. 따라서 실행 경로는 bazel-out/cpu-opt-exec-hash/bin/testapp/app입니다. 이 추가 접두사 를 사용하면 결과가 서로 겹치지 않고 동일한 빌드에서 서로 다른 두 CPU에 대해 동일한 타겟을 빌드할 수 있습니다.

    이 변수에 전달된 라벨은 정확히 하나의 파일을 나타내야 합니다. 소스 파일을 나타내는 라벨의 경우 자동으로 true입니다. 규칙을 나타내는 라벨의 경우 규칙은 정확히 하나의 출력을 생성해야 합니다. false이거나 라벨의 형식이 잘못된 경우 빌드가 오류와 함께 실패합니다.

  • rootpath: 빌드된 바이너리가 런타임에 기본 저장소에 상응하는 실행 파일 디렉터리의 하위 디렉터리를 기준으로 종속 항목을 찾는 데 사용할 수 있는 경로를 나타냅니다. 참고: 이는 --enable_runfiles가 사용 설정된 경우에만 작동하며 Windows에서는 기본적으로 사용 설정되어 있지 않습니다. 교차 플랫폼 지원을 위해 rlocationpath를 대신 사용하세요.

    이는 execpath와 비슷하지만 위에서 설명한 구성 접두사를 삭제합니다. 위의 예에서 이는 empty.source와 app 모두 순수한 작업공간 상대 경로(testapp/empty.source 및 testapp/app)를 사용한다는 의미입니다.

    외부 저장소 repo에 있는 파일의 rootpath는 ../repo/로 시작하고 그 뒤에 저장소 상대 경로가 옵니다.

    이는 execpath와 동일한 "출력 하나만" 요구사항을 갖습니다.

  • rlocationpath: 빌드된 바이너리가 런타임에 종속 항목을 찾기 위해 실행 파일 디렉터리 (사용 가능한 경우) 또는 실행 파일 매니페스트를 사용하여 실행 파일 라이브러리의 Rlocation 함수에 전달할 수 있는 경로입니다.

    구성 접두사를 포함하지 않는다는 점에서 rootpath와 비슷하지만 항상 저장소 이름으로 시작한다는 점에서 다릅니다. 위의 예에서 이는 empty.source와 app이 다음 경로를 생성한다는 의미입니다. myproject/testapp/empty.source 및 myproject/testapp/app.

    외부 저장소 repo에 있는 파일의 rlocationpath는 repo/로 시작하고 그 뒤에 저장소 상대 경로가 옵니다.

    이 경로를 바이너리에 전달하고 실행 파일 라이브러리를 사용하여 파일 시스템 경로로 확인하는 것이 런타임에 종속 항목을 찾는 데 권장되는 접근 방식입니다. rootpath와 비교했을 때 모든 플랫폼에서 작동하고 실행 파일 디렉터리를 사용할 수 없는 경우에도 작동한다는 장점이 있습니다.

    이는 execpath와 동일한 "출력 하나만" 요구사항을 갖습니다.

  • location: 확장되는 속성에 따라 execpath 또는 rootpath의 동의어입니다. 이는 이전 Starlark 동작이며 특정 규칙에 대해 어떤 작업을 하는지 정말로 알고 있지 않는 한 권장되지 않습니다. 자세한 내용은 #2475 를 참고하세요.

execpaths, rootpaths, rlocationpaths, 및 locations는 각각 execpath, rootpath, rlocationpath, 및location, 의 복수형 변형입니다. 여러 출력을 생성하는 라벨을 지원하며 이 경우 각 출력은 공백으로 구분되어 나열됩니다. 출력이 없는 규칙과 형식이 잘못된 라벨은 빌드 오류를 생성합니다.

참조된 모든 라벨은 사용하는 타겟의 srcs, 출력 파일 또는 deps에 표시되어야 합니다. 그렇지 않으면 빌드가 실패합니다. C++ 타겟은 `data`에서 라벨을 참조할 수도 있습니다.data

라벨은 정규 형식일 필요가 없습니다. foo, :foo 및 //somepkg:foo는 모두 괜찮습니다.

맞춤 변수

맞춤 "Make" 변수는 "Make 변수" 대체 대상"으로 표시된 모든 속성에서 참조할 수 있지만 이러한 변수를 정의하는 다른 타겟에 종속된 타겟에서만 참조할 수 있습니다.

Bazel 핵심에 변수를 포함할 만한 정말 좋은 이유가 없다면 모든 변수는 맞춤 변수여야 합니다. 이렇게 하면 Bazel이 변수를 제공하기 위해 잠재적으로 비용이 많이 드는 종속 항목을 로드할 필요가 없으며, 변수를 사용하는 타겟은 신경 쓰지 않을 수 있습니다.

C++ 도구 모음 변수

다음은 C++ 도구 모음 규칙에 정의되어 있으며 을 설정하는 모든 규칙에서 사용할 수 있습니다. toolchains = ["@bazel_tools//tools/cpp:current_cc_toolchain"] java_binary와 같은 일부 규칙은 규칙 정의에 C++ 도구 모음을 암시적으로 포함합니다. 이러한 변수는 자동으로 상속됩니다.

기본 제공 C++ 규칙은 "컴파일러에서 실행"보다 훨씬 정교합니다. 여러 플랫폼에서 빠른 테스트와 동시에 *SAN, ThinLTO, 모듈 포함/제외, 신중하게 최적화된 바이너리와 같은 다양한 컴파일 모드를 지원하기 위해 기본 제공 규칙은 잠재적으로 여러 내부적으로 생성된 작업 각각에 올바른 입력, 출력, 명령줄 플래그가 설정되도록 많은 노력을 기울입니다.

이러한 변수는 드물게 언어 전문가가 사용하는 대체 메커니즘입니다. 이러한 변수를 사용하고 싶다면 먼저 Bazel 개발팀에 문의하세요.

  • ABI: C++ ABI 버전입니다.
  • AR: crosstool의 "ar" 명령어입니다.
  • C_COMPILER: C/C++ 컴파일러 식별자(예: llvm)입니다.

  • CC: C 및 C++ 컴파일러 명령어입니다.

    CC와 함께 CC_FLAGS를 항상 사용하는 것이 좋습니다. 이렇게 하지 않으면 위험을 감수해야 합니다.

  • CC_FLAGS: genrule에서 사용할 수 있는 C/C++ 컴파일러의 최소 플래그 집합입니다. 특히 올바른 아키텍처를 선택하는 플래그가 포함되어 있습니다. CC 여러 아키텍처를 지원하는 경우
  • DUMPBIN: Microsoft Visual Studio의 Microsoft COFF 바이너리 파일 덤퍼 (dumpbin.exe)입니다.
  • NM: crosstool의 "nm" 명령어입니다.
  • OBJCOPY: C/C++ 컴파일러와 동일한 제품군의 objcopy 명령어입니다.
  • STRIP: C/C++ 컴파일러와 동일한 제품군의 strip 명령어입니다.

Java 도구 모음 변수

다음은 Java 도구 모음 규칙에 정의되어 있으며 toolchains = ["@rules_java//toolchains:current_java_runtime"]을 설정하는 모든 규칙에서 사용할 수 있습니다 (또는 "@rules_java//toolchains:current_host_java_runtime" 호스트 도구 모음과 상응하는).

JDK의 대부분의 도구는 직접 사용해서는 안 됩니다. 기본 제공 Java 규칙은 인터페이스 Jar, 헤더 인터페이스 Jar, 고도로 최적화된 Jar 패키징 및 병합 구현과 같이 업스트림 도구가 표현할 수 있는 것보다 훨씬 정교한 Java 컴파일 및 패키징 접근 방식을 사용합니다.

이러한 변수는 드물게 언어 전문가가 사용하는 대체 메커니즘입니다. 이러한 변수를 사용하고 싶다면 먼저 Bazel 개발팀에 문의하세요.

  • JAVA: 'java' 명령어 (Java 가상 머신)입니다. 가능한 경우 이 명령어를 사용하지 말고 java_binary 규칙 대신 사용하세요. 상대 경로일 수 있습니다. `java`를 호출하기 전에 디렉터리를 변경해야 하는 경우 변경하기 전에 작업 디렉터리를 캡처해야 합니다.java
  • JAVABASE: Java 유틸리티가 포함된 기본 디렉터리입니다. 상대 경로일 수 있습니다. 'bin' 하위 디렉터리가 있습니다.

Starlark 정의 변수

규칙 및 도구 모음 작성자는 완전히 맞춤 변수를 정의할 수 있습니다. TemplateVariableInfo 제공자를 반환하여 속성을 통해 이러한 변수에 종속된 모든 규칙은 값을 읽을 수 있습니다.toolchains

Starlark 정의 변수의 예를 참고하세요.