/*
 *  TOPPERS/ASP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Advanced Standard Profile Kernel
 * 
 *  Copyright (C) 2006-2012 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$
 */

/*
 *		ターゲット依存モジュール（Mac OS X用）
 */

#include "kernel_impl.h"
#include "task.h"
#include "interrupt.h"
#include "exception.h"

/*
 *  トレースログマクロのデフォルト定義
 */
#ifndef LOG_DSP_ENTER
#define LOG_DSP_ENTER(p_tcb)
#endif /* LOG_DSP_ENTER */

#ifndef LOG_DSP_LEAVE
#define LOG_DSP_LEAVE(p_tcb)
#endif /* LOG_DSP_LEAVE */

#ifndef LOG_INH_ENTER
#define LOG_INH_ENTER(inhno)
#endif /* LOG_INH_ENTER */

#ifndef LOG_INH_LEAVE
#define LOG_INH_LEAVE(inhno)
#endif /* LOG_INH_LEAVE */

#ifndef LOG_EXC_ENTER
#define LOG_EXC_ENTER(excno)
#endif /* LOG_EXC_ENTER */

#ifndef LOG_EXC_LEAVE
#define LOG_EXC_LEAVE(excno)
#endif /* LOG_EXC_LEAVE */

/*
 *  TMIN_INTPRIの範囲のチェック
 */
#if (TMIN_INTPRI > -1) || (-6 > TMIN_INTPRI)
#error TMIN_INTPRI out of range.
#endif /* (TMIN_INTPRI > -1) || (-6 > TMIN_INTPRI) */

/*
 *  割込み優先度マスクによるシグナルマスク
 */
sigset_t	sigmask_table[8];

/*
 *  割込みロック／CPUロックへの移行でマスクするシグナルを保持する変数
 */
sigset_t	sigmask_intlock;	/* 割込みロックでマスクするシグナル */
sigset_t	sigmask_cpulock;	/* CPUロックでマスクするシグナル */

/*
 *  CPUロックフラグ実現のための変数
 */
volatile bool_t		lock_flag;		/* CPUロックフラグを表す変数 */
volatile sigset_t	saved_sigmask;	/* シグナルマスクを保存する変数 */

/*
 *  割込み優先度マスク実現のための変数
 */
volatile PRI		ipm_value;		/* 割込み優先度マスクを表す変数 */

/*
 *  割込み要求禁止フラグ実現のための変数
 */
volatile sigset_t	sigmask_disint;	/* 個別にマスクしているシグナル */

/*
 *  ディスパッチャ本体の割込み待ち中であることを示す変数
 */
static bool_t	dispatcher_idle;	/* 割込み待ち中である */

/*
 *  ディスパッチャ本体
 *
 *  LOG_DSP_ENTERとLOG_DSP_LEAVEを，dispatcherに入れず，これを呼び出す
 *  関数の側に入れている理由は次の通り．LOG_DSP_ENTERは，ディスパッチの
 *  動作開始時（mainから呼ばれた時）には，呼び出してはならないため，
 *  dispatcherに入れることができない．LOG_DSP_LEAVEは，切換え後のタスク
 *  のスタックで呼び出さなければならないため，_longjmpを実行した後に呼
 *  び出す必要があり，dispatcherを呼び出す関数の側に入れなければならな
 *  い．
 */
static void
dispatcher(void)
{
	sigset_t	sigmask;

	while ((p_runtsk = p_schedtsk) == NULL) {
		/*
		 *  CPUロック状態を解除する準備をする．sigmaskには，CPUロック状
		 *  態に移行する前のシグナルマスクを取り出す．
		 */
		lock_flag = false;
		sigassignset(&sigmask, &saved_sigmask);
		do {
			/*
			 *  割込み待ちの間に発生した割込みハンドラではSIGUSR2を
			 *  raiseしないように，dispatcher_idleをtrueにする．
			 */
			dispatcher_idle = true;
			sigsuspend(&sigmask);			/* 割込み待ち */
			dispatcher_idle = false;
		} while (!reqflg);
		reqflg = false;

		/*
		 *  CPUロック状態に戻す．割込み待ちの間に実行した割込みハンドラ
		 *  により，saved_sigmaskは書き換わる可能性があるため，元の値に
		 *  戻す必要がある．
		 */
		sigassignset(&saved_sigmask, &sigmask);
		lock_flag = true;
	}
	_longjmp(p_runtsk->tskctxb.env, 1);
}

