ITRON入門イベントフラグで学ぶタスク間同期・通信機能

こんにちは、ナナです。

ここからはマルチタスクならではの機能を解説していきます。まずは代表的な機能であるイベントフラグを紹介しましょう。

本記事では次の疑問点を解消する内容となっています。

本記事で学習できること

タスク間同期・通信機能とは何か？
イベントフラグとは何か？
イベントフラグの作り方は？
イベントフラグを使った待ち方・セット方法は？
イベントフラグの特徴を知った上で採用すべきかの判断基準とは？

では、イベントフラグの仕組みを学んでいきましょう。

イベントフラグで学ぶタスク間同期・通信機能とは
1. ITRONが定義するタスク間同期・通信機能とは
イベントフラグの概要
1. イベントフラグで使用する代表的なサービスコール
イベントフラグの生成方法（CRE_FLG）
1. CRE_FLGによるイベントフラグの生成定義
イベントフラグを使ったタスクの待ち方（wai_flgの使い方）
イベントフラグへのイベント発行方法（set_flgの使い方）
イベントフラグによるタスク間同期・通信機能の特徴まとめ

スポンサー

イベントフラグで学ぶタスク間同期・通信機能とは

タスクとは「労働者」であり、マルチタスクとは「複数の労働者」でした。

システムという同じ場所で働く労働者は、それぞれのミッションを遂行していますが、場合によっては他の労働者とコミュニケーションを取る必要性があります。

例えばお店で働く料理人とウェイターでは次のようなシーンがありますね。

料理人が作成した料理ができたため、ウェイターに口頭で連絡して運んでもらうといったシーンです。会話をすることで料理が冷める前に、運ぶことができます。

このようにお互いのタイミングを合わせることを「同期」と呼びます。タスク間同期・通信機能はタスク同士で同期を取るための通信機能を提供します。

このようにITRON仕様というのはタスクというものを中心にして、どのような機能があればシステム構築が便利になるかという考え方で仕様が検討されています。

ITRONが定義するタスク間同期・通信機能とは

タスク同士が会話をするためのこの機能にはいくつかの種類が設けられています。

ITRON仕様「4.4 同期・通信機能」で定義される４つ。

セマフォ
イベントフラグ
データキュー
メールボックス

さらに高機能な「拡張同期・通信機能」で定義される３つ。

ミューテックス
メッセージバッファ
ランデブ

同期・通信機能はそれぞれに特徴があるため、自分が求めるものがどのようなものなのかを見極めて最適なものを選択できるスキルが求められます。

本記事ではイベントフラグを解説します。

スポンサー

イベントフラグの概要

イベントフラグは同期・通信機能の中でおそらく一番使われている機能だと思います。それほど使い勝手がよいということです。

イベント（事象）＋フラグ（有無）という組み合わせで、とあるイベントの発生をタスク間で通知することができる機能です。

では、ITRON仕様におけるイベントフラグの概要を見てみましょう。

4.4.2 イベントフラグ

イベントフラグはイベントの有無をビット毎のフラグで表現することにより、同期を行うためのオブジェクトである。

イベントフラグ機能にはイベントフラグを生成／削除する機能、イベントフラグをセット／クリアする機能、イベントフラグで待つ機能、イベントフラグの状態を参照する機能が含まれている。

イベントフラグはID番号で識別されるオブジェクトである。イベントフラグのID番号をイベントフラグIDと呼ぶ。

イベントフラグは「タスク」や「周期ハンドラ」などと同じように「オブジェクト」として存在するとされています。そのためオブジェクトを生成するためのサービスコールがあります。

イベントフラグで使用する代表的なサービスコール

イベントフラグではよくこれらのサービスコールを使用します。

CRE_FLG
cre_flg
set_flg
wai_flg

まずは、このサービスコールを覚えましょう。

スポンサー

イベントフラグの生成方法（CRE_FLG）

イベントフラグを生成するための静的APIを見てみましょう。

CRE_FLG(ID flgid, {ATR flgatr, FLGPTN iflgptn});

引数パラメータを解説しておきます。

ID	flgid	生成するイベントフラグのID。整数として一意のIDを割り付ける。
ATR	flgatr	イベントフラグの属性。
FLGPTN	iflgptn	イベントフラグパターンの初期値。基本は０を設定。

flgatrが特殊です。 ((TA_FIFO || TA_TPRI)|(TA_WSGL||TA_WMUL)|[TA_CLR])の指定ができます。

このイベントフラグというオブジェクトは複数のタスクで共有してイベントを待つということができる少し特殊な機能を持っています。

