Xcodeの静的アナライザ

※ソースコードの整形表示を行うWPのプラグインの負荷が大きかったため、プラグインを使わずにテキストにしています。そのため、表示が崩れてしまっています(インデントがない)。ソースをよく見たい方は一度、コピーしてテキストエディタで整形してご覧ください。
Xcode 3.2では、静的アナライザが入りました。現時点ではObjective-CのコードとCのコードのみに対応しているようですが、ビルド時にメモリーリークを検出できるような雰囲気なので試してみました。
まずはこんな感じの100%リークするコードをわざと書いて検出できるのか試してみました。

int main (int argc, const char * argv[]) {
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    char* m = malloc(10);
    strcpy(m, "abc");
    NSLog(@"%s", m);
    NSString* s = [[NSString alloc] initWithString:@"abc"];
    NSLog(@"%@", s);
    [pool drain];
    return 0;
}

使ってみる

まずは普通にビルドしてみました。ワーニングもなく普通にビルドされました。

次に静的アナライザを使用してビルドしてみました。これにはビルドメニューの「Build and Analyze」を選択します。すると、次のような表示が出ました。
Xcode 静的アナライザの実行結果1
さらに表示された警告のところをクリックしてみるとさらに詳細が表示されました。
Xcode静的アナライザ実行結果2
わかりやすく検出されたリークについて表示されていますが、問題があります。mallocの方のリークが検出されていないです。Objective-Cの方が検出されたのはうれしいですが、こっちはガーベジコレクタもあるしな。。。と、思ったのですが、iPhoneアプリでは現時点ではガーベジコレクタは使えないので、必要だなと思い直しました。
普通にビルドして静的アナライザが働くようにするには「ビルド設定」で「静的アナライザを実行」にチェックを入れます。Appleのサイトの説明ではカスタム設定を作って分けています。これはおそらく、メモリーリークだけではなく、他のものも表示されるので必要な時に限定した方がよいということなのかもしれませんね。
Xcode静的アナライザを使用する
ただ、このテストコードはあまりにも単純すぎたので、もう少しだけクッションを入れてためしてみました。

#import
static NSString* getName()
{
    return [[NSString alloc] initWithString:@"Test"];
}
int main (int argc, const char * argv[]) {
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* s = getName();
    NSLog(@"%@", s);

    [pool drain];
    return 0;
}

リークしているのは、同じくNSStringクラスのインスタンス。getName関数の戻り値がリークしています。しかし、これは検出されませんでした。
C言語の関数の戻り値は検出できないのかもしれないと思い、次は、Objective-Cのメソッドの戻り値のリークを検出できるか試してみました。コードは次のようなもの。

@interface MyObject : NSObject
    - (NSString*)name;
@end
@implementation MyObject

- (NSString*)name
{
    return [[NSString alloc] initWithString:@"Test"];
}

@end

int main (int argc, const char * argv[]) {
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    MyObject* myObj = [[[MyObject alloc] init] autorelease];

    NSString* s = [myObj name];
    NSLog(@"%@", s);

    [pool drain];
    return 0;
}
このコードに対して実行すると、ちゃんと「name」メソッドの戻り値がリークするかもしれないということが検出されました。

Xcode静的アナライザ実行結果3
それならばということで、少し意地悪なことをしてみました。戻されたNSStringのインスタンスを呼び出し側で解放して、リークしないコードにして、実行してみました。すると、次のように表示されました。
Xcode静的アナライザ実行結果4
戻り値の解放に対して警告されてしまいました。通常のObjective-Cのコードであれば、確かに戻り値はautoreleaseされるものとして扱われるので当然ですが、リークしているメソッドの中身までチェックしません。 メソッド側も先ほど同じ警告が出ています。この辺は静的に行うチェックの限界かもしれません。

考察

少し試してみた感じでは、次のような感触を得ました。

  • リーク検出ではなく、リークの可能性を検出するというスタンスである。
  • 基本的に、メソッド単位でのコードの危険性を検出する。つまり、戻り値はautorelaeseされるべきであり、そのメソッド内で、allocやretain、copyしたもの以外はreleaseするべきではない。
  • C言語の関数の戻り値はリーク危険性の検出対象にならない。
  • あくまで静的分析であるので、実行時の挙動の違いによる、間違いを分けることはできない。そのため、メソッド通しの組み合わせによるチェックまでは行わない。

やはり、プロファイルと同じで、カスタム設定で分けて利用する方がよいように私も思いました。現時点でも使った方がよい機能にはなっていますが、これからもっと進化してくれることに期待です。

参考

Mac OS X Reference Library : Static Analysis in Xcode
clang: a C language family frontend for LLVM
Xcodeの静的アナライザはclangの機能を使って実装しているようです。

著書紹介

Authored Books

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

Akira Hayashi (林 晃)のアバター Akira Hayashi (林 晃) Representative(代表), Software Engineer(ソフトウェアエンジニア)

アールケー開発代表。Appleプラットフォーム向けの開発を専門としているソフトウェアエンジニア。ソフトウェアの受託開発、技術書執筆、技術指導・セミナー講師。note, Medium, LinkedIn
-
Representative of RK Kaihatsu. Software Engineer Specializing in Development for the Apple Platform. Specializing in contract software development, technical writing, and serving as a tech workshop lecturer. note, Medium, LinkedIn

目次