/*
 *  最高優先順位タスクへのディスパッチ
 */
void
dispatch(void)
{
#ifdef TOPPERS_SUPPORT_OVRHDR
	ovrtimer_stop();					/* オーバランタイマの停止 */
#endif /* TOPPERS_SUPPORT_OVRHDR */
	if (_setjmp(p_runtsk->tskctxb.env) == 0) {
		LOG_DSP_ENTER(p_runtsk);
		dispatcher();
		assert(0);
	}
	LOG_DSP_LEAVE(p_runtsk);
#ifdef TOPPERS_SUPPORT_OVRHDR
	ovrtimer_start();					/* オーバランタイマの動作開始 */
#endif /* TOPPERS_SUPPORT_OVRHDR */
	calltex();
}

/*
 *  最高優先順位タスクへのディスパッチ（シグナルハンドラ用）
 */
static void
dispatch_handler(int sig, struct __siginfo *p_info, void *p_ctx)
{
#ifdef TOPPERS_SUPPORT_OVRHDR
	/*
	 *  オーバランハンドラ機能をサポートする場合には，dispatch_handler
	 *  は必ず起動される．ディスパッチが必要ない場合には，オーバランハ
	 *  ンドラの動作開始のみを行う．
	 */
	if (!(!dispatcher_idle && reqflg)) {
		ovrtimer_start();				/* オーバランタイマの動作開始 */
		return;
	}
	reqflg = false;
#endif /* TOPPERS_SUPPORT_OVRHDR */

	/*
	 *  シグナルハンドラの実行開始前のシグナルマスクをsaved_sigmaskに代
	 *  入し，CPUロック状態に移行する．
	 */
	sigassignset(&saved_sigmask, &(((ucontext_t *) p_ctx)->uc_sigmask));
	lock_flag = true;

	if (dspflg && p_runtsk != p_schedtsk) {
		if (_setjmp(p_runtsk->tskctxb.env) == 0) {
			LOG_DSP_ENTER(p_runtsk);
			dispatcher();
			assert(0);
		}
		LOG_DSP_LEAVE(p_runtsk);
	}
#ifdef TOPPERS_SUPPORT_OVRHDR
	ovrtimer_start();					/* オーバランタイマの動作開始 */
#endif /* TOPPERS_SUPPORT_OVRHDR */
	calltex();

	/*
	 *  シグナルハンドラからのリターン後のシグナルマスクがsaved_sigmask
	 *  になるように設定し，CPUロック状態を解除する．
	 */
	lock_flag = false;
	sigassignset(&(((ucontext_t *) p_ctx)->uc_sigmask), &saved_sigmask);
}

/*
 *  現在のコンテキストを捨ててディスパッチ
 */
void
exit_and_dispatch(void)
{
	LOG_DSP_ENTER(p_runtsk);
	dispatcher();
	assert(0);
}

/*
 *  割込みハンドラ出口処理
 *
 *  割込みハンドラ中では，カーネル管理の割込みを禁止しているため，出口
 *  処理で割込みを禁止する必要はない．
 */
void
ret_int(void)
{
#ifndef TOPPERS_SUPPORT_OVRHDR
	/*
	 *  ディスパッチャの起動を要求する．
	 *
	 *  reqflgをチェックした直後に割込みが入っても，入った側の割込みで
	 *  タスクディスパッチャの起動を要求するため，reqflgをチェックする
	 *  前に割込みを禁止する必要がない．
	 */
	if (!dispatcher_idle && reqflg) {
		reqflg = false;
		raise(SIGUSR2);
	}
#else /* TOPPERS_SUPPORT_OVRHDR */
	/*
	 *  オーバランハンドラ機能をサポートする場合には，オーバランタイマ
	 *  を動作開始するために，dispatch_handlerを必ず起動する．
	 */
	raise(SIGUSR2);
#endif /* TOPPERS_SUPPORT_OVRHDR */
}

