MakefileにおけるSIFT生成ターゲットの実装
基本設定
Makefileでは、SIFT生成に必要な各種パスと設定を定義している。
# Generate SIFT traces based on SimPoint results
run_sift: $(RUN_SIFT_TARGETS)
$(RUN_SIFT_TARGETS): benchmark=$(subst run_sift_,,$@)
$(RUN_SIFT_TARGETS):
@SPEC_ROOT=$(SPEC_ROOT) \
SPECINVOKE=$(SPECINVOKE) \
SIMPOINT_DIR=$(SIMPOINT_DIR) \
SIFT_DIR=$(SIFT_DIR) \
SNIPER_ROOT=$(SNIPER_ROOT) \
PIN_HOME=$(PIN_HOME) \
SNIPER_SIM_LD_PATH=$(SNIPER_SIM_LD_PATH) \
QEMU=$(QEMU) \
QEMU_FLAGS="$(QEMU_FLAGS)" \
QEMU_CPU_OPTIONS="$(QEMU_CPU_OPTIONS)" \
QEMU_FRONTEND_PLUGIN=$(QEMU_FRONTEND_PLUGIN) \
./scripts/run_sift_benchmark.sh $(benchmark) $(SIMPOINT_INTERVAL)
このターゲットは、run_sift_<benchmark>という形式で個別のベンチマークに対してSIFTトレースを生成する。ターゲット実行時には、必要な環境変数をすべてスクリプトに渡している。
ターゲットの特徴
環境変数の明示的な受け渡し: SIFT生成に必要なすべてのパスと設定を環境変数としてスクリプトに渡している。これにより、スクリプト内で必要な情報が確実に利用可能となる。
個別ベンチマーク対応:
$(RUN_SIFT_TARGETS)により、各ベンチマークに対して個別にターゲットが生成される。これにより、make run_sift_429.mcfのように特定のベンチマークのみを実行できる。依存関係の管理: スクリプト内でSimPoint結果の存在をチェックするため、Makefileレベルでの依存関係定義は不要である。ただし、実際には
run_simpoint_<benchmark>を先に実行しておく必要がある。
run_sift_benchmark.shスクリプトの実装詳細
スクリプトの全体構造
スクリプトは大きく以下の処理フローで構成されている。
- 引数と環境変数の検証
- SimPoint結果ファイルの探索
- 各サブコマンドとSimPointに対する実行スクリプトの生成
- 生成したスクリプトの並列実行
初期化処理
benchmark="$1"
SIMPOINT_INTERVAL="$2"
: "${SPEC_ROOT:?SPEC_ROOT is required}"
: "${SPECINVOKE:?SPECINVOKE is required}"
: "${SIMPOINT_DIR:?SIMPOINT_DIR is required}"
: "${SIFT_DIR:?SIFT_DIR is required}"
: "${SNIPER_ROOT:?SNIPER_ROOT is required}"
: "${PIN_HOME:?PIN_HOME is required}"
: "${SNIPER_SIM_LD_PATH:?SNIPER_SIM_LD_PATH is required}"
: "${QEMU:?QEMU is required}"
: "${QEMU_FLAGS:?QEMU_FLAGS is required}"
: "${QEMU_CPU_OPTIONS:?QEMU_CPU_OPTIONS is required}"
: "${SIMPOINT_INTERVAL:?SIMPOINT_INTERVAL is required}"
run_dir="${SPEC_ROOT}/benchspec/CPU2006/${benchmark}/run/run_base_ref_gcc.0000"
simpoint_output_dir="${SIMPOINT_DIR}/${benchmark}"
sift_output_dir="${SIFT_DIR}/${benchmark}"
echo "=== Generating SIFT traces for ${benchmark} ==="
mkdir -p "${sift_output_dir}"
if [ ! -d "${simpoint_output_dir}" ]; then
echo "Error: SimPoint directory ${simpoint_output_dir} not found. Please run 'make run_simpoint_${benchmark}' first."
exit 1
fi
subcmds="$(cd "${run_dir}" && "${SPECINVOKE}" -n 2>&1 | grep -v "^#" | grep -v "^timer" | grep -v "^$")"
num_subcmds="$(echo "${subcmds}" | wc -l)"
echo "=== Processing ${benchmark} subcommands for SIFT generation (${num_subcmds} commands)"
sift_dir_abs="$(cd "${sift_output_dir}" && pwd)"
simpoint_dir_abs="$(cd "${simpoint_output_dir}" && pwd)"
export sift_dir_abs simpoint_dir_abs
export BENCHMARK="${benchmark}" NUM_SUBCMDS="${num_subcmds}" RUN_DIR="${run_dir}"
export SNIPER_ROOT PIN_HOME SNIPER_SIM_LD_PATH QEMU QEMU_FLAGS QEMU_CPU_OPTIONS QEMU_FRONTEND_PLUGIN
export SIMPOINT_INTERVAL
スクリプトは、まず必要な環境変数がすべて設定されているかを確認する。:コマンドと${VAR:?message}構文を使用することで、環境変数が未設定の場合はエラーメッセージを表示して終了する。
並列実行の設定
# 並列実行のジョブ数を環境変数から取得(デフォルトはCPU数)
# ファイルハンドル制限を考慮して、最大252に制限
PARALLEL_JOBS="${PARALLEL_JOBS:-$(nproc)}"
if [ "$PARALLEL_JOBS" -gt 252 ]; then
PARALLEL_JOBS=252
fi
並列実行のジョブ数は、環境変数PARALLEL_JOBSから取得し、デフォルトはCPU数(nproc)である。ただし、ファイルハンドル制限を考慮して、最大252に制限している。これは、大量の並列ジョブを実行する際にファイルディスクリプタの枯渇を防ぐための対策である。
SimPointファイルの探索とスクリプト生成
echo "${subcmds}" | nl -nln -w1 -s$'\t'| while IFS=$'\t' read -r cmd_num cmd_raw; do
# sedコマンドを安全に実行するため、特殊文字をエスケープ
cmd_clean=$(printf "%s\n" "$cmd_raw" | sed "s| [0-9]*>>* *[^ ]*||g")
simpoint_file="${simpoint_dir_abs}/bbv_${cmd_num}.out.*.simpoints"
weights_file="${simpoint_dir_abs}/bbv_${cmd_num}.out.*.weights"
simpoint_files=$(ls $simpoint_file 2>/dev/null | head -1)
weights_files=$(ls $weights_file 2>/dev/null | head -1)
if [ -z "$simpoint_files" ] || [ -z "$weights_files" ]; then
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] No SimPoint files found, skipping"
continue
fi
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Found SimPoint files"
sift_subcmd_dir="${sift_dir_abs}/subcmd_${cmd_num}"
mkdir -p "$sift_subcmd_dir"
# 相対パス ../run_base_ref_gcc.0000 が参照できるように親ディレクトリ構造を作成
# subcmdレベルで1つ作成すれば、すべてのSimPointから参照可能
run_base_dir="${sift_subcmd_dir}/run_base_ref_gcc.0000"
if [ ! -d "$run_base_dir" ]; then
cp -r "$RUN_DIR" "$run_base_dir" 2>/dev/null || true
fi
# SimPointごとのスクリプトファイルを生成
paste -d " " "$simpoint_files" "$weights_files" | while IFS=" " read -r simpoint dummy1 weight dummy2; do
output_base="${sift_subcmd_dir}/simpoint_${simpoint}"
response_file="${output_base}_response.app0.th0.sift"
mkdir -p "$(dirname "$response_file")"
touch "$response_file"
cmd_suffix=$(echo "$cmd_clean" | sed "s|^[^ ]* ||")
cmd_suffix_noL=$(echo "$cmd_suffix" | sed "s|^-L [^ ]* ||")
cmd_suffix_noL=$(echo "$cmd_suffix_noL" | sed "s|^ *||")
sniper_vm_ld_path="$SNIPER_SIM_LD_PATH"
original_ld_path="$LD_LIBRARY_PATH"
sniper_script_ld_path="$original_ld_path"
# SimPoint の行は「SimPointIndex」のみを想定しているので、
# BBV のインターバル長(命令数)は .simpoints ファイル名から取得する。
# 例: bbv_1.out.100000000.simpoints -> interval = 100000000
base_name="$(basename "$simpoint_files" .simpoints)"
interval="$SIMPOINT_INTERVAL"
# fast_forward_target = SimPointIndex * interval
fast_forward_target=$((simpoint * interval))
detailed_target="${interval}"
# 各SimPoint用の個別実行ディレクトリを作成
simpoint_run_dir="${sift_subcmd_dir}/run_dir_simpoint_${simpoint}"
mkdir -p "$simpoint_run_dir"
# 各SimPoint用のスクリプトファイルを生成
script_file="${sift_subcmd_dir}/run_sift_simpoint_${simpoint}.sh"
cat > "$script_file" << EOF
#!/usr/bin/env bash
set -euo pipefail
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Generating SIFT for SimPoint ${simpoint} (weight: ${weight})";
# 個別実行ディレクトリにRUN_DIRの内容をコピー(初回のみ)
# run_base_ref_gcc.0000はsubcmdレベルで既に作成済みなので、実行ディレクトリの内容のみコピー
if [ ! -f "${simpoint_run_dir}/.copied" ]; then
if [ -d "${RUN_DIR}" ]; then
# RUN_DIRの内容をコピー(空の場合も対応)
if [ "\$(ls -A "${RUN_DIR}" 2>/dev/null)" ]; then
cp -r "${RUN_DIR}"/* "${simpoint_run_dir}/" 2>&1 || {
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Warning: Failed to copy some files from ${RUN_DIR} to ${simpoint_run_dir}" >&2;
};
fi;
touch "${simpoint_run_dir}/.copied";
else
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Error: RUN_DIR ${RUN_DIR} does not exist" >&2;
exit 1;
fi;
fi;
cd "${simpoint_run_dir}" && \\
SNIPER_ROOT="${SNIPER_ROOT}" \\
GRAPHITE_ROOT="${SNIPER_ROOT}" \\
PIN_HOME="${PIN_HOME}" \\
PIN_LD_RESTORE_REQUIRED=1 \\
PIN_VM_LD_LIBRARY_PATH="${sniper_vm_ld_path}" \\
PIN_APP_LD_LIBRARY_PATH="${original_ld_path}" \\
SNIPER_SCRIPT_LD_LIBRARY_PATH="${sniper_script_ld_path}" \\
LD_LIBRARY_PATH="${sniper_vm_ld_path}" \\
LD_PRELOAD= \\
QEMU_CPU="${QEMU_CPU_OPTIONS}" \\
"${QEMU}" ${QEMU_FLAGS} -plugin "${QEMU_FRONTEND_PLUGIN}",verbose=on,response_files=on,fast_forward_target=${fast_forward_target},detailed_target=${detailed_target},output_file="${output_base}" ${cmd_suffix_noL} \\
> "${output_base}.log" 2>&1 && \\
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Completed SimPoint ${simpoint}" || \\
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] Failed SimPoint ${simpoint}"
EOF
chmod +x "$script_file"
echo "$script_file" >> "$all_script_list_file"
done
echo "[${BENCHMARK} SIFT ${cmd_num}/${NUM_SUBCMDS}] All SimPoints processed"
done
この処理は、各サブコマンドに対して以下の処理を行う。
コマンドの前処理:
specinvokeで取得したコマンドから、リダイレクト部分を除去してクリーンなコマンドを生成する。SimPointファイルの探索: サブコマンド番号に対応するSimPointファイルと重みファイルを探索する。見つからない場合はスキップする。
ディレクトリ構造の準備: 各サブコマンド用のディレクトリを作成し、
run_base_ref_gcc.0000ディレクトリをコピーする。これは、ベンチマーク実行時に相対パスで参照されるファイルへのアクセスを可能にするためである。SimPointごとのスクリプト生成: 各SimPointに対して、個別の実行スクリプトを生成する。スクリプト内では以下の処理を行う。
- 実行ディレクトリの準備(初回のみコピー)
- QEMUプラグインを使用したSIFTトレース生成
fast_forward_targetとdetailed_targetの設定
fast_forward_targetとdetailed_targetの計算
# fast_forward_target = SimPointIndex * interval
fast_forward_target=$((simpoint * interval))
detailed_target="${interval}"
fast_forward_targetは、SimPointのインデックスにインターバル長を掛けた値である。これは、QEMUプラグインに対して、指定された命令数まで高速に実行し、その後詳細トレースを開始する位置を指定する。
detailed_targetは、詳細トレースを取得する命令数である。通常はSimPointインターバル長と同じ値に設定される。
並列実行
# 生成したすべてのスクリプトファイルを並列実行
if [ -f "$all_script_list_file" ] && [ -s "$all_script_list_file" ]; then
num_scripts=$(wc -l < "$all_script_list_file")
echo "=== Executing $num_scripts scripts in parallel ==="
cat "$all_script_list_file" | \
SHELL=/bin/bash parallel --line-buffer -j ${PARALLEL_JOBS} bash '{}' 2>&1 || {
echo "Warning: Some scripts failed. Check logs in ${sift_dir_abs}" >&2;
};
rm -f "$all_script_list_file"
fi
生成したすべてのスクリプトファイルをGNU parallelを使用して並列実行する。--line-bufferオプションにより、各ジョブの出力が即座に表示される。エラーが発生しても処理は継続し、警告メッセージが表示される。
QEMUプラグインの使用方法
生成されたスクリプトでは、QEMUのフロントエンドプラグインを使用してSIFTトレースを生成する。
"${QEMU}" ${QEMU_FLAGS} -plugin "${QEMU_FRONTEND_PLUGIN}",verbose=on,response_files=on,fast_forward_target=${fast_forward_target},detailed_target=${detailed_target},output_file="${output_base}" ${cmd_suffix_noL} \
プラグインの主要なオプションは以下の通りである。
verbose=on: 詳細なログ出力を有効にするresponse_files=on: レスポンスファイル形式で出力するfast_forward_target: 高速実行を終了し、詳細トレースを開始する命令数detailed_target: 詳細トレースを取得する命令数output_file: 出力ファイルのベース名
実行例
特定のベンチマークに対してSIFTトレースを生成するには、以下のコマンドを実行する。
make run_sift_429.mcf
すべてのベンチマークに対してSIFTトレースを生成するには、以下のコマンドを実行する。
make run_sift