はじめに
C言語を学習する上で、様々な組み込み関数を理解し、それぞれの関数がどのように動作し、何に使われるのかを知ることは非常に重要です。
今回の記事では、その中でも特に重要な「fflush関数」について、基本的な使い方から応用例、注意点、詳細な対処法、カスタマイズまで、10ステップで解説します。
●C言語とfflush関数の基本
○C言語とは
C言語は、1970年代にAT&Tベル研究所で開発されたプログラミング言語で、オペレーティングシステム、埋め込みシステムなどの開発に広く使用されています。
C言語は、その性能の高さと、ハードウェアに近い記述が可能なため、システムレベルのプログラミングに適しています。
○fflush関数の基本
C言語で入出力を扱う際には、標準ライブラリの中にある「stdio.h」ヘッダーファイルに定義されている関数を利用します。
その中でも、今回取り上げる「fflush関数」は、指定したストリーム（通常はファイル）に対して、バッファに溜まっているデータを強制的に出力する役割を果たします。
「fflush」は、「File FLUSH」の略で、直訳すると「ファイルをフラッシュ（すすぎ洗い）する」という意味になります。
つまり、バッファに溜まったデータをすべて出力（フラッシュ）する、という動作を指しています。
基本的な使用方法は次のようになります。
#include <stdio.h>
int main(void){
FILE *fp;
fp = fopen("test.txt", "w");
fputs("Hello, World!", fp);
fflush(fp); // ここでバッファをフラッシュ
fclose(fp);
return 0;
}このコードでは、ファイルの書き出しを行なっています。
fopen関数で”test.txt”というファイルを書き込みモードで開き、fputs関数で”Hello, World!”という文字列をファイルに書き出しています。
その後、fflush関数を使ってバッファに溜まったデータをすべて出力（フラッシュ）しています。
上記のコードを実行すると、”test.txt”というファイルに”Hello, World!”という文字列が書き出されます。
●fflush関数の使い方
まず、C言語におけるfflush関数の基本的な使い方について説明します。fflush関数は、指定されたストリームに関連付けられた出力バッファをクリアするための関数です。これは、主にファイルへの書き込みを正確に制御するために使用されます。
この関数の構文は以下のようになります：
int fflush(FILE *stream);この関数は、引数としてファイルポインタを取ります。このファイルポインタは、バッファをフラッシュするストリームを指定します。戻り値は、エラーがなければ0、エラーが発生した場合はEOFを返します。
○基本的な使い方
fflush関数の一番基本的な使い方は、出力を直ちに反映させるために、printf関数の後に用いる方法です。printf関数は、出力をバッファリングするため、その出力がすぐに表示されないことがあります。それを防ぐためにfflush関数を用いることがあります。
例えば、次のコードでは、printf関数で”Processing…”と出力した後、fflush関数を呼び出しています。
#include<stdio.h>
int main() {
printf("Processing...");
fflush(stdout);
// 処理のための遅延
for(long i = 0; i<100000000; i++){}
printf("Done!\n");
return 0;
}この例のコードでは、「Processing…」と表示し、その後すぐにfflush関数を使って出力バッファをフラッシュしています。これにより、”Processing…”というメッセージがユーザーにすぐに表示され、遅延後に”Done!”と表示されます。
○サンプルコード1：ファイルの書き出し
fflush関数は、ファイルへの書き込みを行う際にも使用されます。
下記のコードでは、fflush関数を使用して、書き込みを行った直後にファイルへの出力を反映させています。
#include<stdio.h>
int main() {
FILE *fp = fopen("file.txt", "w");
if (fp == NULL) {
printf("Failed to open file.\n");
return 1;
}
fprintf(fp, "Hello, World!");
fflush(fp);
// ファイルが正しく書き込まれていることを確認するための処理...
fclose(fp);
return 0;
}このサンプルコードでは、まず”file.txt”という名前のファイルを書き込みモード(“w”)で開いています。
次に、fprintf関数を使用して、このファイルに”Hello, World!”と書き込みます。
そして、fflush関数を呼び出して、この書き込みを即座に反映させます。
その後、ファイルが正しく書き込まれていることを確認するための処理を行い、最後にfclose関数でファイルを閉じます。
このコードを実行すると、「file.txt」ファイルは「Hello, World!」という文字列で作成されます。
その後の確認処理で、この出力がすぐにファイルに反映されていることを確認することができます。
なお、このコードの実行結果が正しいかどうかは、作成されたファイルを開いて確認します。
もしファイルの内容が「Hello, World!」であれば、コードは正常に動作していると言えます。
○サンプルコード2：改行文字の扱い
fflush関数は、バッファリングされた出力をフラッシュするため、特定の文字が出力された後に出力をフラッシュするのにも役立ちます。
たとえば、改行文字(‘\n’)が出力された後に出力をフラッシュしたい場合、fflush関数を使用することができます。
下記のコードでは、fgets関数でユーザーからの入力を読み取り、その入力が改行文字で終わるまで待つ例を表します。
#include<stdio.h>
int main() {
char buffer[256];
printf("Enter some text: ");
fgets(buffer, sizeof(buffer), stdin);
printf("You entered: %s", buffer);
fflush(stdout);
return 0;
}このコードでは、ユーザーにテキストの入力を求め、fgets関数でその入力を読み込んでいます。
その後、ユーザーが入力したテキストを表示し、fflush関数を呼び出して出力バッファをフラッシュします。
これにより、printf関数での出力がすぐにユーザーに表示されます。
なお、このコードを実行すると、まず「Enter some text: 」と表示されます。
ここで何かテキストを入力すると、そのテキストがそのまま「You entered: 」の後に表示されます。
したがって、入力したテキストがそのまま表示されれば、このコードは正常に動作していると言えます。
●fflush関数の詳細な対処法
fflush関数は一見シンプルな操作に見えますが、エラーハンドリングという観点からはいくつか注意すべき点があります。
fflush関数はストリームにエラーが発生した場合、EOF（End Of File）を返します。
ここで重要なのは、エラーが発生した場合、その原因を特定し、適切に対処することです。
fflush関数は、通常は0を返し、問題がある場合にはEOFを返します。
しかし、具体的なエラーの内容を把握するには別の関数であるferror関数を使用します。
ferror関数は、ストリームに関連するエラーフラグを返す関数であり、これを用いてエラーハンドリングを行うことが可能となります。
さらに、エラーフラグをリセットするためには、clearerr関数を使用します。
これにより、次回のfflush関数の実行が正常に行われるようにすることができます。
○サンプルコード3：エラーハンドリング
このコードでは、fflush関数のエラーハンドリングを示しています。
この例では、fflush関数がEOFを返すとき、ferror関数を使ってエラーフラグを確認し、clearerr関数でエラーフラグをリセットしています。
#include <stdio.h>
void main() {
FILE *fp = fopen("test.txt", "w");
if(fp == NULL) {
printf("ファイルが開けません\n");
return;
}
// ファイルに書き込み
fputs("Hello, World!", fp);
// fflush関数を使って書き込みを強制
if(fflush(fp) == EOF) {
// エラーハンドリング
if(ferror(fp)) {
printf("fflush関数でエラーが発生しました\n");
clearerr(fp);
}
}
fclose(fp);
}このコードを実行すると、”Hello, World!”という文字列が”test.txt”という名前のファイルに書き込まれます。
そして、fflush関数を用いて、書き込んだ内容が即座にディスクに反映されます。
もしfflush関数がEOFを返した場合、つまりエラーが発生した場合は、ferror関数を用いてエラーを検出します。
そして、エラーが確認できたら、そのエラーをclearerr関数でクリアします。
このようなエラーハンドリングの処理は、fflush関数だけでなく、ファイル操作全般において重要となります。
プログラムはいつ何時、どのような状況でエラーを引き起こすかわからないため、適切なエラーハンドリングにより、予期せぬ動作やデータの損失を防ぐことが可能となります。
●fflush関数の詳細な注意点
C言語のfflush関数の使用にあたり、いくつかの注意点があります。
特にバッファリングとfflush関数の相互作用について理解することは重要です。
fflush関数はバッファリングと密接に関連しています。バッファリングは、コンピュータがデータを一時的に保持する場所で、データが効率的に処理されることを保証します。
しかし、fflush関数を適切に使用しないと、バッファ内のデータが正常に処理されない可能性があります。
○サンプルコード4：バッファリングとfflush関数
fflush関数を使用してバッファを明示的にフラッシュするサンプルコードを紹介します。
このコードでは、テキストファイルに文字列を書き込んだ後にfflush関数を使用してバッファをフラッシュしています。
#include <stdio.h>
int main() {
FILE *fp;
fp = fopen("sample.txt", "w");
if(fp == NULL){
printf("ファイルが開けません\n");
return 1;
}
// ファイルに文字列を書き込む
fputs("Hello, World!\n", fp);
// バッファを明示的にフラッシュ
fflush(fp);
fclose(fp);
return 0;
}このコードでは、fopen関数を使用して”sample.txt”という名前の新しいファイルを書き込みモード(“w”)で開きます。
その後、fputs関数を使ってこのファイルに文字列”Hello, World!\n”を書き込んでいます。
この時点でバッファにデータが溜まりますが、すぐにfflush関数を呼び出してバッファをフラッシュしています。
これにより、バッファの内容がディスクに直ちに書き出されます。最後に、fclose関数を使用してファイルを閉じます。
実行結果として、”sample.txt”という名前のファイルが作成され、その中に”Hello, World!\n”という文字列が書き込まれます。
fflush関数のおかげで、プログラムが途中で何らかの理由で停止した場合でも、データが失われることなくディスクに書き出されます。
バッファリングは効率的なI/O処理を実現しますが、特定の状況ではバッファの内容を直ちにディスクに書き出したい場合があります。
そのような場合にはfflush関数を使用します。
しかし、fflush関数の呼び出しはI/O処理のオーバーヘッドを増加させるため、適切なタイミングで使用することが重要です。
●fflush関数の詳細なカスタマイズ
いよいよfflush関数のカスタマイズについて詳しく見ていきましょう。
C言語には、関数を自身で定義して使用することができる特性があります。
これにより、fflush関数の動作を自身の要件に適した形にカスタマイズすることが可能です。
まず、独自のfflush関数を作成する際には、基本的な動作原理を理解することが不可欠です。
既存のfflush関数は、出力バッファに溜まっているデータを強制的に書き出す役割を果たします。
この機能は、例えば、ファイルにログを書き出すような場合や、デバッグ情報を即座に表示したいときなどに利用できます。
では、実際のカスタマイズ例として、fflush関数の動作にログ出力機能を追加してみましょう。
ログ出力機能を追加することで、バッファがフラッシュされるタイミングを明確に把握することができます。
○サンプルコード5：カスタムfflush関数
#include <stdio.h>
#include <time.h>
// カスタムfflush関数の定義
void custom_fflush(FILE *stream) {
// 元のfflush関数を呼び出す
fflush(stream);
// 現在の時間を取得
time_t now = time(NULL);
// 時間を文字列に変換
char *time_str = ctime(&now);
// ログ出力
printf("[ログ] %s: fflushが実行されました。\n", time_str);
}
int main() {
// カスタムfflush関数を呼び出す
custom_fflush(stdout);
return 0;
}このサンプルコードでは、custom_fflushという新しい関数を定義し、その中で元のfflush関数を呼び出しています。
つまり、この関数はfflush関数のすべての機能を保持しつつ、追加のログ出力機能を持つ関数となります。
このcustom_fflush関数が呼ばれると、まずバッファがフラッシュされ、次に現在の時間が取得されます。
取得した時間はctime関数によって文字列に変換され、その後printf関数を用いてログとともに出力されます。
この結果、バッファがフラッシュされるたびに、その時刻がログとして出力されることになります。
このコードを実行すると、次のような出力結果が得られます。
[ログ] Tue Jul 29 18:35:50 2023: fflushが実行されました。このようなカスタマイズを行うことで、fflush関数の動作をより詳細に制御することが可能となります。
また、この方法はfflush関数に限定されず、C言語における他の関数に対しても適用可能です。
●fflush関数の応用例
fflush関数は単純ながら非常に便利な関数ですが、その応用範囲は非常に広いです。
ここではいくつかの応用例を紹介します。
まず、大規模なデータの書き出しにfflush関数は重宝します。
データ量が大きい場合、一度に全てのデータを書き出すとメモリに大きな負荷がかかる可能性があります。
そこで、一部のデータを書き出した段階でバッファをフラッシュすることで、これを解決することができます。
○サンプルコード6：大規模なデータの書き出し
大規模なデータを扱う際にもfflush関数は重要な役割を果たします。
今回は、一度に大量のデータを書き出す場合の例を紹介します。
このコードでは、大量のデータを生成し、そのデータをファイルに書き出しています。
#include <stdio.h>
#include <stdlib.h>
#define BIG_DATA_SIZE 1000000
int main() {
FILE *fp = fopen("bigdata.txt", "w");
if (fp == NULL) {
printf("ファイルを開くことができません。\n");
return 1;
}
for (int i = 0; i < BIG_DATA_SIZE; i++) {
fprintf(fp, "%d\n", i);
if (i % 1000 == 0) {
fflush(fp);
}
}
fclose(fp);
return 0;
}このコードでは、「BIG_DATA_SIZE」の値だけループを回し、それぞれのループの値をファイルに書き出しています。
また、1000回ごとにfflush関数を呼び出し、バッファをクリアしています。
これにより、プログラムがクラッシュした場合でも、最後にfflushが呼び出された時点までのデータはファイルに書き出されるというメリットがあります。
このコードを実行すると、「bigdata.txt」には「0」から「999999」までの値が順に書き出されます。
しかし、途中でプログラムがクラッシュしたとしても、最後にfflushが呼び出された時点までのデータは安全に保存されています。
○サンプルコード7：マルチスレッド環境でのfflush関数
次に、マルチスレッド環境でのfflush関数の使用方法について説明します。
このコードでは、複数のスレッドが同じファイルに書き込む場合を想定しています。
この例では、2つのスレッドがそれぞれファイルに書き込み、fflush関数を用いてバッファをクリアしています。
#include <stdio.h>
#include <pthread.h>
void* threadFunc(void *arg) {
FILE *fp = (FILE *)arg;
for (int i = 0; i < 100; i++) {
fprintf(fp, "Thread%d: %d\n", pthread_self(), i);
fflush(fp);
}
return NULL;
}
int main() {
FILE *fp = fopen("multithread.txt", "w");
if (fp == NULL) {
printf("ファイルを開くことができません。\n");
return 1;
}
pthread_t thread1, thread2;
pthread_create(&thread1, NULL, threadFunc, fp);
pthread_create(&thread2, NULL, threadFunc, fp);
pthread_join(thread1, NULL);
pthread_join(thread2, NULL);
fclose(fp);
return 0;
}このコードでは、2つのスレッドがそれぞれ100回ループを回しながら、スレッドIDとループの値をファイルに書き出しています。
また、各書き出しの後には必ずfflush関数を呼び出し、バッファをクリアしています。
このコードを実行すると、「multithread.txt」には各スレッドからの出力が交互に書き出されます。
しかし、fflush関数を使わないと、2つのスレッドからの出力が混在してしまう可能性があります。
したがって、マルチスレッド環境でもfflush関数は重要な役割を果たします。
○サンプルコード8：非同期IOとfflush関数
これまでのステップではfflush関数の基本的な使い方から、エラーハンドリングやカスタマイズ方法について解説してきました。
ここでは、非同期IOとfflush関数の連携について考察します。
非同期IOは、プログラムがデータの読み書きを待つことなく、他の作業を進行させることができるIO方式で、効率的なプログラムの実行が可能となります。
このコードでは、非同期IOを使用してデータの書き出しを行い、fflush関数で出力を確定する一連の流れを表しています。
この例では、fflush関数は非同期IOの完了を確認する役割を果たしています。
#include <stdio.h>
#include <aio.h>
#include <string.h>
// 非同期IOの準備と実行
void write_async(FILE *fp, char *data) {
struct aiocb cb;
memset(&cb, 0, sizeof(struct aiocb));
cb.aio_fildes = fileno(fp);
cb.aio_buf = data;
cb.aio_nbytes = strlen(data);
aio_write(&cb);
// 非同期IOの完了を待つ
while (aio_error(&cb) == EINPROGRESS) { }
// エラーハンドリング
int err = aio_error(&cb);
int ret = aio_return(&cb);
if (err != 0) {
printf("Error at aio_error() : %s\n", strerror(err));
} else if (ret != strlen(data)) {
printf("Error at aio_return()\n");
} else {
printf("Return %d\n", ret);
}
}
int main() {
FILE *fp;
fp = fopen("async.txt", "w");
if (fp == NULL) {
printf("Failed to open the file.\n");
return -1;
}
// データ書き出し
write_async(fp, "Hello, World!");
// fflush関数で出力を確定
fflush(fp);
fclose(fp);
return 0;
}このコードの実行結果は、”async.txt”という名前のテキストファイルが作成され、その中に”Hello, World!”と書き出されることです。
非同期IOの完了待ちを行うことで、他の処理をブロックすることなくIO処理が完了するのを待つことが可能となります。
ただし、非同期IOを使用する際には注意が必要です。
fflush関数を使って書き出しを確定する前にプログラムが終了してしまうと、書き出しが完了しない可能性があります。
そのため、必要な処理がすべて完了したことを確認したうえで、fflush関数を使って書き出しを確定するようにしましょう。
○サンプルコード9：fflush関数とsetbuf関数の連携
このセクションでは、fflush関数とsetbuf関数がどのように連携して動作するかを見ていきましょう。
fflush関数は、出力バッファをクリアするために使用されます。
一方、setbuf関数は、ストリームに対するバッファリングを制御するために使用されます。
ここでは、これらの二つの関数を使用して、ファイルへの書き込みを管理するC言語のプログラムを作成します。
この例では、setbuf関数でバッファリングを設定し、fflush関数でバッファをクリアするという流れを表します。
#include <stdio.h>
void main() {
FILE *fp;
char buf[BUFSIZ];
fp = fopen("test.txt", "w");
if(fp == NULL) {
perror("File opening failed");
return;
}
// setbuf関数を使って、自身で設定したバッファを利用する
setbuf(fp, buf);
fprintf(fp, "Hello, world!");
// fflush関数を呼び出して、バッファをクリアする（即時書き出し）
fflush(fp);
fclose(fp);
}このコードでは、初めにファイルを開いています。
そして、setbuf関数を使って自分で設定したバッファを使うように指定します。
その後、”Hello, world!”という文字列をファイルに書き出し、すぐにfflush関数を使ってバッファをクリアしています。
この結果、”Hello, world!”という文字列がすぐにファイルに書き出されます。
fflush関数とsetbuf関数の連携を理解することで、より詳細な制御を持つことができ、より効率的なプログラムを書くことが可能になります。
ただし、バッファリングの設定や管理は、プログラムの動作に大きな影響を及ぼす可能性がありますので、注意深く行う必要があります。
○サンプルコード10：fflush関数のパフォーマンスチューニング
最後に、パフォーマンスの観点からfflush関数を使用する場合のテクニックを解説します。
大量のデータを扱う際や、リアルタイム性が求められる場合には、fflush関数のコール頻度を抑えることが重要になります。
それでは、次のサンプルコードをご覧ください。
#include<stdio.h>
int main() {
FILE *fp;
fp = fopen("sample.txt", "w");
if (fp == NULL) {
printf("ファイルが開けませんでした。\n");
return -1;
}
for (int i = 0; i < 1000000; i++) {
fprintf(fp, "%d\n", i);
if (i % 10000 == 0) {
fflush(fp); // 10000行ごとにバッファをクリア
}
}
fclose(fp);
return 0;
}このコードでは100万回のループを行い、各ループでファイルに数値を書き出しています。
そして、ループが10000回回るごとにfflush関数を呼び出すことで、バッファの書き出しを制御しています。
この例では、fflush関数の呼び出しを適切に間引くことで、パフォーマンスの低下を防ぎつつ、リアルタイム性を確保しています。
このコードを実行すると、”sample.txt”という名前のファイルに0から999999までの数値が改行で区切られて書き出されます。
しかし、この書き出しは全て一度に行われるわけではなく、10000回の書き出し毎に一度ずつバッファがクリアされて書き出しが行われます。
まとめ
これまでに、C言語のfflush関数の基本から応用、注意点やカスタマイズ方法までを幅広く解説してきました。
fflush関数は、その挙動や特性を理解することで、様々な場面で有効に活用することができます。
初心者の方でも理解しやすいように、具体的なサンプルコードを多数掲載し、各コードの動作を詳しく説明しました。
これらのサンプルコードを手本に、自身で試行錯誤しながら実践的な経験を積むことをお勧めします。
それぞれのプログラムやシステムに応じた適切なバッファリングの方法を見つけることが、fflush関数を最大限に活用するための鍵となります。
ぜひ、本記事を参考に、C言語の理解とスキルアップに役立ててください。