提交 #1

developtools/integration_verification/tools/deps_guard/rules/NO-Depends-On-SA/README.md

@@ -0,0 +1,104 @@
+# NO-Depends-On-SA规则说明
+
+
+
+## 1. SA模块的定义
+
+SA模块是指System Ability对应的动态库模块，一般都在/system/profile/下描述，示例如下：
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<info>
+    <process>telephony</process>
+    <loadlibs>
+        <libpath>libtel_cellular_call.z.so</libpath>
+        <libpath>libtel_cellular_data.z.so</libpath>
+        <libpath>libtel_core_service.z.so</libpath>
+        <libpath>libtel_sms_mms.z.so</libpath>
+    </loadlibs>
+    ...
+</info>
+```
+
+如上图所示，这些libpath里的动态库都是由SA框架通过dlopen的方式动态加载。
+
+## 2. 规则解释
+
+NO-Depends-On-SA规则有两个方面的含义：
+
+### 2.1 SA模块需要在编译模板中标识
+
+如下图所示，每个SA模块需要在对应的BUILD.gn中通过shlib_type字段来标识其类型：
+
+```go
+ohos_shared_library(sample_sa_module) {
+    ...
+    shlib_type = "sa"
+    ...
+}
+```
+
+同样，非SA模块不要增加shlib_type="sa"标识。
+
+### 2.2 不允许依赖SA模块
+
+编译框架上ohos_shared_library模板会对所有的SA模块（shlib_type为sa）进行全局符号优化，使得所有的SA模块默认都不对外暴露符号，减小SA模块的大小，同时加快SA模块的加载速度。
+
+```go
+# Hide symbols for all sa libraries if not specified by version_script
+if (defined(invoker.shlib_type) && invoker.shlib_type == "sa") {
+  if (!defined(invoker.version_script)) {
+    configs += [ "//build/config/gcc:symbol_visibility_hidden" ]
+  }
+}
+```
+
+## 3. 违规场景及处理方案建议
+
+### 3.1 SA模块没有添加shlib_type标识
+
+处理方式：参考2.2章节的描述增加shlib_type = "sa"标识。
+
+### 3.2 其它模块确实使用到了SA模块中的符号
+
+**方案一**：把SA模块中被使用到的符号下沉到对应的Inner API模块中供调用者使用，解除对SA模块的依赖。
+
+
+
+**方案二**：对于支持插件扩展的SA模块，需要提供API给插件调用。此场景可以通过version_script来显式申明SA模块需要对外提供的符号，示例如下：
+
+```go
+ohos_shared_library(partly_exported_symbols) {
+    ...
+    version_script = "libbeget_proxy.versionscript"
+    ...
+}
+```
+
+示例的version_script文件如下：
+
+```apl
+1.0 {
+  global:
+    AclGetDevUdid;
+    AclGetSerial;
+    ServiceWatchForStatus;
+    SystemWatchParameter;
+    WatchParameter;
+    Remove*Watcher;
+  local:
+    *;
+};
+```
+
+> 提示：如果符号名称有规律，可以使用*作为通配符简化version_script编写的工作量；如Acl\*;。
+
+### 3.3 ut测试代码需使用SA模块中的符号
+
+此场景可以为SA模块增加静态库目标，ut测试代码deps静态库目标来完成测试。
+
+## 4. 例外说明
+
+SA模块默认都不对外暴露符号；如需提供符号，通过version_script来申明，无其它例外选项。
+
+当前的白名单列表只用于归档存量待整改模块，整改完成后需清零。

developtools/integration_verification/tools/deps_guard/rules/NO-Depends-On-SA/whitelist.json

@@ -0,0 +1,8 @@
+[
+	"liblbsservice_locator.z.so",
+	"libnetsys_native_manager.z.so",
+	"libavsession_service.z.so",
+	"libsg_collect_service.z.so",
+	"libabnormal_efficiency_mgr_service.z.so",
+	"libquickfix_engine_service.z.so"
+]