关于c++:代码级质量技术之基本框架介绍

作者 | CQT& 星云团队

一、背景

代码级品质技术：顾名思义为了服务质量更好，波及到代码层面的相干技术，特地要指出的是，代码级品质技术不单纯指代码召回技术，如动态代码扫描、单元测试等。

钻研代码级品质技术次要有以下几个方面的起因：

1、随着精准测试等概念的衰亡，对代码覆盖率的依赖逐步减轻，代码插桩的性能、准确性、时效性等都成为业界要解决的难题；

2、随着智能化，尤其是基于危险驱动的测试倒退，对代码的了解须要失去冲破，能力更好的从代码实现中开掘危险、判断危险；

3、在黑盒级别的测试，品质工作者往往是通过对象的返回或外在表象观测对下的异样体现进而发现问题，然而其实可能很多潜在的异样并没有到“肉眼”可观测到的级别而导致问题漏出，这时候就须要有更多的对象更细的运行数据来供品质工作者剖析去发现问题的蛛丝马迹，诸如：内存泄露、性能好转等，所以业界有很多 prof、火焰图、asan 等偏白盒动静检测问题的技术呈现；

4、代码作为产生理论问题最前沿的阵地，大部分问题都能够归因到某段代码不合理，如果能够在代码级别间接召回问题，无论从仿真复杂度、修复老本、定位老本等均会失去极大改善；

5、代码是工程师交换的舞台，通过对代码级品质技术的钻研和标准，能够促成代码更加的具备鲁棒性和更优质的设计如单测晋升可测性等，也能够促成品质保障人员对代码加深掌控与了解，进而在品质保障各类场合施展关键作用。

从领导品质行为、极大晋升召回问题能力、加强代码鲁棒性、晋升人员对代码的掌控力等多个方面，都能够看出代码级品质技术的要害且不可代替作用，百度品质效力平台于 2019 年开始关注和投入该方向，在代码了解、代码探针、代码品质技术利用等多个层级多方面进行摸索和落地，接下来的文章中会顺次为大家介绍。

二、代码级品质技术架构

要了解代码级品质技术的原理和后续的次要利用场景，首先要了解代码从语言到可执行态的根本过程，上面以 C ++ 为例说下根本过程：

C++ 从代码到可执行 bin 文件，次要分为四个阶段：预处理、编译、汇编和链接。

预处理 ：解决一些 #号定义的命令或语句（如#define、#include、#ifdef 等），生成.i 文件；

编译 ：进行词法剖析、语法分析和语义剖析等，生成.s 的汇编文件，大家相熟的 AST 形象语法树就在该过程产生；

汇编 ：将对应的汇编指令翻译成机器指令，生成二进制.o 指标文件；

链接 ：链接分为两种，动态链接：将动态链接库中的内容间接装填到可执行程序中；动静链接：只在可执行程序中记录与动态链接库中共享对象的映射信息。

代码级品质技术的技术原理，次要是获取到该过程的代码片段数据或植入对应的指标代码，来达到对应的品质指标，如获取片段数据能够用来了解代码判断危险，能够用来指结构化代码构造，供主动生成单元测试和代码检测提供根底数据；如植入对应指标代码，能够用来做插桩（即覆盖率采集）或动态数据采集等。

基于上述介绍与了解，咱们把代码级品质技术划分大范畴为两个档次，两个档次内蕴含多个档次，如下图所示：

大档次一 ：代码了解，CodeC（Code Comprehend）：偏底层技术，基于底层 AST 等能力、剖析出代码的个性（AST、调用链、依赖等）和危险度，通过 API、SDK 等形式对外提供根底服务

• 存储层：次要用来代码编译过程的根底数据和对应的数据存储选型调优等，在这个过程次要难点在于根底工具的选型和过程性能的调优，以达到能够在业务利用的指标；
• 剖析层：剖析层是依靠根底的数据，依据特定的要求，对数据进行结构化的建模，如函数调用链、依赖关系等，做好根底的剖析供下层利用；
• 模型层：用于通过剖析层和根底数据，去训练代码存在的潜在危险或危险偏差（性能问题突出等）；
• API 层：通过 API、SDK 等形式对外提供根底服务。

