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

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 が標準ライブラリ関数である以上、拡張データメンバを参照して挙動が変わると仕様を逸脱してしまうのだった。おしまい。

コメント

コメントを投稿

このブログの人気の投稿

LIBLINEAR 2.41 で One-class SVM が使えるようになったので Perl から触ってみよう

改訂 (Sep 15, 2020): 必要のない手順を含んでいたのでサンプルコードと記述を修正しました。 CPAN に Algorithm::LibLinear 0.22 がリリースされました (しました。) 高速な線形 SVM およびロジスティック回帰による複数の機械学習アルゴリズムを実装したライブラリである LIBLINEAR への Perl バインディングです。 利用している LIBLINEAR のバージョンが LIBLINEAR 2.30 から LIBLINEAR 2.41 に上がったことで新しいソルバが追加され、One-class SVM (OC-SVM) による一値分類が利用可能になっています (しました。) OC-SVM って何 一値分類を SVM でやること。 一値分類って何 ある値が学習したクラスに含まれるか否かを決定する問題。 HBO の「シリコンバレー」に出てきた「ホットドッグ」と「ホットドッグ以外」を識別するアプリが典型。「ホットドッグ以外」の方は犬でも神でも一つの指輪でも何でも含まれるのがミソ。 二値分類の場合正反両者のデータを集める必要があるのに対して、一値分類の学習器は正例データのみしか要求しない (ものが多い。) 主な用途は外れ値検出で、もちろんホットドッグやホットドッグ様のものを検出したりもできる。 使い方 手順自体は他の二値ないし多値分類問題と同じです。つまり、 訓練パラメータを決めて 訓練データセットで訓練して テストデータセットで確度を検証して 十分良くなったらモデルを保存する といういつもの流れ。 訓練パラメータ use 5.032 ; use Algorithm::LibLinear ; my $learner = Algorithm::LibLinear ->new( epsilon => 0.01 , nu => 0.75 , solver => ' ONECLASS_SVM ' , ); solver => 'ONECLASS_SVM' が一値分類用のソルバです。LIBLINEAR の train コマンドで言うところの -s 21 。 OC-SVM の良いところは (ハイパー)...
コメントを投稿
続きを読む

Perl の新 class 構文を使ってみる

Perl 5 のオブジェクト指向機能は基本的には Python の影響を受けたものだが、データを名前空間 (package) に bless する機構だけで Perl 4 以来の名前空間とサブルーチンをそのままクラスとメソッドに転換し第一級のオブジェクト指向システムとした言語設計は驚嘆に価する。 実際この言語のオブジェクトシステムは動的型付言語のオブジェクト指向プログラミングに要求されるおよそあらゆる機能を暗にサポートしており、CPAN には Moose を筆頭とした屋下屋オブジェクトシステムが複数存在しているがその多くは Pure Perl ライブラリである。つまり「やろうと思えば全部手書きで実現できる」わけである。 そういうわけで Perl のオブジェクト指向プログラミングサポートは機能面では (静的型検査の不在という現代的には極めて重大な欠如を除けば) 申し分ないのだが、しかし Moose その他の存在が示しているように一つ明らかな欠点がある。記述の冗長さだ。 コンストラクタを含むあらゆるメソッドは第一引数としてレシーバを受ける単なるサブルーチンとして明示的に書く必要があるし、オブジェクトのインスタンス変数 (a.k.a. プロパティ / データメンバ) は bless されたデータに直接的ないし間接的に プログラマ定義の方法 で格納されるためアクセス手段は実装依存である。これはカプセル化の観点からは望ましい性質だが、他者の書いたクラスを継承するときに問題となる。ある日データ表現を変更した親クラスがリリースされると突然自分の書いた子クラスが実行時エラーを起こすようになるわけだ。 そうならないためにはインスタンス変数へのアクセスに (protected な) アクセサを使う必要があるのだが、そのためには親クラスが明示的にそれらを提供している必要があるし、そもそも Perl にはメソッドのアクセス修飾子というものがないので完全な制御を与えるならばオブジェクトの内部状態がすべて public になってしまう。 そのような事情もあり、特にパフォーマンスが問題にならないようなアプリケーションコードでは Moose のようなリッチな語彙を提供するオブジェクトシステムを使うことが 公式のチュートリアルでも推奨 されてきた。Perl コアのオブジェクトシステムの改良は...
コメントを投稿
続きを読む

