如何用Xcode检测macOS上的命令行应用的内存泄漏

对于大部分开发者而言，Mac是个好东西，而对于许多C语言、汇编语言开发者而言，Xcode则是个非常棒的IDE！用Xcode编写、调试C语言以及汇编语言代码不仅爽、支持完整的GNU11语法，而且效率也高。不过Xcode+Apple LLVM目前唯一不足的就是快速查询内存泄漏。

对于macOS、iOS App开发者而言，平时我们都会通过Profile（Instruments）中的Leaks工具来探测内存泄漏情况，此工具确实也非常好用，网上也有不少相关文章介绍使用方法。不过，如果我们有时要测试一些算法，要检测其是否有内存泄漏的话，单独创建一个桌面应用进行检测的话就显得太过复杂了，我们是否有办法通过创建一个命令行应用进行内存泄漏检测呢？方法是有的。不过macOS上的这个技术在国内网站上介绍很少，所以我专门收集了一些资料，然后经过一些实验整理成本篇博文供大家参考。

顺便说一句，在Windows系统上，通过使用MSVC自带的crtdbg库可以很轻松地查看内存泄漏情况；而在Linux系统下，则可以通过GCC或Clang自带的LeakSanitizer工具既能很轻松地查看程序内存泄漏的情况（只需要添加-fsanitize=address编译选项）。而在macOS中，事情则没那么简单。Apple提供了两套工具可以让我们检测指定应用的内存泄漏情况，一个是leaks，还有一个是malloc_history，这两者需要结合起来用才能查看到内存泄漏的具体信息。下面我们将具体介绍。

首先，我们用Xcode创建一个基于C语言的控制台应用，我这里将项目名起为“MyCTest”，项目工程的编译选项用默认的即可，或者也可以根据自己的喜好进行设定，这个没啥影响。

然后，我们点击左上角的项目名Icon以设置活跃方案（Set the active scheme），如下图所示：

进入到方案界面之后，我们点击最右边的选项卡“Diagnostics”，如果我们要监测内存泄漏，则必须勾选上“Guard Malloc”，以及“Malloc Stack”，其他可根据自己的需求进行勾选，如下图所示：

完成后点击“Close”按钮退出，我们再进入代码编辑界面，输入以下所示的测试代码。然后在最后return 0;语句处设置断点，我们查看打印日志信息，可以看到GuardMalloc工具所打印出来的一些信息。其中，项目名后面的数字即表示当前所运行程序的进程ID。我们在下一步使用leaks工具时需要这个进程ID号，因此这里可以先复制一下。

接着，我们打开“终端”（terminal），然后先使用leaks工具检测指定进程的发生内存泄漏的地址。比如，上图中所示的ID进程号为“2295”，因此我们直接在控制台输入：leaks 2295即可。然后控制台终端上会打印出许多信息，我们不用怕，直接滚到最上面，直到看到下图所示的信息：

上图中，红框框出来的就是发生泄漏的原始地址。各位这里要注意的是，leaks工具所给出的是发生泄漏的原先的那个地址，而不是后分配而引发泄漏的那个地址。另外，由于记录内存分配的信息是栈式压入的，因此最上面的地址是最后一个检测到的内存泄漏的原先分配地址；而最下面的则是第一个被检测到的原先分配地址。

最后，我们鼠标右键点击Dock上的“终端”，然后选择“新建窗口”，另外开启一个控制台窗口。然后在这里我们开始使用malloc_history工具来定位内存泄漏所发生的源文件以及行号，如下图所示：

这里，malloc_history后面至少需要跟两个参数，第一个是进城ID号，第二个是具体的地址。然后我们就能看到具体的引发当前指定地址内存泄漏的源文件与行号了。

最后这里还需提醒各位，尽管在项目活跃方案的“Diagnostics”中我们看到了运行时的Address Sanitizer选项，但当前的macOS并不支持。

最后再给出一些我参考的文章链接：

1. Finding Memory Leaks
2. libgmalloc(3) [osx man page]
3. Using malloc to Debug Memory Misuse in Cocoa