第 4 章 lint ソースコード検査プログラム

この章では、lint プログラムを使用して C のコードを検査し、コンパイルの失敗や、実行時に予期しない結果を招く可能性のあるエラーを見つける方法を説明します。多くの場合 lint は、コンパイラが必ずしも検出しない誤ったコード、エラーを起こしやすいコード、あるいは標準外コードについて警告を出します。

lint プログラムは C コンパイラにより生成されるすべてのエラーと警告のメッセージを表示します。さらに潜在的バグと移植上の問題に関する警告も表示します。多くの場合、lint から表示されたメッセージは、プログラムのサイズと必要な記憶領域を縮小し、全体の効率を改善する手助けとなります。

lint プログラムはコンパイラと同じロケールを使用し、lint の出力は stderr に送られます。型に基づく別名の明確化を実行する前に、lint を使用してコードをチェックする詳細と例については、「4.6.3 lint フィルタ」を参照してください。

4.1 基本 lint と拡張 lint

lint プログラムは次の 2 つのモードで動作します。

• 基本モード - デフォルトの lint プログラムです。

• 拡張モード - 基本 lint で実行される処理に加えて、さらに詳しい別のコード解析を行います。

基本 lint でも拡張 lint でも、ファイル全域 (ライブラリを含む) で矛盾した定義や使用を検出し、ファイルを個別に独立して処理する C コンパイラの不足を補います。特に大きなプロジェクト環境において 1 つの関数が何百ものモジュールで使用される場合、lint は、ほかの方法で探し出すことが困難なバグを発見するのに役立ちます。たとえば、期待しているよりも 1 つ少ない引数で呼び出された関数は、呼び出し時にプッシュされなかった値をスタックから取り出し、そのスタック位置のメモリーの状態によって正しい結果や間違った結果を返します。このような依存性やマシンアーキテクチャーへの依存性を検出することにより、lint はユーザー自身のマシンや別のマシンで実行されるコードを確かなものにすることができます。

拡張モードでは、lint は基本モードの場合よりさらに詳しい報告を出します。基本モードの lint には次の機能が含まれています。

• ソースプログラムの構造およびフロー解析

• 定数の伝播と定数式の評価

• 制御フローとデータフローの解析

• データ型使用状況の解析

拡張モードでは、lint は次の問題を検出することができます。

• 使用されていない #include 指令、変数、手続き

• 解放後のメモリー使用

• 使用されていない割り当て

• 初期化前の変数値の使用

• 割り当てられていないメモリーの解放

• 定数データセグメントへの書き込み時のポインタの使用

• 等しくないマクロの再定義

• 到達しないコード

• 共用体での値の型利用の適合性

• 実際の引数の暗黙の型変換

4.2 lint 使用方法

lint プログラムは、コマンド行から起動します。基本モードで lint を起動するには、次のコマンドを使用します。

% lint file1.c file2.c

拡張 lint は -Nlevel または -Ncheck オプションを使用して呼び出します。たとえば、次のようにして拡張 lint を起動できます。

% lint -Nlevel=3 file1.c file2.c

lint は、2 つのパスでコードの検査をします。lint は、最初のパスでは C ソースファイルに個別のエラー条件を、第 2 のパスでは C ソースファイル間の不整合を検査します。このプロセスは、lint が -c を指定して呼び出されていなければユーザーには見えません。

% lint -c file1.c file2.c

この場合の lint は、最初のパスのみを実行し、第 2 のパスに関連する情報、つまり file1.c と file2.c 間の定義および仕様の不一致に関する情報を file1.ln および file2.ln と名づけられた中間ファイルに収集します。

% ls
file1.c
file1.ln
file2.c
file2.ln

このように、lint の -c オプションは cc の -c オプションがコンパイラのリンク編集段階を抑制するのと同じように動作します。一般に、lint のコマンド行構文は cc コマンド行構文に従っています。

次のように .ln ファイルに lint を実行します。

% lint file1.ln file2.ln

この場合、第 2 のパスは実行されます。lint は、そのコマンド行の順番で .c または .ln ファイルをいくつでも処理します。次のようなコマンド行があります。

% lint file1.ln file2.ln file3.c

このコマンド行は、file3.c の内部のエラーと 3 つのファイルすべての整合性を検査するように lint に指令します。

lint は cc と同じ順序でインクルードヘッダーファイルのディレクトリを検索します。cc の -I オプションを使用するように、lint の -I オプションを使用できます。「2.16 インクルードファイルを指定する方法」を参照してください。

lint コマンド行には、複数のオプションを指定することができます。どのオプションも引数を取らず、複数の文字から成るオプションがない場合は、オプション文字を連結して指定することができます。

% lint -cp -Idir1 -Idir2 file1.c file2.c

このコマンドは lint に次のことを指示します。

• 第 1 のパスのみを実行する

• 移植性検査も実行する

• 指定されたディレクトリでインクルードするヘッダーファイルを検索する

lint にはオプションが数多くあります。これらのオプションを使うと、lint で特定の処理を実行し、特定の条件について報告することができます。

4.3 lint のオプション