/*
 *  CPU例外ハンドラ出口処理
 */
void
ret_exc(void)
{
#ifndef TOPPERS_SUPPORT_OVRHDR
	/*
	 *  ディスパッチャの起動を要求する．
	 *
	 *  reqflgをチェックした直後に割込みが入っても，入った側の割込みで
	 *  タスクディスパッチャの起動を要求するため，reqflgをチェックする
	 *  前に割込みを禁止する必要がない．
	 */
	if (!dispatcher_idle && reqflg) {
		reqflg = false;
		raise(SIGUSR2);
	}
#else /* TOPPERS_SUPPORT_OVRHDR */
	/*
	 *  オーバランハンドラ機能をサポートする場合には，オーバランタイマ
	 *  を動作開始するために，dispatch_handlerを必ず起動する．
	 */
	raise(SIGUSR2);
#endif /* TOPPERS_SUPPORT_OVRHDR */
}

/*
 *  カーネルの終了処理の呼出し
 */
void
call_exit_kernel(void)
{
	sigset_t			sigmask;
	struct sigaction	sigact;

	/*
	 *  SIGUSR2のシグナルハンドラにexit_kernelを登録
	 */
	sigact.sa_handler = (void (*)(int)) exit_kernel;
	sigact.sa_flags = SA_ONSTACK;
	sigemptyset(&(sigact.sa_mask));
	sigaction(SIGUSR2, &sigact, NULL);

	/*
	 *  SIGUSR2のマスクを解除
	 */
	sigemptyset(&sigmask);
	sigaddset(&sigmask, SIGUSR2);
	sigprocmask(SIG_UNBLOCK, &sigmask, NULL);

	/*
	 *  exit_kernelの呼出し
	 */
	raise(SIGUSR2);
	assert(0);
	while (true);
}

/*
 *  タスク開始時処理
 */
void
start_r(void)
{
#ifdef TOPPERS_SUPPORT_OVRHDR
	ovrtimer_start();					/* オーバランタイマの動作開始 */
#endif /* TOPPERS_SUPPORT_OVRHDR */
	t_unlock_cpu();
	(*(p_runtsk->p_tinib->task))(p_runtsk->p_tinib->exinf);
	(void) ext_tsk();
	assert(0);
}

/*
 *  割込みハンドラの出入口処理
 */
static void
generic_inthdr(int sig, struct __siginfo *p_info, void *p_ctx)
{
	PRI		saved_ipm;
	INHNO	inhno;
	INTNO	intno;
	IINTHDR	inthdr;

	saved_ipm = ipm_value;
	inhno = (INHNO)(sig);
	intno = INTNO_INHNO(inhno);
	inthdr = get_inhinib(inhno)->inthdr;
	ipm_value = get_intinib(intno)->intpri;
	OVRTIMER_STOP();
	LOG_INH_ENTER(intno);
	inthdr(intno);			/* 割込みハンドラを呼び出す */
	LOG_INH_LEAVE(intno);
	ret_int();				/* 割込みハンドラ出口処理を呼び出す */
	ipm_value = saved_ipm;
	lock_flag = false;
}

/*
 *  CPU例外ハンドラの出入口処理
 */
static void
generic_exchdr(int sig, struct __siginfo *p_info, void *p_ctx)
{
	bool_t		saved_lock_flag;
	EXCNO		excno;
	EXCHDR		exchdr;

	saved_lock_flag = lock_flag;
	excno = (EXCNO)(sig);
	exchdr = get_excinib(excno)->exchdr;
	if (exc_sense_nonkernel(p_ctx)) {
		/* カーネル管理外のCPU例外ハンドラの場合 */
		exchdr(p_ctx);			/* CPU例外ハンドラを呼び出す */
	}
	else {
		/* カーネル管理のCPU例外ハンドラの場合 */
		OVRTIMER_STOP();
		LOG_EXC_ENTER(excno);
		exchdr(p_ctx);			/* CPU例外ハンドラを呼び出す */
		LOG_EXC_LEAVE(excno);
		ret_exc();				/* CPU例外ハンドラ出口処理を呼び出す */
	}
	lock_flag = saved_lock_flag;
}

