-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathDEVELOP
More file actions
223 lines (163 loc) · 4.48 KB
/
Copy pathDEVELOP
File metadata and controls
223 lines (163 loc) · 4.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# SLIM開発者ガイド
## ビルド
### CMakeを使った通常ビルド
```bash
./build-cmake.sh
```
### CMakeを使ったデバッグビルド
```bash
./build-cmake.sh --debug
```
### アドバンストビルド: 全ての開発者向け機能を有効化
```bash
./build-cmake.sh --devel
```
### 手動CMakeビルド
```bash
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)
make install
```
### デバッグ用手動ビルド
```bash
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON
make -j$(nproc)
make install
```
## テスト
### 通常のテスト
```bash
# プロジェクトルートから(推奨 - 最もシンプル)
./run-tests.sh
# または(詳細な出力)
./run-tests.sh --output-on-failure
```
### 非決定性実行の重いテスト(モデル検査)も含む
```bash
slim_CHECK_ND=yes ./run-tests.sh
```
### より詳細なテスト結果を表示
```bash
./run-tests.sh --output-on-failure
./run-tests.sh -V # 更に詳細
```
### 特定のテストのみ実行
```bash
./run-tests.sh -R "basic" # basic テストのみ
./run-tests.sh -L "statespace" # statespace テストのみ
```
## プロファイリング
### gcov を使ったカバレッジ測定
```bash
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="--coverage" -DCMAKE_C_FLAGS="--coverage"
make -j$(nproc)
make install
cd .. && ./run-tests.sh
cd build && gcov ../src/*.cpp
```
### gprof を使った実行時間プロファイリング
```bash
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-pg" -DCMAKE_C_FLAGS="-pg" -DCMAKE_EXE_LINKER_FLAGS="-pg"
make -j$(nproc)
make install
./bin/slim your_program.il
gprof ./bin/slim gmon.out > profile.txt
```
## デバッグ
### gdb を使ったデバッグ
```bash
./build-cmake.sh --debug
gdb ./build/bin/slim
```
### Valgrind を使ったメモリリークチェック
```bash
valgrind --leak-check=full ./build/bin/slim your_program.il
```
## コードフォーマット
```bash
# 個別ファイル
clang-format -i filename.cpp
# 全ファイル(スクリプト使用)
./scripts/format.sh
# 手動で全ファイル
find src -name "*.cpp" -o -name "*.h" | xargs clang-format -i
```
## 静的解析
```bash
# Clang-Tidy を使った静的解析
./scripts/lint.sh
```
## ビルドオプション
### CMake主要オプション
```bash
cmake .. -DCMAKE_BUILD_TYPE=Release|Debug # ビルドタイプ
cmake .. -DENABLE_DEBUG=ON|OFF # デバッグ機能
cmake .. -DENABLE_DEVEL=ON|OFF # 開発者向け機能
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local # インストール先
```
### カスタムビルドディレクトリ
```bash
./build-cmake.sh --build-dir mybuild
```
## リリース手順
1. バージョン番号を更新(VERSION ファイル)
2. NEWS ファイルを更新
3. コミット・タグ付け
4. CMake パッケージ作成:
```bash
cd build
cpack
```
5. GitHub Releases にアップロード
## クリーンビルド
```bash
# ビルドディレクトリを削除
rm -rf build
# 再ビルド
./build-cmake.sh
```
## 継続的インテグレーション
GitHub Actions ワークフローは `.github/workflows/c-cpp.yml` で定義されています。
```bash
# ローカルでCI相当のテスト
./build-cmake.sh
slim_CHECK_ND=yes ./run-tests.sh --output-on-failure
```
## 環境変数
- `LMNTAL_HOME`: LMNtal コンパイラのホームディレクトリ
- `slim_CHECK_ND`: "yes" に設定すると非決定性実行テストを含む
- `slim_CHECK_OPTIONS`: テスト実行時の追加オプション
- `SLIM_BINARY`: テスト時に使用するSLIMバイナリのパス
## トラブルシューティング
### よくある問題
1. **LMNTAL_HOME が設定されていない**
```bash
export LMNTAL_HOME=/path/to/lmntal-compiler
```
2. **依存関係が不足**
```bash
# Ubuntu/Debian
sudo apt install cmake build-essential bison re2c ruby
```
3. **テストが失敗する**
```bash
# 詳細出力でテスト実行
./run-tests.sh --output-on-failure -V
```
## パフォーマンステスト
```bash
# ベンチマークスクリプト実行(要修正)
./benchmarkset/exec_all_ltl.sh
```
## 開発ワークフロー
1. 機能ブランチを作成
2. コードを編集
3. フォーマット: `./scripts/format.sh`
4. ビルド: `./build-cmake.sh`
5. テスト: `./run-tests.sh`
6. コミット・プッシュ
7. プルリクエスト作成