lint プログラムは、静的なアナライザです。そのため、検出した依存性に関する実行時の結果を評価できません。たとえば、あまり重要ではない何百もの到達不可能な break 文を持ち、これについてユーザーがほとんど何もすることができないプログラムがあるとすると、lint はそれに忠実にフラグを立ててしまいます。この場合、lint のコマンド行オプションと指令 (ソーステキストに埋め込まれた特別のコメント) が役に立ちます。次にその例を示します。

• -b オプションを指定して lint を実行し、到達不可能な break 文に対するすべての警告を抑制することができます。

• 注釈 /*NOTREACHED*/ を到達不可能な文の前に付けて、その文に対する診断を抑制することができます。

lint のオプションを次にアルファベット順に説明します。いくつかの lint オプションは、lint 診断メッセージの抑制に関連しています。アルファベット順の説明のあと、表 4–8 にこれらのオプションとそれが抑制するメッセージの一覧を示します。拡張 lint を呼び出すオプションは -N で始まります。

lint は、-A、-D、-E、-g、-H、-O、-P、-U、-Xa、-Xc、-Xs、-Xt、-Y を含む多くの cc コマンド行オプションを認識しますが、-g と -O は無視します。認識されないオプションがあると警告が出され、そのオプションは無視されます。

4.3.1 -#

冗長モードをオンにし、呼び出すごとに各構成要素を表示します。

4.3.2 -###

呼び出すごとに各構成要素を表示しますが、実際には実行しません。

4.3.3 -a

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.4 -b

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.5 -C filename;

指定されたファイル名を持つ .ln ファイルを作成します。これらの .ln ファイルは lint の最初のパスだけで作成されます。filename; は絶対パス名でもかまいません。

4.3.6 -c

コマンド行で指定された .c ファイルごとに、lint の第 2 パスに関連する情報からなる .ln ファイルを作成します。第 2 パスは実行されません。

4.3.7 -dirout=dir

lint 出力ファイル (.ln ファイル) を入れるディレクトリを指定します。このオプションは -c オプションに影響を与えます。

4.3.8 -err=warn

-err=warn は -errwarn=%all のマクロです。「4.3.15 -errwarn=t」を参照してください。

4.3.9 -errchk=l(, l)

l で指定した検査を実行します。デフォルトは、-errchk=%none です。-errchk を指定すると、-errchk=%all を指定する場合と同様に機能します。l には、次に示す 1 つまたは複数の項目をコンマで区切って指定します。たとえば、-errchk=longptr64,structarg のように指定します。

4.3.10 -errfmt=f

lint 出力の書式を指定します。f には、macro、simple、src、tab のいずれか 1 つを指定できます。

デフォルトは -errfmt=tab です。-errfmt だけを指定すると、-errfmt=tab を指定するのと同じことになります。

複数の書式を指定すると最後に指定した書式が使用され、lint は使用されない書式について警告を出します。

4.3.11 -errhdr=h

-Ncheck も指定すると、lint でヘッダーファイルの一定のメッセージレポート作成ができます。h には、次の 1 つまたは複数の項目をコンマで区切って指定します。dir、no%dir、%all、%none、%user

デフォルトは -errhdr=%none です。-errhdr だけを指定すると、-errhdr=%user を指定するのと同じことになります。

次に例を示します。

% lint -errhdr=inc1 -errhdr=../inc2

この例は、ディレクトリ inc1 と ../inc2 内で使用されているヘッダーファイルを検査します。

% lint -errhdr=%all,no%../inc

この例は、ディレクトリ ../inc に入っているものを除く、使用されているすべてのヘッダーファイルを検査します。

4.3.12 -erroff=tag(, tag)

lintエラーメッセージ を抑制または使用可能にします。

t には、次の 1 つまたは複数の項目をコンマで区切って指定します。tag、no%tag、 %all、%none。

デフォルトは -erroff=%none です。-erroff と指定すると、-erroff=%all を指定した場合と同じ結果が得られます。

次に例を示します。

% lint -erroff=%all,no%E_ENUM_NEVER_DEF,no%E_STATIC_UNUSED

この例は、「列挙型が定義されていません」と「静的シンボルが使用されていません」のメッセージだけを表示し、その他のメッセージは抑制します。

% lint -erroff=E_ENUM_NEVER_DEF,E_STATIC_UNUSED

この例は、「列挙型が定義されていません」と「静的シンボルが使用されていません」のメッセージだけを抑制します。

4.3.13 -errsecurity=v

-errsecurity オプションを使用して、コードのセキュリティーに問題がないか検査することができます。

v には、次のいずれかを指定します。

-errsecurity の値が指定されていない場合は、-errsecurity=%none に設定されます。-errsecurity は指定されているが、引数が指定されていない場合は、-errsecurity=standard に設定されます。

4.3.14 -errtags=a

各エラーメッセージのメッセージタグを表示します。a には yes または no のいずれかを指定します。デフォルトは -errtags=no です。-errtags だけを指定すると、-errtags=yes を指定するのと同じことになります。

すべての -errfmt オプションに使用できます。

4.3.15 -errwarn=t

指定された警告メッセージが表示された場合、lint はエラーステータスを返して終了します。t には、次の 1 つまたは複数の項目をコンマで区切って指定します。tag、no%tag、 %all、%none。指定する順序は重要です。たとえば、%all,no%tag と指定した場合、tag 以外の警告が発行されると、lint は致命的なエラーステータスで終了します。-errwarn の値を次に示します。

