source: extension/mutex/kernel/mutex.h

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

/*
 *              ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹µ¡Çœ
 */

#ifndef TOPPERS_MUTEX_H
#define TOPPERS_MUTEX_H

#include "wait.h"

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹œéŽü²œ¥Ö¥í¥Ã¥¯
 *
 *  €³€Î¹œÂ€Â΀ϡ€Æ±Žü¡ŠÄÌ¿®¥ª¥Ö¥ž¥§¥¯¥È€ÎœéŽü²œ¥Ö¥í¥Ã¥¯€Î¶ŠÄÌÉôʬ
 *  ¡ÊWOBJINIB¡Ë€ò³ÈÄ¥¡Ê¥ª¥Ö¥ž¥§¥¯¥È»ØžþžÀžì€Î·ÑŸµ€ËÁêÅö¡Ë€·€¿€â€Î€Ç¡€
 *  ºÇœé€Î¥Õ¥£¡Œ¥ë¥É€¬¶ŠÄ̀ˀʀÀƀ€€ë¡¥
 */
typedef struct mutex_initialization_block {
        ATR                     mtxatr;                 /* ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹Â°À­ */
        uint_t          ceilpri;                /* ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ÎŸåžÂÍ¥ÀèÅÙ¡ÊÆâÉôÉœžœ¡Ë*/
} MTXINIB;

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ŽÉÍý¥Ö¥í¥Ã¥¯
 *
 *  €³€Î¹œÂ€Â΀ϡ€Æ±Žü¡ŠÄÌ¿®¥ª¥Ö¥ž¥§¥¯¥È€ÎŽÉÍý¥Ö¥í¥Ã¥¯€Î¶ŠÄÌÉôʬ¡ÊWOBJCB¡Ë
 *  €ò³ÈÄ¥¡Ê¥ª¥Ö¥ž¥§¥¯¥È»ØžþžÀžì€Î·ÑŸµ€ËÁêÅö¡Ë€·€¿€â€Î€Ç¡€ºÇœé€Î2€Ä€Î
 *  ¥Õ¥£¡Œ¥ë¥É€¬¶ŠÄ̀ˀʀÀƀ€€ë¡¥
 */
typedef struct mutex_control_block {
        QUEUE           wait_queue;             /* ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ÂÔ€Á¥­¥å¡Œ */
        const MTXINIB *p_mtxinib;       /* œéŽü²œ¥Ö¥í¥Ã¥¯€Ø€Î¥Ý¥€¥ó¥¿ */
        TCB                     *p_loctsk;              /* ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯€·€Æ€€€ë¥¿¥¹¥¯ */
        QUEUE           mutex_queue;    /* ¥í¥Ã¥¯€·€Æ€€€ë¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€Î¥­¥å¡Œ */
} MTXCB;

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ÂÔ€ÁŸðÊó¥Ö¥í¥Ã¥¯€ÎÄêµÁ
 *
 *  €³€Î¹œÂ€Â΀ϡ€Æ±Žü¡ŠÄÌ¿®¥ª¥Ö¥ž¥§¥¯¥È€ÎÂÔ€ÁŸðÊó¥Ö¥í¥Ã¥¯€Î¶ŠÄÌÉôʬ
 *  ¡ÊWINFO_WOBJ¡Ë€ò³ÈÄ¥¡Ê¥ª¥Ö¥ž¥§¥¯¥È»ØžþžÀžì€Î·ÑŸµ€ËÁêÅö¡Ë€·€¿€â€Î€Ç¡€
 *  €¹€Ù€Æ€Î¥Õ¥£¡Œ¥ë¥É€¬¶ŠÄ̀ˀʀÀƀ€€ë¡¥
 */
typedef struct mutex_waiting_information {
        WINFO   winfo;                  /* Éžœà€ÎÂÔ€ÁŸðÊó¥Ö¥í¥Ã¥¯ */
        MTXCB   *p_mtxcb;               /* ÂԀÀƀ€€ë¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ÎŽÉÍý¥Ö¥í¥Ã¥¯ */
} WINFO_MTX;

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ID€ÎºÇÂçÃÍ¡Êkernel_cfg.c¡Ë
 */
extern const ID tmax_mtxid;

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹œéŽü²œ¥Ö¥í¥Ã¥¯€Î¥š¥ê¥¢¡Êkernel_cfg.c¡Ë
 */
extern const MTXINIB    mtxinib_table[];

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ŽÉÍý¥Ö¥í¥Ã¥¯€Î¥š¥ê¥¢¡Êkernel_cfg.c¡Ë
 */
extern MTXCB    mtxcb_table[];

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ŽÉÍý¥Ö¥í¥Ã¥¯€«€é¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹ID€òŒè€êœÐ€¹€¿€á€Î¥Þ¥¯¥í
 */
#define MTXID(p_mtxcb)  ((ID)(((p_mtxcb) - mtxcb_table) + TMIN_MTXID))

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹µ¡Çœ€ÎœéŽü²œ
 */
extern void     initialize_mutex(void);