/*
 *  サービスコールのターゲット依存エラーチェックコード
 */
ER
target_check_cint(INTNO intno, const T_CINT *pk_cint)
{
	if ((pk_cint->intatr & TA_EDGE) == 0U) {
		/*
		 *  レベルトリガはサポートしていない．
		 */
		return(E_RSATR);
	}
	else if (excinib_table[INDEX_INTNO(intno)].excatr != TA_NOEXS) {
		/*
		 *  CPU例外ハンドラが定義されたシグナルに対して，割込み要求ライ
		 *  ンの属性を設定しようとした場合は，E_OBJエラーとする．
		 */
		return(E_OBJ);
	}
	return(E_OK);
}

ER
target_check_dexc(EXCNO excno, const T_DEXC *pk_dexc)
{
	if (intinib_table[INDEX_EXCNO(excno)].intatr != TA_NOEXS) {
		/*
		 *  割込み要求ラインの属性が設定されたシグナルに対して，CPU例外
		 *  ハンドラを定義しようとした場合は，E_OBJエラーとする．
		 */
		return(E_OBJ);
	}
	return(E_OK);
}

/*
 *  ターゲット依存の初期化
 */
void
target_initialize(void)
{
	struct sigaction	sigact;
	uint_t				i;

	for (i = 0; i < TNUM_INTNO; i++) {
		intinib_table[i].intpri = 0;
	}

	/*
	 *  マスクできないシグナル
	 */
	intinib_table[INDEX_INTNO(SIGKILL)].intpri = -7;
	intinib_table[INDEX_INTNO(SIGSTOP)].intpri = -7;

	/*
	 *  デバッグ用にマスクしないシグナル
	 */
	intinib_table[INDEX_INTNO(SIGINT)].intpri = -7;
	intinib_table[INDEX_INTNO(SIGBUS)].intpri = -7;
	intinib_table[INDEX_INTNO(SIGSEGV)].intpri = -7;

	/*
	 *  CPUロックフラグ実現のための変数の初期化
	 *
	 *  saved_sigmaskは，カーネル起動時に呼び出すset_sigmaskで初期化さ
	 *  れる．
	 */
	lock_flag = true;

	/*
	 *  割込み優先度マスク実現のための変数の初期化
	 */
	ipm_value = TIPM_ENAALL;

	/*
	 *  ディスパッチャ本体のアイドルループ中であることを示す変数の初期化
	 */
	dispatcher_idle = false;

	/*
	 *  SIGUSR2のシグナルハンドラにディスパッチャを登録
	 */
	sigact.sa_sigaction = dispatch_handler;
	sigact.sa_flags = SA_SIGINFO;
	sigassignset(&(sigact.sa_mask), &sigmask_cpulock);
	sigaction(SIGUSR2, &sigact, NULL);
}

/*
 *  割込み/CPU例外の初期化処理（ターゲット依存）
 */