デフォルトは -errwarn=%none です。-errwarn だけを指定した場合、-errwarn=%all を指定したことと同じになります。

4.3.16 -F

コマンド行で指定された .c ファイルを参照するとき、そのベース名ではなくコマンド行に与えられたパス名を出力します。

4.3.17 -fd

古い形式の関数定義または宣言について報告します。

4.3.18 -flagsrc=file

ファイル中に格納されたオプションを用いて lint を実行します。ファイルには、1 行に 1 つずつ、複数のオプションを指定できます。

4.3.19 -h

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.20 -Idir

インクルード用ヘッダーファイルをディレクトリから検索します。

4.3.21 -k

/* LINTED [メッセージ] */ 指令または注釈 NOTE(LINTED(message)) の動作を変更します。通常 lint は、前述のような指令のあとにコードが続く場合、警告メッセージを抑制します。lint は、メッセージを抑制する代わりに、指令または注釈の中のコメントを含むメッセージを出力します。

4.3.22 -Ldir

-l とともに使用し、ディレクトリの lint ライブラリを検索します。

4.3.23 -lx

lint ライブラリ llib-lx.ln にアクセスします。

4.3.24 -m

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.25 -m32|-m64

分析するプログラムのメモリーモデルを指定します。また、選択したメモリーモデル (32 ビットまたは 64 ビット) に対応する lint ライブラリを検索します。

32 ビット C プログラムの確認には -m32 を使用し、64 ビット C プログラムの確認には -m64 を使用します。

ILP32 メモリーモデル (32 ビット int、long、ポインタデータ型) は 64 ビット対応ではないすべての Solaris プラットフォームおよび Linux プラットフォームのデフォルトです。LP64 メモリーモデル (64 ビット long、ポインタデータ型) は 64 ビット対応の Linux プラットフォームのデフォルトです。-m64 は LP64 モデル対応のプラットフォームでのみ使用できます。

以前のリリースのコンパイラでは、メモリーモデル、ILP32 または LP64 は、-Xarch オプションを選択して指定されていました。Solaris Studio 12 以降のコンパイラでは、このようなことはありません。ほとんどのプラットフォームでは、コマンド行に -m64 を追加するだけで 64 ビットプログラムで lint を実行することができます。

事前定義のマクロについては、この lint オプションの一覧の次の節を参照してください。

4.3.26 -Ncheck=c

ヘッダーファイル中の宣言の対応とマクロの検査を行います。c には、検査項目である macro、extern、%all、%none、no%macro、no%extern の 1 つまたは複数をコンマで区切って指定します。

デフォルトは -Ncheck=%none です。-Ncheck だけを指定すると、-Ncheck=%all を指定するのと同じことになります。

値はコンマを用いて組み合わせることができます (例: -Ncheck=extern,macro)。

次に例を示します。

% lint -Ncheck=%all,no%macro

この例はマクロ以外のすべての検査項目を実行します。

4.3.27 -Nlevel=n

拡張 lint 解析のレベルを指定することによって、問題報告の拡張 lint モードを有効にします。このオプションによって、検出するエラーの量を制御することができます。レベルが高いほど検証にかかる時間は長くなります。n は数値で、1、2、3、4 のいずれかです。デフォルトはありません。-Nlevel が指定されなかった場合は、lint の基本解析モードが使用されます。引数なしで -Nlevel が指定された場合は、-Nlevel=4 に設定されます。

基本および拡張 lint モードについては、「4.2 lint 使用方法」を参照してください。

4.3.27.1 -Nlevel=1

個々の手続きを解析します。いくつかのプログラムの実行パスで発生する無条件エラーを報告します。大域的なデータおよび制御のフロー解析は行いません。

4.3.27.2 -Nlevel=2

大域的なデータおよびフローを含め、プログラム全体を解析します。いくつかのプログラムの実行パスで発生する無条件エラーを報告します。

4.3.27.3 -Nlevel=3

-Nlevel=2 で実行される解析に加えて、定数の伝播、定数が実際の引数として使用されている場合を含め、プログラム全体を解析します。

この解析レベルでの C プログラムの検査は、直前のレベルより 2 倍から 4 倍長い時間がかかります。これは、lint がプログラムの変数に対して取り得る値の集合を作成し、プログラムの部分解釈を行うためです。これらの変数値の集合は、定数と、プログラムで使用可能な定数オペランドを含む条件文に基づいて作成され、ほかの集合 (定数伝播の形式) を作成するときの基準になります。そのあと、解析の結果として受け取った集合は、次のアルゴリズムに従って誤りがないか評価されます。

オブジェクトが取り得る値の集合の中に正しい値が存在する場合は、その値が次の伝搬の基準として使用されます。正しい値が存在しない場合は、エラーと診断されます。

4.3.27.4 -Nlevel=4

-Nlevel=3 で実行される解析に加えて、プログラム全体を解析して一定のプログラム実行パスが使用された場合に発生する条件付きエラーも報告します。