该层会遇到泛滥技术挑战，如要适配不同语言的解析器、编译过程；根底框架进行代码调优；剖析过程数据缺失修复等，是一项十分粗疏且有技术挑战的工作，当然咱们在该过程也会摸索出一些技术教训供大家参考。

大档次二 ：代码级品质技术利用，Codeπ：次要是依靠代码了解的过程或产出，植入对应的信息，以达到对应的品质指标，这个档次利用场景是要害，因而咱们是以解决问题的指标为导向，对该档次进行细分，所以指标或利用场景的不同会使得该档次的分类会一直减少，目前分为以下四类：

• CodeQ（Code Quality）: 与召回问题相干（智能 UT、基于规定的代码缺点检测、基于 AI 的代码缺点检测、火焰图、ASAN 等在个分类）；
• CodeP（Code Probe）：与动静插桩相干（ccover、covtool、jacoco、gocov 等在这层），次要是往代码外面植入探针获取运行行为数据；
• CodeH（Code Health）：评估代码衰弱度（相似 sonarcube 等）、代码危险度评估用于决策后续的品质行为；
• CodeDL(Code defect location)：代码缺点定位。

上面的章节咱们会散布从第二级的档次，为大家做基本原理和过程介绍，后续还会有系列发文再深刻的介绍对应实现内容。

三、代码了解层介绍

代码了解是一个以软件程序为对象，对其外部的运作流程进行剖析，获取相干的常识信息，这些信息能够用于软件开发、软件测试、软件维护等各个阶段，旨在对程序进行性能优化和正确性验证。代码了解罕用的剖析方向有动态剖析、动态分析、非源码剖析 3 类，然而随着 LLM 大模型的倒退，咱们也正在钻研模型在代码了解畛域的冲破与利用。

动态剖析 ：是指在不运行代码的形式下，通过词法剖析、语法分析、控制流、数据流剖析等技术对程序代码进行扫描，验证代码是否满足规范性、安全性、可靠性、可维护性等指标的一种代码剖析技术。

动态分析 ：软件系统在模仿的或实在的环境中执行之前、之中和之后，对软件系统行为的剖析。

非代码剖析 ：次要是对数据文件、配置文件等非源码文件和源码间进行关联剖析，当代码仓变更时，能感知变更内容对源码、性能的影响。

动态分析多为对程序进行的一些功能测试或性能测试等对程序的运行后果，资源应用状况的相干程序剖析工作。故本大节次要介绍动态程序剖析相干的代码了解技术，不对动静程序剖析做开展。

动态程序剖析在不执行程序程序的状况下对程序进行剖析，剖析的对象能够是针对特定版本的源代码或者二进制文件，通过词法剖析、语法分析、控制流、数据流剖析等技术对程序代码进行扫描，依据不同的剖析指标，失去对应的剖析后果。在学术界和工业界次要利用在软件平安畛域，验证代码是否满足规范性、安全性、可靠性、可维护性；在百度外部，除破绽检测外，动态程序剖析还包含多维度的代码剖析和度量伎俩，在交付零碎和监测零碎中被宽泛应用。

业界动态剖析个别基于以下 4 种形式开展：

• 关键字匹配，基于正则表达式剖析
• 基于 AST 的代码剖析，联合正则表达式和关键字能力
• 长处：联合语法和语义，能够引入作用域等更多概念，更精确。
• 毛病：无奈应答所有场景，另外，基于 AST 来剖析失去的数据流，疏忽了分支、跳转、循环等影响执行过程程序的条件，短少控制流信息。
• 基于 IR/CFG 的代码剖析等自制的两头语言数据结构剖析
• 属于以后比拟支流的代码剖析计划，例如被源伞，实现了多种语言生成对立的 IR，这样一来对于新语言的扫描反对难度就变得大大减少。
• IR：是一种相似于汇编语言的线性代码，其中各个指令依照程序执行。其中当初支流的 IR 是三地址码（四元组），例如 llvm 的 IR。
• CFG：（Control flow graph）控制流图，在程序中最简略的控制流单位是一个基本块，在 CFG 中，每一个节点代表一个基本块，每一个边代表一个可控的管制转移，整个 CFG 代表了整个代码的的管制流程图。基于 IR 来生成失去 CFG。
• 基于 QL（Query Language）剖析
• 例如 codeQL，把源代码转化成一个可查问的数据库，通过 对源代码工程进行要害信息剖析提取，形成一个关系型数据库。安全漏洞、Bug 和其余谬误被建模为可针对从代码中提取的数据库执行的查问。

