Man page - gfarm(3)

Packages contains this manual

Available languages:

en ja

Manual

GFARM

NAME
SYNOPSIS
DESCRIPTION
初 期 化 ／ 終 了 処 理
フ ァ イ ル 入 出 力 処 理
デ ィ レ ク ト リ ア ク セ ス
フ ァ イ ル ／ デ ィ レ ク ト リ 操 作
ア ク セ ス コ ン ト ロ ー ル リ ス ト (ACL) 操 作
エ ラ ー コ ー ド
文 字 列 配 列 操 作 ユ ー テ ィ リ テ ィ
文 字 列 配 列 操 作 ユ ー テ ィ リ テ ィ マ ク ロ

NAME

gfarm - Gfarm フ ァ イ ル シ ス テ ム API ラ イ ブ ラ リ

SYNOPSIS

#include <gfarm/gfarm.h>

DESCRIPTION

Gfarm ラ イ ブ ラ リ は ， Gfarm フ ァ イ ル シ ス テ ム や ， ス ケ ジ ュ ー リ ン グ 機 能 に 対 す る イ ン タ ー フ ェ ー ス を 提 供 し ま す ． こ の マ ニ ュ ア ル は ラ イ ブ ラ リ の 概 要 を 記 述 し ま す ． 各 関 数 の 詳 細 は ， 関 数 単 位 の マ ニ ュ ア ル を 参 照 し て く だ さ い ．

初 期 化 ／ 終 了 処 理

gfarm_initialize () 関 数 は Gfarm ラ イ ブ ラ リ の 初 期 化 に ， gfarm_terminate () 関 数 は Gfarm ラ イ ブ ラ リ の 終 了 処 理 に 用 い ま す ．

フ ァ イ ル 入 出 力 処 理

既 存 の フ ァ イ ル を ス ト リ ー ム と し て オ ー プ ン す る に は gfs_pio_open () 関 数 を ， 新 規 フ ァ イ ル を 作 成 し て ス ト リ ー ム と し て オ ー プ ン す る に は gfs_pio_create () 関 数 を 用 い ま す ． フ ァ イ ル の ク ロ ー ズ は gfs_pio_close () 関 数 を 使 い ま す ．

gfs_pio_error () 関 数 は オ ー プ ン し て い る ス ト リ ー ム に 関 し て エ ラ ー が 生 じ て い る か を 判 別 し ， gfs_pio_eof () 関 数 は 読 み 込 み オ ー プ ン し て い る ス ト リ ー ム が フ ァ イ ル 末 尾 に 達 し て い る か を 判 別 し ま す ． gfs_pio_seek () 関 数 は ， ス ト リ ー ム 中 の 現 在 位 置 を 変 更 し ま す ．

gfs_pio_getc () 関 数 は ス ト リ ー ム か ら 一 文 字 読 み 込 み ， gfs_pio_ungetc () 関 数 は 逆 に 読 み 込 ん だ 一 文 字 を ス ト リ ー ム に 戻 し ま す ． gfs_pio_getline () 関 数 や gfs_pio_gets () 関 数 ， gfs_pio_readline () 関 数 は ， ス ト リ ー ム か ら 一 行 を 読 み 込 み ， gfs_pio_readdelim () 関 数 は ， ス ト リ ー ム か ら 指 定 し た デ リ ミ タ ま で を 読 み 込 み ま す ． gfs_pio_read () 関 数 は ， ス ト リ ー ム か ら 指 定 し た バ イ ト 数 だ け 読 み 込 み ま す ．

gfs_pio_putc () 関 数 は ス ト リ ー ム へ 一 文 字 書 き だ し ， gfs_pio_putline () 関 数 や gfs_pio_puts () 関 数 は ス ト リ ー ム へ 一 行 書 き だ し ま す ． gfs_pio_write () 関 数 は ， ス ト リ ー ム へ 指 定 し た バ イ ト 数 だ け 書 き 込 み ま す ． gfs_pio_flush () 関 数 や ， gfs_pio_sync () 関 数 ， gfs_pio_datasync () 関 数 は ， バ ッ フ ァ リ ン グ し て い る デ ー タ を 記 憶 装 置 に 書 き 出 し ま す ． gfs_pio_truncate () 関 数 は ， フ ァ イ ル の サ イ ズ を 変 更 し ま す ．