Perl 5 to 6 - コンテキスト

2011-02-27: コメント欄で既に改訂された仕様の指摘がありました ので一部補足しました。 id:uasi に感謝します。 これはMoritz Lenz氏のWebサイト Perlgeek.de で公開されているブログ記事 "Perl 5 to 6" Lesson 06 - Contexts の日本語訳です。 原文は 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 06 - コンテキスト SYNOPSIS my @a = <a b c> my $x = @a; say $x[2]; # c say (~2).WHAT # Str() say +@a; # 3 if @a < 10 { say "short array"; } DESCRIPTION 次のように書いたとき、 $x = @a Perl5では $x は @a より少ない情報—— @a の要素数だけ——しか持ちません。 すべての情報を保存しておくためには明示的にリファレンスを取る必要があります: $x = \@a Perl6ではこれらは反対になります: デフォルトでは何も失うことなく、スカラ変数は配列を単に格納します。 これは一般要素コンテキスト(Perl5で scalar と呼ばれていたもの)及びより特化された数値、整数、文字列コンテキストの導入によって可能となりました。無効コンテキストとリストコンテキストは変更されていません。 特別な構文でコンテキストを強制できます。 構文 コンテキスト ~stuff 文字列 ?stuff 真理値 +stuff ...
2 件のコメント
続きを読む

去る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 +{} ...
コメントを投稿
続きを読む

多分週刊チラシの裏 (Oct 19, 2020 - Feb 26, 2021)

週刊とは言ったが毎週刊とは言ってないという言い訳。 C++ のコンパイルを高速化する小技 ビルドシステムやツールを変更せずともコーディングだけで改善できるコンパイル時間短縮テクニック。 #include を減らす インライン化を明示的に避ける 関数オーバーロードの可視性を制限する 公開シンボルを減らす の 4 本。 歯医者で歯を治したら記憶能力を失った話 歯医者で簡単な治療を受けた日から後、記憶が 90 分しか保持できなくなった英国の軍人の話。まるで「博士の愛した数式」だが実話である。 DRPK で売られていた Sim City っぽいゲームのリバースエンジニアリング 平壌市内のアプリストア (物理) で売られていた Sim City 風ゲームがインストールに失敗してライセンス認証で止まってしまったのでなんとか動かせないものかとリバースエンジニアリングしてみた話。 日本にあっては DPRK のデジタル事情というと 3G セルラーが現役とか国内 Web サイトのリストがポスター一枚に収まるとか何故かコンピュータ将棋の古豪とかの断片的な情報が伝え聞かれる程度だが、近頃は Android タブレットでゲームなどもできるらしい。 国内のインフラ及びエコシステム事情に合わせて元々フリーミアム + アプリ内課金モデルだったものが買い切り 5,000 KPW (< 1 USD) になっているなど、我々が失った自由が我々よりも不自由な (はずだと我々が信じている) 国に残存しているのは皮肉だろうか。 typosquatting は単なる typo じゃ済まない typo を狙って人気のあるドメインやソフトウェアに類似した名前をつける手法 (typosquatting) は人を辟易させるのみならずセキュリティの脅威である。 IQT が 2017 年から 2020 年にかけて Python ライブラリの中央リポジトリである PyPI において行った調査で、メジャーなライブラリに名前を似せたマルウェアが 40 個確認されたとのこと。 その内 16 個が単純なスペルミス狙い (e.g., “urlib3” vs. “urllib3”) で、26 個は正当なパッケージと混同するような名前 (e.g., “nmap-python” vs. “pytho...
コメントを投稿
続きを読む