使用方法
メモ
Fortranについてのメモ
- AutotoolsはFortranのプロジェクトにも使える。
- AC_LANG(Fortran), AC_PROG_FC(gfortran ifort)などを使う。
- 関係する変数はFC, FCFLAGS, FCLIBS, CPPFLAGSなど。
- Fortranでもcpp（Cプリプロセッサ）を使うと便利。
その場合、ソースのファイル名の拡張子は.Fを使う。.F90はGNU makeのデフォルトでないので使わない。
- CプリプロセッサのオプションはCPPFLAGS変数で与える。
Fortranのプロジェクトの場合はAC_ARG_VARでその使用を明示的に宣言する（後述）。
- AC_FC_FREEFORM()で自由形式のオプションがわかる。
- C/C++のプロジェクトの場合はファイル間の依存関係を自動的に調べてくれるが、
Fortranの場合はMakefile.amに依存関係を書いておくことがまだ必要。
- C言語のプロジェクトの場合はAC_CHECK_HEADERS([fftw3.h])でヘッダファイルの有無を調べることができるが、
Fortranの場合はAC_CHECK_HEADERS([fftw3.f])やAC_CHECK_HEADERS([fftw3.f03])とするのはまだ困難。
- module名とそのファイル名は_moduleを付けて、例えばmodule foo_module, foo_module.Fと一致させる。
- use foo_module しているソースはfoo_module.oに依存している（例: bar.o: foo_module.o）とsrc/Makefile.amに記述する。
- foo_module.Fをコンパイルするとfoo_module.modとfoo_module.oとの２つのファイルができる。
そのような複数ターゲットができる状況をMakefileに記述するにはコツがいることが知られている
http://www.bookshelf.jp/texi/automake-ja/automake-ja_26.html#SEC150 が、
わざわざ記述する必要はない。上述の通り bar.o: foo_module.o と書いておけば十分。
- Fortranは.modファイルを通してサブルーチンの引数の型のチェックを行うので、moduleは積極的に用いるべき。
手順
configure.ac, Makefile.am, src/Makefile.amを書いて、
$ autoreconf -v
$ automake --add-missing # 初回にautoreconfで実行を要求されたとき。Cygwinの場合は--copyもつけた方がよい。
$ autoreconf -v # ☆
$ ./configure
$ make # ソースの編集など開発を進め、最後にmakeでコンパイルできることを確認
$ make distclean # Makefileなどをきれいさっぱり消す
$ ./configure
$ make distcheck # 配布用パッケージをテストしてから作成（オプションは DISTCHECK_CONFIGURE_FLAGS で指定できる）
$ make dist # 配布用パッケージの作成
新たにconfigure.ac, Makefile.am, src/Makefile.amを書き変えたら☆からやり直す。
実際は☆からやり直さずとも、Makefile に Fig. 1 にある依存関係が書き込まれているので、
make だけで Makefile そのものがうまい具合に更新される。他に
$ make clean # makeでできたファイルを消去
$ make check # コンパイルしたバイナリをテスト（後述）
$ sudo make install
$ make installcheck # インストールしたバイナリをテスト（後述）
$ sudo make uninstall # make installしたファイルの消去
などが便利。
make checkでテストの自動化
src/Makefile.amに
TESTS=foo.sh bar baz
と書いておけば
$ make check
でsrc/の中でfoo.shとbarとbazとがテストとして実行される。
ソフトウェアのテストを自動化できる。
foo.shとbarとbazとはカレントディレクトリになければsrcdirの中も探されるので、
build directoryの中でもテストができる。
ただし、foo.shは自動的にパッケージに入れてくれるわけではないので、
Makefile.amの中のEXTRA_DISTに次のように加えておく必要がある。
EXTRA_DIST = README foo.sh
テストのログがfoo.sh.logとbar.logとbaz.logとに、
テストの結果がfoo.sh.trsとbar.trsとbaz.trsとに保存される。
テスト全体のまとめがtest-suite.logに保存される。
一部のテストだけを選択的に行いたい場合は
$ make check TESTS='foo.sh bar'
とTESTS変数で指定するする。
テストスクリプトの中でsrcdirを明示的に参照する必要がある場合は$srcdirを用いる。
make distcheck とすると、上記テストとさらにファイルの過不足のチェックして、最終的にパッケージを作ることができる。
make distcheck で作るパッケージは、簡単かつ自動的に in-source build, out-of-source build のどちらも可能になる。
automakeのオプション
automakeのオプションはconfigure.acの中にAM_INIT_AUTOMAKEで指定する。例えば
AM_INIT_AUTOMAKE([1.14.1 no-dist-gzip dist-xz tar-pax foreign])
では、automakeのバージョン1.14.1以上を使用することを強制し、
パッケージをtar.gzでなくtar.xzで作るように指定している。
また、長いディレクトリ名／ファイル名でもパッケージに入るようなtarのオプションを指定している。
foreignを指定しておけば、NEWS, COPYING, AUTHORS, ChangeLog, READMEのファイルが勝手に作られるのを防ぐことができる。
ライセンスとしてGLPを採用するとしても、ここにforeignを指定して、
パッケージに含めたいファイルはMakefile.amのEXTRA_DISTに明示的にリストアップするのがよいだろう。
Autotools Mythbuster の該当ページ https://autotools.io/automake/options.html が詳しい。
インストールしたバイナリのテスト make installcheck
さらにAM_INIT_AUTOMAKEにstd-optionsを加えておけば
$ sudo make install
でバイナリをインストールした後に
$ make installcheck
とすると、そのインストールしたバイナリで
GNU的なコマンドラインオプションの--helpと--versionとをテストできる。
エラーが起きればログが残こされ、テストが成功したなら何も残らない。
Makefile.amの中にinstallcheck-local:ルールを書いておけばそれも実行される。
installcheckは一般的なテストではないので、make installcheckとしても何も実行されないパッケージも多い。
コンパイラとコンパイラオプションの設定と決定
C, Fortran, C++コンパイラとそのオプションはそれぞれ
AC_PROG_CC(), AC_PROG_FC(), AC_PROG_CXX() が
configure.ac の中で決定する。コンパイラは CC, FC, CXX に、
コンパイラオプションは CFLAGS, FCFLAGS, CXXFLAGS に
セットされる。 コンパイラオプションのデフォルトはたいてい
-g -O2 または -O2 である。configure.ac の中で
デフォルト以外に独自に設定したい場合には
cflags_save="$CFLAGS"
AC_PROG_CC()
CFLAGS="$cflags_save"
test -n "$CFLAGS" || CFLAGS="-g -Wall -O3"
などとAC_PROG_*()の前後でsave/restoreし、その後に独自設定をする。
configureにオプションや変数を与える方法
configureにオプションや変数を与える方法は
$ ./configure --help
で表示されるように、
$ ./configure --enable-openmp --with-lapack=mkl CPPFLAGS=-I/home/t-nissie/include
などと
- --enable-FEATURE, --disable-FEATURE
- --with-PACKAGE, --without-PACKAGE
- FOO='bar baz'
の３つがある。それぞれconfigure.acの中で
- AC_ARG_ENABLE(openmp, [AC_HELP_STRING([--enable-openmp],[use OpenMP directives for parallelism])], enable_openmp=$enableval, enable_openmp=no)
- AC_ARG_WITH(lapack,[AS_HELP_STRING([--with-lapack=ARG],[LAPACK library.])])
- AC_ARG_VAR(CPPFLAGS, [C preprocessor (CPP) Flags, e.g. -I<include dir>])
と宣言しておく。設定される変数はconfig.hを通してプログラム内で参照できる。
注意：CPPFLAGS変数はC/C++のプロジェクトの場合は自動的に使用されるので宣言の必要はない。
Fortranのプロジェクトの場合は明示的に宣言してはじめてconfigure --helpで説明が表示されるようになる。
configureに与えられた引数はconfig.logの先頭に記録されるので、後々の再確認に便利である。
ただし、''や""のクォーテイションは消えてしまう。
Manpage
パッケージにUNIXのmanシステムの流儀に則って書いたmanpageを同梱する場合は、Makefile.amに
man_MANS = xtalgrowth.1 crystal_growth.7
EXTRA_DIST = README COPYING $(man_MANS)
などと書く。ここで数字の1や7はmanpageのセクション番号で1〜9の値をとり、
その番号にしたがってmanpageは/usr/local/share/man/man1/などにmake installでインストールされる。
manpageはデフォルトでパッケージに同梱されないのでEXTRA_DISTに加えておく。
Documents
マニュアルなどドキュメントを (prefix)/share/doc/(パッケージ名)/ にインストールするには
Makefile.am の中の dist_doc_DATA にインストールしたいファイルを指定する。
さらに例えば figures/ サブディレクトリを作ってその中にJPEGファイルなどをインストールしたい場合は次の通り。
docfiguresdir = $(docdir)/figures
dist_doc_DATA = index.en.html index.es.html index.ja.html COPYING style.css favicon.ico README.md
EXTRA_DIST = index.en.html index.es.html index.ja.html COPYING style.css favicon.ico figures\
CMakeLists.txt ChangeLog.md $(man_MANS)
dist_docfigures_DATA = figures/cd.jpg figures/example.jpg figures/large.jpg figures/xtals.jpg
dist_doc_DATAに指定してもREADME.md以外はソースパッケージに自動で同梱されないのでEXTRA_DISTに加えておく。
Ref.: https://stackoverflow.com/questions/23839858/autotools-not-installing-directories-appends-to-directories-only
任意のディレクトリへのファイルのインストール
PREFIX/bin/やPREFIX/share/ではない任意のディレクトリへファイルをインストールしたい場合は
https://stackoverflow.com/questions/3538705 とその中のproski氏のアドバイスを参考に
configure.ac には
AC_ARG_WITH([pkgconfigdir],
[AS_HELP_STRING([--with-pkgconfigdir=DIR], [pkgconfig files [LIBDIR/pkgconfig]])],
[pkgconfigdir=$withval],
[pkgconfigdir='${libdir}/pkgconfig'])
AC_SUBST(pkgconfigdir)
Makefile.am には
dist_pkgconfig_DATA = mylibrary.pc
と書く。`--pkgconfigdir`のような新しいconfigureオプションを作るのは難しそう。
任意のファイル内の変数の置換
テキストファイルの中にconfogureで決定された変数を挿入したいことはしばしばある。
たとえば、foo.1.inに
This is a manpage of foo version @PACAGE_VERSION@.
と書いておき、configure.acの中で
AC_CONFIG_FILES([Makefile src/Makefile foo.1])
とAC_CONFIG_FILESにMakefileに加えてfoo.1を指定しておく。
config.statusがMakefile.in→Makefileと同様にfoo.1.in→foo.1の変換もするようになる。