ただ、私はこの複数待ちを使っているアプリケーションには出会ったことがありません。使うなとは言いませんが、使うならしっかりと理解した上で使わないと思わぬ動きになるため注意しましょう。

TA_CLRはイベントフラグ待ち状態から待ち解除する時に、受信したイベントフラグのビットパターンを全てクリアするためのオプションであり、基本的には付けておくことが推奨です。

CRE_FLGによるイベントフラグの生成定義

では、皆さんにイベントフラグの定義をsystem.cfgに追加していただきましょう。前回までの設定はそのままで、イベントフラグの定義を１つ追加しましょう。

追加するイベントフラグ生成情報

IDは「FLGID_FLG1」を指定する。
属性は「(TA_TPRI | TA_WSGL | TA_CLR)」を指定する。
初期値は「０」を指定する。

system.cfg（一部抜粋）

//------------------------------------------------
//  アラームハンドラ定義
//------------------------------------------------
CRE_ALM(ALMID_ALM1,  {TA_HLNG, 0, ALM1});

//------------------------------------------------
//  イベントフラグ定義
//------------------------------------------------

解答

system.cfg（一部抜粋）

//------------------------------------------------
//  イベントフラグ定義
//------------------------------------------------
CRE_FLG(FLGID_FLG1,  {(TA_TPRI | TA_WSGL | TA_CLR), 0});

イベントフラグの設定値はこの値が最も基本形である。

イベントフラグを１つのタスクからしか待たない場合は、TA_TPRIでもTA_FIFOでもどっちでもよい。

スポンサー

イベントフラグを使ったタスクの待ち方（wai_flgの使い方）

イベントフラグを使ってイベント待ちをするタスク処理を作ってみましょう。イベント待ちをするタスクはTASK1とします。

イベント待ちのサービスコールであるwai_flgの仕様

では、wai_flgのITRON仕様を見てみましょう。

ER wai_flg(ID flgid, FLGPTN waiptn, MODE wfmode, FLGPTN * p_flgptn);

wai_flg：イベントフラグ待ち

flgidで指定されるイベントフラグのビットパターンがwaiptnとwfmodeで指定される待ち解除条件を満たすのを待つ。

flgptnには待ち解除される時のイベントフラグのビットパターンを返す。

wai_flgはタスクをイベント待ち状態に遷移させるサービスコールです。イベントフラグがセットされることで待ち状態が解除されます。

wfmodeという待ち方のオプション指定が必要であり、TWF_ANDWかTWF_ORWのどちらかを指定します。これはイベントフラグをANDで待つかORで待つかという違いであり、イベントを独立して待つことができるTWF_ORWを指定するのが一般的です。

TASK1タスクからwai_flgを使ったミッション内容

wai_flgを行うTASK1のミッション内容を決めます。次のミッションに従い処理を行いましょう。

TASK1：イベント待ちのミッション

TASK1にはLEDを制御するミッションを与える。外部から要求されるイベントに応じてLEDを制御する。

イベント待ちの種類として次の４つをサポートするものとする。

グリーンLED点灯要求イベント
グリーンLED消灯要求イベント
オレンジLED点灯要求イベント
オレンジLED消灯要求イベント

これらのイベント要求に従い各LEDの点灯／消灯を実施するものとする。

wai_flg関数の呼び出し方は、少し慣れが必要です。定型の形があるのですが、この形を知っていないとどのように指定するのかわかりづらいです。順に使い方を解説しましょう。

イベント種類の定義

今回は４種類のイベントがあるため、これらをmain.cにマクロ定義にて行います。

main.c（追記）

//  各イベント定義
#define D_FLG1_GREEN_LED_ON     (0x0001)    // 緑LED点灯
#define D_FLG1_GREEN_LED_OFF    (0x0002)    // 緑LED消灯
#define D_FLG1_ORANGE_LED_ON    (0x0004)    // 橙LED点灯
#define D_FLG1_ORANGE_LED_OFF   (0x0008)    // 橙LED消灯

//  全イベントパターン
#define D_FLG1_ALLPTN ( D_FLG1_GREEN_LED_ON     |   \
                        D_FLG1_GREEN_LED_OFF    |   \
                        D_FLG1_ORANGE_LED_ON    |   \
                        D_FLG1_ORANGE_LED_OFF   )

イベント定義時の注意点①

各イベントをビット単位の数値で定義します。この時に定義値は0x01、0x02、0x04、0x08、0x10…といった２進数においてどこか１つのビットのみが立っている値にすることです。

これを1、2、3、4…といった連番で定義するとイベントフラグは意図した動きにならないため注意してください。イベントフラグとは各ビットにイベントを割り付ける機能なのです。