/*
 *  ŸåžÂÍ¥ÀèÅÙ°ãÈ¿€Î¥Á¥§¥Ã¥¯
 *
 *  chg_pri€ÎÃæ€ÇŸåžÂÍ¥ÀèÅÙ°ãÈ¿€Î¥Á¥§¥Ã¥¯€ò¹Ô€Š€¿€á€ËÍÑ€€€ëŽØ¿ô€Ç€¢€ê¡€
 *  p_tcb€Ç»ØÄꀵ€ì€ë¥¿¥¹¥¯€¬¥í¥Ã¥¯€·€Æ€€€ëÍ¥ÀèÅÙŸåžÂ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€È¡€
 *  ¥í¥Ã¥¯€òÂԀÀƀ€€ëÍ¥ÀèÅÙŸåžÂ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ÎÃæ€Ç¡€ŸåžÂÍ¥ÀèÅÙ€¬
 *  bpriority€è€ê€âÄ　€â€Î€¬€¢€ì€Ðfalse€ò¡€€œ€Š€Ç€Ê€±€ì€Ðtrue€òÊÖ€¹¡¥
 */
extern bool_t   (*mtxhook_check_ceilpri)(TCB *p_tcb, uint_t bpriority);
extern bool_t   mutex_check_ceilpri(TCB *p_tcb, uint_t bpriority);

/* 
 *  Í¥ÀèÅÙŸåžÂ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯€·€Æ€€€ë€«€Î¥Á¥§¥Ã¥¯
 *
 *  p_tcb€Ç»ØÄꀵ€ì€ë¥¿¥¹¥¯€¬Í¥ÀèÅÙŸåžÂ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯€·€Æ€€€ì€Ð
 *  true¡€€œ€Š€Ç€Ê€±€ì€Ðfalse€òÊÖ€¹¡¥
 */
extern bool_t   (*mtxhook_scan_ceilmtx)(TCB *p_tcb);
extern bool_t   mutex_scan_ceilmtx(TCB *p_tcb);

/* 
 *  ¥¿¥¹¥¯€ÎžœºßÍ¥ÀèÅـη׻»
 *
 *  p_tcb€Ç»ØÄꀵ€ì€ë¥¿¥¹¥¯€ÎžœºßÍ¥ÀèÅÙ¡Ê€ËÀßÄꀹ€Ù€­ÃÍ¡Ë€ò·×»»€¹€ë¡¥
 */
extern uint_t   mutex_calc_priority(TCB *p_tcb);

/*
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€Î¥í¥Ã¥¯²òœü
 *
 *  p_mtxcb€Ç»ØÄꀵ€ì€ë¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯²òœü€¹€ë¡¥¥í¥Ã¥¯²òœü€·€¿
 *  ¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€Ë¡€¥í¥Ã¥¯ÂÔ€ÁŸõÂրΥ¿¥¹¥¯€¬€¢€ëŸì¹ç€Ë€Ï¡€€œ€Î¥¿¥¹¥¯
 *  €Ë¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯€µ€»€ë¡¥
 */
extern bool_t   mutex_release(MTXCB *p_mtxcb);

/*
 *  ¥¿¥¹¥¯€¬¥í¥Ã¥¯€·€Æ€€€ë€¹€Ù€Æ€Î¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€Î¥í¥Ã¥¯²òœü
 *
 *  p_tcb€Ç»ØÄꀵ€ì€ë¥¿¥¹¥¯€Ë¡€€œ€ì€¬¥í¥Ã¥¯€·€Æ€€€ë€¹€Ù€Æ€Î¥ß¥å¡Œ¥Æ¥Ã¥¯
 *  ¥¹€ò¥í¥Ã¥¯²òœü€µ€»€ë¡¥¥í¥Ã¥¯²òœü€·€¿¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€Ë¡€¥í¥Ã¥¯ÂÔ€ÁŸõ
 *  ÂրΥ¿¥¹¥¯€¬€¢€ëŸì¹ç€Ë€Ï¡€€œ€Î¥¿¥¹¥¯€Ë¥ß¥å¡Œ¥Æ¥Ã¥¯¥¹€ò¥í¥Ã¥¯€µ€»€ë¡¥
 *
 *  €³€ÎŽØ¿ô€Ï¡€¥¿¥¹¥¯€ÎœªÎ»»þ€Ë»È€ï€ì€ë€â€Î€Ç€¢€ë€¿€á¡€p_tcb€Ç»ØÄꀵ€ì
 *  €ë¥¿¥¹¥¯€ÎÍ¥ÀèÅÙ€òÊѹ¹€¹€ëœèÍý€Ï¹Ô€ï€Ê€€¡¥€¿€À€·¡€€³€ÎŽØ¿ô€ÎÃæ€ÇŸ
 *  €Î¥¿¥¹¥¯€ÎÍ¥ÀèÅÙ€¬ÊѲœ€·¡€ŒÂ¹Ô€¹€Ù€­¥¿¥¹¥¯€¬ÊÑ€ï€ë€³€È€¬€¢€ë¡¥€œ€Î
 *  €¿€á¡€€³€ÎŽØ¿ô€«€éÌá€Ã€¿žå€Ë¡€¥Ç¥£¥¹¥Ñ¥Ã¥Á€¬É¬Í×€«ÈœÊÌ€·€Æ¡€É¬Í×€Ê
 *  Ÿì¹ç€Ë€Ï¥Ç¥£¥¹¥Ñ¥Ã¥Á€ò¹Ô€ï€Ê€±€ì€Ð€Ê€é€Ê€€¡¥
 */
extern bool_t   (*mtxhook_release_all)(TCB *p_tcb);
extern bool_t   mutex_release_all(TCB *p_tcb);

#endif /* TOPPERS_MUTEX_H */