debugsrv/runmodedebug/rmdriver/inc/d_debug_agent.inl
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
parent 42 0ff24a8f6ca2
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42
hgs
parents:
diff changeset
     1
// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
56
hgs
parents: 42
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
42
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Inline methods for debug agent class
hgs
parents:
diff changeset
    15
//
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef D_DEBUG_AGENT_INL
hgs
parents:
diff changeset
    19
#define D_DEBUG_AGENT_INL
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
/**
hgs
parents:
diff changeset
    23
 Checks whether the event queue is empty
hgs
parents:
diff changeset
    24
*/
hgs
parents:
diff changeset
    25
inline TBool DDebugAgent::BufferEmpty() const
hgs
parents:
diff changeset
    26
	{
hgs
parents:
diff changeset
    27
	return (NumberOfEmptySlots() == KNumberOfEventsToQueue);
hgs
parents:
diff changeset
    28
	}
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
 Checks whether the event queue is full
hgs
parents:
diff changeset
    32
*/
hgs
parents:
diff changeset
    33
inline TBool DDebugAgent::BufferFull() const
hgs
parents:
diff changeset
    34
	{
hgs
parents:
diff changeset
    35
	return (NumberOfEmptySlots() == 0);
hgs
parents:
diff changeset
    36
	}
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
/**
hgs
parents:
diff changeset
    39
 Checks whether there is room in the event queue to store an event
hgs
parents:
diff changeset
    40
*/
hgs
parents:
diff changeset
    41
inline TBool DDebugAgent::BufferCanStoreEvent() const
hgs
parents:
diff changeset
    42
	{
hgs
parents:
diff changeset
    43
	return (NumberOfEmptySlots() > 0);
hgs
parents:
diff changeset
    44
	}
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
/**
hgs
parents:
diff changeset
    47
 This looks to see if the buffer is close to being full and should only
hgs
parents:
diff changeset
    48
 accept higher priority debug events (user trace is the only low priority event) 
hgs
parents:
diff changeset
    49
*/
hgs
parents:
diff changeset
    50
inline TBool DDebugAgent::BufferAtCriticalLevel() const
hgs
parents:
diff changeset
    51
	{
hgs
parents:
diff changeset
    52
	return (NumberOfEmptySlots() < KNumberOfEventsToQueue - KCriticalBufferSize);
hgs
parents:
diff changeset
    53
	}
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
/**
hgs
parents:
diff changeset
    56
 Increments Head position, wrapping at KNumberOfEventsToQueue if necessary
hgs
parents:
diff changeset
    57
*/
hgs
parents:
diff changeset
    58
inline void DDebugAgent::IncrementHeadPosition(void)
hgs
parents:
diff changeset
    59
	{
hgs
parents:
diff changeset
    60
	iHead = (iHead + 1) % KNumberOfEventsToQueue;
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
	iFreeSlots--;
hgs
parents:
diff changeset
    63
	}
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
/**
hgs
parents:
diff changeset
    66
 Increments Tail position, wrapping at KNumberOfEventsToQueue if necessary
hgs
parents:
diff changeset
    67
*/
hgs
parents:
diff changeset
    68
inline void DDebugAgent::IncrementTailPosition(void)
hgs
parents:
diff changeset
    69
	{
hgs
parents:
diff changeset
    70
	iTail = (iTail + 1) % KNumberOfEventsToQueue;
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
	iFreeSlots++;
hgs
parents:
diff changeset
    73
}
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
/**
hgs
parents:
diff changeset
    76
 Returns the number of free slots in the event queue
hgs
parents:
diff changeset
    77
*/
hgs
parents:
diff changeset
    78
inline TInt DDebugAgent::NumberOfEmptySlots() const
hgs
parents:
diff changeset
    79
	{
hgs
parents:
diff changeset
    80
	return iFreeSlots;
hgs
parents:
diff changeset
    81
	}
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
/**
hgs
parents:
diff changeset
    84
 Lock access to this agent's event queue
hgs
parents:
diff changeset
    85
*/
hgs
parents:
diff changeset
    86
inline void DDebugAgent::LockEventQueue(void)
hgs
parents:
diff changeset
    87
	{
hgs
parents:
diff changeset
    88
	NKern::ThreadEnterCS(); // Waiting on a semaphore is broken but this makes things marginally better.
hgs
parents:
diff changeset
    89
	// Anyone changing this, bear in mind the CS is also needed for some of the DebugUtils::OpenThreadHandle calls
hgs
parents:
diff changeset
    90
	Kern::SemaphoreWait(*iEventQueueLock);
hgs
parents:
diff changeset
    91
	}
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
/**
hgs
parents:
diff changeset
    94
 Release the lock on this agent's event queue
hgs
parents:
diff changeset
    95
*/
hgs
parents:
diff changeset
    96
inline void DDebugAgent::UnlockEventQueue(void)
hgs
parents:
diff changeset
    97
	{
hgs
parents:
diff changeset
    98
	Kern::SemaphoreSignal(*iEventQueueLock);
hgs
parents:
diff changeset
    99
	NKern::ThreadLeaveCS();
hgs
parents:
diff changeset
   100
	}
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
#endif	// D_DEBUG_AGENT_INL