HOSにおいてフラグパターンのデータ型であるFLGPTN型はunsigned short型のため全16個まで定義することができます。

イベント定義時の注意点②

各イベントをまとめたマクロであるD_FLG1_ALLPTNを用意します。これはwai_flgの引数で後程使用します。

この定義は各イベントのマクロ値をOR演算で合体させています。これにより次のように対象イベントのビットが全て立った値を定義することになります。

イベントフラグはビット演算との関係が非常に強い機能です。

ビット演算について詳しくない方は『C言語ビット演算を扱うための本当の視点と実践的な使用例を図解』の記事を見ておくとよいでしょう。

イベントの待ち方

タスク処理の中からwai_flgを呼び出します。TASK1の関数では次のように呼び出します。

main.c（一部抜粋）

void TASK1(VP_INT exinf)
{
    FLGPTN  flg = 0;

    while(1)
    {
        //  イベントフラグ待ち処理
        wai_flg(FLGID_FLG1, D_FLG1_ALLPTN, TWF_ORW, &flg);

        //  イベント処理

    }

    return;
}

wai_flgの第２引数には待つべきイベントフラグのパターンを指定する必要があります。今回は４つ全てのイベントを待つため、D_FLG1_ALLPTNを指定しています。

第３引数にはTWF_ORWを指定し、いづれかのイベントが１つでも発生したら待ちを解除します。TWF_ANDWにすると全てのビットが立たないと待ちを解除できません。

待ちが解除されると第４引数の中には発生したイベントフラグの内容が格納されます。引数がポインタになっているのはそのためですね。

ITRON入門編を受講されている方はよほど大丈夫だと思いますが、ポインタについて詳しく知りたい方は『C言語ポインタを使いこなせ【身に付けるための９の極意】』の記事を参照してください。

さあ皆さん、それではTASK1で不足している各種イベント処理の実装を行ってみましょう。各イベントが発生したときにLEDを適宜点灯、消灯させてください。

解答

main.c（一部抜粋）

//------------------------------------------------
//  概  要：練習用TASK1関数
//------------------------------------------------
void TASK1(VP_INT exinf)
{
    FLGPTN  flg = 0;

    while(1)
    {
        //  イベントフラグ待ち処理
        wai_flg(FLGID_FLG1, D_FLG1_ALLPTN, TWF_ORW, &flg);

        //  イベント処理        
        if ((flg & D_FLG1_GREEN_LED_ON) == D_FLG1_GREEN_LED_ON)
        {
            Led_setLight(D_LED_KIND_GREEN, D_LED_LIGHT_ON);
        }

        if ((flg & D_FLG1_GREEN_LED_OFF) == D_FLG1_GREEN_LED_OFF)
        {
            Led_setLight(D_LED_KIND_GREEN, D_LED_LIGHT_OFF);
        }

        if ((flg & D_FLG1_ORANGE_LED_ON) == D_FLG1_ORANGE_LED_ON)
        {
            Led_setLight(D_LED_KIND_ORANGE, D_LED_LIGHT_ON);
        }

        if ((flg & D_FLG1_ORANGE_LED_OFF) == D_FLG1_ORANGE_LED_OFF)
        {
            Led_setLight(D_LED_KIND_ORANGE, D_LED_LIGHT_OFF);
        }
    }

    return;
}

flg変数に対してAND演算によるマスク処理を実施し、ビットが立っているかをチェックしています。

イベント待ち処理の注意点①

イベント受信時の各イベントは独立したif文を使うのが基本です。if-elseif文ではつなげないようにしましょう。

イベントのフラグは同時に複数のビットが立つことがあり得ます。

そのため、独立したif文で各イベントに対する処理を行うのが基本になります。if-elseif文にすると１つのイベントしか処理できなくなります。

イベントの待ち方注意点②

イベントフラグは同時に複数立つことを想定します。

イベントフラグが同時に複数立った場合に、どちらを先に実施するかで処理の意味合いが変化するケースがあります。

もちろん順番に依存しないケースも多いのですが、イベントフラグを使うときは処理順番は検証する必要があることを覚えておきましょう。

スポンサー

イベントフラグへのイベント発行方法（set_flgの使い方）

では、続いて外部からイベントを発行する処理を作ってみましょう。イベントはTASK2とCYC1から発行することにします。

イベントフラグをセットするset_flgの仕様

では、set_flgのITRON仕様を見てみましょう。

ER set_flg(ID flgid, FLGPTN setptn);

set_flg：フラグのセット