この解析レベルでは、さらに多くの診断メッセージが出力されます。一般的に、この解析アルゴリズムは、不正な値に対してエラーメッセージが生成されることを除けば、-Nlevel=3 の解析アルゴリズムと同じです。このレベルでの解析に要する時間は、2 桁 (約 20 倍から 100 倍) ほど増加する可能性があります。余計にかかる時間は、再帰、条件文などの面でのプログラムの複雑さに比例して長くなります。このため、100,000 行を超えるプログラムに対してこのレベルの解析を行うことはあまり現実的ではありません。

4.3.28 -n

デフォルトの lint 標準ライブラリとの互換性検査を抑制します。

4.3.29 -ox

lint は llib-lx.ln という名前の lint ライブラリを作成します。このライブラリは、lint が第 2 パスで使用する .ln ファイルから作成されます。-c オプションを使用すると、すべての -o オプションが無効になります。不要なメッセージを表示しないで llib-lx.ln を作成するには、-x オプションを使用します。lint ライブラリのソースファイルが外部からの参照専用である場合は、-v オプションが便利です。作成された lint ライブラリは、あとで lint が -lx で呼び出された場合に使用することができます。

デフォルトでは、ライブラリは lint の基本形式で作成されます。拡張 lint モードを使用した場合は、ライブラリは拡張モードで作成されるため、それ以外のモードでは使用できなくなります。

4.3.30 -p

移植性に関連する一定のメッセージを使用可能にします。

4.3.31 -Rファイル

cxref(1) で使用する .ln ファイルをファイルに書き込みます。lint が拡張モードで起動されている場合、このオプションは拡張モードを取り消します。

4.3.32 -s

「警告:」または「エラー:」で始まる単一の診断メッセージを生成します。デフォルトでは、lint は複合的な出力を生成するためにいくつかのメッセージをバッファリングします。

4.3.33 -u

一定のメッセージを抑制します。表 4–8 を参照してください。このオプションは、大型プログラムのファイルの一部分に対して lint を実行する場合に適しています。

4.3.34 -V

製品名とリリース時期を標準エラーに書き込みます。

4.3.35 -v

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.36 -Wfile

cflow(1) で使用する .ln ファイルをファイルに書き込みます。lint が拡張モードで起動されている場合、このオプションは拡張モードを取り消します。

4.3.37 -XCC=a

C++ 形式のコメントを受け入れます。このオプションを使用すると、// を使用してコメントの始まりを示すことができます。a には yes または no のいずれかを指定します。デフォルトは -XCC=no です。-XCC だけを指定すると、-XCC=yes を指定するのと同じことになります。

-xc99=none を使用する場合のみ、このオプションを指定する必要があります。デフォルトの -xc99=all では、lint は // で指定したコメントを受け入れます。

4.3.38 -Xalias_level[=l ]

l には、 any、basic、weak、layout、strict、std、strong のいずれか 1 つが入ります。各レベルの明確化の詳細については、表 B–13 を参照してください。

-Xalias_level を指定しない場合、フラグのデフォルトは -Xalias_level=any になります。このことは、型に基づく別名解析が行われないことを意味します。-Xalias_level を指定してもレベルを設定しない場合、デフォルトは -Xalias_level=layout になります。

lint を実行する際に、明確化のレベルをコンパイラの実行レベルよりも緩やかに設定してください。明確化のレベルをコンパイルより厳密に設定して lint を実行すると、解釈の困難な結果が生成され、誤解を招く恐れがあります。

明確化の詳細と、明確化を支援するために作成されたプラグマのリストについては、「4.6.3 lint フィルタ」を参照してください。

4.3.39 -Xarch=amd64

(Solaris オペレーティングシステム) 推奨されていません。使用しないでください。「4.3.25 -m32|-m64」を参照してください。

4.3.40 -Xarch=v9

(Solaris オペレーティングシステム) 推奨されていません。使用しないでください。「4.3.25 -m32|-m64」を参照してください。

4.3.41 -Xc99[= o]

-Xc99 フラグは、C99 規格 (『Programming Language - C (ISO/IEC 9899:1999)』) からの実装機能に対するコンパイラの認識状況を制御します。

o には、次のいずれかを指定します。all、none。

-Xc99=none を指定すると、C99 機能に対する認識がオフになります。-Xc99=all を指定すると、サポートされている C99 機能に対する認識がオンになります。

引数を付けずに -Xc99 を発行すると、-Xc99=all と同じ結果になります。

コンパイラのサポートレベルは、デフォルトでは表 C–6 で説明している C99 の機能になりますが、Solaris が提供する /usr/include の標準ヘッダーファイルは、1999 ISO/IEC C 規格にまだ準拠していません。エラーメッセージが生成される場合は、-Xc99=none を指定して、前述のヘッダー用に 1990 ISO/IEC C 規格を使用してみてください。

4.3.42 -Xkeeptmp=a

lint の実行中、一時ファイルを自動的に削除せず、作成した状態のままにします。a には yes または no のいずれかを指定します。デフォルトは -Xkeeptmp=no です。-Xkeeptmp だけを指定すると、-Xkeeptmp=yes を指定するのと同じことになります。

4.3.43 -Xtemp=dir