罕用的动态程序剖析技术：

• 数据流剖析
• 数据流剖析收集程序运行到不同地位时各个值的信息和它们随工夫变动的信息。污点测验是一个典型的通过数据流剖析进行程序危险检测的例子，它会找到所有的可能被使用者批改的变量（也就是有“污点”、不平安的变量），并阻止这些变量在被修复安全漏洞前被应用。
• 控制流剖析
• 用于剖析程序控制流构造的动态剖析技术，目标在于生成程序的控制流图，在污点剖析、编译器设计、程序剖析、程序了解等畛域都有重要利用。
• 指针剖析
• 指针剖析次要用于剖析指针所有可能指向的对象，它会剖析出一个指针所指向的内存地位和所对应的对象。能够用于调用剖析、代码优化、Bug 追究、安全性剖析与验证测试。

四、代码级利用之探针

代码探针 ，也是插桩技术，它是在保障被测程序原有逻辑完整性的根底上在程序中插入一些探针（又称为“探测仪”，实质上就是进行信息采集的代码段，能够是赋值语句或采集笼罩信息的函数调用），通过探针的执行并抛出程序运行的特色数据，通过对这些数据的剖析，能够取得程序的控制流和数据流信息，进而失去逻辑笼罩等动静信息，从而实现测试目标的办法。

不同语言的插桩技术有所不同，常见的技术有：ccover、covtool、jacoco、gocov。

CodeP 代码探针能够利用在: 代码监控（办法执行耗时等），代码剖析（函数、数据流的跟踪等），业务埋点。

除此之外， 代码探针最常见的场景是代码覆盖率采集。

4.1 覆盖率

代码覆盖率，是软件测试中的一种度量，形容程序中源代码被测试的比例和水平，所得比例称为代码覆盖率，剖析未笼罩局部的代码，从而反推在后期测试设计是否充沛，没有笼罩到的代码是否是测试设计的盲点。覆盖率统计的分类蕴含:

行覆盖率 ：行覆盖率是最根本的指标，示意是否代码中的每个可执行语句都被执行过；

分支覆盖率 ：分支笼罩应用一组测试参数来测试是否代码中所有的分支都能被测试到了；

门路覆盖率 ：对包含所有分支在内的所有的门路都能测试一遍，这就是门路笼罩；

变更行覆盖率 ：上一次公布代码后更新的代码的行覆盖率，这个数据能够不便的看出新的代码是否做了测试。

覆盖率的业务应用场景宽泛比方 ：RD 自测、RD 准入、QA 准出、外包评估、精准测试、集成测试、基线降级评估、灰度测试评估，自动化测试能力评估、众测等。

代码探针实现覆盖率统计的步骤如下:

1、辨认待插桩的函数

2、用 codep 技术对函数进行插桩，插桩技术分为:

• 源码插桩: 侵入式的在源代码的根底上替换或者插入另外一些代码
• 编译过程插桩: 在字节码文件中写入桩函数（如 asm、javassit 等技术）

3、探针采集笼罩信息整合, 统计覆盖率数据

五、代码级利用之召回

从召回异样问题的角度介绍两类代码级技术利用：智能 UT、SA。与现有异样测试方法进行比照剖析，压力测试、功能测试依赖编译运行且需人工结构异样场景，存在高老本、低召回的问题。而智能 UT 和 SA 基于白盒剖析产出的数据能够提前、疾速、低成本、轻量级地召回异样问题。

5.1 智能 UT

