Depset은 타겟의 전이 종속 항목에서 데이터를 효율적으로 수집하기 위한 특수화된 데이터 구조입니다. 규칙 처리의 필수 요소입니다.
depset의 정의는 시간과 공간을 절약하는 합집합 연산입니다. depset 생성자는 요소 목록 ('직접')과 다른 depset 목록 ('전이')을 허용하고 모든 직접 요소와 모든 전이 집합의 합집합을 포함하는 집합을 나타내는 depset을 반환합니다. 개념적으로 생성자는 직접 노드와 전이 노드를 후속 노드로 갖는 새 그래프 노드를 만듭니다. Depset에는 이 그래프의 탐색을 기반으로 잘 정의된 순서 시맨틱스가 있습니다.
depset의 사용 예는 다음과 같습니다.
프로그램 라이브러리의 모든 객체 파일의 경로를 저장하면 이를 제공자를 통해 링커 작업에 전달할 수 있습니다.
해석된 언어의 경우 실행 파일의 runfiles에 포함된 전이 소스 파일을 저장합니다.
설명 및 작업
개념적으로 depset은 일반적으로 타겟 그래프와 유사하게 보이는 방향성 비순환 그래프 (DAG)입니다. 리프에서 루트까지 구성됩니다. 종속 항목 체인의 각 타겟은 이전 항목을 읽거나 복사하지 않고도 이전 항목 위에 자체 콘텐츠를 추가할 수 있습니다.
DAG의 각 노드에는 직접 요소 목록과 하위 노드 목록이 있습니다. depset의 콘텐츠는 모든 노드의 직접 요소와 같은 전이 요소입니다. 새 depset은 depset 생성자를 사용하여 만들 수 있습니다. 이 생성자는 직접 요소 목록과 다른 하위 노드 목록을 허용합니다.
s = depset(["a", "b", "c"])
t = depset(["d", "e"], transitive = [s])
print(s) # depset(["a", "b", "c"])
print(t) # depset(["d", "e", "a", "b", "c"])
depset의 콘텐츠를 검색하려면 to_list() 메서드를 사용합니다. 중복을 제외한 모든 전이성 요소의 목록을 반환합니다. DAG의 정확한 구조를 직접 검사할 방법은 없지만 이 구조는 요소가 반환되는 순서에 영향을 미칩니다.
s = depset(["a", "b", "c"])
print("c" in s.to_list()) # True
print(s.to_list() == ["a", "b", "c"]) # True
사전에서 허용되는 키가 제한되는 것처럼 depset에서 허용되는 항목도 제한됩니다. 특히 depset 콘텐츠는 변경 불가능할 수 있습니다.
Depset은 참조 동등성을 사용합니다. depset은 자체와 동일하지만 다른 depset과는 동일하지 않습니다. 콘텐츠와 내부 구조가 동일하더라도 마찬가지입니다.
s = depset(["a", "b", "c"])
t = s
print(s == t) # True
t = depset(["a", "b", "c"])
print(s == t) # False
d = {}
d[s] = None
d[t] = None
print(len(d)) # 2
콘텐츠별로 depset을 비교하려면 정렬된 목록으로 변환합니다.
s = depset(["a", "b", "c"])
t = depset(["c", "b", "a"])
print(sorted(s.to_list()) == sorted(t.to_list())) # True
depset에서 요소를 삭제할 수 있는 기능은 없습니다. 필요한 경우 depset의 전체 콘텐츠를 읽고 삭제하려는 요소를 필터링한 다음 새 depset을 재구성해야 합니다. 이는 특히 비효율적입니다.
s = depset(["a", "b", "c"])
t = depset(["b", "c"])
# Compute set difference s - t. Precompute t.to_list() so it's not done
# in a loop, and convert it to a dictionary for fast membership tests.
t_items = {e: None for e in t.to_list()}
diff_items = [x for x in s.to_list() if x not in t_items]
# Convert back to depset if it's still going to be used for union operations.
s = depset(diff_items)
print(s) # depset(["a"])
주문
to_list 연산은 DAG를 통해 순회를 실행합니다. 탐색 유형은 depset이 생성될 때 지정된 순서에 따라 다릅니다. 도구에서 입력 순서를 중요하게 생각하는 경우가 있으므로 Bazel에서 여러 순서를 지원하는 것이 유용합니다. 예를 들어 링커 작업은 B가 A에 종속되는 경우 링커의 명령줄에서 A.o가 B.o 앞에 오는지 확인해야 할 수 있습니다. 다른 도구에서는 반대의 요구사항이 적용될 수 있습니다.
postorder, preorder, topological의 세 가지 순회 순서가 지원됩니다. 처음 두 가지는 DAG에서 작동하고 이미 방문한 노드를 건너뛰는 점을 제외하고는 트리 탐색과 정확히 동일하게 작동합니다. 세 번째 순서는 루트에서 리프까지의 순서 정렬로 작동하며, 공유된 하위 요소가 모든 상위 요소 뒤에만 나열된다는 점을 제외하고는 사실상 선순서와 동일합니다.
선행 순회와 후행 순회는 왼쪽에서 오른쪽으로 탐색하지만 각 노드 내에서 직접 요소는 하위 요소와 관련된 순서가 없습니다. 순서론적 순서의 경우 왼쪽에서 오른쪽으로 표시된다는 보장이 없으며 DAG의 여러 노드에 중복 요소가 있는 경우에는 모든 상위 요소가 하위 요소 앞에 표시된다는 보장도 적용되지 않습니다.
# This demonstrates different traversal orders.
def create(order):
cd = depset(["c", "d"], order = order)
gh = depset(["g", "h"], order = order)
return depset(["a", "b", "e", "f"], transitive = [cd, gh], order = order)
print(create("postorder").to_list()) # ["c", "d", "g", "h", "a", "b", "e", "f"]
print(create("preorder").to_list()) # ["a", "b", "e", "f", "c", "d", "g", "h"]
# This demonstrates different orders on a diamond graph.
def create(order):
a = depset(["a"], order=order)
b = depset(["b"], transitive = [a], order = order)
c = depset(["c"], transitive = [a], order = order)
d = depset(["d"], transitive = [b, c], order = order)
return d
print(create("postorder").to_list()) # ["a", "b", "c", "d"]
print(create("preorder").to_list()) # ["d", "b", "a", "c"]
print(create("topological").to_list()) # ["d", "b", "c", "a"]
순회가 구현되는 방식으로 인해 생성자의 order 키워드 인수를 사용하여 depset을 만들 때 순서를 지정해야 합니다. 이 인수가 생략되면 depset에 특수한 default 순서가 적용되며, 이 경우 결정론적이라는 점을 제외하고 요소의 순서에 대한 보장이 없습니다.
전체 예
이 예시는 https://github.com/bazelbuild/examples/tree/main/rules/depsets에서 확인할 수 있습니다.
가상의 해석 언어 Foo가 있다고 가정해 보겠습니다. 각 foo_binary를 빌드하려면 foo_binary가 직접 또는 간접적으로 종속되는 모든 *.foo 파일을 알아야 합니다.
# //depsets:BUILD
load(":foo.bzl", "foo_library", "foo_binary")
# Our hypothetical Foo compiler.
py_binary(
name = "foocc",
srcs = ["foocc.py"],
)
foo_library(
name = "a",
srcs = ["a.foo", "a_impl.foo"],
)
foo_library(
name = "b",
srcs = ["b.foo", "b_impl.foo"],
deps = [":a"],
)
foo_library(
name = "c",
srcs = ["c.foo", "c_impl.foo"],
deps = [":a"],
)
foo_binary(
name = "d",
srcs = ["d.foo"],
deps = [":b", ":c"],
)
# //depsets:foocc.py
# "Foo compiler" that just concatenates its inputs to form its output.
import sys
if __name__ == "__main__":
assert len(sys.argv) >= 1
output = open(sys.argv[1], "wt")
for path in sys.argv[2:]:
input = open(path, "rt")
output.write(input.read())
여기서 바이너리 d의 전이 소스는 a, b, c, d의 srcs 필드에 있는 모든 *.foo 파일입니다. foo_binary 타겟이 d.foo 외의 파일을 알 수 있도록 하려면 foo_library 타겟이 제공업체에서 파일을 전달해야 합니다. 각 라이브러리는 자체 종속 항목에서 제공업체를 수신하고 자체 즉시 소스를 추가한 후 증강된 콘텐츠가 포함된 새 제공업체를 전달합니다. foo_binary 규칙도 동일하지만 제공자를 반환하는 대신 전체 소스 목록을 사용하여 작업의 명령줄을 구성합니다.
다음은 foo_library 및 foo_binary 규칙의 전체 구현입니다.
# //depsets/foo.bzl
# A provider with one field, transitive_sources.
FooFiles = provider(fields = ["transitive_sources"])
def get_transitive_srcs(srcs, deps):
"""Obtain the source files for a target and its transitive dependencies.
Args:
srcs: a list of source files
deps: a list of targets that are direct dependencies
Returns:
a collection of the transitive sources
"""
return depset(
srcs,
transitive = [dep[FooFiles].transitive_sources for dep in deps])
def _foo_library_impl(ctx):
trans_srcs = get_transitive_srcs(ctx.files.srcs, ctx.attr.deps)
return [FooFiles(transitive_sources=trans_srcs)]
foo_library = rule(
implementation = _foo_library_impl,
attrs = {
"srcs": attr.label_list(allow_files=True),
"deps": attr.label_list(),
},
)
def _foo_binary_impl(ctx):
foocc = ctx.executable._foocc
out = ctx.outputs.out
trans_srcs = get_transitive_srcs(ctx.files.srcs, ctx.attr.deps)
srcs_list = trans_srcs.to_list()
ctx.actions.run(executable = foocc,
arguments = [out.path] + [src.path for src in srcs_list],
inputs = srcs_list + [foocc],
outputs = [out])
foo_binary = rule(
implementation = _foo_binary_impl,
attrs = {
"srcs": attr.label_list(allow_files=True),
"deps": attr.label_list(),
"_foocc": attr.label(default=Label("//depsets:foocc"),
allow_files=True, executable=True, cfg="host")
},
outputs = {"out": "%{name}.out"},
)
이러한 파일을 새 패키지로 복사하고, 라벨 이름을 적절하게 바꾸고, 더미 콘텐츠가 포함된 소스 *.foo 파일을 만들고, d 타겟을 빌드하여 테스트할 수 있습니다.
성능
depset을 사용하는 이유를 알아보려면 get_transitive_srcs()가 목록에 소스를 수집하면 어떻게 되는지 생각해 보세요.
def get_transitive_srcs(srcs, deps):
trans_srcs = []
for dep in deps:
trans_srcs += dep[FooFiles].transitive_sources
trans_srcs += srcs
return trans_srcs
중복은 고려되지 않으므로 a의 소스 파일이 명령줄에 두 번, 출력 파일의 콘텐츠에 두 번 표시됩니다.
대안으로 일반적인 집합을 사용할 수 있습니다. 일반적인 집합은 키가 요소이고 모든 키가 True에 매핑되는 사전으로 시뮬레이션할 수 있습니다.
def get_transitive_srcs(srcs, deps):
trans_srcs = {}
for dep in deps:
for file in dep[FooFiles].transitive_sources:
trans_srcs[file] = True
for file in srcs:
trans_srcs[file] = True
return trans_srcs
이렇게 하면 중복이 제거되지만 명령줄 인수의 순서 (따라서 파일의 콘텐츠)는 여전히 결정론적이지만 지정되지 않습니다.
또한 두 접근 방식 모두 depset 기반 접근 방식보다 점근적으로 성능이 떨어집니다. Foo 라이브러리에 긴 종속 항목 체인이 있는 경우를 가정해 보겠습니다. 모든 규칙을 처리하려면 그 앞에 나온 모든 전이 소스를 새 데이터 구조로 복사해야 합니다. 즉, 개별 라이브러리 또는 바이너리 타겟을 분석하는 데 드는 시간과 공간 비용은 체인의 자체 높이에 비례합니다. 길이가 n인 체인 foolib_1 ← foolib_2 ← … ← foolib_n의 경우 전체 비용은 사실상 O(n^2)입니다.
일반적으로 전이 종속 항목을 통해 정보를 축적할 때마다 depset을 사용해야 합니다. 이렇게 하면 타겟 그래프가 더 깊어짐에 따라 빌드가 잘 확장됩니다.
마지막으로 규칙 구현에서 불필요하게 depset의 콘텐츠를 검색하지 않는 것이 중요합니다. 전체 비용은 O(n)이므로 바이너리 규칙의 끝에서 to_list()을 한 번 호출해도 됩니다. 비말단 타겟이 to_list()를 호출하려고 시도할 때 이차 항 동작이 발생합니다.
depset을 효율적으로 사용하는 방법에 관한 자세한 내용은 성능 페이지를 참고하세요.
API 참조
자세한 내용은 여기를 참고하세요.