一時ファイルのディレクトリをディレクトリに設定します。このオプションを指定しないと、一時ファイルは /tmp に格納されます。

4.3.44 -Xtime=a

各 lint パスの実行時間を報告します。a には yes または no のいずれかを指定します。デフォルトは -Xtime=no です。-Xtime だけを指定すると、-Xtime=yes を指定するのと同じことになります。

4.3.45 -Xtransition=a

K&R C と Solaris Studio ISO C の相違を検出した場合に警告を出します。a には yes または no を指定します。デフォルトは -Xtransition=no です。-Xtransition だけを指定すると、-Xtransition=yes を指定するのと同じことになります。

4.3.46 -Xustr={ascii_utf16_ushort| no}

このオプションは、U"ASCII_文字列" という書式の文字列リテラルについて unsigned short int の配列としての認識を有効にします。デフォルトは -Xustr=no です。このオプションは、コンパイラによる U"ASCII_文字列" という文字列リテラルの認識を無効にします。-Xustr=ascii_utf16_ushort は、コンパイラによる U"ASCII_文字列" の文字列リテラルの認識を有効にします。

4.3.47 -x

一定のメッセージを抑制します。表 4–8 を参照してください。

4.3.48 -y

コマンド行で指定されたすべての .c ファイルを、/* LINTLIBRARY */ 指令で開始した場合または注釈 NOTE(LINTLIBRARY) が付いている場合と同じように扱います。lint ライブラリは、通常、/* LINTLIBRARY */ 指令または注釈 NOTE(LINTLIBRARY) を使用して作成します。

4.4 lint のメッセージ

大部分の lint のメッセージは簡単な 1 行の文で、問題が起こって診断されるたびに出力されます。インクルードファイルで検出されたエラーはコンパイラでは複数回報告されますが、lint ではそのファイルがほかのソースファイルに何度インクルードされようとも一度報告されるだけです。複合メッセージは、ファイル全域の矛盾に対して、また時にはファイル内の問題に対しても表示されます。単一メッセージは、検査しているファイルで問題が発生するごとに知らせます。lint フィルタ (「4.6.2 lint ライブラリ」を参照) を使用して各現象ごとに表示されるメッセージを要求する時に、-s オプションを使用して lint を実行することにより、複雑なメッセージを簡単なものに変換することができます。

lint のメッセージは stderr に書き込まれます。

4.4.1 メッセージを抑制するオプション

いくつかの lint オプションを使用して、lint の診断メッセージを抑制することができます。メッセージを抑制するには、-erroff オプションのあとに 1 つ以上の タグ を指定して実行してください。これらのニーモニックタグは、-errtags=yes オプションで表示することができます。

次の表に lint のメッセージを抑制するオプションを示します。

4.4.2 lint メッセージの形式

lint プログラムに特定のオプションを付けると、エラーが発生した行へのポインタを付けて、ソースファイルの正確な行が示されます。この機能を使用可能にするオプションは -errfmt=f です。このオプションを指定しておくと、lint は次の情報を出力します。

• ソースの行と位置

• マクロの展開

• エラーを起こしやすいスタック

たとえば、次に示すプログラム Test1.c にはエラーがあります。

1 #include <string.h>
2 static void cpv(char *s, char* v, unsigned n)
3 { int i;
4   for (i=0; i<=n; i++){
5        *v++ = *s++;}
6 }
7 void main(int argc, char* argv[])
8 {
9     if (argc != 0){
10        cpv(argv[0], argc, strlen(argv[0]));}
11}

そこで、次のようなオプションを使用して Test1.c に lint を実行します。

% lint -errfmt=src -Nlevel=2 Test1.c

結果として、次のような出力が得られます。

      |static void cpv(char *s, char* v, unsigned n)
      |            ^  line 2, Test1.c
      |
      |         cpv(argv[0], argc, strlen(argv[0]));
      |                      ^  line 10, Test1.c
warning: improper pointer/integer combination: arg #2
      |
      |static void cpv(char *s, char* v, unsigned n)
      |                               ^  line 2, Test1.c
      |
      |cpv(argv[0], argc, strlen(argv[0]));
      |                       ^ line 10, Test1.c
      |
      |        *v++ = *s++;
      |         ^  line 5, Test1.c
warning:use of a pointer produced in a questionable way
    v defined at Test1.c(2)    ::Test1.c(5)
      call stack:
          main()                ,    Test1.c(10)
          cpv()                 ,    Test1.c(5)

1 つめの警告は、2 つのコード行の間で矛盾があることを示しています。2 つめの警告には、その時のコールスタックとエラーに到るまでの制御フローが表示されます。

次に示すプログラム Test2.c には、前述のものとは異なる種類のエラーがあります。

1 #define AA(b) AR[b+l]
2 #define B(c,d) c+AA(d)
3
4 int x=0;
5
6 int AR[10]={1,2,3,4,5,6,77,88,99,0};
7
8 main()
9  {
10  int y=-5, z=5;
11  return B(y,z);
12 }

そこで、次のようなオプションを使用して Test2.c に lint を実行します。

% lint -errfmt=macro Test2.c

