vfs -- 仮想ファイルシステム制御¶
vfs モジュールには、仮想ファイルシステム内のファイルシステムオブジェクトを作成し、マウント／アンマウントするための関数が含まれています。
ファイルシステムのマウント¶
いくつかのポートは仮想ファイルシステム(VFS)を提供し、この VFS 内に複数の「実」ファイルシステムをマウントする機能を備えています。ファイルシステムオブジェクトは、VFS のルート、またはルートに存在するサブディレクトリにマウントできます。これにより、Python プログラムで見られるファイルシステムの動的で柔軟な設定が可能になります。この機能を持つポートは mount() と umount() 関数、そしておそらく VFS クラスで表されるさまざまなファイルシステムの実装を提供します。
- vfs.mount(fsobj, mount_point, *, readonly)¶
ファイルシステムオブジェクト fsobj を mount_point 文字列で指定した VFS 内の場所にマウントします。 fsobj には
mount()メソッドを持つ VFS オブジェクト、またはブロックデバイスを指定できます。ブロックデバイスであればファイルシステムタイプが自動的に検出されます(ファイルシステムが認識されない場合は例外が発生します)。 mount_point が'/'であれば fsobj をルートににマウントし、'/<name>'であればルート配下のサブディレクトリにマウントします。readonly が
Trueであればファイルシステムが読み取り専用でマウントされています。マウント処理では、ファイルシステムオブジェクトに対してメソッド
mount()呼出します。mount_point に既にマウントされていれば
OSError(EPERM)例外が発生します。
- vfs.umount(mount_point)¶
ファイルシステムをアンマウントします。 mount_point には、マウント場所を指定する文字列、または以前にマウントされたファイルシステムオブジェクトを指定できます。アンマウント処理では、ファイルシステムオブジェクトに対してメソッド
unmount()呼出します。mount_point が見つからなければ
OSError(EINVAL)例外が発生します。
- class vfs.VfsFat(block_dev)¶
FAT ファイルシステムのフォーマットを使うファイルシステムオブジェクトを作成します。FAT ファイルシステムのストレージは block_dev によって提供されます。このコンストラクタによって作成されたオブジェクトは
mount()を使ってマウントできます。- static mkfs(block_dev)¶
block_dev に FAT ファイルシステムを構築します。
- class vfs.VfsLfs1(block_dev, readsize=32, progsize=32, lookahead=32)¶
littlefs v1 filesystem format を使うファイルシステムオブジェクトを作成します。littlefs ファイルシステムのストレージは block_dev によって提供されます。 block_dev は extended interface をサポートしている必要があります。このコンストラクタによって作成されたオブジェクトは
mount()を使ってマウントできます。詳しくは ファイルシステムの利用 を参照してください。
- static mkfs(block_dev, readsize=32, progsize=32, lookahead=32)¶
block_dev に Lfs1 ファイルシステムを構築します。
注釈
特定の状況で littlefs v1 が失敗するという報告があります。詳細については littlefs issue 347 を参照してください。
- class vfs.VfsLfs2(block_dev, readsize=32, progsize=32, lookahead=32, mtime=True)¶
littlefs v2 filesystem format を使うファイルシステムオブジェクトを作成します。littlefs ファイルシステムのストレージは block_dev によって提供されます。 block_dev は extended interface をサポートしている必要があります。このコンストラクタによって作成されたオブジェクトは
mount()を使ってマウントできます。mtime 引数はファイルの更新タイムスタンプを有効にします。このオプションはマウント毎に有効/無効にでき、 mtime が有効な場合にのみタイムスタンプが追加/更新されます。 mtime が無効であれば、タイムスタンプが追加/更新されないままとなります。タイムスタンプのない Littlefs v2 ファイルシステムは、再フォーマットしなくても動作し、既存のファイルをオープンして書き込みを行うと、タイムスタンプは透過的に追加されます。 mtime が有効になっている場合、タイムスタンプのないファイルに対して
os.statを行った際のタイムスタンプの値は 0 になります。詳しくは ファイルシステムの利用 を参照してください。
- static mkfs(block_dev, readsize=32, progsize=32, lookahead=32)¶
block_dev に Lfs2 ファイルシステムを構築します。
注釈
特定の状況で littlefs v2 が失敗するという報告があります。詳細については littlefs issue 295 を参照してください。
- class vfs.VfsPosix(root=None)¶
ホストの POSIX ファイルシステムにアクセスするファイルシステムオブジェクトを作成します。 root を指定した場合、それは
VfsPosixオブジェクトのルートとして使用するホストファイルシステム内のパスである必要があります。それ以外の場合、ホストファイルシステムの現在のディレクトリが適用されます。
ブロックデバイス¶
ブロックデバイスは、ブロックプロトコルを実装するオブジェクトです。これによりデバイスが MicroPython ファイルシステムをサポートできるようになります。物理ハードウェアはユーザー定義のクラスによって表されます。 AbstractBlockDev クラスはそのようなクラスを定義するためのテンプレートです。MicroPython が提供していないブロックデバイスクラスを自作する場合は後述のメソッドを実装する必要があります。
このクラスの具象サブクラスでは通常(フラッシュメモリのような)ハードウェアの一部にメモリのような機能へのアクセスが許可されます。ブロックデバイスはサポートされているファイルシステムでフォーマットでき、 os のメソッドを使ってマウントできます。
後述する２種類のブロックプロトコルを使ったブロックデバイスの実装例については ファイルシステムの利用 を参照してください。
シンプルインタフェースと拡張インタフェース¶
さまざまなユースケースをサポートするために、 readblocks や writeblocks メソッドには２つの互換性のあるシグネチャがあります(以下を参照)。与えられたブロックデバイスは、どちらか一方、または両方を実装しています。２番目の形式(offset 引数のあるもの)は「拡張インタフェース」といいます。
書き込み操作をより細かく制御する必要のある一部のファイルシステム(littlefs など)では、たとえば、消去せずにサブブロック領域に書き込む場合、ブロックデバイスが拡張インターフェイスをサポートしている必要がある場合があります。
- class vfs.AbstractBlockDev(...)¶
ブロックデバイスオブジェクトを構築します。コンストラクタへのパラメータは、特定のブロックデバイスに依存します。
- readblocks(block_num, buf)¶
- readblocks(block_num, buf, offset)
最初の形式は、整列した複数のブロックを読み取ります。インデックス block_num で指定したブロックを開始点として、デバイスから buf (バイトの配列)にブロックを読み込みます。読み込むブロック数は buf の長さで与えられ、ブロックサイズの倍数になります。
２番目の形式では、ブロック内の任意の場所、任意の長さで読み取ることができます。ブロックインデックス block_num とブロック内のバイトオフセット offset を開始点として、デバイスから buf (バイトの配列)にブロックを読み込みます。読み込むブロック数は buf の長さで与えられ、読み込むバイト数になります。
- writeblocks(block_num, buf)¶
- writeblocks(block_num, buf, offset)
最初の形式は、整列した複数のブロックを書き込みます。書き込む前には、対象のブロックが（必要に応じて）消去されます。インデックス block_num で指定したブロックに buf (バイトの配列)からブロックを書き込みます。書き込むブロック数は buf の長さで与えられ、ブロックサイズの倍数になります。
２番目の形式では、ブロック内の任意の場所に、任意の長さで書き込むことができます。書き込むバイトのみを変更する必要があり、このメソッドの呼び出し元は、関連するブロックが事前の
ioctl呼び出しによって消去されることを保証する必要があります。ブロックインデックス block_num とそのブロック内のバイトオフセット offset を開始点として、 buf （バイト配列）からデバイスに書き込みます。書き込むバイト数は buf の長さで指定されます。offset 引数が指定されている場合、たとえゼロであっても、実装がブロックを暗黙的に消去してはならないことに注意してください。
- ioctl(op, arg)¶
ブロックデバイスの制御とパラメータ問い合わせをおこないます。実行する操作は op に次の整数のうちの１つで指定します。
1 -- デバイスを初期化します(arg は未使用)
2 -- デバイスをシャットダウンします(arg は未使用)
3 -- デバイスを同期します(arg は未使用)
4 -- ブロック数を取得し、整数で返します(arg は未使用)
5 -- ブロック内のバイト数を取得し、整数で返します。
Noneの場合はデフォルト値の 512 が使われます(arg は未使用)6 -- ブロックを消去します。 arg は消去するブロック数です
少なくとも
ioctl(4, ...)が受け付けられる必要があります。littlefs についてはioctl(6, ...)も受け付けられる必要があります。その他の操作が受け付けられるかはハードウェアに依存します。littlefs は
writeblocks(block, ...)の呼び出しの前にioctl(6, block)を発行します。これによりハードウェアが要求するなら、デバイスドライバは書き込みの前にブロックを消去できます。あるいは、ドライバがioctl(6, block)を捉えて 0 (成功)を返すようにするかもしれません。この場合、ドライバは消去の必要性を検出する責任を負います。特に記載のない限り
ioctl(op, arg)はNoneを返します。したがって処理系はopの未使用値を無視できます。opが受け付けられる場合、操作 4 と 5 の戻り値は上記のとおりです。受け付けられる他の操作の戻り値は、成功した場合は 0 を返し、失敗した場合はゼロ以外を返します。失敗した場合の戻り値はOSErrorの errno コードです。