実行時設定

php.ini の設定により動作が変化します。

たいていの場合はデフォルトの APC 設定でうまく動作しますが、きちんとチューニングをしたい場合は以下のパラメータを設定します。

あなたが決めなければいけないことは、以下の 2 つです。まず APC にどれくらいの共有メモリを設定するかということ、そして、ファイルの更新チェックをリクエストのたびに APC が行うかどうかということです。これらに関連する ini ディレクティブが apc.shm_size および apc.stat です。これらのディレクティブについて、以下の説明を注意深くお読みください。

サーバーを起動したら、この拡張モジュールに含まれているスクリプト apc.php をドキュメントルート以下に配置し、ブラウザでアクセスしてください。キャッシュの状態についての詳細な情報がここで得られます。 PHP で GD が使用可能になっている場合は、きれいなグラフも表示されます。まず最初にチェックすべきなのは、当然、実際にファイルがキャッシュされているかどうかでしょう。実際に動作していることを確認したら、次は左側にある Cache full count の値に注目しましょう。これは、キャッシュがいっぱいになったために強制削除が行われた (直近の apc.ttl 秒間にアクセスされなかったエントリが、キャッシュから削除された) 回数を表します。この値ができるだけ小さくなるようにキャッシュを設定しなければなりません。キャッシュが絶えずいっぱいになっているようだと、パフォーマンスに影響を及ぼします。この場合は、APC に割り当てるメモリの量を増やすか、キャッシュするスクリプトを絞り込むために apc.filters を使用します。

APC を mmap (メモリマッピング) サポート付きでコンパイルすると、ひとつのメモリセグメントだけを使うようになります。一方、APC を SHM (SysV 共有メモリ) サポートでビルドした場合は複数のメモリセグメントを使います。 MMAP には、SHM における /proc/sys/kernel/shmmax のような最大値の制限はありません。一般的には MMAP サポートを推奨します。ウェブサーバーを再起動するよりも高速にメモリを再利用するし、起動時のメモリ割り当て量も軽減できるからです。