デ ィ レ ク ト リ ア ク セ ス

gfs_opendir () 関 数 で デ ィ レ ク ト リ を オ ー プ ン す る と ， gfs_readdir () 関 数 で ， そ の デ ィ レ ク ト リ を 構 成 す る エ ン ト リ を 得 る こ と が で き ま す ． オ ー プ ン し た デ ィ レ ク ト リ へ の ア ク セ ス は ， gfs_closedir () 関 数 で 終 了 し ま す ．

gfs_glob_init () 関 数 で 初 期 化 し た gfs_glob_t を gfs_glob () 関 数 に 渡 す こ と で ， ワ イ ル ド カ ー ド の 展 開 を 行 う こ と が で き ま す ． 利 用 が 終 わ っ た ら ， こ の 領 域 は gfs_glob_free () 関 数 で 開 放 し ま す ． gfs_glob_add () 関 数 は ， gfs_glob_t に エ ン ト リ を 追 加 す る の に 用 い ま す ．

フ ァ イ ル ／ デ ィ レ ク ト リ 操 作

gfs_chmod () 関 数 で フ ァ イ ル の モ ー ド を 変 更 し ， gfs_chown () 関 数 で フ ァ イ ル の 所 有 者 を 変 更 し ， gfs_utimes () 関 数 で フ ァ イ ル の 更 新 時 刻 と ア ク セ ス 時 刻 を 変 更 し ま す ．

gfs_mkdir () 関 数 は デ ィ レ ク ト リ を 作 成 し ， gfs_rmdir () 関 数 は デ ィ レ ク ト リ を 削 除 し ま す ． gfs_unlink () 関 数 は フ ァ イ ル を 削 除 し ， gfs_rename () 関 数 は デ ィ レ ク ト リ や フ ァ イ ル を 改 名 し ま す ．

gfs_stat () 関 数 は 指 定 し た フ ァ イ ル あ る い は デ ィ レ ク ト リ の サ イ ズ や 更 新 時 刻 な ど の 情 報 を 返 し ま す ． こ の 関 数 が 返 し た gfs_stat 構 造 体 は gfs_stat_free () 関 数 を 用 い て 解 放 す る 必 要 が あ り ま す ．

ア ク セ ス コ ン ト ロ ー ル リ ス ト (ACL) 操 作

gfs_acl_init () 関 数 は ACL 構 造 体 (gfarm_acl_t) を 初 期 化 し ， gfs_acl_free () 関 数 で ACL 構 造 体 を 開 放 し ま す ． gfs_acl_dup () 関 数 は ACL 構 造 体 を 複 製 し ま す ．

gfs_acl_create_entry () 関 数 は ACL 構 造 体 の ACL エ ン ト リ (gfarm_acl_entry_t) を ひ と つ 生 成 し て 追 加 し ， gfs_acl_get_entry () 関 数 で ACL 構 造 体 の ACL エ ン ト リ を ひ と つ 取 得 し ， gfs_acl_delete_entry () 関 数 で ACL 構 造 体 の ACL エ ン ト リ を ひ と つ 削 除 し ま す ．

gfs_acl_valid () 関 数 は ACL 構 造 体 が 有 効 な 形 式 か ど う か 確 認 し ま す ． gfs_acl_check 関 数 な ら ば よ り 詳 し く 確 認 で き ま す ．

gfs_acl_calc_mask () 関 数 は ACL 構 造 体 の GFARM_ACL_MASK タ グ の エ ン ト リ を 計 算 し て ， GFARM_ACL_MASK が 既 に 存 在 す れ ば 上 書 き し ， 存 在 し な け れ ば 作 成 し ま す ．

gfs_acl_get_tag_type () 関 数 は ACL エ ン ト リ か ら ACL タ グ (gfarm_acl_tag_t) (ACL エ ン ト リ の 種 類 ) を 取 得 し ま す ． gfs_acl_set_tag_type () 関 数 は ACL エ ン ト リ の ACL タ グ を 差 し 替 え ま す ．