結果として、次のような出力が得られます。

      | return B(y,z);
      |        ^  line 11, Test2.c
      |
      |#define B(c,d) c+AA(d)
      |                 ^  line 2, Test2.c
      |
      |#define AA(b) AR[b+l]
      |                   ^  line 1, Test2.c
error: undefined symbol: l
|
      |    return B(y,z);
      |           ^  line 11, Test2.c
      |
      |#define B(c,d) c+AA(d)
      |                 ^  line 2, Test2.c
      |
      |#define AA(b) AR[b+l]
      |                   ^  line 1, Test2.c
variable may be used before set: l
lint: errors in Test2.c; no output created
lint: pass2 not run - errors in Test2.c

4.5 lint の指令

4.5.1 事前定義された値

lint を実行すると、lint トークンが事前定義されます。事前定義されたトークンのリストについては、cc(1) のマニュアルページも参照してください。

4.5.2 指令

lint 指令を /*...*/ の形式で注釈として表記する方法は、現在サポートされていますが、将来はサポートされなくなる予定です。指令を注釈として挿入する際は、ソースコードの注釈 NOTE(...) として表記することをお勧めします。

次のようにファイル note.h をインクルードして、lint 指令をソースコードの注釈として指定してください。

#include <note.h>

lint は、ソースコードの注釈を別のツールと共有します。Solaris Studio C コンパイラをインストールすると、/usr/lib/note/SUNW_SPRO-lint ファイルが自動的にインストールされます。このファイルには、LockLint が認識する注釈の名前がすべて記述されています。ただし、Solaris Studio C のソースコードを検査する lint は、/usr/lib/note と Solaris Studio のデフォルトの場所である <install-directory>/prod/lib/note の全ファイルを検索して、該当する注釈を探します。

次のように、環境変数 NOTEPATH を設定することにより、/usr/lib/note 以外の位置を指定することもできます。

setenv NOTEPATH $NOTEPATH:other_location

次の表に、lint 指令と動作を示します。

4.6 lint の参考情報と例

lint が行う検査、lint ライブラリ、および lint フィルタなどに関する lint の参考情報について説明します。

4.6.1 lint が行う診断

lint 固有 の診断は、矛盾した使い方、移植不能のコード、疑わしい言語構造の 3 つの広い条件カテゴリ に対して表示されます。この節では、各カテゴリにおける lint の動作の例を示し、どのような対応が可能かを説明します。

4.6.1.1 整合性の検査

ファイル全域とファイル内部における変数、引数、関数の矛盾した使用を検査します。概して lint が古いスタイルの関数に対して検査していたのと同様に、プロトタイプの使用、宣言、引数を検査します。プログラムが関数プロトタイプを使用していない場合、lint は関数の呼び出しごとにコンパイラより厳しく引数の数と型を検査します。lint は、[fs]printf() と [fs]scanf() の制御文字列の変換指示子と引数の不一致も識別します。

次に例を示します。

• lint はファイル内で呼び出した関数に値を返すことなくそのまま終了してしまうような非 void 型関数にフラグを立てます。以前、プログラマは fun() {} のように戻り型を省略することによって「関数は値を返さない」ということを示しました。しかし、fun() が戻り型 int を持っているとみなすコンパイラには何の意味もありません。この問題を解決するには、戻り型 void の関数として宣言します。

• lint はファイル全域で非 void 型関数が値を返さず、しかも式の中でその値が使用されている場合や、これとは反対に、関数が返す値があとの呼び出しで時々または常に無視されるという場合を検出します。値が常に無視されるのは、関数定義が不十分だと考えられます。時々無視されるのは、間違ったプログラミングスタイルをとっていることが考えられます (エラー状態のテストが行われていないなど)。strcat()、strcpy()、および sprintf() のような文字列関数や、printf() と putchar() のような出力関数の戻り値を検査する必要がない場合、その問題となる呼び出しは void 型にキャストしてください。

• lint は次の場合に変数や関数を識別します。宣言されたが定義または使用されていない。使用されたが定義されていない。定義されたが使用されていない。したがって、一緒に読み込まれるファイルのすべてにではなくその一部に lint が適用されると、lint は次の場合に警告を出します。

  • そのファイルで宣言された関数と変数がほかの場所で定義または使用された。

  • そのファイルで使用された関数と変数がほかの場所で定義されていた。

  • そのファイルで定義された関数と変数がほかの場所で使用された。

    1 つめの場合を抑制するには -x オプションを、あとの 2 つの場合を抑制するには -u オプションを使用してください。

4.6.1.2 移植性の検査

一部の移植不可能なコードは、lint のデフォルトの動作によってフラグを付けられます。また、ほかにも少数の状況で、 -p または -Xc を指定して lint を起動すると、診断されることがあります。lint は ISO C 規格に一致しない言語構造を検査します。-p および -Xc のもとで発行されるメッセージに関しては、「4.6.2 lint ライブラリ」を参照してください。

次に例を示します。

• 一部の C 言語の実装では、signed または unsigned のどちらも明示的に宣言されていない文字変数は、符号付き (signed) の量として扱われ、通常は -128 ～ 127 の範囲になります。ほかの実装では、これらは負にならない量として扱われ、通常は 0 ～ 255 の範囲になります。そのため次のテストは

char c;
c = getchar();
if (c == EOF) ...