**APC の設定オプション**
名前	デフォルト	変更可能	変更履歴
apc.enabled	"1"	PHP_INI_SYSTEM	APC 2 で PHP_INI_SYSTEM。APC <= 3.0.12 で PHP_INI_ALL。
apc.shm_segments	"1"	PHP_INI_SYSTEM
apc.shm_size	"32M"	PHP_INI_SYSTEM
apc.shm_strings_buffer	"4M"	PHP_INI_SYSTEM	APC 3.1.4 以降で利用可能。
apc.optimization	"0"	PHP_INI_ALL	APC 2 では PHP_INI_SYSTEM。APC 3.0.13 で削除。
apc.num_files_hint	"1000"	PHP_INI_SYSTEM
apc.user_entries_hint	"4096"	PHP_INI_SYSTEM	APC 3.0.0 以降で利用可能。
apc.ttl	"0"	PHP_INI_SYSTEM	APC 3.0.0 以降で利用可能。
apc.user_ttl	"0"	PHP_INI_SYSTEM	APC 3.0.0 以降で利用可能。
apc.gc_ttl	"3600"	PHP_INI_SYSTEM
apc.cache_by_default	"1"	PHP_INI_ALL	APC <= 3.0.12 で PHP_INI_SYSTEM。APC 3.0.0 以降で利用可能。
apc.filters	NULL	PHP_INI_SYSTEM
apc.mmap_file_mask	NULL	PHP_INI_SYSTEM
apc.slam_defense	"1"	PHP_INI_SYSTEM	APC 3.0.0 以降で利用可能。APC 3.1.4 より前のバージョンでは、デフォルト値が "0" (無効) でした。
apc.file_update_protection	"2"	PHP_INI_SYSTEM	APC 3.0.6 以降で利用可能。
apc.enable_cli	"0"	PHP_INI_SYSTEM	APC 3.0.7 以降で利用可能。
apc.max_file_size	"1M"	PHP_INI_SYSTEM	APC 3.0.7 以降で利用可能。
apc.use_request_time	"1"	PHP_INI_ALL	APC 3.1.3 以降で利用可能。
apc.stat	"1"	PHP_INI_SYSTEM	APC 3.0.10 以降で利用可能。
apc.write_lock	"1"	PHP_INI_SYSTEM	APC 3.0.11 以降で利用可能。
apc.report_autofilter	"0"	PHP_INI_SYSTEM	APC 3.0.11 以降で利用可能。
apc.serializer	"default"	PHP_INI_SYSTEM	APC 3.1.0 以降で利用可能。
apc.include_once_override	"0"	PHP_INI_SYSTEM	APC 3.0.12 以降で利用可能。
apc.rfc1867	"0"	PHP_INI_SYSTEM	APC 3.0.13 以降で利用可能。
apc.rfc1867_prefix	"upload_"	PHP_INI_SYSTEM
apc.rfc1867_name	"APC_UPLOAD_PROGRESS"	PHP_INI_SYSTEM
apc.rfc1867_freq	"0"	PHP_INI_SYSTEM
apc.rfc1867_ttl	"3600"	PHP_INI_SYSTEM	APC 3.1.1 以降で利用可能。
apc.localcache	"0"	PHP_INI_SYSTEM	APC 3.0.14 から 3.1.11 で利用可能。
apc.localcache.size	"512"	PHP_INI_SYSTEM	APC 3.0.14 から 3.1.11 で利用可能。
apc.coredump_unmap	"0"	PHP_INI_SYSTEM	APC 3.0.16 以降で利用可能。
apc.stat_ctime	"0"	PHP_INI_SYSTEM	APC 3.0.13 以降で利用可能。
apc.preload_path	NULL	PHP_INI_SYSTEM	APC 3.1.1 以降で利用可能。
apc.file_md5	"0"	PHP_INI_SYSTEM	APC 3.1.1 以降で利用可能。
apc.canonicalize	"1"	PHP_INI_SYSTEM	APC 3.1.1 以降で利用可能。
apc.lazy_functions	0	PHP_INI_SYSTEM	APC 3.1.3 以降で利用可能。
apc.lazy_classes	0	PHP_INI_SYSTEM	APC 3.1.3 以降で利用可能。

PHP_INI_* モードの詳細および定義についてはどこで設定を行うのかを参照してください。

以下に設定ディレクティブに関する簡単な説明を示します。

apc.enabled boolean

apc.enabled を 0 にすることで APC を無効にできます。 APC が静的にコンパイルされて PHP に組み込まれており、他に無効にする手段がない場合などに有用です (DSO としてコンパイルされている場合は、単に php.ini の中の extension という行をコメントアウトするだけで無効にできます)。

apc.shm_segments integer

コンパイラキャッシュのために割り当てる共有メモリセグメントの数。 APC が割り当て済みの共有メモリを使い切ってしまっているが、すでにシステムが許す限り apc.shm_size を拡大しているといった場合に、この値を大きくすることを試みます。

apc.shm_size string

個々の共有メモリセグメントの大きさを、この FAQ で説明している記法で指定します。デフォルトで、共有メモリセグメントの大きさが非常に小さく設定されているシステムもあります (大半の BSD 系システムがこれに含まれます)。

apc.shm_strings_buffer string

APC が内部的に文字列用の共有バッファとして使うためのメモリのサイズ。最後に M (メガバイト) あるいは G (ギガバイト) をつけなければいけません。このオプションを有効にすると、PHP-FPM ごとに使うメモリの量を減らせます。文字列をワーカーごとに格納するのではなく、一括で格納することになるからです。

apc.optimization integer

最適化レベル。ゼロは最適化を無効にし、値を大きくするほど最適化のレベルが高くなります。わずかながら速度の向上が期待できます。この項目は実験的なものです。

apc.num_files_hint integer

Web サーバーで読み込まれるソースファイルの総数についての「ヒント」。よくわからない場合はゼロを指定するか、単に無視してください。何千ものソースファイルを扱っているようなサイトで有用です。