gfs_acl_get_permset () 関 数 は ACL エ ン ト リ か ら ACL パ ー ミ ッ シ ョ ン セ ッ ト (gfarm_acl_permset_t) を 取 り 出 し ま す ． gfs_acl_set_permset () 関 数 は ACL エ ン ト リ へ ACL パ ー ミ ッ シ ョ ン セ ッ ト を 差 し 替 え ま す ．

gfs_acl_add_perm () 関 数 は ACL パ ー ミ ッ シ ョ ン セ ッ ト に ACL パ ー ミ ッ シ ョ ン 値 (gfarm_acl_perm_t) を 追 加 し ま す ． gfs_acl_clear_perms () 関 数 は ACL パ ー ミ ッ シ ョ ン セ ッ ト か ら す べ て の ACL パ ー ミ ッ シ ョ ン 値 を ク リ ア し ま す ． gfs_acl_delete_perm () 関 数 は ACL パ ー ミ ッ シ ョ ン セ ッ ト か ら ACL パ ー ミ ッ シ ョ ン 値 を ひ と つ 削 除 し ま す ．

gfs_acl_get_qualifier () 関 数 は ACL エ ン ト リ か ら ， ユ ー ザ 名 ま た は グ ル ー プ 名 を 取 得 し ま す ． GFARM_ACL_USER ま た は GFARM_ACL_GROUP タ グ の ACL エ ン ト リ か ら 取 得 で き ま す ． gfs_acl_set_qualifier () 関 数 は ACL エ ン ト リ に 対 し て ， 指 定 し た ユ ー ザ 名 ま た は グ ル ー プ 名 を 差 し 替 え ま す ．

gfs_acl_delete_def_file () 関 数 は ， フ ァ イ ル や デ ィ レ ク ト リ か ら デ フ ォ ル ト ACL を 削 除 し ま す ． gfs_acl_get_file () 関 数 は ， フ ァ イ ル や デ ィ レ ク ト リ か ら ACL 構 造 体 を 取 得 し ま す ． gfs_acl_set_file () 関 数 は ， フ ァ イ ル や デ ィ レ ク ト リ の ACL 構 造 体 を 差 し 替 え ま す ． 事 前 に gfs_acl_sort 関 数 で ソ ー ト し て く だ さ い ．

gfs_acl_to_text () 関 数 は ACL 構 造 体 を ACL 文 字 列 形 式 に 変 換 し ま す ． gfs_acl_to_any_text 関 数 の ほ う が よ り 高 機 能 で す ． gfs_acl_from_text () 関 数 は ACL 文 字 列 形 式 か ら ACL 構 造 体 に 変 換 し ま す ．

gfs_acl_get_perm () 関 数 は ACL パ ー ミ ッ シ ョ ン セ ッ ト の 中 か ら ひ と つ の パ ー ミ ッ シ ョ ン を テ ス ト し ま す ．

gfs_acl_check () 関 数 は ACL 構 造 体 が 有 効 な 形 式 か ど う か 確 認 し ま す ． ま た ， エ ラ ー の 場 所 と エ ラ ー の 種 類 が わ か り ま す ． gfs_acl_valid 関 数 よ り も 高 機 能 で す ． gfs_acl_error () 関 数 は gfs_acl_check 関 数 の エ ラ ー を 文 字 列 に 変 換 し ま す ．

gfs_acl_entries () 関 数 は ACL エ ン ト リ の 数 を 数 え ま す ．

gfs_acl_equiv_mode () 関 数 は ， ACL 構 造 体 が 基 本 ACL (GFARM_ACL_USER_OBJ, GFARM_ACL_GROUP_OBJ, GFARM_ACL_OTHER) だ け で 構 成 さ れ て い る か ど う か 確 認 し ま す ． ま た ， 基 本 ACL 部 分 か ら gfarm_mode_t に 変 換 で き ま す ．

gfs_acl_cmp () 関 数 は 二 つ の ACL 構 造 体 を 比 較 し ま す ．

gfs_acl_from_mode () 関 数 は gfarm_mode_t か ら ACL 構 造 体 を 生 成 し ま す ．

