スキップしてメイン コンテンツに移動

C の時間操作関数は tm 構造体の BSD 拡張を無視するという話

ラベル:

久しぶりに C++ (as better C) で真面目なプログラムを書いていて引っかかったので備忘録。 「拡張なんだから標準関数の挙動に影響するわけねえだろ」という常識人は読む必要はない。

要旨

  • time_t の表現は環境依存
  • サポートしている時刻は UTC とプロセスグローバルなシステム時刻 (local time) のみで、任意のタイムゾーン間の時刻変換を行う標準的な方法はない
  • BSD / GNU libc は tm 構造体にタイムゾーン情報を含むが、tm -> time_t の変換 (timegm / mktime) においてその情報は無視される

事前知識

C 標準ライブラリにおいて時刻の操作に関係するものは time.h (C++ では ctime) ヘッダに定義されている。ここで時刻を表現するデータ型は2つある: time_t と tm である。time_t が第一義的な型であり、それを人間が扱い易いように分解した副次的な構造体が tm という関係になっている。なので標準ライブラリには現在時刻を time_t として取得する関数 (time_t time(time_t *)) が先ずあり、そこから time_t と tm を相互に変換する関数が定義されている。

ここで time_t の定義は処理系依存である。C / C++ 標準はそれが算術型であることを求めているのみで (C11 からは実数型に厳格化された)、その実体は任意である。POSIX においては UNIX epoch (1970-01-01T00:00:00Z) からのうるう秒を除いた経過秒数であることが保証されており Linux や BSD の子孫も同様だが、この事実に依存するのは移植性のある方法ではない。

一方で tm は構造体であり、最低限必要なデータメンバが規定されている:

  • int tm_year: 1900 年からの年数
  • int tm_mon: 月 (0-based; 即ち [0, 11])
  • int tm_mday: 月初からの日数 (1-based)
  • int tm_hour: 時 (Military clock; 即ち [0, 23])
  • int tm_min: 分
  • int tm_sec: 秒 (うるう秒を含み得るので [0, 60])
  • int tm_wday: 直近の日曜日からの日数
  • int tm_yday: 年初からの日数
  • int tm_isdst: サマータイム中か (1) 否か (0)

tm_isdst 以外タイムゾーンに関係する項目がないのが分かる。

また BSD / GNU libc は以下のデータメンバも含む:

  • char *tm_zone: 考慮したタイムゾーンの名前
  • long gmtoff: 考慮したタイムゾーンのUTC からのオフセット秒数

tm_zone が指しているのはライブラリ内部で管理している領域なので、const はついていないものの書き換えたりするべきではない。

タイムゾーン

time_t は扱うシステムのタイムゾーンに依らない表現だが、それを変換した tm はカレンダー日時なので当然影響を受ける。 そのため C 標準ライブラリが提供する time_t -> tm の変換は常に UTC に基いて計算する gmtime と、プロセスのタイムゾーン設定を考慮した localtime の2種が提供されている。 逆の操作 (tm -> time_t) は local time に対応する mktime だけが標準化されている。BSD / GNU libc には名前の対称性から timegm / timelocal (mktime の同義語) が存在する。

今「プロセスのタイムゾーン設定」と書いたとおり、タイムゾーン設定はプロセスグローバルである。またその設定方法 (POSIX であれば TZ 環境変数を設定して tzset 関数で変更を反映する) は環境依存なので、C 標準ライブラリには任意のタイムゾーン間の時刻変換をする可搬な方法はないものと思って良い。

gmtime で時刻を得た場合、time_isdst = 0 / tm_zone = "GMT" / tm_gmtoff = 0 になる。 localtime の場合は環境によるが、例えば TZ=Asia/Tokyo (JST) な環境なら time_isdst = 0 / tm_zone = "JST" / tm_gmtoff = 32400 になるだろう。

tm から time_t への逆変換

さて得られたカレンダー日時を再び time_t 表現に戻す操作を考える。この場合に使える変換は先述のように timegm / mktime (timelocal; 対称性から以後こちらを使う) である。

tm 構造体は便利のために tm_wday / tm_yday データメンバを持つが、これらは tM_year / tm_mon / tm_mday から定まるので単に無視される。整合性はチェックされない。

time_t から tm への変換時には tm の各データメンバは自明な値域内の値を持ったが、逆変換に渡す tm 構造体はそれらを逸脱する値を持っても良い: tm_mon = 8 / tm_mday = 40 (9月40日) なら tm_mon = 9 / tm_mday = 10 (10月10日) に正規化されるし、tm_year = 100 / tm_mon = -1 (2000年-1月) なら tm_year = 99 / tm_mon = 11 (1999年12月) になる。