そこで EOF が値 -1 を持つテストは、文字変数が負でない値を取るマシンでは常に失敗します。-p オプションで呼び出した lint は、普通の char が負の値を取る可能性があるような比較をすべて検査します。しかし前述の例では、c を signed char で宣言しても、問題が除去されるのではなく診断が除去されるだけです。これは、getchar() が入力可能な文字と明確な EOF 値を返さなければならず、char がその値を格納することができないためです。これは、処理系ごとに定義される符号拡張から生ずるもっとも一般的な例です。これにより、lint の移植性オプションを注意深く使用すると移植性に関係しないバグを発見するのに役立つということがわかります。ここでは c を int で宣言します。

• 同様の問題がビットフィールドにもあります。定数値がビットフィールドに代入される場合、その値を保持するにはフィールドが小さすぎる場合があります。int 型のビットフィールドを符号なし (unsigned) の量として取り扱うマシンでは、int x:3 の範囲で許可される値が 0 ～ 7 であるのに対し、符号付き (signed) の量として取り扱うマシンでは -4 ～ 3 になります。ただし、int 型として宣言された 3 ビットのフィールドは、後者のマシンでは値 4 を保持できません。-p を指定して呼び出された lint は、unsigned int または signed int を除き、すべてのビットフィールドの型にフラグを付けます。これらのみが、移植可能なビットフィールド型です。コンパイラは、ビットフィールドの型 int、char、short、および long をサポートしますが、これらは unsigned、signed またはそのどちらでもない場合があります。さらにコンパイラは enum のビットフィールドの型もサポートします。

• 大きなサイズの型が小さなサイズの型に代入されると、バグが発生することがあります。有効なビットが切り捨てられると正確な値を保持できなくなります。

short s;
long l;
s = l;

lint は、デフォルトでこのような代入すべてを知らせます。診断は、-a オプションを指定して呼び出すことにより抑制することができます。どのオプションを指定して lint を呼び出しても、ほかの診断をも抑制する可能性があることに注意してください。2 つ以上の診断を抑制するオプションについては、「4.6.2 lint ライブラリ」にあるリストを参照してください。

• あるオブジェクト型へのポインタをより厳密な境界整列要求を持つオブジェクト型のポインタにキャストすると、移植性がなくなることがあります。lint のフラグは次のようになります。

int *fun(y)
char *y;
{
    return(int *)y;
}

大部分のマシンでは、int は char とは異なり任意のバイト境界から開始することができないため、lint はフラグを立てます。-h を指定して lint を実行することによってこの診断を抑制することができます。この場合もまた、ほかのメッセージを抑制する可能性があります。汎用ポインタ void * を使用すればほかの影響を回避することができます。

• ISO C は、複雑な式の評価順序を定義していません。この意味は、関数呼び出し、入れ子になった代入文、またはインクリメントとデクリメント演算子から副作用が生じる場合 (すなわち、式評価の副作用として変数が変更される時)、副作用の生じる順序はマシンへの依存度が高いということです。デフォルトでは、lint は副作用で変更されたり同一式内でほかの場所に使用される変数を知らせます。

int a[10];
main()
{
    int i = 1;
    a[i++] = i;
}

この例での a[1] の値は、あるコンパイラでは 1、別のコンパイラでは 2 という可能性もあります。ビット単位の論理演算子 & がこのような診断をもたらすことがあるのは、誤って 論理演算子 && の代わりに使用される場合です。

if ((c = getchar()) != EOF & c != ’0’)

4.6.1.3 疑わしい言語構造

lint は、プログラマの意図には反するが、言語構造上は正しい箇所についても報告します。次に例を示します。

• unsigned 変数は常に負ではない値を持ちます。そのため次のテストは

unsigned x;
if (x < 0) ...

常に失敗します。一方、

unsigned x;
if (x > 0) ...

これは次のように指定するのと同じことです。

if (x != 0) ...

最初の例は意図したものではない可能性があります。lint は、負の定数または 0 と unsigned 変数との疑わしい比較を知らせます。unsigned 変数を負数のビットパターンと比較するには、その負数を unsigned にキャストします。

if (u == (unsigned) -1) ...

または、接尾辞 U を使用します。

if (u == -1U) ...

• lint は、副作用が予想される状況で使用される副作用のない式、すなわちプログラマの意図に反した式を知らせます。代入演算子が予想されるところ、つまり副作用が予想されたところで等価演算子が存在する場合は追加の警告が発行されます。

int fun()
{
    int a, b, x, y;
    (a = x) && (b == y);
}

• lint は、論理演算子とビット単位の演算子 (具体的には、&、|、^、<<、>>) の両方が混在する式に括弧を入れるように注意を与えます。これは演算子の優先度を間違って解釈することにより、不正確な結果になる可能性があります。ビット単位の演算子 & の優先度は論理演算子 == より低いため、式はユーザーの意図とは異なる次のような式として評価されます。

if (x & a == 0) ...

この式は、次のように評価されます。

if (x & (a == 0)) ...

これは、ユーザーの意図とは異なる可能性が高いものです。-h を指定して lint を起動すると、診断のものは無効になります。

4.6.2 lint ライブラリ