gfs_acl_to_any_text () 関 数 は ACL 構 造 体 を ACL 文 字 列 形 式 に 変 換 し ま す ． 出 力 形 式 を オ プ シ ョ ン な ど で 変 更 で き ま す ． gfs_acl_to_text 関 数 と 比 べ て 高 機 能 で す ．

gfs_acl_to_xattr_value () 関 数 は ACL 構 造 体 を 拡 張 属 性 に 格 納 す る た め の ACL バ イ ナ リ デ ー タ に 変 換 し ま す ． 事 前 に gfs_acl_sort 関 数 で ソ ー ト し て く だ さ い ． gfs_acl_from_xattr_value () 関 数 は 拡 張 属 性 か ら 取 り 出 し た ACL バ イ ナ リ デ ー タ を ACL 構 造 体 に 変 換 し ま す ．

gfs_acl_sort () 関 数 は ACL 構 造 体 を 有 効 な 形 式 と な る 順 番 に ソ ー ト し ま す ．

gfs_acl_from_text_with_default () 関 数 は "default:" で 始 ま る ACL エ ン ト リ を 持 つ ACL 文 字 列 を 解 釈 し ， ア ク セ ス ACL 構 造 体 と デ フ ォ ル ト ACL 構 造 体 を 2 個 生 成 し ま す ．

エ ラ ー コ ー ド

ほ と ん ど の Gfarm ラ イ ブ ラ リ の 関 数 は gfarm_error_t 型 の Gfarm エ ラ ー コ ー ド を 返 し ま す 。 gfarm_error_string () 関 数 は Gfarm エ ラ ー コ ー ド を 表 す 文 字 列 を 返 し ま す 。 gfarm_errno_to_error () 関 数 は errno を Gfarm エ ラ ー コ ー ド に 変 換 し ま す 。 gfarm_error_to_errno () 関 数 は Gfarm エ ラ ー コ ー ド を errno に 変 換 し ま す 。

文 字 列 配 列 操 作 ユ ー テ ィ リ テ ィ

文 字 列 配 列 を 表 す gfarm_stringlist 型 の 変 数 は ， gfarm_stringlist_init () 関 数 で 初 期 化 し ， gfarm_stringlist_add () 関 数 で 文 字 列 を 一 つ 追 加 し ， gfarm_stringlist_cat () 関 数 で 文 字 列 を 複 数 追 加 し ， gfarm_stringlist_free () 関 数 で 解 放 す る こ と が で き ま す ． 文 字 列 配 列 の 各 要 素 文 字 列 に は gfarm_stringlist_elem () 関 数 あ る い は GFARM_STRINGLIST_ELEM() マ ク ロ で ア ク セ ス す る こ と が で き ま す ． ま た ， 文 字 列 配 列 を 構 成 す る 文 字 列 の 数 は gfarm_stringlist_length () 関 数 で 得 る こ と が で き ま す ．

gfarm_strings_free_deeply () 関 数 は ， 文 字 列 配 列 お よ び そ れ を 構 成 す る 各 文 字 列 に 対 し て 標 準 ラ イ ブ ラ リ 関 数 の free() を 呼 び 出 し て 解 放 し ま す ．

文 字 列 配 列 操 作 ユ ー テ ィ リ テ ィ マ ク ロ

GFARM_STRINGLIST_ELEM(list, i)

gfarm_stringlist 型 の list 引 数 が 表 す 文 字 列 配 列 の i 番 目 の 要 素 を 表 す マ ク ロ で す ． こ の マ ク ロ は 左 辺 値 と し て 使 え ま す ． 値 と し て 評 価 し た 場 合 に は gfarm_stringlist_elem () 関 数 と 同 一 の 結 果 を 返 し ま す ．

GFARM_STRINGLIST_STRARRAY(list)

gfarm_stringlist 型 の list 引 数 が 表 す 文 字 列 配 列 の 先 頭 要 素 へ の ポ イ ン タ を 返 し ま す ． 返 り 値 は ， 文 字 へ の ポ イ ン タ へ の ポ イ ン タ と な り ま す ．