The Flags API.

These methods relate to the Flags interface. More...

	Flags< T >::Flags (Type flags=0)
	Initialize flags with a given value. More...
	Flags< T >::operator const Type () const
const Flags< T > &	Flags< T >::operator= (T flags)
bool	Flags< T >::isSet (Type mask) const
	Verifies whether any bit matching the given mask is set. More...
bool	Flags< T >::allSet (Type mask) const
	Verifies whether no bits matching the given mask are set. More...
bool	Flags< T >::noneSet (Type mask) const
	Verifies whether no bits matching the given mask are set. More...
void	Flags< T >::clear ()
	Clear all flag's bits. More...
void	Flags< T >::clear (Type mask)
	Clear all flag's bits matching the given mask. More...
void	Flags< T >::set (Type mask)
	Set all flag's bits matching the given mask. More...
void	Flags< T >::set (Type mask, bool condition)
	Conditionally set or clear some bits of the flag, given a mask. More...
void	Flags< T >::replace (Type flags, Type mask)
	Replace the contents of the bits matching the mask with the corresponding bits in the provided flags. More...

Detailed Description

These methods relate to the Flags interface.

Function Documentation

allSet()

template<typename T >

bool Flags< T >::allSet ( Type  mask ) const

inline

Verifies whether no bits matching the given mask are set.

Parameters

mask	The mask containing the bits to verify.

Returns

True if matching bits are set; false otherwise.

Definition at line 88 of file flags.hh.

Referenced by TEST().

clear() [1/2]

template<typename T >

void Flags< T >::clear ( )

inline

Clear all flag's bits.

Definition at line 99 of file flags.hh.

Referenced by Packet::clearBlockCached(), Event::clearFlags(), Packet::clearWriteThrough(), Packet::deleteData(), Packet::makeHtmTransactionalReqResponse(), Packet::makeResponse(), Packet::Packet(), LSQ< Impl >::LSQRequest::packetNotSent(), EventQueue::serviceOne(), Flags< FlagsType >< FlagsType >::set(), Request::setVirt(), TEST(), and Event::unserialize().

clear() [2/2]

template<typename T >

void Flags< T >::clear ( Type  mask )

inline

Clear all flag's bits matching the given mask.

Parameters

mask	The mask containing the bits to be cleared.

Definition at line 106 of file flags.hh.

Flags()

template<typename T >

Flags< T >::Flags ( Type  flags = 0 )

inline

Initialize flags with a given value.

If no value is provided, the flag bits are initialized cleared.

Parameters

flags

The value to initialize the flags with.

Definition at line 63 of file flags.hh.

isSet()

template<typename T >

bool Flags< T >::isSet ( Type  mask ) const

inline

Verifies whether any bit matching the given mask is set.

Parameters

mask	The mask containing the bits to verify.

Returns

True if any matching bit is set; false otherwise.

Definition at line 80 of file flags.hh.

Referenced by Event::acquire(), Packet::cacheResponding(), Packet::deleteData(), Request::extraDataValid(), Packet::getAddr(), Packet::getConstPtr(), Packet::getHtmTransactionUid(), Packet::getPtr(), Packet::getRaw(), Packet::getSize(), Request::getVaddr(), Request::hasContextId(), Request::hasHtmAbortCause(), Request::hasInstCount(), Request::hasInstSeqNum(), Request::hasPaddr(), Request::hasPC(), Packet::hasSharers(), Request::hasSize(), Request::hasStreamId(), Request::hasSubstreamId(), Request::hasVaddr(), Packet::htmTransactionFailedInCache(), Request::isAcquire(), LSQ< Impl >::LSQRequest::isAnyOutstandingRequest(), LSQ< Impl >::LSQRequest::isAtomic(), Request::isAtomic(), Request::isAtomicNoReturn(), Request::isAtomicReturn(), Packet::isBlockCached(), Request::isCacheClean(), Request::isCacheInvalidate(), Request::isCacheMaintenance(), LSQ< Impl >::LSQRequest::isComplete(), Request::isCondSwap(), LSQ< Impl >::LSQRequest::isDelayed(), Event::isExitEvent(), Packet::isExpressSnoop(), Event::isFlagSet(), Request::isGL2CacheFlush(), Request::isHTMAbort(), Request::isHTMCancel(), Request::isHTMCommit(), Request::isHTMStart(), Packet::isHtmTransactional(), Request::isInstFetch(), Request::isInvL1(), Request::isKernel(), Request::isLLSC(), LSQ< Impl >::LSQRequest::isLoad(), Request::isLockedRMW(), Event::isManaged(), Request::isPrefetch(), Request::isPrefetchEx(), Request::isPriv(), Request::isPTWalk(), Request::isRelease(), LSQ< Impl >::LSQRequest::isReleased(), Packet::isSecure(), Request::isSecure(), LSQ< Impl >::LSQRequest::isSent(), LSQ< Impl >::LSQRequest::isSplit(), TraceCPU::ElasticDataGen::GraphNode::isStrictlyOrdered(), Request::isStrictlyOrdered(), Request::isSwap(), Request::isToPOC(), Request::isToPOU(), LSQ< Impl >::LSQRequest::isTranslationBlocked(), LSQ< Impl >::LSQRequest::isTranslationComplete(), Request::isUncacheable(), Stats::Text::noOutput(), Stats::ScalarPrint::operator()(), Stats::VectorPrint::operator()(), Stats::DistPrint::operator()(), Packet::Packet(), Event::release(), Packet::responderHadWritable(), Packet::satisfied(), Event::scheduled(), Packet::setAddr(), Packet::setCacheResponding(), Packet::setData(), Packet::setRaw(), Packet::setSatisfied(), Packet::setSize(), Event::squashed(), Packet::suppressFuncError(), TEST(), Event::unserialize(), Stats::Text::visit(), LSQ< Impl >::LSQRequest::writebackScheduled(), and Packet::writeThrough().