void
target_prepare(void)
{
	uint_t				i;
	PRI					intpri;
	sigset_t			sigmask;
	struct sigaction	sigact;

	/*
	 *  割込み優先度マスクによるシグナルマスクの設定
	 */
	for (intpri = 0; intpri >= -6; intpri--) {
		sigemptyset(&sigmask);
		for (i = 0; i < TNUM_INTNO; i++) {
			if (excinib_table[i].excatr == TA_NOEXS
						&& intinib_table[i].intpri >= intpri) {
				sigaddset(&sigmask, i + 1);
			}
		}
		sigmask_table[-intpri] = sigmask;
	}
	sigmask_table[7] = sigmask;

	/*
	 *  割込みロックへの移行でマスクするシグナルを保持する変数の初期化
	 */
	sigassignset(&sigmask_intlock, &(sigmask_table[6]));
	sigaddset(&sigmask_intlock, SIGUSR2);

	/*
	 *  CPUロックへの移行でマスクするシグナルを保持する変数の初期化
	 */
	sigassignset(&sigmask_cpulock, &(sigmask_table[-TMIN_INTPRI]));
	sigaddset(&sigmask_cpulock, SIGUSR2);

	/*
	 *  割込み要求禁止フラグ実現のための変数の初期化
	 */
	sigemptyset(&sigmask_disint);
	for (i = 0; i < TNUM_INTNO; i++) {
		if (intinib_table[i].intatr != TA_NOEXS
					&& (intinib_table[i].intatr & TA_ENAINT) == 0) {
			sigaddset(&sigmask_disint, i + 1);
		}
	}

	for (i = 0; i < TNUM_INHNO; i++) {
		if (inhinib_table[i].inhatr != TA_NOEXS) {
			sigact.sa_sigaction = generic_inthdr;
			sigact.sa_flags = SA_ONSTACK;
			sigassignset(&(sigact.sa_mask),
							&sigmask_table[-intinib_table[i].intpri]);
			sigaddset(&(sigact.sa_mask), SIGUSR2);
			sigaction(i + 1, &sigact, NULL);
		}
	}

	for (i = 0; i < TNUM_EXCNO; i++) {
		if (excinib_table[i].excatr != TA_NOEXS) {
			/*
			 *  SA_NODEFERにより，シグナルハンドラの起動時に，そのシグ
			 *  ナルをマスクするのを抑止している．
			 */
			sigact.sa_sigaction = generic_exchdr;
			sigact.sa_flags = (SA_ONSTACK | SA_SIGINFO | SA_NODEFER);
			sigemptyset(&(sigact.sa_mask));
			sigaddset(&(sigact.sa_mask), SIGUSR2);
			sigaction(i + 1, &sigact, NULL);
		}
	}
}

/*
 *  ターゲット依存の終了処理
 */
void
target_exit(void)
{
	/*
	 *  プロセスの終了処理
	 */
	exit(0);
}

/*
 *  システムログの低レベル出力のための文字出力
 */
void
target_fput_log(char c)
{
	write(STDERR_FILENO, &c, 1);
}

/*
 *  メイン関数
 */
int
main()
{
	sigset_t			sigmask;
	stack_t				ss;
	struct sigaction	sigact;

	/*
	 *  SIGUSR2以外のすべてのシグナルをマスク
	 */
	sigfillset(&sigmask);
	sigdelset(&sigmask, SIGUSR2);
	sigprocmask(SIG_BLOCK, &sigmask, NULL);

	/*
	 *  シグナルスタック（非タスクコンテキスト用のスタック）の設定
	 */
	ss.ss_sp = (char *)(istk);
	ss.ss_size = (int)(istksz);
	ss.ss_flags = 0;
	sigaltstack(&ss, NULL);

	/*
	 *  SIGUSR2のシグナルハンドラにsta_kerを登録
	 */
	sigact.sa_handler = (void (*)(int)) sta_ker;
	sigact.sa_flags = SA_ONSTACK;
	sigemptyset(&(sigact.sa_mask));
	sigaction(SIGUSR2, &sigact, NULL);

	/*
	 *  sta_kerの呼出し
	 */
	raise(SIGUSR2);

	/*
	 *  ディスパッチャの動作開始
	 *
	 *  target_initializeで，lock_flagをtrueに，ipm_valueをTIPM_ENAALL
	 *  に初期化しているため，set_sigmaskを呼び出してシグナルマスクと
	 *  saved_sigmaskを設定することで，CPUロック状態・（モデル上の）割
	 *  込み優先度マスクがTIPM_ENAALLの状態になる．
	 *
	 *  また，initialize_taskでdisdspをfalseに初期化しているため，ディ
	 *  スパッチ許可状態になっている．
	 */
	set_sigmask();
	dispatcher();
	assert(0);
	return(0);
}
