使用infer进行静态分析总结

infer的安装

• 直接通过Homebrew进行安装

brew install infer

• 通过源码进行安装，可以参考GitHub上的说明

使用infer过程中遇到的问题及解决方案

问题1

• 问题描述

# 直接分析我这里没有成功
infer run --skip-analysis-in-path Pods --no-xcpretty --keep-going -- xcodebuild -workspace xxxx.xcworkspace -scheme xxxx -configuration Debug -sdk iphoneos

# 使用上述分析命令会有编译失败的问题（已脱敏）
** BUILD FAILED **

The following build commands failed:
    这一段省略了...
(8 failures)
Internal Error:   /usr/local/Cellar/infer/0.17.0/lib/infer/infer/bin/../lib/python/infer.py
  -j 8 --project-root /Users/xxx/Desktop/Code/xxx-iOS/xxx --out
  /Users/xxx/Desktop/Code/xxx-iOS/xxx/infer-out -- xcodebuild
  -workspace xxx.xcworkspace -scheme xxx -configuration Debug -sdk
  iphoneos:
  exited with code 65
Error backtrace:
Raised at file "string.ml", line 145, characters 16-31
Called from file "string.ml" (inlined), line 149, characters 17-46
Called from file "src/string.ml", line 407, characters 12-33
Called from file "src/string.ml", line 416, characters 11-33
Re-raised at file "base/Die.ml", line 26, characters 8-56
Called from file "integration/Driver.ml", line 171, characters 2-16
Called from file "integration/Driver.ml", line 272, characters 6-409
Called from file "integration/Driver.ml", line 323, characters 2-29
Called from file "base/Utils.ml", line 398, characters 16-20
Called from file "scuba/ScubaLogging.ml", line 66, characters 29-44
Called from file "infer.ml", line 20, characters 2-36
Called from file "base/Utils.ml", line 398, characters 16-20
Called from file "scuba/ScubaLogging.ml", line 66, characters 29-44
Called from file "infer.ml", line 137, characters 8-54

• 解决办法：编译数据生成compile_commands.json文件，再对生成的数据文件进行分析，官方文档中也有说明The most robust way is to generate a compilation database, then pass that database to Infer，后面会给出完整命令，继续往下看

问题2

• 问题描述

Error message:
clang-8: error: unknown argument: '-index-store-path'

*** Infer needs a working compilation command to run.

• clang-8: error: unknown argument: '-index-store-path'错误
  • 分析：由于从Xcode 9.0开始将-index-store-path参数添加到构建命令中。而infer所依赖的clang还不支持此参数。在项目Build Setting中搜索index并将Enable Index-While-Building Functionality选项设置为NO

  • 主工程设置如下图

    
    
    1.jpg

  • Pods工程设置如下图

    
    
    2.jpg
• Infer needs a working compilation command to run.错误
  • 解决方案：在分析命令中添加--no-xcpretty
• 在分析过程中由于一些错误会中断分析，可以在分析命令中添加--keep-going参数来忽略这些错误，继续分析

使用infer进行项目分析

• 未使用Pods工程的项目比较简单，命令如下

infer run -- xcodebuild -target  -configuration  -sdk iphoneos

• 使用了Pods工程的项目

# 进入项目根目录
cd projectRootMenu

# infer默认是增量编译，只会分析变动的代码，如果我们想整体编译的话，需要clean一下项目
xcodebuild clean
或者
xcodebuild -workspace xxx.xcworkspace -scheme xxx -sdk iphoneos clean

# 可以通过如下命令查看-sdk版本，如果使用iphoneos需要**检查证书**
xcodebuild -showsdks

# 分析项目命令步骤如下
# 第1步：编译工程生成编译日志xcodebuild.log文件
xcodebuild -workspace xxx.xcworkspace -scheme xxx -configuration Debug -sdk iphoneos COMPILER_INDEX_STORE_ENABLE=NO | tee xcodebuild.log
# 第2步：根据编译日志生成编译数据compile_commands.json文件
xcpretty -r json-compilation-database -o compile_commands.json < xcodebuild.log > /dev/null
# 第3步：基于编译数据compile_commands.json文件进行静态分析
infer run --skip-analysis-in-path Pods --no-xcpretty --keep-going --compilation-database-escaped compile_commands.json

infer检测的错误类型说明

• RESOURCE_LEAK资源泄漏
  • 此问题在Java/C/OC都存在，资源代表文件、sockets连接等，使用后需要关闭
• MEMORY_LEAK内存泄漏
  • 项目代码全面启动了ARC进行内存管理，在OC层没有扫描出内存泄露。目前扫描出的内存泄露问题都是使用了malloc或者ralloc等c语言内存申请函数，在函数提前return前没有及时free
• Retain cycle内存死锁只存在OC中，A 创造B，B也创造了A，然后你等我，我等你，都无法释放
• NULL_DEREFERENCE空指针的错误
  • 传参为0的情况下。例如代码中，在调用showAlertViewA()时，将tag传参为0，infer检测此处传0，判断为一个NULL空指针，所以爆出警告。这里可以理解为误报，不会出现问题。
  • 通过malloc、calloc、realloc等函数申请内存，当内存不足时，有可能会在该函数中返回NULL，如果没有做NULL的判断，则infer会警告
  • 在创建NSArray或者NSDictionary时，传入的参数有可能会nil。由于NSArray与NSDictionary不接受空指针，所以在对其addObject或者setObject:forKey: 时需要进行判断一下是否为nil
  • 当一个对象声明后，没有初始化，就被引用了，这个时候会报空指针错误。
• ASSIGN_POINTER_WARNING
  • 由于在mrc时代，没有weak指针，所以一些view的属性声明是__unsafe__unretain__的形式，在arc中，这个属性被判断为assign，需要将其修改为weak或者strong
• DIRECT_ATOMIC_PROPERTY_ACCESS
  • 在代码中使用了使用了一个atomic的成员变量，infer建议我们将atomic修改为nonatomic。由于OC中，属性会被默认设置为atomic属性，我们需要显示将属性声明为nonatomic。
• IVAR_NOT_NULL_CHECKED
  • 在代码中调用block，运行代码时，没有做判空处理。即需要改动为，if(block){block()}
• BAD_POINTER_COMPARISON
  • 没有判断一个NSNumber类型的对象是不是空？
• TAINTED_VALUE_REACHING_SENSITIVE_FUNCTION
  • 代码中使用了cookie的value。可以理解为误报
• PARAMETER_NOT_NULL_CHECKED
  • 传参时没有判断是否为null，加一次判断就可以了
• STRONG_DELEGATE_WARNING
  • 将一个delegate属性设置为strong的类型。
• PREMATURE_NIL_TERMINATION_ARGUMENT
  • 没有判断是否为空
• REGISTERED_OBSERVER_BEING_DEALLOCATED
  • 创建一个对象后，监听了某些通知，但是没有在dealloc中释放该通知。项目中出现这种问题的类，基本都是单例，不会被销毁。
• UNSAFE_CALL_TO_OPTIONAL_METHOD
  • This is a call to an @optional protocol method. Calling it without checking if its implemented
• DEAD_STORE
  • 未使用的变量
• UNINITIALIZED_VALUE
  • 值未初始化
• POINTER_TO_CONST_OBJC_CLASS
  • const错误用法
• RETAIN_CYCLE
  • 循环引用

参考资料

• iOS开发-代码分析工具之Infer
• infer官方文档
• infer官方中文文档
• clang-8: error: unknown argument: '-index-store-path'
• Infer bug types
• iOS开发之使用 infer静态代码扫描工具
• infer代码扫描工具详解