lint ライブラリを使用して、呼び出したライブラリ関数とユーザープログラムとの互換性を検査することができます。関数戻り型の宣言、関数が期待する引数の数と型などを検査します。標準 lint ライブラリは、C 言語処理系で供給されるライブラリに対応し、一般にはシステムの標準位置であるディレクトリに格納されています。慣例では、lint ライブラリは llib-lx.ln という形の名前を持ちます。

lint 標準 C ライブラリの llib-lc.ln は、デフォルトで lint コマンド行に追加されます。ライブラリ関数との互換性の検査は、-n オプションを指定して呼び出すことにより抑制することができます。そのほかの lint ライブラリは、-l に対して引数として指定することでアクセスされます。次に例を示します。

% lint -lx file1.c file2.c

この例では、lint ライブラリ llib-lx.ln との互換性について、file1.c と file2.c の関数と変数の使用方法を調べるよう lint に指示します。定義だけからなるライブラリファイルは、厳密に通常のソースファイルと .ln ファイルとして処理されます。ただしライブラリファイルで関数と変数が矛盾したまま使用されるか、またはライブラリファイルで定義されてもソースファイルでは使用されない関数と変数に対しては警告を出しません。

自分の lint ライブラリを作成するには、C ソースファイルの先頭に NOTE(LINTLIBRARY) 指令を挿入し、次いで -o オプションとそのライブラリ名を与える -l オプションとともにそのファイルに対して lint を実行してください。

% lint -ox file1.c file2.c

前述のコマンド行により、NOTE(LINTLIBRARY) が先頭に付いたソースファイル中の定義だけがファイル llib-lx.ln に書き込まれます。lint -o と cc -o の類似に注意してください。ライブラリは、同様に関数プロトタイプ宣言のファイルから作成されます。ただし、NOTE(LINTLIBRARY) と NOTE(PROTOLIB(n)) の両方が宣言ファイルの先頭に挿入されている場合は別です。n が 1 の場合、プロトタイプ宣言は古いスタイルの定義と同様にライブラリ .ln ファイルに書き込まれます。n がデフォルトの 0 の場合、処理はキャンセルされます。-y を指定して lint を呼び出しても、lint ライブラリを作成することができます。次のようなコマンド行があるとします。

% lint -y -ox file1.c file2.c

前述のコマンド行で指定された各ソースファイルは NOTE(LINTLIBRARY) で開始したかのように扱われ、その定義だけが llib-lx.ln に書き込まれます。

デフォルトでは、lint は標準位置で lint ライブラリを検索します。標準位置以外のディレクトリで lint ライブラリを検索するように lint に指示するには、-L オプションを使用してディレクトリのパスを指定します。

% lint -Ldir -lx file1.c file2.c

拡張モードでは、lint は基本モードで生成される .ln ファイルより多くの情報が格納された .ln ファイルを生成します。拡張モードの lint は、基本モードまたは拡張モードのどちらの lint で生成された .ln ファイルでもすべて読み取って理解することができます。基本モードの lint は、基本モードの lint を用いて生成された .ln ファイルだけを読み取って理解することができます。

デフォルトでは、lint は /usr/lib ディレクトリのライブラリを使用します。これらのライブラリは基本 lint 形式です。makefile を一度実行して新しい形式の拡張 lint ライブラリを作成すれば、拡張 lint をより効率的に利用することができます。makefile を実行して新しいライブラリを作成するには、次のコマンドを入力してください。

% cd <install-directory>/prod/src/lintlib; make

ここで、<install-directory> はインストールディレクトリです。makefile の実行後、lint は /usr/lib ディレクトリ内のライブラリの代わりに拡張モードの新ライブラリを使うようになります。

指定されたディレクトリは標準位置の前に検索されます。

4.6.3 lint フィルタ

lint フィルタは、プロジェクト固有のポストプロセッサ (後処理) です。典型的な例では awk スクリプトや類似のプログラムを使用して lint の出力を読み取り、ユーザーのプロジェクトが特に問題ないと判断したメッセージを捨てます。たとえば、時々または常に無視される値を返す文字列関数などです。lint オプションと指令だけでは出力に対して十分な制御が与えられない時は、lint フィルタを使用するとカスタマイズされた診断レポートを作成することができます。

lint の 2 つのオプションはフィルタを開発する際に特に役立ちます。

• -s を指定して lint を呼び出すと、複合診断が問題の発生ごとに表示される単純な一行メッセージに変換されます。この解析されたメッセージ書式は awk スクリプトによる分析に適しています。

• -k を指定して lint を呼び出すと、ソースファイルに書き込まれたコメントが出力されるので、プロジェクトの決定を文書化したり後処理の動作を指定するのに便利です。コメントが予想される lint メッセージを示していて、報告されたメッセージがそれと同一であった場合、メッセージは除かれます。-k を使用するときは NOTE(LINTED(メッセージ)) 指令をコメントしたいコードの前の行に挿入してください。ここでのメッセージは、lint が -k を指定して呼び出されたときに出力されるコメントです。

  (メッセージ) のあるファイルに対して -k が使用されない場合の lint の動作については、表 4–9 を参照してください。 NOTE(LINTED (メッセージ))。