@ohos-graphics/stability-code-review 0.1.0

package/references/MemoryStability/StabilityCodeReview_MemoryStability_007.md

@@ -0,0 +1,279 @@
+---
+rule_id: "StabilityCodeReview_MemoryStability_007"
+name: "函数返回指针未检查NULL"
+category: "内存稳定性"
+severity: "CRITICAL"
+language: ["cpp", "c++"]
+author: "OH-Department7 Stability Team"
+---
+
+# 函数返回指针未检查NULL
+
+## 问题描述
+
+函数返回指针类型时可能返回NULL表示错误或特殊情况，调用方未检查返回值直接使用会导致空指针解引用，引发程序崩溃或拒绝服务。
+
+## 检测示例
+
+### ❌ 问题代码
+
+```cpp
+// 场景1：工厂函数返回NULL未检查
+void ProcessObject()
+{
+    Object* obj = CreateObject();  // 可能返回nullptr
+    obj->Initialize();  // 错误：未检查obj是否为nullptr
+    obj->Process();
+}
+
+// 场景2：查找函数返回NULL未检查
+void UseFoundItem()
+{
+    Item* item = FindItem(id);  // 可能返回nullptr（未找到）
+    item->Update();  // 错误：未检查item是否为nullptr
+}
+
+// 场景3：分配函数返回NULL未检查
+void AllocateResource()
+{
+    Resource* res = AllocateResource();  // 可能返回nullptr（分配失败）
+    res->Use();  // 错误：未检查res是否为nullptr
+}
+
+// 场景4：获取器函数返回NULL未检查
+void AccessMember()
+{
+    Member* member = obj.GetMember();  // 可能返回nullptr
+    member->SetValue(100);  // 错误：未检查member是否为nullptr
+}
+
+// 场景5：智能指针get()后未检查
+void UseSmartPointer()
+{
+    std::shared_ptr<Data> ptr = GetData();
+    Data* raw = ptr.get();  // ptr可能为空，raw为nullptr
+    raw->Process();  // 错误：未检查raw是否为nullptr
+}
+
+// 场景6：链式调用返回NULL
+void ChainAccess()
+{
+    Node* node = GetRootNode();  // 可能返回nullptr
+    node->GetNext()->GetValue();  // 错误：node或GetNext可能返回nullptr
+}
+```
+
+### ✅ 修复方案
+
+```cpp
+// 修复场景1：工厂函数返回值检查
+void ProcessObject()
+{
+    Object* obj = CreateObject();
+    if (obj == nullptr) {  // 正确：检查返回值
+        LOGE("CreateObject failed");
+        return;
+    }
+    obj->Initialize();
+    obj->Process();
+}
+
+// 修复场景2：查找函数返回值检查
+void UseFoundItem()
+{
+    Item* item = FindItem(id);
+    if (item == nullptr) {  // 正确：检查返回值
+        LOGE("Item not found: %d", id);
+        return;
+    }
+    item->Update();
+}
+
+// 修复场景3：分配函数返回值检查
+void AllocateResource()
+{
+    Resource* res = AllocateResource();
+    if (res == nullptr) {  // 正确：检查返回值
+        LOGE("AllocateResource failed");
+        return;
+    }
+    res->Use();
+}
+
+// 修复场景4：获取器函数返回值检查
+void AccessMember()
+{
+    Member* member = obj.GetMember();
+    if (member == nullptr) {  // 正确：检查返回值
+        LOGE("GetMember returned nullptr");
+        return;
+    }
+    member->SetValue(100);
+}
+
+// 修复场景5：智能指针直接使用或检查
+void UseSmartPointer()
+{
+    std::shared_ptr<Data> ptr = GetData();
+    if (!ptr) {  // 正确：检查智能指针
+        LOGE("GetData returned empty");
+        return;
+    }
+    ptr->Process();  // 直接使用智能指针，无需get()
+}
+
+// 修复场景6：链式调用逐级检查
+void ChainAccess()
+{
+    Node* node = GetRootNode();
+    if (node == nullptr) {  // 正确：检查第一级
+        LOGE("GetRootNode returned nullptr");
+        return;
+    }
+    
+    Node* next = node->GetNext();
+    if (next == nullptr) {  // 正确：检查第二级
+        LOGE("GetNext returned nullptr");
+        return;
+    }
+    
+    next->GetValue();
+}
+
+// 修复场景7：使用智能指针代替裸指针
+void UseSmartPointerSafe()
+{
+    std::unique_ptr<Object> obj = CreateObjectUnique();  // 使用智能指针版本
+    if (!obj) {
+        return;
+    }
+    obj->Initialize();  // 安全：智能指针管理
+}
+```
+
+## 检测范围
+
+检查以下模式：
+
+- 工厂函数（Create、New、Make）返回指针未检查
+- 查找函数（Find、Get、Lookup）返回指针未检查
+- 分配函数（Allocate、Acquire）返回指针未检查
+- 获取器函数（GetMember、GetData）返回指针未检查
+- 智能指针get()后裸指针未检查
+- 链式调用中每一级返回指针未检查
+
+## 检测要点
+
+1. 识别函数返回类型为指针（Type*）
+2. 检查函数名特征（Create、Find、Get、Allocate等）
+3. 检查调用后是否有判空操作（if ptr == nullptr）
+4. 检查是否在判空前有解引用操作
+5. 排除已知不会返回nullptr的函数（如成员函数返回this）
+6. 排除NOPROTECT标记
+
+## 风险流分析（RiskFlow）
+
+- **RISK_SOURCE**：返回指针类型的函数
+- **RISK_TYPE**：空指针解引用
+- **RISK_PATH**：函数返回nullptr -> 未检查返回值 -> 直接解引用 -> 空指针崩溃
+- **IMPACT_POINT**：程序崩溃、服务中断
+
+## 影响分析（ImpactAnalysis）
+
+- **Trigger**：函数返回nullptr（表示错误或特殊情况）
+- **Propagation**：调用方未检查，直接解引用nullptr指针
+- **Consequence**：空指针解引用导致程序崩溃（SIGSEGV）
+- **Mitigation**：所有指针返回值必须判空后使用，或使用智能指针
+
+## 误报排除
+
+| 场景 | 识别特征 | 处理方式 |
+|------|----------|----------|
+| 已判空 | 有 if (ptr == nullptr) 检查 | 不报 |
+| 智能指针直接用 | shared_ptr/unique_ptr->method() | 不报 |
+| 成员函数返回this | return this 或 return *this | 不报 |
+| 已知安全函数 | 函数注释保证不返回nullptr | 上下文分析 |
+| NOPROTECT标记 | // NOPROTECT 注释 | 不报 |
+| 测试代码 | 文件名包含 _test.cpp | 白名单排除 |
+## 测试用例
+
+### 触发用例（应该报）
+
+```cpp
+// test_MemoryStability_007_trigger.cpp
+void trigger_bad_1()
+{
+    Object* obj = CreateObject();  // 应该报：返回指针未检查
+    obj->Initialize();
+}
+
+void trigger_bad_2()
+{
+    Item* item = FindItem(id);  // 应该报：返回指针未检查
+    item->Update();
+}
+
+void trigger_bad_3()
+{
+    std::shared_ptr<Data> ptr = GetData();
+    Data* raw = ptr.get();
+    raw->Process();  // 应该报：智能指针get()后未检查
+}
+
+void trigger_bad_4()
+{
+    Node* node = GetRootNode();  // 应该报：链式调用未逐级检查
+    node->GetNext()->GetValue();
+}
+```
+
+### 安全用例（不应该报）
+
+```cpp
+// test_MemoryStability_007_safe.cpp
+void safe_good_1()
+{
+    Object* obj = CreateObject();
+    if (obj == nullptr) {  // 安全：有判空检查
+        return;
+    }
+    obj->Initialize();
+}
+
+void safe_good_2()
+{
+    std::shared_ptr<Data> ptr = GetData();
+    if (!ptr) {  // 安全：智能指针判空
+        return;
+    }
+    ptr->Process();
+}
+
+void safe_good_3()
+{
+    Object* obj = CreateObject();
+    if (obj) {  // 安全：if条件中判空
+        obj->Initialize();
+    }
+}
+
+void safe_good_4()
+{
+    Node* node = GetRootNode();
+    if (node == nullptr) {  // 安全：第一级检查
+        return;
+    }
+    Node* next = node->GetNext();
+    if (next == nullptr) {  // 安全：第二级检查
+        return;
+    }
+    next->GetValue();
+}
+
+// NOPROTECT: 特殊场景
+void noprotect_case()
+{
+    Object* obj = CreateObject();
+    obj->Initialize();  // NOPROTECT标记，不报
+}
+```

