source: asp3_wo_tecs/trunk/syssvc/syslog.c@ 302

/*
 *  TOPPERS/ASP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Advanced Standard Profile Kernel
 * 
 *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
 *                              Toyohashi Univ. of Technology, JAPAN
 *  Copyright (C) 2005-2015 by Embedded and Real-Time Systems Laboratory
 *              Graduate School of Information Science, Nagoya Univ., JAPAN
 * 
 *  上記著作権者
は，以下の(1)〜(4)ã®æ¡ä»¶ã‚’æº€ãŸã™å ´åˆã«é™ã‚Šï¼Œæœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§
 *  ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
 *  変・再é…
å¸ƒï¼ˆä»¥ä¸‹ï¼Œåˆ©ç”¨ã¨å‘¼ã¶ï¼‰ã™ã‚‹ã“とを無償で許諾する．
 *  (1) æœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚’ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã®å½¢ã§åˆ©ç”¨ã™ã‚‹å ´åˆã«ã¯ï¼Œä¸Šè¨˜ã®è‘—ä½œ
 *      権表示，この利用条件および下記の無保証規定が，そのままの形でソー
 *      スコード中に含まれていること．
 *  (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
 *      用できる形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œå†é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨
 *      者
マニュアルなど）に，上記の著作権表示，この利用条件および下記
 *      の無保証規定を掲載すること．
 *  (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
 *      用できない形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œæ¬¡ã®ã„ずれかの条件を満たすこ
 *      と．
 *    (a) 再é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨è€…
マニュアルなど）に，上記の著
 *        作権表示，この利用条件および下記の無保証規定を掲載すること．
 *    (b) 再é…
å¸ƒã®å½¢æ…
‹ã‚’，別に定める方法によって，TOPPERSプロジェクトに
 *        å ±å‘Šã™ã‚‹ã“ã¨ï¼Ž
 *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
 *      害からも，上記著作権者
およびTOPPERSプロジェクトをå…
è²¬ã™ã‚‹ã“と．
 *      また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
 *      由に基づく請求からも，上記著作権者
およびTOPPERSプロジェクトを
 *      å…
è²¬ã™ã‚‹ã“と．
 * 
 *  本ソフトウェアは，無保証で提供されているものである．上記著作権者
お
 *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
 *  に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
 *  アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
 *  ã®è²¬ä»»ã‚’è² ã‚ãªã„ï¼Ž
 * 
 *  $Id: syslog.c 406 2015-08-02 21:57:18Z ertl-hiro $
 */

/*
 *              システムログ機能
 */

#include <sil.h>
#undef TOPPERS_OMIT_SYSLOG
#include <t_syslog.h>
#include <log_output.h>
#include "target_syssvc.h"
#include "syslog.h"

/*
 *  トレースログマクロのデフォルト定義
 */
#ifndef LOG_SYSLOG_WRI_LOG_ENTER
#define LOG_SYSLOG_WRI_LOG_ENTER(prio, p_syslog)
#endif /* LOG_SYSLOG_WRI_LOG_ENTER */

#ifndef LOG_SYSLOG_WRI_LOG_LEAVE
#define LOG_SYSLOG_WRI_LOG_LEAVE(ercd)
#endif /* LOG_SYSLOG_WRI_LOG_LEAVE */

#ifndef LOG_SYSLOG_REA_LOG_ENTER
#define LOG_SYSLOG_REA_LOG_ENTER(p_syslog)
#endif /* LOG_SYSLOG_REA_LOG_ENTER */

#ifndef LOG_SYSLOG_REA_LOG_LEAVE
#define LOG_SYSLOG_REA_LOG_LEAVE(ercd, p_syslog)
#endif /* LOG_SYSLOG_REA_LOG_LEAVE */

#ifndef LOG_SYSLOG_MSK_LOG_ENTER
#define LOG_SYSLOG_MSK_LOG_ENTER(logmask, lowmask)
#endif /* LOG_SYSLOG_MSK_LOG_ENTER */

