game-networking-sockets-sys 0.2.0

//====== Copyright Valve Corporation, All rights reserved. ====================

#ifdef __GNUC__
	// src/public/tier0/basetypes.h:104:30: error: assuming signed overflow does not occur when assuming that (X + c) < X is always false [-Werror=strict-overflow]
	// current steamrt:scout gcc "g++ (SteamRT 4.8.4-1ubuntu15~12.04+steamrt1.2+srt1) 4.8.4" requires this at the top due to optimizations
	#pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

#include <tier1/utlpriorityqueue.h>

#include "steamnetworkingsockets_thinker.h"

#ifdef IS_STEAMDATAGRAMROUTER
	#include "router/sdr.h"
#else
	#include "clientlib/steamnetworkingsockets_lowlevel.h"
#endif

// memdbgon must be the last include file in a .cpp file!!!
#include "tier0/memdbgon.h"

namespace SteamNetworkingSocketsLib {

/////////////////////////////////////////////////////////////////////////////
//
// Periodic processing
//
/////////////////////////////////////////////////////////////////////////////

struct ThinkerLess
{
	bool operator()( const IThinker *a, const IThinker *b ) const
	{
		return a->GetNextThinkTime() > b->GetNextThinkTime();
	}
};
class ThinkerSetIndex
{
public:
	static void SetIndex( IThinker *p, int idx, void *pContext ) { p->m_queueIndex = idx; }
};

static CUtlPriorityQueue<IThinker*,ThinkerLess,ThinkerSetIndex> s_queueThinkers;

IThinker::IThinker()
: m_usecNextThinkTime( k_nThinkTime_Never )
, m_queueIndex( -1 )
{
}

IThinker::~IThinker()
{
	ClearNextThinkTime();
}

#ifdef __GNUC__
	// older steamrt:scout gcc requires this also, probably getting confused by unbalanced push/pop
	#pragma GCC diagnostic ignored "-Wstrict-overflow"
#endif

#ifdef IS_STEAMDATAGRAMROUTER
struct ShortDurationLock { inline void lock() {}; inline void unlock() {}; };
static ShortDurationLock s_mutexThinkerTable;
#else
static ShortDurationLock s_mutexThinkerTable( "thinker", ShortDurationLock::k_nOrder_Max ); // We do sometimes take another lock, but it is always a "try"
#endif

// Base class isn't lockable
bool IThinker::TryLock() const { return true; }

void IThinker::InternalEnsureMinThinkTime( SteamNetworkingMicroseconds usecTargetThinkTime )
{
	s_mutexThinkerTable.lock();
	if ( usecTargetThinkTime < m_usecNextThinkTime )
		InternalSetNextThinkTime( usecTargetThinkTime );
	s_mutexThinkerTable.unlock();
}

ATTR_NO_SANITIZE_THREAD void IThinker::SetNextThinkTime( SteamNetworkingMicroseconds usecTargetThinkTime )
{
	// Fast-path: check whether the schedule is already set to the requested time before acquiring
	// the thinker mutex.  This read of m_usecNextThinkTime is intentionally lockless -- the service
	// thread may write it concurrently.  The race is safe because:
	//   1. The read is a hint only.  A stale or torn value just causes a spurious fall-through to
	//      InternalSetNextThinkTime, which re-checks under the lock.  There is no state corruption.
	//   2. On all supported 64-bit platforms the aligned 64-bit load is atomic at the hardware level,
	//      so a torn read is not possible in practice.
	// We use ATTR_NO_SANITIZE_THREAD rather than making m_usecNextThinkTime std::atomic<> because
	// std::atomic would suppress TSan on every access to the variable, masking any future
	// unintentional races.  The attribute suppresses only this one known-safe lockless access.
	if ( usecTargetThinkTime == m_usecNextThinkTime )
		return;
	s_mutexThinkerTable.lock();
	InternalSetNextThinkTime( usecTargetThinkTime );
	s_mutexThinkerTable.unlock();
}

ATTR_NO_SANITIZE_THREAD void IThinker::EnsureMinThinkTime( SteamNetworkingMicroseconds usecTargetThinkTime )
{
	// Lockless fast-path read -- see SetNextThinkTime for explanation of the intentional race.
	if ( usecTargetThinkTime < m_usecNextThinkTime )
		InternalEnsureMinThinkTime( usecTargetThinkTime );
}

void IThinker::InternalSetNextThinkTime( SteamNetworkingMicroseconds usecTargetThinkTime )
{


	// Protect against us blowing up because of an invalid think time.
	// Zero is reserved (since it often means there is an uninitialized value),
	// and our initial time value is effectively infinite compared to the
	// intervals we deal with in this code, so we should never need to deal
	// with a timestamp that far in the past.  See k_nThinkTime_ASAP
	if ( unlikely( usecTargetThinkTime <= 0 ) )
	{
		AssertMsg1( false, "Attempt to set target think time to %lld", (long long)usecTargetThinkTime );
		usecTargetThinkTime = SteamNetworkingSockets_GetLocalTimestamp() + 2000;
	}

	// Clearing it?
	if ( usecTargetThinkTime == k_nThinkTime_Never )
	{
		if ( m_queueIndex >= 0 )
		{
			Assert( s_queueThinkers.Element( m_queueIndex ) == this );
			s_queueThinkers.RemoveAt( m_queueIndex );
			Assert( m_queueIndex == -1 );
		}

		m_usecNextThinkTime = k_nThinkTime_Never;
		return;
	}

	// Save current time when the next thinker wants service
	#ifndef IS_STEAMDATAGRAMROUTER
		SteamNetworkingMicroseconds usecNextWake = ( s_queueThinkers.Count() > 0 ) ? s_queueThinkers.ElementAtHead()->GetNextThinkTime() : k_nThinkTime_Never;
	#endif

	// Not currently scheduled?
	if ( m_queueIndex < 0 )
	{
		Assert( m_usecNextThinkTime == k_nThinkTime_Never );
		m_usecNextThinkTime = usecTargetThinkTime;
		s_queueThinkers.Insert( this );
	}
	else
	{

		// We're already scheduled.
		Assert( s_queueThinkers.Element( m_queueIndex ) == this );
		Assert( m_usecNextThinkTime != k_nThinkTime_Never );

		// Set the new schedule time
		m_usecNextThinkTime = usecTargetThinkTime;

		// And update our position in the queue
		s_queueThinkers.RevaluateElement( m_queueIndex );
	}

	// Check that we know our place
	Assert( m_queueIndex >= 0 );
	Assert( s_queueThinkers.Element( m_queueIndex ) == this );

	#ifndef IS_STEAMDATAGRAMROUTER
		// Do we need service before we were previously schedule to wake up?
		// If so, wake the thread now so that it can redo its schedule work
		// NOTE: On Windows we could use a waitable timer.  This would avoid
		// waking up the service thread just to re-schedule when it should
		// wake up for real.
		if ( m_usecNextThinkTime < usecNextWake )
			WakeServiceThread();
	#endif
}

SteamNetworkingMicroseconds IThinker::Thinker_GetNextScheduledThinkTime()
{
	SteamNetworkingMicroseconds usecResult = k_nThinkTime_Never;
	s_mutexThinkerTable.lock();
	if ( s_queueThinkers.Count() )
		usecResult = s_queueThinkers.ElementAtHead()->GetNextThinkTime();
	s_mutexThinkerTable.unlock();
	return usecResult;
}

void IThinker::Thinker_ProcessThinkers()
{
	// We need the lock to access the thinker queue
	s_mutexThinkerTable.lock();

	// Until the queue is empty
	int nIterations = 0;
	while ( s_queueThinkers.Count() > 0 )
	{

		// Grab the head element
		IThinker *pNextThinker = s_queueThinkers.ElementAtHead();

		// Refetch timestamp each time.  The reason is that certain thinkers
		// may pass through to other systems (e.g. fake lag) that fetch the time.
		// If we don't update the time here, that code may have used the newer
		// timestamp (e.g. to mark when a packet was received) and then
		// in our next iteration, we will use an older timestamp to process
		// a thinker.
		SteamNetworkingMicroseconds usecNow = SteamNetworkingSockets_GetLocalTimestamp();

		// Scheduled too far in the future?
		if ( pNextThinker->GetNextThinkTime() >= usecNow )
		{
			// Keep waiting
			break;
		}

		++nIterations;
		if ( nIterations > 10000 )
		{
			AssertMsg1( false, "Processed thinkers %d times -- probably one thinker keeps requesting an immediate wakeup call.", nIterations );
			break;
		}

		// Try to acquire the thinker's lock, if any
		if ( pNextThinker->TryLock() )
		{

			// Go ahead and clear his think time now and remove him
			// from the heap.  He needs to schedule a new think time
			// if heeds service again.  For thinkers that need frequent
			// service, removing them and then re-inserting them when
			// they reschedule is a bit of extra work that could be
			// optimized by trying to not remove them now, but adjusting
			// them once we know when they want to think.  But this
			// is probably just a bit too complicated for the expected
			// benefit.  If the number of total Thinkers is relatively
			// small (which it probably will be), the heap operations
			// are probably negligible.
			pNextThinker->InternalSetNextThinkTime( k_nThinkTime_Never );

			// Release the global thinker table lock, so that other threads
			// can schedule work while we are doing work here.
			// (E.g. other connections can be accessed in the main thread,
			// and can mark the connection to wake up.)
			s_mutexThinkerTable.unlock();

			// Execute callback.  (Note: this could result
			// in self-destruction or essentially any change
			// to the rest of the queue.)
			pNextThinker->Think( usecNow );

			// Re-acquire table lock for the next check
			s_mutexThinkerTable.lock();
		}
		else
		{
			// Deadlock!  Should be extremely rare.  Reschedule him for 1ms in the
			// future, and we'll try again.
			pNextThinker->InternalSetNextThinkTime( usecNow + 1000 );
		}
	}

	// Release table lock
	s_mutexThinkerTable.unlock();
}

#ifdef DBGFLAG_VALIDATE
void Thinker_ValidateStatics( CValidator &validator )
{
	ValidateRecursive( s_queueThinkers );
}

void IThinker::Validate( CValidator &validator, const char *pchName )
{
}

#endif

} // namespace SteamNetworkingSocketsLib