package/references/PROBLEM_TEMPLATE.md

@@ -0,0 +1,65 @@
+# 检出问题格式模板
+
+本文档定义了稳定性代码检视报告中每个检出问题的标准格式。
+
+## 问题格式规范
+
+每个检出的问题**必须**包含以下完整信息：
+
+#### 问题 `<序号>` : `<问题标题>`
+
+**分类**: `<分类名称>`  
+**规则**: `<规则ID> - <规则名称> - <严重程度>`  
+**位置**: `<文件相对路径>:<问题代码关键行号>`  
+**函数**: `<类名>::<函数名>` 或 `<命名空间>::<函数名>` 或 `<函数名>`  
+
+**关键源码片段**:  
+```cpp
+`<起始行号> | <代码行1>`
+`<起始行号+1> | <代码行2>`
+`...` (省略非必要代码)
+`<关键行号> | <问题代码行>`
+`...` (省略非必要代码)
+`<结束行号> | <代码行n>`
+```
+
+**问题描述**:  
+`<问题详细描述，说明违反了什么规则，存在什么风险>`
+
+**风险流分析（RiskFlow）**:  
+```
+风险来源: `<风险如何产生>`
+    ↓
+传播路径: `<风险如何传播>`
+    ↓
+影响点: `<风险在何处造成影响>`
+```
+
+**影响分析 (ImpactAnalysis)**:  
+```
+触发条件: `<什么条件下会触发问题>`
+    ↓
+传播方式: `<问题如何扩散>`
+    ↓
+后果: `<问题造成的稳定性影响>`
+```
+
+**修复建议**:  
+`<修复建议描述>`
+```cpp
+`<起始行号> | <修复后的代码行1>`
+`<起始行号+1> | <修复后的代码行2>`
+`...` (省略非必要代码)
+`<关键行号> | <修复后的问题代码行>`
+`...` (省略非必要代码)
+`<结束行号> | <修复后的代码行n>`
+```
+
+## 注意事项
+
+1. **代码片段完整性**：提取的代码片段应包含足够的上下文，便于理解问题
+2. **行号格式规范**：代码行号采用 `行号 | 代码内容` 格式，保持竖线对齐
+3. **省略号使用**：使用 `...` 省略非必要的代码行，仅保留问题相关的关键上下文
+4. **问题描述清晰**：说明违反的规则、存在的风险、潜在影响
+5. **风险流分析完整**：从风险来源到影响点，完整描述传播链路
+6. **修复建议可行**：提供具体的修复方案和代码示例，确保可落地执行