#ifndef LOG_SYSLOG_MSK_LOG_LEAVE
#define LOG_SYSLOG_MSK_LOG_LEAVE(ercd)
#endif /* LOG_SYSLOG_MSK_LOG_LEAVE */

#ifndef LOG_SYSLOG_REF_LOG_ENTER
#define LOG_SYSLOG_REF_LOG_ENTER(pk_rlog)
#endif /* LOG_SYSLOG_REF_LOG_ENTER */

#ifndef LOG_SYSLOG_REF_LOG_LEAVE
#define LOG_SYSLOG_REF_LOG_LEAVE(ercd, pk_rlog)
#endif /* LOG_SYSLOG_REF_LOG_LEAVE */

#ifndef LOG_SYSLOG_FLS_LOG_ENTER
#define LOG_SYSLOG_FLS_LOG_ENTER()
#endif /* LOG_SYSLOG_FLS_LOG_ENTER */

#ifndef LOG_SYSLOG_FLS_LOG_LEAVE
#define LOG_SYSLOG_FLS_LOG_LEAVE(ercd)
#endif /* LOG_SYSLOG_FLS_LOG_LEAVE */

/*
 *  ログ時刻の取り出し
 *
 *  デフォルトでは，ログ時刻として，高分解能タイマのカウント値を用いて
 *  ã„ã‚‹ï¼Žã‚¿ãƒ¼ã‚²ãƒƒãƒˆä¾å­˜ã§å¤‰æ›´ã™ã‚‹å ´åˆã«ã¯ï¼ŒSYSLOG_GET_LOGTIMに，ログ時
 *  刻を取り出すマクロを定義する．
 */
#ifndef SYSLOG_GET_LOGTIM
#define target_hrt_get_current          _kernel_target_hrt_get_current
#include "target_timer.h"
#define SYSLOG_GET_LOGTIM(p_logtim) \
                                (*(p_logtim) = _kernel_target_hrt_get_current())
#endif /* SYSLOG_GET_LOGTIM */

/*
 *  ログバッファとそれにアクセスするためのポインタ
 */
static SYSLOG   syslog_buffer[TCNT_SYSLOG_BUFFER];      /* ログバッファ */
static uint_t   syslog_count;                   /* ログバッファ中のログの数 */
static uint_t   syslog_head;                    /* å…
ˆé ­ã®ãƒ­ã‚°ã®æ ¼ç´ä½ç½® */
static uint_t   syslog_tail;                    /* æ¬¡ã®ãƒ­ã‚°ã®æ ¼ç´ä½ç½® */
static uint_t   syslog_lost;                    /* 失われたログの数 */

/*
 *  出力すべきログ情
å ±ã®é‡è¦åº¦ï¼ˆãƒ“ãƒƒãƒˆãƒžãƒƒãƒ—ï¼‰
 */
static uint_t   syslog_logmask;                 /* ログバッファに記録すべき重要度 */
static uint_t   syslog_lowmask_not;             /* 低レベル出力すべき重要度（反転）*/

/*
 *  システムログ機能の初期化
 */
void
syslog_initialize(intptr_t exinf)
{
        syslog_count = 0U;
        syslog_head = 0U;
        syslog_tail = 0U;
        syslog_lost = 0U;
        syslog_logmask = 0U;
        syslog_lowmask_not = 0U;
}     

/* 
 *  ログ情
å ±ã®å‡ºåŠ›
 *
 *  CPUロック状æ…
‹ã‚„実行コンテキストによらず動作できるように実装
してある．
 */
