編寫規則時,最常見的效能問題是周遊或複製 所累積的資料如果從整個資料中匯總資料 建構,這些作業可以輕鬆採用 O(N^2) 時間或空間。為避免這種情況發生 重要的是,才能有效使用解碼器。
這可能很難正確處理,因此 Bazel 也提供了記憶體分析器 幫助您找到可能出錯的地方警告: 要寫出效率低落的規則成本,可能要等到 以及應用層面
使用解碼器
每當您從應該使用的規則依附性取得資訊時 depsets。僅使用純清單或字典發布資訊 對應至現行規則
depset 會以巢狀圖方式呈現資訊,因此可以分享。
請見下圖:
C -> B -> A
D ---^
每個節點都會發布單一字串。使用 depset 後,資料會如下所示:
a = depset(direct=['a'])
b = depset(direct=['b'], transitive=[a])
c = depset(direct=['c'], transitive=[b])
d = depset(direct=['d'], transitive=[b])
請注意,每個項目只會出現一次。建立清單的好處如下:
a = ['a']
b = ['b', 'a']
c = ['c', 'b', 'a']
d = ['d', 'b', 'a']
請注意,在本例中,'a'
被提及 4 次!大型圖表
問題只會越來越嚴重
以下舉例說明規則實作的正確用法 以及發布遞移資訊請注意,您可以發布規則-本機 資訊,因為這不是 O(N^2)。
MyProvider = provider()
def _impl(ctx):
my_things = ctx.attr.things
all_things = depset(
direct=my_things,
transitive=[dep[MyProvider].all_things for dep in ctx.attr.deps]
)
...
return [MyProvider(
my_things=my_things, # OK, a flat list of rule-local things only
all_things=all_things, # OK, a depset containing dependencies
)]
詳情請參閱 depset 總覽頁面。
避免撥打 depset.to_list()
您可以使用
to_list()
,但這麼做通常會產生 O(N^2)
這項功能會將不常存取的資料
移至「較冷」的儲存空間級別來減少費用請盡可能避免除偵錯之外的任何依附元件分割
用途。
常見的誤解是,如果只用到,就能自由壓平依附元件
頂層目標,例如 <xx>_binary
規則,因為這樣就不必
每個等級的累計值但這 還是 O(N^2)
您需要建構一組依附元件重疊的目標。發生這種情況時
建構測試 //foo/tests/...
,或匯入 IDE 專案時。
減少呼叫 depset
的次數
在迴圈中呼叫 depset
通常是錯誤。這會導致
建立非常深層的巢狀結構,效能不佳例如:
x = depset()
for i in inputs:
# Do not do that.
x = depset(transitive = [x, i.deps])
這個代碼很容易更換。首先,收集遞移依附元件 一次合併所有內容:
transitive = []
for i in inputs:
transitive.append(i.deps)
x = depset(transitive = transitive)
但有時候,只要遵循清單理解即可改善做法:
x = depset(transitive = [i.deps for i in inputs])
針對指令列使用 ctx.actions.args()
建構指令列時,應使用 ctx.actions.args()。 這會將任何偏移值延後到執行階段。
如此一來,除了速度更快,這項機制也會減少 你的規則,有時可能會增加 90% 以上
以下提供幾個訣竅:
傳遞依附元件和清單做為引數,而不是壓平合併函式 你自己。系統會為你延長
ctx.actions.args()
。 如果您需要對解碼器內容進行任何轉換,請參閱 ctx.actions.args#add 查看是否有任何項目符合帳單。避免將字串串連在一起來建構字串。 最佳字串引數是常數,因為這個引數會在 所有例項都一樣
如果指令列的引數過長,
ctx.actions.args()
物件 可以是有條件或無條件地寫入參數檔案ctx.actions.args#use_param_file
。這是 完成操作如果您需要明確設定 控制參數檔案ctx.actions.write
。
範例:
def _impl(ctx):
...
args = ctx.actions.args()
file = ctx.declare_file(...)
files = depset(...)
# Bad, constructs a full string "--foo=<file path>" for each rule instance
args.add("--foo=" + file.path)
# Good, shares "--foo" among all rule instances, and defers file.path to later
# It will however pass ["--foo", <file path>] to the action command line,
# instead of ["--foo=<file_path>"]
args.add("--foo", file)
# Use format if you prefer ["--foo=<file path>"] to ["--foo", <file path>]
args.add(format="--foo=%s", value=file)
# Bad, makes a giant string of a whole depset
args.add(" ".join(["-I%s" % file.short_path for file in files])
# Good, only stores a reference to the depset
args.add_all(files, format_each="-I%s", map_each=_to_short_path)
# Function passed to map_each above
def _to_short_path(f):
return f.short_path
遞移動作輸入內容應為解碼器
使用 ctx.actions.run 建構動作時,請勿
注意,inputs
欄位可接受 Depset。每當有輸入內容
從依附元件間接收集而來
inputs = depset(...)
ctx.actions.run(
inputs = inputs, # Do *not* turn inputs into a list
...
)
懸掛式
如果 Bazel 顯示為無回應,即可按下 Ctrl-\ 鍵或傳送
Bazel 會傳送 SIGQUIT
信號 (kill -3 $(bazel info server_pid)
),以取得執行緒
轉儲 $(bazel info output_base)/server/jvm.out
檔案中的傾印
由於 bazel 停止運作,您可能無法執行 bazel info
,
output_base
目錄通常是 bazel-<workspace>
的父項
。
效能分析
Bazel 會將 JSON 設定檔寫入輸出基準中的 command.profile.gz
預設值。您可以使用
--profile
標記,例如:
--profile=/tmp/profile.gz
。結尾為 .gz
的位置都會使用以下格式壓縮:
GZIP。
如要查看結果,請在 Chrome 瀏覽器分頁中開啟 chrome://tracing
,然後按一下
「載入」,然後選擇 (可能壓縮的) 設定檔。如要進一步瞭解
結果時,請按一下左下角的方塊。
您可以使用下列鍵盤控制項進行瀏覽:
- 按下
1
鍵即可選取「選取」模式。在這個模式下 查看活動詳細資訊的方塊 (請見左下角)。 選取多個事件,即可取得匯總統計資料和匯總統計資料。 - 按下
2
移至「平移」模式。然後拖曳滑鼠來移動檢視畫面。個人中心 您也可以使用a
/d
來左右移動。 - 按下
3
即可開啟「縮放」模式。然後拖曳滑鼠來縮放。你可以 您也可以使用w
/s
來放大/縮小。 - 按下
4
即可查看「計時」在這個模式中 這種做法 - 按
?
即可查看所有控制選項。
個人資訊
個人資料範例:
圖 1. 範例個人資料。
幾個特殊資料列如下:
action counters
:顯示過程中同時執行的操作數量。按一下 即可查看實際值等於--jobs
的值: 乾淨的建構作業cpu counters
:顯示建構的每秒 CPU 數量 (值為 1 等於一個核心處於 100% 忙碌狀態)。Critical Path
:針對重要路徑中的每個動作顯示一個區塊。grpc-command-1
:Bazel 的主執行緒。這有助於概略瞭解 Bazel 正在執行的動作,例如「啟動 Bazel」、「評估 TargetPatterns」 和「runAnalysisPhase」Service Thread
:顯示小型和主要垃圾收集 (GC) 暫停畫面。
其他資料列代表 Bazel 執行緒,並顯示該執行緒上的所有事件。
常見效能問題
分析成效概況時,請找出:
- 比預期分析階段 (
runAnalysisPhase
) 慢,尤其是在 漸進式建構作業這可能表示規則執行不當, 以扁平的解碼器為例系統可能會要求 目標過多、複雜巨集或遞迴 glob。 - 個別的緩慢動作,尤其是重要路徑上的動作。有可能
可以將大型動作分成多個較小的動作
一組 (遞移) 依附元件來加快其速度。同時檢查是否有異常
高非
PROCESS_TIME
(例如REMOTE_SETUP
或FETCH
)。 - 瓶頸,只有少量執行緒處於忙碌狀態,其他所有執行緒則仍在處理中 閒置 / 等待結果 (請見上方螢幕截圖中約 15 至 30 秒)。 要進行最佳化,就可能需要符合規則的導入方式。 或 Bazel 本身,以引入更多平行處理可能發生這種情況 垃圾收集量異常
設定檔檔案格式
頂層物件包含中繼資料 (otherData
) 和實際的追蹤資料
(traceEvents
)。中繼資料含有額外資訊,例如叫用 ID
和 Bazel 叫用的日期
範例:
{
"otherData": {
"build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
"date": "Tue Jun 16 08:30:21 CEST 2020",
"output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
},
"traceEvents": [
{"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
{"cat":"build phase marker","name":"Launch Bazel","ph":"X","ts":-1824000,"dur":1824000,"pid":1,"tid":60},
...
{"cat":"general information","name":"NoSpawnCacheModule.beforeCommand","ph":"X","ts":116461,"dur":419,"pid":1,"tid":60},
...
{"cat":"package creation","name":"src","ph":"X","ts":279844,"dur":15479,"pid":1,"tid":838},
...
{"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Service Thread"}},
{"cat":"gc notification","name":"minor GC","ph":"X","ts":334626,"dur":13000,"pid":1,"tid":11},
...
{"cat":"action processing","name":"Compiling third_party/grpc/src/core/lib/transport/status_conversion.cc","ph":"X","ts":12630845,"dur":136644,"pid":1,"tid":1546}
]
}
追蹤記錄事件中的時間戳記 (ts
) 和時間長度 (dur
) 位於
微秒。類別 (cat
) 是 ProfilerTask
的其中一個列舉值。
請注意,某些事件很短且接近
資源;如果想要--noslim_json_profile
避免事件合併
另請參閱 Chrome 追蹤事件格式規格。
analyze-profile
這個剖析方法包含兩個步驟,您必須先執行
透過 --profile
旗標建構/測試
$ bazel build --profile=/tmp/prof //path/to:target
產生的檔案 (在本例中為 /tmp/prof
) 是二進位檔案,可以是
進行後處理和分析:analyze-profile
:
$ bazel analyze-profile /tmp/prof
根據預設,系統會輸出指定設定檔的摘要分析資訊 資料檔。其中包含不同任務類型的累計統計資料 建構階段及分析關鍵路徑
預設輸出內容的第一個部分是時間總覽 並在不同的建構階段
INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0
=== PHASE SUMMARY INFORMATION ===
Total launch phase time 1.070 s 12.95%
Total init phase time 0.299 s 3.62%
Total loading phase time 0.878 s 10.64%
Total analysis phase time 1.319 s 15.98%
Total preparation phase time 0.047 s 0.57%
Total execution phase time 4.629 s 56.05%
Total finish phase time 0.014 s 0.18%
------------------------------------------------
Total run time 8.260 s 100.00%
Critical path (4.245 s):
Time Percentage Description
8.85 ms 0.21% _Ccompiler_Udeps for @local_config_cc// compiler_deps
3.839 s 90.44% action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
270 ms 6.36% action 'Linking external/com_google_protobuf/protoc [for host]'
0.25 ms 0.01% runfiles for @com_google_protobuf// protoc
126 ms 2.97% action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
0.96 ms 0.02% runfiles for //tools/aquery_differ aquery_differ
記憶體分析
Bazel 內建的記憶體分析器可協助您檢查規則的 記憶體用量如果發生問題,您可以轉儲記憶體快照資料來找出 造成問題的確切程式碼行。
啟用記憶體追蹤
您必須將這兩個啟動標記傳送到「每個」Bazel 叫用:
STARTUP_FLAGS=\
--host_jvm_args=-javaagent:$(BAZEL)/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
--host_jvm_args=-DRULE_MEMORY_TRACKER=1
這些指令會以記憶體追蹤模式啟動伺服器。萬一你忘記這些 伺服器就會重新啟動一次 Bazel 叫用,這時必須重新開始。
使用記憶體追蹤程式
舉例來說,請查看目標 foo
並瞭解其功用。僅
執行分析,但不執行建構執行階段,請將
--nobuild
標記。
$ bazel $(STARTUP_FLAGS) build --nobuild //foo:foo
接下來,看看整個 Bazel 執行個體會使用多少記憶體:
$ bazel $(STARTUP_FLAGS) info used-heap-size-after-gc
> 2594MB
使用 bazel dump --rules
即可依規則類別細分:
$ bazel $(STARTUP_FLAGS) dump --rules
>
RULE COUNT ACTIONS BYTES EACH
genrule 33,762 33,801 291,538,824 8,635
config_setting 25,374 0 24,897,336 981
filegroup 25,369 25,369 97,496,272 3,843
cc_library 5,372 73,235 182,214,456 33,919
proto_library 4,140 110,409 186,776,864 45,115
android_library 2,621 36,921 218,504,848 83,366
java_library 2,371 12,459 38,841,000 16,381
_gen_source 719 2,157 9,195,312 12,789
_check_proto_library_deps 719 668 1,835,288 2,552
... (more output)
產生 pprof
檔案即可瞭解記憶體的用途
使用 bazel dump --skylark_memory
:
$ bazel $(STARTUP_FLAGS) dump --skylark_memory=$HOME/prof.gz
> Dumping Starlark heap to: /usr/local/google/home/$USER/prof.gz
使用 pprof
工具調查堆積。有一個好的開始是
使用 pprof -flame $HOME/prof.gz
取得火焰圖。
從 https://github.com/google/pprof 取得 pprof
。
取得熱門通話網站的文字傾印檔,並加上下列幾行註解:
$ pprof -text -lines $HOME/prof.gz
>
flat flat% sum% cum cum%
146.11MB 19.64% 19.64% 146.11MB 19.64% android_library <native>:-1
113.02MB 15.19% 34.83% 113.02MB 15.19% genrule <native>:-1
74.11MB 9.96% 44.80% 74.11MB 9.96% glob <native>:-1
55.98MB 7.53% 52.32% 55.98MB 7.53% filegroup <native>:-1
53.44MB 7.18% 59.51% 53.44MB 7.18% sh_test <native>:-1
26.55MB 3.57% 63.07% 26.55MB 3.57% _generate_foo_files /foo/tc/tc.bzl:491
26.01MB 3.50% 66.57% 26.01MB 3.50% _build_foo_impl /foo/build_test.bzl:78
22.01MB 2.96% 69.53% 22.01MB 2.96% _build_foo_impl /foo/build_test.bzl:73
... (more output)