Home

Resume

Blog

Teikitu


/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
/*  »Project«   Teikitu Gaming System (TgS) (∂)
    »File«      TgS Common - Util MP - Spin Lock.h
    »Author«    Andrew Aye (EMail: mailto:andrew.aye@gmail.com, Web: http://www.andrewaye.com)
    »Version«   4.51 / »GUID« A9981407-3EC9-42AF-8B6F-8BE6DD919615                                                                                                        */
/*   -------------------------------------------------------------------------------------------------------------------------------------------------------------------- */
/*  Copyright: © 2002-2017, Andrew Aye.  All Rights Reserved.
    This software is free for non-commercial use.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
      following conditions are met:
        Redistribution of source code must retain this copyright notice, this list of conditions and the following disclaimers.
        Redistribution in binary form must reproduce this copyright notice, this list of conditions and the following disclaimers in the documentation and other materials
          provided with the distribution.
    The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
    The intellectual property rights of the algorithms used reside with Andrew Aye.
    You may not use this software, in whole or in part, in support of any commercial product without the express written consent of the author.
    There is no warranty or other guarantee of fitness of this software for any purpose. It is provided solely "as is".                                                   */
/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
#if !defined(TGS_COMMON_UTIL_MP_SN_H)
#define TGS_COMMON_UTIL_MP_SN_H
#pragma once


/* == Common ============================================================================================================================================================ */

/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Public Types                                                                                                                                                          */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

TgTYPE_UNION_ALIGN(STg2_UTM_SN,8,)
{
    struct
    {
        volatile TgATOMIC_SINT32                    niServed;
        volatile TgATOMIC_SINT32                    iRequest;
    }                                           m;
    volatile TgATOMIC_SINT64                    m_iData;
};
TgCOMPILER_ASSERT( 8 == sizeof( STg2_UTM_SN ), 0 );

TgTYPE_STRUCT_ALIGN(STg2_UTM_SN_ISO,TgCOMPILE_CACHE_LINE_SIZE,)
{
    STg2_UTM_SN                                 m_sLock;
#if TgCOMPILE_CACHE_LINE_SIZE > 8
    TgUINT08                                    m_uiPad[TgCOMPILE_CACHE_LINE_SIZE - 8];
#endif
};

TgTYPE_STRUCT_ALIGN(STg2_UTM_SNC,16,)
{
    STg2_UTM_SN                                 m_sData0;
    union
    {
        struct
        {
            volatile TgATOMIC_SINT32                    niAttempt;
        }                                           m;
        volatile TgATOMIC_SINT64                    m_iData;
    }                                           m_sData1;
};
TgCOMPILER_ASSERT( 16 == sizeof( STg2_UTM_SNC ), 0 );

TgTYPE_STRUCT_ALIGN(STg2_UTM_SNC_ISO,TgCOMPILE_CACHE_LINE_SIZE,)
{
    STg2_UTM_SNC                                m_sLock;
#if TgCOMPILE_CACHE_LINE_SIZE > 16
    TgUINT08                                    m_uiPad[TgCOMPILE_CACHE_LINE_SIZE - 16];
#endif
};


/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Public Functions                                                                                                                                                      */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

                                            /* Spin locks start in a signaled state and it is not a counting lock (i.e. you can not */
                                            /* pre-signal the lock to allow thread permission). */
TgINLINE TgRESULT                           tgCM_UTM_SN_Init( PCU_STg2_UTM_SN );
TgINLINE TgVOID                             tgCM_UTM_SN_Free( PCU_STg2_UTM_SN );

TgINLINE TgVOID                             tgCM_UTM_SN_Lock_Yield( PCU_STg2_UTM_SN );
TgINLINE TgVOID                             tgCM_UTM_SN_Lock_Spin( PCU_STg2_UTM_SN );
TgINLINE TgRESULT                           tgCM_UTM_SN_Lock_Test( PCU_STg2_UTM_SN );

TgINLINE TgVOID                             tgCM_UTM_SN_Signal( PCU_STg2_UTM_SN );



TgINLINE TgRESULT                           tgCM_UTM_SNC_Init( PCU_STg2_UTM_SNC );
TgINLINE TgVOID                             tgCM_UTM_SNC_Free( PCU_STg2_UTM_SNC );

TgINLINE TgVOID                             tgCM_UTM_SNC_Lock_Yield( PCU_STg2_UTM_SNC );
TgINLINE TgVOID                             tgCM_UTM_SNC_Lock_Spin( PCU_STg2_UTM_SNC );
TgINLINE TgRESULT                           tgCM_UTM_SNC_Lock_Test( PCU_STg2_UTM_SNC );

TgINLINE TgSINT32                           tgCM_UTM_SNC_Signal( PCU_STg2_UTM_SNC ); /* Signals the lock on a return of 0, otherwise retains the lock */

/* ====================================================================================================================================================================== */
#endif