apc.user_entries_hint integer

apc.num_files_hint と同様に、保存するユーザーキャッシュ変数の数についての「ヒント」。よくわからない場合は、ゼロを設定するか無視してください。

apc.ttl integer

キャッシュされているエントリが、他のエントリに割り当てられるまでスロットに残っていることの可能な秒数。ゼロのままにしておくと、キャッシュの中身が古いエントリでいっぱいになってしまい、新しいエントリがキャッシュできなくなります。キャッシュが使用可能メモリを超えてしまった場合、 ttl が 0 ならキャッシュを完全に破棄します。 ttl が 0 より大きい場合は、APC は期限切れのエントリの削除を試みます。

apc.user_ttl integer

ユーザーキャッシュエントリが、他のエントリに割り当てられるまでスロットに残っていることの可能な秒数。ゼロのままにしておくと、キャッシュの中身が古いエントリでいっぱいになってしまい、新しいエントリがキャッシュできなくなります。キャッシュが使用可能メモリを超えてしまった場合、 ttl が 0 ならキャッシュを完全に破棄します。 ttl が 0 より大きい場合は、APC は期限切れのエントリの削除を試みます。

apc.gc_ttl integer

キャッシュエントリがガベージコレクションのリストに残り続ける秒数。ソースファイルのキャッシュ中にサーバープロセスが死んだ場合の安全装置となります。ソースファイルが変更された場合、メモリに割り当てられている古いバージョンは、この TTL に達するまで再読み込みされません。この機能を無効にするにはゼロを設定します。

apc.cache_by_default boolean

デフォルトで On です。しかし、これを Off にして + で始まる apc.filters とともに使用することで、フィルタに一致したファイルのみをキャッシュすることが可能です。

apc.filters string

カンマで区切られた、POSIX 拡張正規表現のリスト。ソースファイル名がいずれかのパターンにマッチした場合、そのファイルはキャッシュされません。マッチングに使用されるファイル名は include/require に渡される名前であり、絶対パスではないことに注意しましょう。正規表現が + で始まっている場合、その条件にマッチするファイルはキャッシュされます。また - で始まっている場合は、条件にマッチするファイルはキャッシュされません。デフォルトは - なので、これは省略可能です。

apc.mmap_file_mask string

--enable-mmap を用いて MMAP サポートつきでコンパイルされている場合、ここで mktemp 形式のファイルマスクを指定します。mmap モジュールは、 mmap されたメモリ領域をファイルに置くか共有メモリに置くかを、これによって判断します。ファイルベースの mmap を使用するには、この値を /tmp/apc.XXXXXX （正確に 6 つの X）のように指定します。 POSIX 形式の shm_open/mmap を使用するには、.shm をマスクのどこかで指定します。例: /apc.shm.XXXXXX 。また、/dev/zero を指定することで、カーネルの /dev/zero インターフェイスを使用した anonymous mmap を使用することもできます。未定義の場合は、この方式が用いられます。

apc.slam_defense integer

非常にアクセスの多いサーバーでは、サーバーを起動したりファイルを書き換えたりするたびに「多くのプロセスが」「同時に」「同じファイルを」キャッシュしようとすることになります。このオプションを指定すると、ある一定のパーセンテージでファイルをキャッシュせずに利用するようにします。あるいは、単一のプロセスがキャッシュ処理をスキップする確率と考えることもできます。たとえば、apc.slam_defense を 75 に設定すると、プロセスがキャッシュされていないファイルをキャッシュする処理を 75% の確率で抑えられます。つまり、この値を大きく設定することで、キャッシュ処理の混雑を防ぐことが可能です。値を 0 に設定すると、この機能が無効になります。

非推奨です。かわりに apc.write_lock を使用しましょう。

apc.file_update_protection integer