ER
syslog_wri_log(uint_t prio, const SYSLOG *p_syslog)
{
        SIL_PRE_LOC;

        LOG_SYSLOG_WRI_LOG_ENTER(prio, p_syslog);
        SIL_LOC_INT();

        /*
         *  ログ時刻の設定
         */
        SYSLOG_GET_LOGTIM(&(((SYSLOG *) p_syslog)->logtim));

        /*
         *  ログバッファに記録
         */
        if ((syslog_logmask & LOG_MASK(prio)) != 0U) {
                syslog_buffer[syslog_tail] = *p_syslog;
                syslog_tail++;
                if (syslog_tail >= TCNT_SYSLOG_BUFFER) {
                        syslog_tail = 0U;
                }
                if (syslog_count < TCNT_SYSLOG_BUFFER) {
                        syslog_count++;
                }
                else {
                        syslog_head = syslog_tail;
                        syslog_lost++;
                }
        }

        /*
         *  低レベル出力
         */
        if (((~syslog_lowmask_not) & LOG_MASK(prio)) != 0U) {
                syslog_print(p_syslog, target_fput_log);
                target_fput_log('\n');
        }

        SIL_UNL_INT();
        LOG_SYSLOG_WRI_LOG_LEAVE(E_OK);
        return(E_OK);
}

/*
 *  ログバッファからの読出し
 *
 *  CPUロック状æ…
‹ã‚„実行コンテキストによらず動作できるように実装
してある．
 */
ER_UINT
syslog_rea_log(SYSLOG *p_syslog)
{
        ER_UINT ercd;
        SIL_PRE_LOC;

        LOG_SYSLOG_REA_LOG_ENTER(p_syslog);
        SIL_LOC_INT();

        /*
         *  ログバッファからの取出し
         */
        if (syslog_count > 0U) {
                *p_syslog = syslog_buffer[syslog_head];
                syslog_count--;
                syslog_head++;
                if (syslog_head >= TCNT_SYSLOG_BUFFER) {
                        syslog_head = 0U;
                }
                ercd = (ER_UINT) syslog_lost;
                syslog_lost = 0U;
        }
        else {
                ercd = E_OBJ;
        }

        SIL_UNL_INT();
        LOG_SYSLOG_REA_LOG_LEAVE(ercd, p_syslog);
        return(ercd);
}

/* 
 *  出力すべきログ情
å ±ã®é‡è¦åº¦ã®è¨­å®š
 */
ER
syslog_msk_log(uint_t logmask, uint_t lowmask)
{
        SIL_PRE_LOC;

        LOG_SYSLOG_MSK_LOG_ENTER(logmask, lowmask);
        SIL_LOC_INT();

        syslog_logmask = logmask;
        syslog_lowmask_not = ~lowmask;

        SIL_UNL_INT();
        LOG_SYSLOG_MSK_LOG_LEAVE(E_OK);
        return(E_OK);
}

/*
 *  ログバッファの状æ…
‹å‚ç…
§
 */
ER
syslog_ref_log(T_SYSLOG_RLOG *pk_rlog)
{
        SIL_PRE_LOC;

        LOG_SYSLOG_REF_LOG_ENTER(pk_rlog);
        SIL_LOC_INT();

        pk_rlog->count = syslog_count;
        pk_rlog->lost = syslog_lost;
        pk_rlog->logmask = syslog_logmask;
        pk_rlog->lowmask = ~syslog_lowmask_not;

        SIL_UNL_INT();
        LOG_SYSLOG_REF_LOG_LEAVE(E_OK, pk_rlog);
        return(E_OK);
}

/* 
 *  低レベル出力によるすべてのログ情
å ±ã®å‡ºåŠ›
 */
ER
syslog_fls_log(void)
{
        SYSLOG  logbuf;
        ER_UINT rercd;
        SIL_PRE_LOC;

        LOG_SYSLOG_FLS_LOG_ENTER();
        SIL_LOC_INT();

        while ((rercd = syslog_rea_log(&logbuf)) >= 0) {
                if (rercd > 0) {
                        syslog_lostmsg((uint_t) rercd, target_fput_log);
                }
                if (logbuf.logtype >= LOG_TYPE_COMMENT) {
                        syslog_print(&logbuf, target_fput_log);
                        target_fput_log('\n');
                }
        }

        SIL_UNL_INT();
        LOG_SYSLOG_FLS_LOG_LEAVE(E_OK);
        return(E_OK);
}