Concurrency::location Class Reference

An abstraction of a physical location on hardware. More...

#include <concrt.h>

Public Types
enum	_Type { _System, _NumaNode, _SchedulingNode, _ExecutionResource }
	Describes the type of the given location. More...

Public Member Functions
	location ()
	Constructs a location object. More...
	location (const location &_Src)
	Constructs a location object. More...
location &	operator= (const location &_Rhs)
	Assigns the contents of a different location object to this one. More...
	~location ()
	Destroys a location object. More...
bool	operator== (const location &_Rhs) const
	Determines whether two location objects represent the same location. More...
bool	operator!= (const location &_Rhs) const
	Determines whether two location objects represent different location. More...
	location (_Type _LocationType, unsigned int _Id, unsigned int _BindingId=0, _Inout_opt_ void *_PBinding=NULL)
	Constructs a specific location. More...
bool	_FastVPIntersects (const location &_Rhs) const
	Determines whether two locations have an intersection. This is a fast intersection which avoids certain checks by knowing that the this pointer is a virtual processor location for a validly bound virtual processor. More...
bool	_FastNodeIntersects (const location &_Rhs) const
	Determines whether two locations have an intersection. This is a fast intersection which avoids certain checks by knowing that the this pointer is a node for a validly bound node. More...
void	_Assign (const location &_Rhs)
	Assigns _Rhs to this location. More...
bool	_Is_system () const
	Internal routine that tells whether a location represents the "system location". This indicates no specific placement. More...
template<typename T >
T *	_As () const
	Returns the internal binding as a specified object. More...
unsigned int	_GetId () const
	Returns the ID which this location object represents. More...
_Type	_GetType () const
	Returns the type which this location object represents. More...
unsigned int	_GetBindingId () const
	Gets the binding ID for this location. More...

Static Public Member Functions
static _CRTIMP location __cdecl	current ()
	Returns a location object representing the most specific place the calling thread is executing. More...
static _CRTIMP location __cdecl	_Current_node ()
	Returns a location representing the scheduling node that the calling thread is executing. More...

Private Attributes
unsigned int	_M_type: 28
unsigned int	_M_reserved: 4
unsigned int	_M_bindingId
union {
unsigned int   _M_id
void *   _M_ptr
};
void *	_M_pBinding

Detailed Description

An abstraction of a physical location on hardware.

Member Enumeration Documentation

enum Concurrency::location::_Type

Describes the type of the given location.

Enumerator
_System	Indicates that the location represents the "system location". This has no specific affinity.
_NumaNode	Indicates that the location represents a particular NUMA node.
_SchedulingNode	Indicates that the location represents a particular scheduling node.
_ExecutionResource	Indicates that the location represents a paritcular execution resource.

    {
        _System, // _M_id is meaningless

        _NumaNode, // _M_id is the Windows NUMA node number

        _SchedulingNode, // _M_id is the unique identifier for the scheduling node

        _ExecutionResource, // _M_id is the unique identifier for the execution resource
    };

Constructor & Destructor Documentation

Concurrency::location::location ( )

inline

Constructs a location object.

A default constructed location represents the system as a whole.

               :
        _M_type(_System),
        _M_reserved(0),
        _M_pBinding(NULL),
        _M_ptr(NULL)
    {
    }

Concurrency::location::location ( const location &  _Src )

inline

Constructs a location object.

    {
        _Assign(_Src);
    }

Concurrency::location::~location ( )

inline

Destroys a location object.

    {
    }

Concurrency::location::location	(	_Type	_LocationType,
		unsigned int	_Id,
		unsigned int	_BindingId = 0,
		_Inout_opt_ void *	_PBinding = NULL
	)

Constructs a specific location.

Member Function Documentation

template<typename T >

T* Concurrency::location::_As ( ) const

inline

Returns the internal binding as a specified object.

    {
        return reinterpret_cast<T *>(_M_pBinding);
    }

void Concurrency::location::_Assign ( const location &  _Rhs )

inline

Assigns _Rhs to this location.

    {
        _M_type = _Rhs._M_type;
        _M_reserved = _Rhs._M_reserved;

        _M_ptr = _Rhs._M_ptr;

        _M_bindingId = _Rhs._M_bindingId;
        _M_pBinding = _Rhs._M_pBinding;
    }

static _CRTIMP location __cdecl Concurrency::location::_Current_node ( )

static

Returns a location representing the scheduling node that the calling thread is executing.

bool Concurrency::location::_FastNodeIntersects

(

const location &

_Rhs

)

const

Determines whether two locations have an intersection. This is a fast intersection which avoids certain checks by knowing that the this pointer is a node for a validly bound node.

Parameters

_Rhs	The location to intersect with this.

Returns

An indication as to whether the two locations intersect.

bool Concurrency::location::_FastVPIntersects

(

const location &

_Rhs

)

const

Determines whether two locations have an intersection. This is a fast intersection which avoids certain checks by knowing that the this pointer is a virtual processor location for a validly bound virtual processor.

Parameters

_Rhs	The location to intersect with this.

Returns

An indication as to whether the two locations intersect.

unsigned int Concurrency::location::_GetBindingId ( ) const

inline

Gets the binding ID for this location.

    {
        return _M_bindingId;
    }

unsigned int Concurrency::location::_GetId ( ) const

inline

Returns the ID which this location object represents.

    {
        return _M_id;
    }

_Type Concurrency::location::_GetType ( ) const

inline

Returns the type which this location object represents.

    {
        return (_Type)_M_type;
    }

bool Concurrency::location::_Is_system ( ) const

inline

Internal routine that tells whether a location represents the "system location". This indicates no specific placement.

    {
        return (_Type)_M_type == _System;
    }

static _CRTIMP location __cdecl Concurrency::location::current ( )

static

Returns a location object representing the most specific place the calling thread is executing.

Returns

A location representing the most specific place the calling thread is executing.

bool Concurrency::location::operator!= ( const location &  _Rhs ) const

inline

Determines whether two location objects represent different location.

Returns

true if the two locations are different, false otherwise.

    {
        return !operator==(_Rhs);
    }

location& Concurrency::location::operator= ( const location &  _Rhs )

inline

Assigns the contents of a different location object to this one.

Parameters

_Rhs	The source location object.

    {
        _Assign(_Rhs);
        return *this;
    }

bool Concurrency::location::operator== ( const location &  _Rhs ) const

inline

Determines whether two location objects represent the same location.

Returns

true if the two locations are identical, and false otherwise.

    {
        return (_M_type == _Rhs._M_type && _M_ptr == _Rhs._M_ptr);
    }

Member Data Documentation

union { ... }

unsigned int Concurrency::location::_M_bindingId

private

unsigned int Concurrency::location::_M_id

void* Concurrency::location::_M_pBinding

private

void* Concurrency::location::_M_ptr

unsigned int Concurrency::location::_M_reserved

private

unsigned int Concurrency::location::_M_type

private

---

The documentation for this class was generated from the following file:

• VS2013/inc/concrt.h