ややこしいのは tm_isdst の扱いで、まず timegm で変換する場合単に無視される。サマータイムは有り得ないからだ。timelocal の場合、tm_isdst >= 1 / tm_isdst = 0 はそれぞれサマータイム中か否かを示しそれを計算に含む。tm_isdst < 0 のときは環境変数で設定されたタイムゾーンから指定の日付がサマータイム中か否かを自動判定する。

ところで BSD / GNU 拡張の tm_zone / tm_gmtoff だが、実はこれらも常に無視される。例え tm_zone = "JST" / tm_gmtoff = 32400 になっていようが TZ=Europe/Berlin な環境で timelocal を呼べば CET (UTC+0100) タイムゾーンにおける日時として計算される。

#include <cstdio>
#include <cstdlib>
#include <ctime>

using namespace std;

int main() {
  time_t now = time(nullptr);
  tm calendar = *localtime(&now);

  // Resets local time zone to CET.
  setenv("TZ", "Europe/Berlin", 1);
  tzset();
  // Restores |time_t|, treating the given |calendar| as a CET datetime.
  time_t restored_in_cet = timelocal(&calendar);

  // Shows difference between CET and original time zone, in seconds.
  printf("%lf\n", difftime(restored_in_cet, now));

  return 0;
}

これをコンパイルして実行すると以下の結果を得られる:

% clang++ --std=c++11 -o timelocal timelocal.cc
% TZ=Asia/Tokyo ./timelocal
28800.000000

考えてみればこれは当たり前で、mktime が標準ライブラリ関数である以上、拡張データメンバを参照して挙動が変わると仕様を逸脱してしまうのだった。おしまい。

コメント

コメントを投稿

このブログの人気の投稿

開発環境の構築に asdf が便利なので anyenv から移行した

プロジェクト毎に異なるバージョンの言語処理系やツールを管理するために、pyenv や nodenv など *env の利用はほとんど必須となっている。 これらはほとんど一貫したコマンド体系を提供しており、同じ要領で様々な環境構築ができる非常に便利なソフトウェアだが、それを使うことで別の問題が出てくる: *env 自身の管理である。 無数の *env をインストールし、シェルを設定し、場合によりプラグインを導入し、アップデートに追従するのは非常に面倒な作業だ。 幸いなことにこれをワンストップで解決してくれるソリューションとして anyenv がある。これは各種 *env のパッケージマネージャというべきもので、一度 anyenv をインストールすれば複数の *env を簡単にインストールして利用できる。さらに anyenv-update プラグインを導入すればアップデートまでコマンド一発で完了する。素晴らしい。 そういうわけでもう長いこと anyenv を使ってきた。それで十分だった。 ——のだが、 ここにもう一つ、対抗馬となるツールがある。 asdf である。anyenv に対する asdf の優位性は大きく2つある: 一貫性と多様性だ。 一貫性 “Manage multiple runtime versions with a single CLI tool” という触れ込み通り、asdf は様々な言語やツールの管理について一貫したインタフェースを提供している。対して anyenv は *env をインストールするのみで、各 *env はそれぞれ個別のインタフェースを持っている。 基本的なコマンド体系は元祖である rbenv から大きく外れないにしても、例えば jenv のように単体で処理系を導入する機能を持たないものもある。それらの差異はユーザが把握し対応する必要がある。 多様性 asdf はプラグインシステムを持っている。というより asdf 本体はインタフェースを規定するだけで、環境構築の実務はすべてプラグイン任せである。 そのプラグインの数は本稿を書いている時点でおよそ 300 を数える。これは言語処理系ばかりでなく jq などのユーティリティや MySQL のようなミドルウェアも含むが、いずれにしても膨大なツールが asdf を使えば
コメントを投稿
続きを読む

BuckleScript が ReScript に改称し独自言語を導入した

