Tạo biến

Nightly · 9.2 · 9.1 · 9.0 · 8.7 · 8.6

Biến "Make" là một lớp đặc biệt gồm các biến chuỗi có thể mở rộng, có sẵn cho các thuộc tính được đánh dấu là "Subject to 'Make variable' substitution".

Ví dụ: bạn có thể dùng các biến này để chèn các đường dẫn chuỗi công cụ cụ thể vào các thao tác xây dựng do người dùng tạo.

Bazel cung cấp cả biến xác định trước (có sẵn cho tất cả mục tiêu) và biến tuỳ chỉnh (được xác định trong các mục tiêu phụ thuộc và chỉ có sẵn cho các mục tiêu phụ thuộc vào các biến đó).

Lý do cho thuật ngữ "Make" là do lịch sử: cú pháp và ngữ nghĩa của các biến này ban đầu được dự định khớp với GNU Make.

Sử dụng

Các thuộc tính được đánh dấu là "Subject to 'Make variable' substitution" có thể tham chiếu đến biến "Make" FOO như sau:

my_attr = "prefix $(FOO) suffix"

Nói cách khác, mọi chuỗi con khớp với $(FOO) đều được mở rộng thành FOO's value. Nếu giá trị đó là "bar", thì chuỗi cuối cùng sẽ trở thành:

my_attr = "prefix bar suffix"

Nếu FOO không tương ứng với một biến mà mục tiêu sử dụng biết, thì Bazel sẽ gặp lỗi.

Bạn cũng có thể tham chiếu đến các biến "Make" có tên là ký hiệu không phải chữ cái, chẳng hạn như @, chỉ bằng cách sử dụng dấu đô la mà không cần dấu ngoặc đơn. Ví dụ:

my_attr = "prefix $@ suffix"

Để ghi $ dưới dạng một chuỗi ký tự (tức là để ngăn việc mở rộng biến), hãy ghi $$.

Predefined variables

Predefined "Make" variables can be referenced by any attribute marked as "Subject to 'Make variable' substitution" on any target.

To see the list of these variables and their values for a given set of build options, run

bazel info --show_make_env [build options]

and look at the top output lines with capital letters.

See an example of predefined variables.

Toolchain option variables

Path variables

  • BINDIR: The base of the generated binary tree for the target architecture.

    Note that a different tree may be used for programs that run during the build on the host architecture, to support cross-compiling.

    If you want to run a tool from within a genrule, the recommended way to get its path is $(execpath toolname), where toolname must be listed in the genrule's tools attribute.

  • GENDIR: The base of the generated code tree for the target architecture.

Machine architecture variables

  • TARGET_CPU: The target architecture's CPU, e.g. k8.

Predefined genrule variables

The following are specially available to genrule's cmd attribute and are generally important for making that attribute work.

See an example of predefined genrule variables.

  • OUTS: The genrule's outs list. If you have only one output file, you can also use $@.
  • SRCS: The genrule's srcs list (or more precisely: the path names of the files corresponding to labels in the srcs list). If you have only one source file, you can also use $<.
  • <: SRCS, if it is a single file. Else triggers a build error.
  • @: OUTS, if it is a single file. Else triggers a build error.

  • RULEDIR: The output directory of the target, that is, the directory corresponding to the name of the package containing the target under the genfiles or bin tree. For //my/pkg:my_genrule this always ends in my/pkg, even if //my/pkg:my_genrule's outputs are in subdirectories.

  • @D: The output directory. If outs has one entry, this expands to the directory containing that file. If it has multiple entries, this expands to the package's root directory in the genfiles tree, even if all output files are in the same subdirectory!

    Note: Use RULEDIR over @D because RULEDIR has simpler semantics and behaves the same way regardless of the number of output files.

    If the genrule needs to generate temporary intermediate files (perhaps as a result of using some other tool like a compiler), it should attempt to write them to @D (although /tmp will also be writable) and remove them before finishing.

    Especially avoid writing to directories containing inputs. They may be on read-only filesystems. Even if not, doing so would trash the source tree.

Note: If the filenames corresponding to the input labels or the output filenames contain spaces, ', or other special characters (or your genrule is part of a Starlark macro which downstream users may invoke on such files), then $(SRCS) and $(OUTS) are not suitable for interpolation into a command line, as they do not have the semantics that "${@}" would in Bash.

