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

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 を使えば
コメントを投稿
続きを読む

Perl のサブルーチンシグネチャ早見表

Perl のサブルーチン引数といえば実引数への参照を保持する特殊配列 @_ を手続き的に分解するのが長らくの伝統だった。これはシェルの特殊変数 $@ に由来する意味論で、おそらく JavaScript の arguments 変数にも影響を与えている。 すべての Perl サブルーチンはプロトタイプ宣言がない限りリスト演算子なので、この流儀は一種合理的でもあるのだが、実用的にそれで良いかというとまったくそうではないという問題があった; 結局大多数のサブルーチンは定数個の引数を取るので、それを参照する形式的パラメータが宣言できる方が都合が良いのである。 そういうわけで実験的に導入されたサブルーチンシグネチャ機能により形式的パラメータが宣言できるようになったのは Perl 5.20 からである。その後 Perl 5.28 において出現位置がサブルーチン属性の後に移動したことを除けば Perl 5.34 リリース前夜の今まで基本的に変わっておらず、未だに実験的機能のままである。 おまじない シグネチャは前方互換性を持たない (構文的にプロトタイプと衝突している) 実験的機能なのでデフォルトでは無効になっている。 そのため明示的にプラグマで利用を宣言しなければならない: use feature qw/signatures/; no warnings qw/experimental::signatures/; どの途みんな say 関数のために使うので feature プラグマは問題ないだろう。実験的機能を断りなしに使うと怒られるので、 no warnings で確信犯であることをアピールする必要がある。 これでプラグマのスコープにおいてサブルーチンシグネチャ (と :prototype 属性; 後述) が利用可能になり、 従来のプロトタイプ構文が無効になる。 使い方 対訳を載せておく。シグネチャの方は実行時に引数チェックを行うので厳密には等価でないことに注意: # Old School use feature qw/signatures/ 1 sub f { my ($x) = @_; ... } sub f($x) { ... } 2 sub f { my ($x, undef, $y) = @_
コメントを投稿
続きを読む

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 の
コメントを投稿
続きを読む

Perl 5 to 6 - 列挙型

これはMoritz Lenz氏のWebサイト Perlgeek.de で公開されているブログ記事 "Perl 5 to 6" Lesson 16 - Enums の日本語訳です。 原文は Creative Commons Attribution 3.0 Germany に基づいて公開されています。 本エントリには Creative Commons Attribution 3.0 Unported を適用します。 Original text: Copyright© 2008-2010 Moritz Lenz Japanese translation: Copyright© 2011 SATOH Koichi NAME "Perl 5 to 6" Lesson 16 - 列挙型 SYNOPSIS enum bit Bool <False True>; my $value = $arbitrary_value but True; if $value { say "Yes, it's true"; # 表示される } enum Day ('Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'); if custom_get_date().Day == Day::Sat | Day::Sun { say "Weekend"; } DESCRIPTION 列挙型は用途の広い獣です。定数の列挙からなる低レベルのクラスであり、定数は典型的には整数や文字列です(が任意のものが使えます)。 これらの定数は派生型やメソッド、あるいは通常の値のようにふるまいます。 but 演算子でオブジェクトに結びつけることができ、これによって列挙型を値に「ミックスイン」できます: my $x = $today but Day::Tue; 列挙型の型名を関数のように使うこともでき、引数として値を指定できます: $x = $today but Day($weekday);
コメントを投稿
続きを読む