flgidで指定されるイベントフラグに対して、setptnで指定するビットをセットする。

具体的には対象イベントフラグのビットパターンをサービスコール呼び出し前のビットパターンとsetptnの値のビット毎の論理和に更新する。

第２引数で指定したイベントをイベントフラグにセットするサービスコールです。setptnの値を論理和、つまりOR演算にて更新するとされています。

これは待つ側のタスクが動きだすまでの間に、イベントフラグを複数立てられる可能性を示唆しています。

TASK2タスクとCYC1周期ハンドラからset_flgを使ったミッション内容

set_flgを行うTASK2とCYC1のミッション内容を決めます。次のミッションに従い処理を行いましょう。

TASK2：イベントセットのミッション

TASK2はスイッチの押下状態に応じてグリーンLEDの点灯、消灯イベントを発行するミッションを与える。

スイッチが押されている時はグリーンLED点灯イベントを発行する。
スイッチが押されていない時はグリーンLED消灯のイベントを発行する。

これらの処理をdly_tskによる100ミリ秒周期で実施するものとする。

CYC1：イベントセットのミッション

CYC1は５秒周期で起動する周期ハンドラである。周期ハンドラが起動するたびにオレンジLEDの点灯、消灯イベントを発行するミッションを与える。

１回目の周期によってオレンジLEDを点灯するイベントを発行。
２回目の周期によってオレンジLEDを消灯するイベントを発行。
３回目の周期によってオレンジLEDを点灯するイベントを発行。

以降同様の規則で交互に点灯／消灯のイベントを発行することとする。

TASK2のイベントのセットのプログラム作成

では、TASK2からイベントを発行してみましょう。次のプログラムをベースにミッション内容をプログラミングしてみてください。

main.c（一部抜粋）

//------------------------------------------------
//  概  要：練習用TASK2関数
//------------------------------------------------
void TASK2(VP_INT exinf)
{
    while(1)
    {

    }

    return;
}

解答

main.c（一部抜粋）

//------------------------------------------------
//  概  要：練習用TASK2関数
//------------------------------------------------
void TASK2(VP_INT exinf)
{
    while(1)
    {
        if (Sw_getPressed() == D_SW_PRESSED_ON)
        {
            //  緑LED点灯イベント
            set_flg(FLGID_FLG1, D_FLG1_GREEN_LED_ON);
        }
        else
        {
            //  緑LED消灯イベント
            set_flg(FLGID_FLG1, D_FLG1_GREEN_LED_OFF);
        }

        dly_tsk(100);
    }

    return;
}

スイッチモジュールのSw_getPressed関数を利用し、スイッチONとOFFの場合でset_flgを呼び出している。指定するのはグリーンLED用イベントのマクロ定数である。

CYC1のイベントのセット方法

続いて、CYC1からイベントを発行してみましょう。次のプログラムをベースにミッション内容をプログラミングしてみてください。

main.c（一部抜粋）

//------------------------------------------------
//  概  要：練習用周期ハンドラ関数
//------------------------------------------------
void CYC1(VP_INT exinf)
{
    //  5秒毎に周期起動する

}

解答

main.c（一部抜粋）

//------------------------------------------------
//  概  要：練習用周期ハンドラ関数
//------------------------------------------------
void CYC1(VP_INT exinf)
{
    //  5秒毎に周期起動する

    static int led = 1; //  LEDは最初に点灯

    if (led == 1)
    {
        //  橙LED点灯イベント
        iset_flg(FLGID_FLG1, D_FLG1_ORANGE_LED_ON);
        led = 0;
    }
    else
    {
        //  橙LED消灯イベント
        iset_flg(FLGID_FLG1, D_FLG1_ORANGE_LED_OFF);
        led = 1;
    }
}

周期ハンドラが呼び出される度にLEDの発行イベントを切り替えるため、static変数を利用している。最初は点灯イベント、２回目は消灯イベント…となるようにプログラムする。

MAINタスクとALM1に関しては特にやるべきことはないので次のようにしておきましょう。

main.c（一部抜粋）

//------------------------------------------------
//  概  要：    MAINタスク
//------------------------------------------------
void MAIN(VP_INT exinf)
{
    while(1)
    {
        dly_tsk(1000);
    }

    return;
}

//------------------------------------------------
//  概  要：練習用アラームハンドラ関数
//------------------------------------------------
void ALM1(VP_INT exinf)
{

}

ここまでできたら、ビルドして動かしてみましょう。オレンジLEDは５秒周期で点滅し、グリーンLEDはスイッチの押下に従い点滅するはずです。

全体の動きのシーケンス図は次のようになっています。