One workaround is to convert to a Bash array, with 

mapfile SRCS <<< "$$(sed -e 's/ /\\n/g' <<'genrule_srcs_expansion'
$(SRC)
genrule_srcs_expansion
) và sau đó sử dụng "$$\{SRCS[@]}" trong các dòng lệnh tiếp theo thay cho $(SRCS). Một lựa chọn mạnh mẽ hơn là viết một quy tắc Starlark.





Biến đường dẫn đầu ra/nguồn xác định trước



  Các biến xác định trước execpath, execpaths,
  rootpath, rootpaths, location, và
  locations nhận các tham số nhãn (ví dụ: $(execpath
  //foo:bar)) và thay thế các đường dẫn tệp được biểu thị bằng nhãn đó.





  Đối với các tệp nguồn, đây là đường dẫn tương ứng với gốc không gian làm việc của bạn.
  Đối với các tệp là kết quả đầu ra của quy tắc, đây là đường dẫn đầu ra
  của tệp (xem phần giải thích về tệp đầu ra bên dưới).





  Xem ví dụ về các biến đường dẫn xác định trước.



    
  
  • 
    
    
      execpath:  Biểu thị đường dẫn bên dưới 

 execroot
 nơi Bazel chạy các thao tác xây dựng.
    
    
    
    
      Trong ví dụ trên, Bazel chạy tất cả các thao tác xây dựng trong thư mục được liên kết
 bằng liên kết tượng trưng bazel-myproject trong gốc không gian làm việc của bạn. Tệp nguồn empty.source được liên kết tại đường dẫn
      bazel-myproject/testapp/empty.source. Vì vậy, đường dẫn exec của tệp (là đường dẫn con bên dưới gốc) là testapp/empty.source. Đây
 là đường dẫn mà các thao tác xây dựng có thể dùng để tìm tệp.
    
    
    
    
      Các tệp đầu ra được dàn dựng tương tự, nhưng cũng được thêm tiền tố bằng đường dẫn con
      bazel-out/cpu-compilation_mode/bin (hoặc đối với kết quả đầu ra của
      công cụ: bazel-out/cpu-opt-exec-hash/bin). Trong ví dụ trên,
      //testapp:app là một công cụ vì công cụ này xuất hiện trong
      thuộc tính tools của show_app_output.
      Vì vậy, tệp đầu ra app được ghi vào
      bazel-myproject/bazel-out/cpu-opt-exec-hash/bin/testapp/app.
      Do đó, đường dẫn exec là 
      bazel-out/cpu-opt-exec-hash/bin/testapp/app. Tiền tố bổ sung này
 giúp bạn có thể xây dựng cùng một mục tiêu cho, chẳng hạn như 2 CPU khác nhau trong
 cùng một bản dựng mà không làm ảnh hưởng đến kết quả của nhau.
    
    
    
    
      Nhãn được truyền đến biến này phải biểu thị chính xác một tệp. Đối với
 các nhãn biểu thị tệp nguồn, điều này sẽ tự động đúng. Đối với các nhãn
 biểu thị quy tắc, quy tắc phải tạo chính xác một kết quả đầu ra. Nếu điều này là
 sai hoặc nhãn bị lỗi, thì bản dựng sẽ gặp lỗi.
    
    
  
    • 

  
  • 
    
    
      rootpath: Biểu thị đường dẫn mà tệp nhị phân đã xây dựng có thể dùng để
 tìm phần phụ thuộc trong thời gian chạy tương ứng với thư mục con của thư mục runfiles
 thư mục tương ứng với kho lưu trữ chính.
      Lưu ý: Điều này chỉ hoạt động nếu bạn bật 
      --enable_runfiles, nhưng theo mặc định thì không phải như vậy trên
      Windows. Hãy sử dụng rlocationpath để hỗ trợ đa nền tảng.
    
    
      Điều này tương tự như execpath nhưng sẽ loại bỏ các tiền tố cấu hình được mô tả ở trên. Trong ví dụ ở trên, điều này có nghĩa là cả
      empty.source và app đều sử dụng các đường dẫn tương đối thuần tuý trong không gian làm việc: testapp/empty.source và testapp/app.
    
    
    
    
      rootpath của một tệp trong kho lưu trữ bên ngoài
      repo sẽ bắt đầu bằng ../repo/, tiếp theo là đường dẫn tương đối trong kho lưu trữ.
    
    
    
    
      Điều này có cùng yêu cầu "chỉ một kết quả đầu ra" như execpath.
    
    
  
    • 

  
  • 
    
    
      rlocationpath: Đường dẫn mà tệp nhị phân đã xây dựng có thể truyền đến hàm 
      Rlocation của thư viện runfiles để tìm phần phụ thuộc trong thời gian chạy, trong thư mục runfiles (nếu có) hoặc bằng cách sử dụng tệp kê khai runfiles.
    
    
    
    
      Điều này tương tự như rootpath ở chỗ không chứa
 tiền tố cấu hình, nhưng khác ở chỗ luôn bắt đầu bằng tên của kho lưu trữ. Trong ví dụ ở trên, điều này có nghĩa là 
      empty.source và app sẽ tạo ra các
      đường dẫn sau: myproject/testapp/empty.source và 
      myproject/testapp/app.
    
    
    
    
      rlocationpath của một tệp trong kho lưu trữ bên ngoài
      repo sẽ bắt đầu bằng repo/, tiếp theo là đường dẫn tương đối trong kho lưu trữ.
    
    
    
    
      Truyền đường dẫn này đến một tệp nhị phân và phân giải đường dẫn đó thành đường dẫn hệ thống tệp bằng cách sử dụng
 thư viện runfiles là phương pháp ưu tiên để tìm các phần phụ thuộc trong thời gian chạy. So với rootpath, phương pháp này có ưu điểm là hoạt động trên tất cả các nền tảng và ngay cả khi thư mục runfiles không có sẵn.
    
    
    
    
      Điều này có cùng yêu cầu "chỉ một kết quả đầu ra" như execpath.
    
    
  
    • 

  
  • 
    location: Từ đồng nghĩa với execpath hoặc 
 rootpath, tuỳ thuộc vào thuộc tính đang được mở rộng. Đây là
 hành vi cũ trước Starlark và không nên dùng trừ phi bạn thực sự biết hành vi này đối với một quy tắc cụ thể. Xem #2475
 để biết thông tin chi tiết.
  
    • 





  execpaths, rootpaths, rlocationpaths,
 và locations lần lượt là các biến thể số nhiều của execpath,
 rootpath, rlocationpath, vàlocation,
 . Các biến này hỗ trợ các nhãn tạo ra nhiều kết quả đầu ra, trong trường hợp đó
 mỗi kết quả đầu ra được liệt kê và phân tách bằng dấu cách. Các quy tắc không có kết quả đầu ra và nhãn bị lỗi
 sẽ tạo ra lỗi xây dựng.





  Tất cả các nhãn được tham chiếu phải xuất hiện trong srcs,
 tệp đầu ra hoặc deps. Nếu không, bản dựng sẽ gặp lỗi. Các mục tiêu C++ cũng có thể tham chiếu đến các nhãn trong data.





  Các nhãn không cần ở dạng chính tắc: foo, :foo
 và //somepkg:foo đều ổn.




Biến tuỳ chỉnh




  Mọi thuộc tính được đánh dấu là
   "Subject to 'Make variable' substitution" đều có thể tham chiếu đến các biến "Make" tuỳ chỉnh, nhưng chỉ trên các mục tiêu
  phụ thuộc vào các mục tiêu khác xác định các biến này.





  Theo phương pháp hay nhất, tất cả các biến phải là biến tuỳ chỉnh, trừ phi có lý do thực sự chính đáng
 để đưa các biến đó vào Bazel cốt lõi. Điều này giúp Bazel không phải tải
 các phần phụ thuộc có khả năng tốn kém để cung cấp các biến mà các mục tiêu sử dụng có thể
 không quan tâm.




Biến chuỗi công cụ C++



  Các biến sau được xác định trong các quy tắc chuỗi công cụ C++ và có sẵn cho mọi quy tắc
 đặt toolchains =
  ["@bazel_tools//tools/cpp:toolchain_type"]
 Một số quy tắc, chẳng hạn như java_binary, ngầm
 bao gồm chuỗi công cụ C++ trong định nghĩa quy tắc của chúng. Các quy tắc này tự động kế thừa các biến này.





  Các quy tắc C++ tích hợp phức tạp hơn nhiều so với "chạy trình biên dịch trên
 đó". Để hỗ trợ các chế độ biên dịch đa dạng như *SAN, ThinLTO,
 có/không có mô-đun và các tệp nhị phân được tối ưu hoá cẩn thận đồng thời với các bài kiểm thử chạy nhanh trên nhiều nền tảng, các quy tắc tích hợp sẽ cố gắng hết sức để đảm bảo rằng các đầu vào, đầu ra và cờ dòng lệnh chính xác được đặt trên mỗi thao tác có khả năng được tạo nội bộ.





  Các biến này là cơ chế dự phòng để các chuyên gia ngôn ngữ sử dụng trong
 những trường hợp hiếm gặp. Nếu bạn muốn sử dụng các biến này, vui lòng liên hệ với nhóm phát triển Bazel trước.




    
  
  • ABI: Phiên bản ABI C++. 
    • 

  
  •  AR: Lệnh "ar" từ crosstool. 
    • 
  
  •  C_COMPILER:
 Mã nhận dạng trình biên dịch C/C++, ví dụ: llvm.
  
    • 
  
  • 
    
    CC: Lệnh trình biên dịch C và C++.
    
    
    
      Bạn nên luôn sử dụng CC_FLAGS kết hợp với CC. Nếu không làm như vậy, bạn sẽ tự chịu rủi ro.
    
    
  
    • 
  
  • CC_FLAGS: Một tập hợp cờ tối thiểu để trình biên dịch C/C++
 có thể sử dụng được bằng genrules. Cụ thể, tập hợp này chứa các cờ để
 chọn đúng cấu trúc nếu CC hỗ trợ nhiều
 cấu trúc.
  
    • 


  
  •  DUMPBIN: Microsoft COFF Binary File Dumper (dumpbin.exe) từ
    từ Microsoft Visual Studio. 
    • 

  
  •  NM: Lệnh "nm" từ crosstool. 
    • 
  
  •  OBJCOPY: Lệnh objcopy từ cùng một bộ như trình biên dịch C/C++
 
    • 

  
  •  STRIP: Lệnh strip từ cùng một bộ như trình biên dịch C/C++

    • 




Biến chuỗi công cụ Java




  Các biến sau được xác định trong các quy tắc chuỗi công cụ Java và có sẵn cho mọi quy tắc
 đặt toolchains =
["@rules_java//toolchains:current_java_runtime"] (hoặc
 "@rules_java//toolchains:current_host_java_runtime"
 cho chuỗi công cụ máy chủ tương đương).





  Bạn không nên sử dụng trực tiếp hầu hết các công cụ trong JDK. Các quy tắc Java
 tích hợp sử dụng các phương pháp phức tạp hơn nhiều để biên dịch và đóng gói Java
 so với các công cụ ngược dòng có thể biểu thị, chẳng hạn như Jars giao diện, Jars giao diện tiêu đề
 và các triển khai đóng gói và hợp nhất Jar được tối ưu hoá cao.





  Các biến này là cơ chế dự phòng để các chuyên gia ngôn ngữ sử dụng trong
 những trường hợp hiếm gặp. Nếu bạn muốn sử dụng các biến này, vui lòng liên hệ với nhóm phát triển Bazel trước.




    
  
  •  JAVA: Lệnh "java" (máy ảo Java
    ). Tránh sử dụng lệnh này và thay vào đó hãy sử dụng quy tắc java_binary rule
 nếu có thể. Có thể là đường dẫn tương đối. Nếu bạn phải thay đổi
 thư mục trước khi gọi java, bạn cần ghi lại thư mục làm việc trước khi thay đổi.
  
    • 

  
  • JAVABASE: Thư mục cơ sở chứa các tiện ích Java. Có thể là đường dẫn tương đối. Thư mục này sẽ có một thư mục con "bin"
 subdirectory.
  
    • 




Biến do Starlark xác định




  Người viết quy tắc và chuỗi công cụ có thể xác định
 các biến hoàn toàn tuỳ chỉnh bằng cách trả về
 trình cung cấp TemplateVariableInfo. Mọi quy tắc phụ thuộc vào các quy tắc này thông qua thuộc tính 
 toolchains đều có thể đọc các giá trị của chúng:





  Xem ví dụ về các biến do Starlark xác định.