稼動中の Web サーバー上のファイルを書き換える場合、アトミックな手段で行うべきです。つまり、まずいったん一時ファイルに書き込み、準備ができた時点でそれをリネーム（mv）して正しい位置に移動します。多くのテキストエディタや cp、tar その他のプログラムはこの方式ではありません。ということは、ファイルの書き込み中にそのファイルがアクセスされる（そしてキャッシュされる）可能性があるわけです。 apc.file_update_protection は、新しいファイルをキャッシュするまでの遅延を設定します。デフォルトは 2 秒で、ファイルの更新時刻（mtime）がアクセス時刻と 2 秒未満しか違わない場合はファイルをキャッシュしないという意味です。更新の最中のファイルにアクセスしてしまった不幸な人には変なデータが見えてしまいますが、少なくともその変な状態がキャッシュされてしまうことはありません。 rsync などのアトミックな更新を保証する方式を利用することがわかっている場合は、値を 0 に設定することでこの機能を無効にできます。更新処理に 2 秒以上かかるようなシステムを利用している場合は、この値をもう少し大きくしたくなるかもしれません。

apc.enable_cli integer

たいていは、テストやデバッグ用に使用します。これを設定すると CLI バージョンの PHP で APC を有効にします。通常は、すべての CLI リクエストに対して APC キャッシュを作成/格納/削除したいとは思わないでしょう。しかし、CLI バージョンの APC を簡単に作成できるようにしておくことは、多くのテストシナリオで有用です。

apc.max_file_size integer

この値よも大きなサイズのファイルは、キャッシュされません。デフォルトは 1M です。

apc.stat integer

この設定を変更する場合は十分注意してください。デフォルト設定は On で、これは、ファイルが変更されていないかどうかをスクリプトの実行のたびに APC が調べ、もし変更されていれば、再コンパイルして新しいバージョンをキャッシュします。この設定を Off にすると、変更されているかどうかがチェックされません。つまり、変更内容を有効にするには Web サーバーを再起動する必要があるということです。実運用環境ではコードを変更することはめったにないでしょうから、この設定を Off にしておくことでパフォーマンスを大きく向上させられます。

include/require されたファイルについてもこのオプションは適用されますが、もし相対パス (Unix の場合は / で始まらないすべてのパス) の include を使用している場合は、ファイルを一意に識別するために APC がチェックする必要があります。絶対パスの include を使用している場合、 APC 絶対パスをファイルの識別子として使用し、チェックを飛ばすことができます。

apc.write_lock boolean

多くの処理が実行されるサーバーでは、最初にサーバーを立ち上げたときや多くのファイルを変更した場合などに、すべてのプロセスが同一のファイルをコンパイルしたりキャッシュしたりしてしまうことがあります。 write_lock を有効にすると、ひとつのプロセスのみが未キャッシュのスクリプトをコンパイルするようになります。その間、他のプロセスはロック待ちをするのではなくキャッシュされていない状態で実行します。

apc.report_autofilter boolean

バインド時の問題によりキャッシュから自動的に除外されたスクリプトを記録します。

apc.serializer string

APC でサードパーティーのシリアライザーを使うよう設定します。

apc.include_once_override boolean

include_once および require_once を最適化し、コストの高いシステムコールの使用を避けるようにします。

警告

この機能は実験的なものです。このディレクティブの挙動やディレクティブ名、そして関連するドキュメントなどは、今後 APC の新バージョンがリリースされるときに予告なく変更される可能性があります。この機能は自己責任の下で使うようにしましょう。

apc.rfc1867 boolean

RFC1867 のファイルアップロード進捗ハンドラが有効になるのは、 PHP 5.2.0 以降で APC をコンパイルした場合のみです。これを有効にすると、ファイルアップロードフォームの file フィールドの前に APC_UPLOAD_PROGRESS というフィールドがある場合に APC が自動的にユーザーキャッシュエントリ upload_key を作成します。ここで、key はフォームの APC_UPLOAD_PROGRESS エントリの値となります。