noneSet()

template<typename T >

bool Flags< T >::noneSet ( Type  mask ) const

inline

Verifies whether no bits matching the given mask are set.

Parameters

mask	The mask containing the bits to verify.

Returns

True if matching bits are cleared; false otherwise.

Definition at line 96 of file flags.hh.

Referenced by Packet::allocate(), Event::clearFlags(), Packet::dataDynamic(), Packet::dataStatic(), Packet::dataStaticConst(), Event::isFlagSet(), Event::setFlags(), and TEST().

operator const Type()

template<typename T >

Flags< T >::operator const Type ( ) const

inline

Definition at line 65 of file flags.hh.

operator=()

template<typename T >

const Flags<T>& Flags< T >::operator= ( T  flags )

inline

Definition at line 68 of file flags.hh.

replace()

template<typename T >

void Flags< T >::replace ( Type  flags, Type  mask  )

inline

Replace the contents of the bits matching the mask with the corresponding bits in the provided flags.

This is equivalent to: flags.clear(mask); flags.set(flags & mask);

Parameters

flags	Flags to extract new bits from.
mask	Mask used to determine which bits are replaced.

Definition at line 138 of file flags.hh.

Referenced by TEST().

set() [1/2]

template<typename T >

void Flags< T >::set ( Type  mask )

inline

Set all flag's bits matching the given mask.

Parameters

mask	The mask containing the bits to be set.

Definition at line 113 of file flags.hh.

Referenced by Packet::allocate(), LSQ< Impl >::LSQRequest::complete(), Packet::copyResponderFlags(), Packet::dataDynamic(), Packet::dataStatic(), Packet::dataStaticConst(), ArmISA::TableWalker::doL1Descriptor(), ArmISA::TableWalker::doLongDescriptor(), LSQ< Impl >::SingleDataRequest::finish(), GarnetSyntheticTraffic::generatePkt(), Check::initiateCheck(), Check::initiatePrefetch(), LSQ< Impl >::LSQRequest::LSQRequest(), LSQ< Impl >::LSQRequest::markDelayed(), Packet::Packet(), LSQ< Impl >::LSQRequest::packetNotSent(), LSQ< Impl >::LSQRequest::packetSent(), ArmISA::TableWalker::processWalk(), ArmISA::TableWalker::processWalkLPAE(), LSQ< Impl >::LSQRequest::release(), Request::Request(), Flags< FlagsType >< FlagsType >::set(), Packet::setBlockCached(), Request::setCacheCoherenceFlags(), Packet::setCacheResponding(), Request::setContext(), Packet::setExpressSnoop(), Request::setExtraData(), Event::setFlags(), Request::setFlags(), Packet::setHasSharers(), Request::setHtmAbortCause(), Packet::setHtmTransactional(), Packet::setHtmTransactionFailedInCache(), Stats::InfoAccess::setInit(), Request::setInstCount(), Request::setPaddr(), Request::setPC(), Request::setReqInstSeqNum(), Packet::setResponderHadWritable(), Packet::setSatisfied(), Packet::setSize(), Request::setStreamId(), Request::setSubstreamId(), Packet::setSuppressFuncError(), X86ISA::Walker::WalkerState::setupWalk(), Request::setVirt(), Packet::setWriteThrough(), LSQ< Impl >::SplitDataRequest::SplitDataRequest(), Event::squash(), LSQ< Impl >::LSQRequest::squashTranslation(), X86ISA::Walker::WalkerState::stepWalk(), TEST(), MemTest::tick(), Event::unserialize(), LSQ< Impl >::LSQRequest::writebackDone(), and LSQ< Impl >::LSQRequest::writebackScheduled().

set() [2/2]

template<typename T >

void Flags< T >::set ( Type  mask, bool  condition  )

inline

Conditionally set or clear some bits of the flag, given a mask.

Parameters

mask	The mask containing the bits to be modified.
condition	If true, set masked bits; otherwise, clear them.

Definition at line 122 of file flags.hh.