Pythonでfcntl・ioctlシステムコールを扱う方法|fcntlモジュールの基本とロック制御

fcntlモジュールとは

ファイルや入出力(I/O)を制御したい場合は、Pythonのfcntlモジュールを使用します。このモジュールは、Unix系OSが提供するfcntl()やioctl()といったルーチンへのインターフェースとして機能します。

fcntlモジュールに含まれるすべてのメソッドは、第1引数として整数値、またはio.IOBaseオブジェクトのファイルディスクリプタを受け取ります。

このモジュールを使用するには、まず次のようにインポートします。

import fcntl

fcntlモジュールには、主に以下のようなメソッドが用意されています。

fcntl.fcntl(fd, op[, arg])メソッド

ファイルディスクリプタを指定して、ファイルに対する操作を実行します。実行内容はopによって定義されます。第3引数は省略可能で、整数型または文字列型の値を指定できます。整数型を渡した場合、戻り値はC言語のfcntl()呼び出しの返り値になります。文字列型の場合はバイナリ構造体として扱われます。処理に失敗した場合にはIOError(Python 3ではOSErrorの別名)が発生します。

fcntl.ioctl(fd, op[, arg[, mutate_flag]])メソッド

fcntl.fcntl()メソッドとほぼ同じ動作をしますが、こちらは引数の扱いがより複雑になっています。可変バッファ(mutable buffer)を引数に渡した場合、その挙動はmutate_flagに依存します。mutate_flagがTrueの場合、バッファは変更可能として扱われ、Falseの場合は読み取り専用バッファのように振る舞います。

fcntl.flock(fd, op)メソッド

ファイルディスクリプタを指定して、ファイルに対してロック操作opを実行します。一部のシステムでは、このメソッドはfcntl()メソッドを使ってエミュレートされます。

fcntl.lockf(fd, operation[, length[, start[, whence]]])メソッド

ロック関連のシステムコールを包むラッパーとして動作するメソッドです。operation引数に指定した値に応じて、ファイルのロックまたはロック解除を行います。operationには以下の値を指定できます。

• LOCK_UN − ファイルのロックを解除する

• LOCK_SH − 共有ロックをかける

• LOCK_EX − 排他ロックをかける

サンプルコード

次の例では、カウンタファイル「my_counter.txt」を作成し、排他ロック(LOCK_EX)を取得しながら15回カウントアップしています。flockによる排他制御により、複数プロセスから同時にアクセスされてもデータの整合性が保たれる点に注目してください。

import fcntl, os, time
counter_file = 'my_counter.txt'
if not os.path.exists(counter_file):
   counter_file = open('my_counter.txt', 'w')
   counter_file.write('0') # 初期値として0を保存
   counter_file.close()
for i in range(15):
   counter_file = open('my_counter.txt', 'r+')
   fcntl.flock(counter_file.fileno(), fcntl.LOCK_EX)
   count = int(counter_file.readline()) + 1
   counter_file.seek(0)
   counter_file.write(str(count))
   counter_file.close()
   print('Process ID: ' + str(os.getpid()) + ', Count: ' + str(count))
   time.sleep(0.2)

実行結果

$ python3 example.py
Process ID: 12698, Count: 1
Process ID: 12698, Count: 2
Process ID: 12698, Count: 3
Process ID: 12698, Count: 4
Process ID: 12698, Count: 5
Process ID: 12698, Count: 6
Process ID: 12698, Count: 7
Process ID: 12698, Count: 8
Process ID: 12698, Count: 9
Process ID: 12698, Count: 10
Process ID: 12698, Count: 11
Process ID: 12698, Count: 12
Process ID: 12698, Count: 13
Process ID: 12698, Count: 14
Process ID: 12698, Count: 15
$
$
$ cat my_counter.txt
15
$

このように、fcntl.flock()で排他ロックを取得してから読み書きを行うことで、並行アクセス時にもカウンタの値が正しく更新されることが確認できます。