Via: BuckleScript Good and Bad News - Psellos OCaml / ReasonML 文法と標準ライブラリを採用した JavaScript トランスパイラである BuckleScript が ReScript に改称した。 公式サイトによると改称の理由は、 Unifying the tools in one coherent platform and core team allows us to build features that wouldn’t be possible in the original BuckleScript + Reason setup. (単一のプラットフォームとコアチームにツールを統合することで従来の BuckleScript + Reason 体制では不可能であった機能開発が可能になる) とのこと。要は Facebook が主導する外部プロジェクトである ReasonML に依存せずに開発を進めていくためにフォークするという話で、Chromium のレンダリングエンジンが Apple の WebKit から Google 主導の Blink に切り替わったのと似た動機である (プログラミング言語の分野でも Object Pascal が Pascal を逸脱して Delphi Language になったとか PLT Scheme (の第一言語) が RnRS とは別路線に舵を切って Racket になったとか、割とよくある話である。) 公式ブログの Q&A によると OCaml / ReasonML 文法のサポートは継続され、既存の BuckleScript プロジェクトは問題なくビルドできるとのこと。ただし現時点で公式ドキュメントは ReScript 文法のみに言及しているなど、サポート水準のティアを分けて ReScript 文法を優遇することで移行を推進していく方針である。 上流である OCaml の更新は取り込み、AST の互換性も維持される。将来 ReScript から言語機能が削除されることは有り得るが、OCaml / ReasonML からは今日の BuckleScript が提供する機能すべてにアクセスできる。 現時点における ReScript の
コメントを投稿
続きを読む

去る6月に Perl 5.32.0 がリリースされたので差分を把握するために perldelta を読んだ件

要旨 Perl 5 メジャーバージョンアップの季節がやって来たのでまともな Perl プログラマの嗜みとして perldelta を読んだ。 今回は有り体に言えばルーティン的なリリースで、言語コアの拡張は他言語にも見られる構文が実験的に入ったくらいで大きな変化はない。新機能は RegExp の拡充が主である。 比較的重要と思われる変更点を抜粋する。 新機能 isa 演算子 実験的機能。Python とか Java における isinstance とか instanceof 。 これまでも UNIVERSAL::isa があったが、これはメソッドなのでレシーバにオブジェクトでもクラスでもない値 (i.e., 未定義値 / bless されていないリファレンス) を置くと実行時エラーが起きるのが問題だった: package Foo { use Moo; } package Bar { use Moo; extends ' Foo ' ; } package Baz { use Moo; } use feature qw/ say / ; sub do_something_with_foo_or_return_undef { my ( $foo ) = @_ ; # Returns safely if the argument isn't an expected instance, in mind. return unless $foo -> isa ( ' Foo ' ); ...; } # OK. do_something_with_foo(Bar->new); # |undef| is expected in mind, but actually error will be thrown. do_something_with_foo( undef ); これを避けるために今までは Scalar::Util::blessed を併用したりしていたわけだが、 isa 演算子は左辺が何であっても意味のある値を返すのでよりシンプルになる: # True +( bless +{}
コメントを投稿
続きを読む

Perl 7 より先に Perl 5.34 が出るぞという話

Perl 5 の次期バージョンとして一部後方互換でない変更 (主に間接オブジェクト記法の削除とベストプラクティスのデフォルトでの有効化) を含んだメジャーバージョンアップである Perl 7 がアナウンスされたのは昨年の 6 月 のことだったが、その前に Perl 5 の次期周期リリースである Perl 5.34 が 5 月にリリース予定 である。 現在開発版は Perl 5.33.8 がリリースされておりユーザから見える変更は凍結、4 月下旬の 5.33.9 で全コードが凍結され 5 月下旬に 5.34.0 としてリリース予定とのこと。 そういうわけで事前に新機能の予習をしておく。 8進数数値リテラルの新構文 見た瞬間「マジかよ」と口に出た。これまで Perl はプレフィクス 0 がついた数値リテラルを8進数と見做してきたが、プレフィクスに 0o (zero, small o) も使えるようになる。 もちろんこれは2進数リテラルの 0b や 16進数リテラルの 0x との一貫性のためである。リテラルと同じ解釈で文字列を数値に変換する組み込み関数 oct も` 新構文を解するようになる。 昨今無数の言語に取り入れられているリテラル記法ではあるが、この記法の問題は o (small o) と 0 (zero) の区別が難しいことで、より悪いことに大文字も合法である： 0O755 Try / Catch 構文 Perl 5 のリリース以来 30 年ほど待たれた実験的「新機能」である。 Perl 5 における例外処理が特別な構文でなかったのは予約語を増やさない配慮だったはずだが、TryCatch とか Try::Tiny のようなモジュールが氾濫して当初の意図が無意味になったというのもあるかも知れない。 use feature qw/ try / ; no warnings qw/ experimental::try / ; try { failable_operation(); } catch ( $e ) { recover_from_error( $e ); } Raku (former Perl 6) だと CATCH (大文字なことに注意) ブロックが自分の宣言されたスコープ内で投げられた例外を捕らえる
1 件のコメント
続きを読む