单元测试（unit testing），是指对软件中的最小可测试单元进行检查和验证，这里的最小测试单元是指函数或者类。在问题召回层面，UT 针对最小单元进行测试，结构数据简略、易于验证正确性，便于后续性能的回归，可能更早地发现问题，定位和解决问题成本低。

传统 UT 依赖开发人员人工编写单测代码来进行测试，存在开发成本高、依赖人的意识等毛病。基于单测的基本原理衍生出了智能 UT 工具。智能 UT 通过主动的剖析函数和随机的结构测试数据，可主动生成异样单元测试代码，生成的代码能够间接用于单元测试工作，单元测试运行后，智能 UT 工具能剖析代码中存在的稳定性问题。

如下图展现，智能 UT 建设的次要思路是将一个开发人员编写单元测试代码的过程进行拆解，将整个过程形象为确认待测试函数 -> 剖析代码 -> 结构测试数据 -> 生成测试代码四个步骤，利用白盒数据和一系列算法模仿上述单测代码生成的过程从而主动地生成异样单元测试代码并利用于单元测试工作。

△UT 与智能 UT 过程比照

5.2 SA- 基于规定的代码缺点检测

SA（static analysis）意为动态代码扫描，整个扫描过程无需编译运行，仅通过词法剖析，语法分析，语义剖析等技术对代码进行扫描，进而发现代码逻辑谬误和编程缺点。根据编程语言的本身个性，可将各类危险场景提取转化为通用的规定进行异样拦挡。现有 SA 查看是通过依赖代码剖析、基于通用的危险规定进行代码缺点查看的动态代码扫描工具，可召回例如空指针拜访、数组越界、除零等危险问题。

下图展现了基于规定的动态代码查看解决流程。

△SA 解决流程框架

长处 ：无需编译运行、资源耗费少，扫描剖析过程高度自动化、不依赖人力。

毛病 ：依赖后验常识、存在滞后性，依赖人开发规定、准召低、可持续性差。

此外在代码级畛域还有专门被测对象动静行为的检测技术，用于发现程序轻微的异样，比方业界罕用的火焰图、gprof、ASAN 等工具，就是在程序运行时收集程序体现数据，用于检测程序异样问题。

六、代码级利用之孤岛函数辨认

6.1 什么是孤岛函数

不被调用的函数被称为孤岛函数。如果一个函数已不再被调用，就成了无用的废除函数。

6.2 为什么要做孤独函数辨认

无用函数属于技术债治理的场景之一，无用代码的存在减少了软件开发、测试、以及问题排查的开销，例如 QA 和 RD 须要更多额定的精力来评估需要的影响范畴。

通过孤岛函数辨认的能力能够做无用代码和相干用例、配置、数据的清理，晋升代码可维护性，同时晋升问题的排查效率。

6.3 如何辨认孤岛函数

1、动态分析方法

原理：通过函数调用剖析，获取入度为 0 的函数，再联合不同语言个性，筛选出理论未被调用的函数。例如：c++ 语言中构造函数等非显式调用的函数、纯虚构函数等函数个性。

• 长处 ：执行速度快，开发成本低。
• 毛病 ：受限于不同语言个性，辨认准确率须要继续优化。例如：配置反射调用、多态个性下辨认准确率更低。

2、动态分析办法

原理：通过探针的形式，在程序运行时对函数调用栈进行记录，个别是基于抽样或者开关的形式来管制。

• 长处 ：辨认准确率相比动态分析方法要高。
• 毛病 ：代码侵入对性能有损，同时也受限于流量丰盛度，可能须要接入适配。

3、动静联合办法

将上述两种办法联合起来时应用，进行能力互补。

这篇文章更多的是从背景、构造和各个层的基本概念介绍了代码级品质技术的详情，接下来的文章将会在各个方面、各个层级进行开展，欢送大家关注和一起探讨。

———-  END  ———-

举荐浏览【技术加油站】系列：

基于 openfaas 托管脚本的实际

百度工程师挪动开发避坑指南——Swift 语言篇

百度工程师挪动开发避坑指南——内存透露篇

百度工程师教你玩转设计模式（装璜器模式）

揭秘百度智能测试在测试定位畛域实际

百度工程师教你玩转设计模式（适配器模式）