• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright (c) 2021 Huawei Device Co., Ltd.
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6#     http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14import("//build/config/python.gni")
15import("//build/config/sanitizers/sanitizers.gni")
16import("//build/ohos_var.gni")
17
18# Gen module info to file
19# private template
20#
21template("generate_module_info") {
22  assert(defined(invoker.module_name),
23         "module_label must be defined for ${target_name}.")
24  assert(defined(invoker.module_type),
25         "module_type must be defined for ${target_name}.")
26
27  forward_variables_from(invoker,
28                         [
29                           "testonly",
30                           "visibility",
31                         ])
32  forward_variables_from(invoker,
33                         [
34                           "module_label",
35                           "module_name",
36                           "module_source_dir",
37                           "module_install_images",
38                           "module_type",
39                           "module_install_name",
40                           "module_install_dir",
41                           "relative_install_dir",
42                           "module_output_extension",
43                           "module_source",
44                           "notice",
45                         ])
46
47  if (!defined(module_label)) {
48    if (module_type == "java_library" || module_type == "none" ||
49        module_type == "app" || module_type == "dex") {
50      module_label = get_label_info(":$module_name", "label_no_toolchain")
51    } else {
52      module_label = get_label_info(":$module_name", "label_with_toolchain")
53    }
54  }
55  module_deps = [ get_label_info(module_label, "label_no_toolchain") ]
56
57  gen_script = rebase_path("//build/templates/metadata/gen_module_info.py")
58
59  if (!defined(module_source_dir)) {
60    module_source_dir = "$root_out_dir"
61  }
62  if (!defined(module_install_name)) {
63    module_install_name = module_name
64  }
65  if (!defined(module_output_extension)) {
66    module_output_extension = ""
67  }
68
69  output_file = "${target_out_dir}/${module_name}_module_info.json"
70
71  # reset module_type when module_type is lib
72  if (module_type == "lib") {
73    if (target_cpu == "arm64" || target_cpu == "x86_64") {
74      module_type = "lib64"
75    } else if (target_cpu == "arm" || target_cpu == "x86") {
76      module_type = "lib"
77    } else {
78      assert(false, "Error: unsupported target cpu name.")
79    }
80  }
81
82  if (!is_standard_system && is_asan &&
83      ("${module_type}" == "lib" || "${module_type}" == "lib64" ||
84       "${module_type}" == "bin")) {
85    system_base_dir = "${system_base_dir}/asan"
86  }
87
88  arguments = [
89    "--system-base-dir",
90    system_base_dir,
91    "--ramdisk-base-dir",
92    ramdisk_base_dir,
93    "--vendor-base-dir",
94    vendor_base_dir,
95    "--updater-base-dir",
96    updater_base_dir,
97    "--type",
98    module_type,
99    "--target-label",
100    module_label,
101    "--source-dir",
102    rebase_path(module_source_dir, "$root_build_dir"),
103    "--label-name",
104    module_name,
105    "--install-name",
106    module_install_name,
107    "--output-file",
108    rebase_path(output_file, "$root_build_dir"),
109  ]
110
111  if (defined(invoker.module_alt_output_extension)) {
112    arguments += [
113      "--alternative-suffix",
114      invoker.module_alt_output_extension,
115    ]
116  }
117
118  if (defined(invoker.install_enable) && !invoker.install_enable) {
119    arguments += [ "--install-enable" ]
120  }
121  if (defined(invoker.collect) && invoker.collect) {
122    arguments += [ "--collect" ]
123  }
124
125  if (defined(module_install_images)) {
126    if (!defined(module_install_dir)) {
127      module_install_dir = ""
128    }
129    if (!defined(relative_install_dir)) {
130      relative_install_dir = ""
131    }
132    arguments += [
133      "--module-install-dir",
134      module_install_dir,
135      "--relative-install-dir",
136      relative_install_dir,
137      "--install-images",
138    ]
139    arguments += module_install_images
140  }
141
142  # if prebuilt, add prebuilt=True
143  if (defined(invoker.prebuilt) && invoker.prebuilt) {
144    arguments += [
145      "--prebuilt",
146      "--module-source",
147      module_source,
148    ]
149  } else {
150    arguments += [
151      "--install-name",
152      module_install_name,
153    ]
154  }
155
156  if (module_output_extension != "") {
157    arguments += [
158      "--suffix",
159      module_output_extension,
160    ]
161  }
162
163  if (defined(invoker.symlink_target_name)) {
164    arguments += [ "--symlink-target" ]
165    arguments += invoker.symlink_target_name
166  }
167
168  if (defined(invoker.output_prefix_override) &&
169      invoker.output_prefix_override) {
170    arguments += [ "--prefix-override" ]
171  }
172  if (defined(notice)) {
173    arguments += [
174      "--notice",
175      rebase_path(notice, root_build_dir),
176    ]
177  }
178
179  exec_script(gen_script, arguments)
180
181  generated_file("${target_name}") {
182    outputs = [ "${target_out_dir}/${module_name}_install_info.json" ]
183    data_keys = [ "install_modules" ]
184    output_conversion = "json"
185    deps = module_deps
186  }
187}
188
189template("write_meta_data") {
190  assert(defined(invoker.meta_data), "meta_data must be defined")
191  assert(defined(invoker.type), "type must be defined")
192  forward_variables_from(invoker, [ "testonly" ])
193
194  action_with_pydeps(target_name) {
195    forward_variables_from(invoker,
196                           [
197                             "deps",
198                             "meta_data",
199                             "type",
200                             "resources",
201                             "hap_path",
202                             "app_profile",
203                             "hap_profile",
204                             "package_name",
205                             "raw_assets",
206                             "js_assets",
207                             "ets_assets",
208                             "js2abc",
209                             "unresolved_assets",
210                           ])
211    if (type != "js_assets" && type != "ets_assets" &&
212        type != "unresolved_assets" && type != "assets" &&
213        type != "resources" && type != "hap" && type != "app_profile") {
214      assert(
215          false,
216          "type must be one of [js_assets, ets_assets, unresolved_assets, assets, resources, hap, app_profile]")
217    }
218    if (type != "hap") {
219      _parent_invoker = invoker.invoker
220      _caller_target_name = get_label_info(":${_parent_invoker.target_name}",
221                                           "label_no_toolchain")
222      set_sources_assignment_filter(app_target_allowlist)
223      sources = [ _caller_target_name ]
224      if (sources != []) {
225        if (type == "js_assets" || type == "ets_assets" ||
226            type == "unresolved_assets" || type == "assets") {
227          assert(
228              false,
229              "Illegal target name: \"${_caller_target_name}\", target name of ohos_js_assets or ohos_assets must endswith assets or asset ")
230        } else if (type == "resources") {
231          assert(
232              false,
233              "Illegal target name: \"${_caller_target_name}\", target name of ohos_resources must endswith res or resources or resource")
234        }
235      }
236      set_sources_assignment_filter([])
237    }
238
239    script = "//build/templates/metadata/write_meta_data.py"
240    outputs = [ meta_data ]
241    depfile = "$target_gen_dir/$target_name.d"
242
243    args = [
244      "--output",
245      rebase_path(meta_data, root_build_dir),
246      "--type",
247      type,
248      "--depfile",
249      rebase_path(depfile, root_build_dir),
250    ]
251
252    if (!defined(deps)) {
253      deps = []
254    }
255
256    _possible_deps = []
257    if (defined(invoker.possible_deps)) {
258      _possible_deps = invoker.possible_deps
259    }
260
261    _deps_metadata = []
262    inputs = []
263    set_sources_assignment_filter(app_target_allowlist)
264    foreach(d, _possible_deps) {
265      sources = []
266      _target_label = get_label_info(d, "label_no_toolchain")
267      sources += [ _target_label ]
268      if (sources == []) {
269        _deps_metadata += [ get_label_info(d, "target_gen_dir") + "/" +
270                            get_label_info(d, "name") + ".metadata" ]
271        deps += [ "${_target_label}__metadata" ]
272      }
273    }
274    set_sources_assignment_filter([])
275
276    if (_deps_metadata != []) {
277      args += [ "--deps-metadata" ]
278      foreach(d, _deps_metadata) {
279        args += [ rebase_path(d, root_build_dir) ]
280      }
281      inputs += _deps_metadata
282    }
283
284    if (defined(resources)) {
285      args += [ "--resources" ]
286      foreach(res, resources) {
287        args += [ rebase_path(res, root_build_dir) ]
288      }
289      if (defined(package_name)) {
290        args += [
291          "--package-name",
292          package_name,
293        ]
294      }
295    }
296
297    if (defined(app_profile)) {
298      args += [
299        "--app-profile",
300        rebase_path(app_profile, root_build_dir),
301      ]
302    }
303
304    if (defined(hap_profile)) {
305      args += [
306        "--hap-profile",
307        rebase_path(hap_profile, root_build_dir),
308      ]
309    }
310
311    if (defined(raw_assets)) {
312      args += [ "--raw-assets" ]
313      foreach(asset, raw_assets) {
314        args += [ rebase_path(asset, root_build_dir) ]
315      }
316    }
317
318    if (defined(js_assets)) {
319      args += [ "--js-assets" ]
320      foreach(asset, js_assets) {
321        args += [ rebase_path(asset, root_build_dir) ]
322      }
323    }
324
325    if (defined(ets_assets)) {
326      args += [ "--ets-assets" ]
327      foreach(asset, ets_assets) {
328        args += [ rebase_path(asset, root_build_dir) ]
329      }
330    }
331
332    if (defined(unresolved_assets)) {
333      args += [ "--unresolved-assets" ]
334      foreach(asset, unresolved_assets) {
335        args += [ rebase_path(asset, root_build_dir) ]
336      }
337    }
338
339    if (defined(js2abc) && js2abc) {
340      args += [ "--js2abc" ]
341    }
342
343    if (defined(hap_path)) {
344      args += [
345        "--hap-path",
346        rebase_path(hap_path, root_build_dir),
347      ]
348    }
349  }
350}
351