APC_UPLOAD_PROGRESS で指定した hidden フィールドが file フィールドよりも前にこなければならないことに注意しましょう。そうしないと、アップロードの進捗処理が正しく動作しません。

現時点では、ファイルアップロードの追跡はスレッドセーフではないことに注意しましょう。前のアップロード処理が終わる前に別のアップロードを開始すると、前のアップロードの追跡が無効になってしまいます。

rate が使えるのは、すべてのファイルの転送が完了してからであることに注意しましょう。

例1 apc.rfc1867 の例


<?php
print_r(apc_fetch("upload_$_POST[APC_UPLOAD_PROGRESS]"));
?>

上の例の出力は、たとえば以下のようになります。

Array
(
    [total] => 1142543
    [current] => 1142543
    [rate] => 1828068.8
    [filename] => test
    [name] => file
    [temp_filename] => /tmp/php8F
    [cancel_upload] => 0
    [done] => 1
)

apc.rfc1867_prefix string

rfc1867 のアップロード進捗処理機能で作成するユーザーキャッシュエントリのキーにつけるプレフィックスを指定します。

apc.rfc1867_name string

APC のアップロード進捗処理機能を有効にするフォームの hidden 項目名、そしてユーザーキャッシュエントリのキーのサフィックスを指定します。

apc.rfc1867_freq string

アップロードの進捗を記録するユーザーキャッシュエントリの更新頻度を指定します。ファイルサイズに対するパーセンテージ、あるいはファイルサイズで指定します。サイズを指定する場合は、最後に "k"、"m" あるいは "g" を指定することでそれぞれキロバイト、メガバイト、ギガバイトを指定できます (大文字小文字は区別しません)。 0 を指定すると、可能な限り進捗を更新するようにします。これは、アップロードの速度を低下させてしまいます。

apc.rfc1867_ttl integer

rfc1867 エントリの TTL。

apc.localcache boolean

これは、ロックが不要なローカルプロセスのシャドウキャッシュを有効にします。これにより、キャッシュが書き込まれる際のロックの競合を軽減します。

apc.localcache.size integer

ローカルプロセスのシャドウキャッシュの大きさ。ある程度大きなな値を設定しておく必要があります。目安としては apc.num_files_hint の半分程度となります。

apc.coredump_unmap boolean

APC で SIGSEGV のようなシグナルを捕捉し、シグナルの発生時にコアファイルを書き出せるようにします。シグナルを受け取ると、 APC は共有メモリセグメントの割り当てを解除し、コアファイルにそれが書き出されないようにします。この設定を行うと、 APC の共有メモリセグメントを大きめに設定しているときに致命的なシグナルを受け取った場合のシステムの安定性が向上します。

警告

この機能には危険性があります。致命的なシグナルのハンドラで共有メモリセグメントの割り当てを解除しようとすると、発生したエラーによっては未定義の振る舞いを起こす可能性があります。

注意:
カーネルによってはコアダンプファイルの生成時に共有メモリを無視する機能を持つものもありますが、そのような実装は、たとえば Apache のスコアボードのような重要な共有メモリセグメントも無視してしまう可能性があります。

apc.stat_ctime integer

ctime による検証を行えば、svn や rsync といったプログラムが引き起こす問題を回避することができます。直近の状態から inode が変わっていないことを確実に確かめられるからです。 APC は、通常は mtime のみしか確認しません。

apc.canonicalize bool

オンにすると、no-stat モードのときに相対パスを正規化します。これを設定すると、ストリームラッパー経由でインクルードしたファイルはキャッシュできなくなります。realpath() はストリームラッパーをサポートしていないからです。

apc.preload_path string

オプションで、ディレクトリへのパスを指定します。 APC の起動時に、ここにあるキャッシュデータを読み込みます。

apc.use_request_time bool

SAPI リクエストの開始時刻を TTL に使用します。

apc.file_md5 bool

ファイルの md5 ハッシュを記録します。

apc.lazy_functions integer

関数の lazy loading を有効にします。

apc.lazy_classes integer

クラスの lazy loading を有効にします。