A class to assist in processing the core_work in the GSS(k) batch, ensuring that items within a batch in a thread are fully processed before any wait in that thread is performed, because we could deadlock. More...

#include <thread_client_context.hpp>

Public Types
typedef WQ	signalled_work_queue_type
	This is a container of GSSk items from the front of the queue to implement the GSS(k) or bakers' scheduling algorithm. More...

typedef Stats	statistics_type
	The statistics to be gathered by the thread_pool, by default none. More...

typedef signalled_work_queue_type::value_ret_type::value_type::no_ref_counting	no_ref_counting

typedef signalled_work_queue_type::value_ret_type::value_type::value_type::cfg_type	cfg_type

using	eval_shared_del_t = eval_shared_deleter_t< typename signalled_work_queue_type::value_ret_type::value_type >

Public Member Functions
	BOOST_STATIC_ASSERT (signalled_work_queue_type::max_size<=GSSk)

bool __fastcall	batch_empty () const noexcept(true) FORCE_INLINE

constexpr __stdcall	batch_details () noexcept(true) FORCE_INLINE

bool __fastcall	add_work_to_batch (typename signalled_work_queue_type::value_type &&wk) noexcept(true) FORCE_INLINE
	Put the closure_base-derived closure in the batch, if it is empty. More...

void __fastcall	refill_batch (signalled_work_queue_type &signalled_work_queue) noexcept(false) FORCE_INLINE

bool __fastcall	process_a_batch_item () noexcept(false) FORCE_INLINE

void __fastcall	process_a_batch (signalled_work_queue_type &signalled_work_queue) noexcept(false) FORCE_INLINE

statistics_type const &__fastcall	statistics () const noexcept(true) FORCE_INLINE

statistics_type &__fastcall	statistics () noexcept(true) FORCE_INLINE

Static Public Attributes
static constexpr unsigned long	GSSk =GSSkSz

static constexpr ppd::generic_traits::memory_access_modes	memory_access_mode =eval_shared_del_t::memory_access_mode

Protected Member Functions
void __fastcall	reload_batch_if_empty_nochk_nolk (signalled_work_queue_type &signalled_work_queue) noexcept(false) FORCE_INLINE

template<class UpdStats >
void FORCE_INLINE	process_the_work (UpdStats &&update_stats, typename cfg_type::edge_annotation_t const e_details) noexcept(false)

Protected Attributes
statistics_type	statistics_

signalled_work_queue_type::value_ret_type	batched_work

signalled_work_queue_type::value_ret_type::iterator	current_work_item

Detailed Description

template<unsigned long GSSkSz, class WQ, class Stats>
class jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >

A class to assist in processing the core_work in the GSS(k) batch, ensuring that items within a batch in a thread are fully processed before any wait in that thread is performed, because we could deadlock.

Note that this class is used for the implicit batch contained formed by the main thread in the program that creates the thread_pool.

See also: execution_context_type, thread_pool, pool_traits::work_distribution_mode_t::worker_threads_get_work<pool_traits::work_distribution_mode_t::queue_model_t::pool_owns_queue>, pool_thread, generic_traits::return_data::joinable

Definition at line 97 of file thread_client_context.hpp.

Member Typedef Documentation

◆ cfg_type

template<unsigned long GSSkSz, class WQ , class Stats >

typedef signalled_work_queue_type::value_ret_type::value_type::value_type::cfg_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::cfg_type

Definition at line 104 of file thread_client_context.hpp.

◆ eval_shared_del_t

template<unsigned long GSSkSz, class WQ , class Stats >

using jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::eval_shared_del_t = eval_shared_deleter_t<typename signalled_work_queue_type::value_ret_type::value_type>

Definition at line 105 of file thread_client_context.hpp.

◆ no_ref_counting

template<unsigned long GSSkSz, class WQ , class Stats >

typedef signalled_work_queue_type::value_ret_type::value_type::no_ref_counting jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::no_ref_counting

Definition at line 103 of file thread_client_context.hpp.

◆ signalled_work_queue_type

template<unsigned long GSSkSz, class WQ , class Stats >

typedef WQ jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::signalled_work_queue_type

This is a container of GSSk items from the front of the queue to implement the GSS(k) or bakers' scheduling algorithm.

Definition at line 100 of file thread_client_context.hpp.

◆ statistics_type

template<unsigned long GSSkSz, class WQ , class Stats >

typedef Stats jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_type

The statistics to be gathered by the thread_pool, by default none.

Definition at line 102 of file thread_client_context.hpp.

Constructor & Destructor Documentation

◆ batch_details()

template<unsigned long GSSkSz, class WQ , class Stats >

constexpr __stdcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_details ( )

inlineconstexprnoexcept

Definition at line 145 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work, jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_.

Member Function Documentation

◆ add_work_to_batch()

template<unsigned long GSSkSz, class WQ , class Stats >

bool __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::add_work_to_batch ( typename signalled_work_queue_type::value_type && wk )

inlinenoexcept

Put the closure_base-derived closure in the batch, if it is empty.

Note that this function runs with no locks, as it presumes that the caller is the same pool_thread that consumes the work from the batch.

Parameters

wk	The closure_base-derived closure to attempt to add.

Returns: true if the closure_base-derived closure was added, false otherwise.

Definition at line 158 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item.

◆ batch_empty()

template<unsigned long GSSkSz, class WQ , class Stats >

bool __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty ( ) const

inlinenoexcept

Returns: true if the batch is empty, false otherwise.

Definition at line 124 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::add_work_to_batch(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch_item(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::reload_batch_if_empty_nochk_nolk().

◆ BOOST_STATIC_ASSERT()

template<unsigned long GSSkSz, class WQ , class Stats >

jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::BOOST_STATIC_ASSERT ( signalled_work_queue_type::max_size<= GSSk )

Make sure that the batch_size's are the same, so that when a batch is popped off the signalled_work_queue, all of the elements are copied, with none being lost, which would cause closure_base-derived closure not to be processed.

See also: pool_aspect::GSSk

◆ process_a_batch()

template<unsigned long GSSkSz, class WQ , class Stats >

void __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch ( signalled_work_queue_type & signalled_work_queue )

inlinenoexcept

If the batch_size>1 and the first closure_base-derived closure depends upon a later job to complete, then that sub-tree of dependent closure_base-derived closures will deadlock. This is because this loop will wait for the first closure_base-derived closure to complete, which depends upon the second (or later in the batch) closure_base-derived closure which will not be executed as the earlier closure_base-derived closure is preventing this loop for continuing.

See also: process_a_batch_item

Definition at line 194 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::refill_batch(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_.

◆ process_a_batch_item()

template<unsigned long GSSkSz, class WQ , class Stats >

bool __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch_item ( )

inlinenoexcept

Definition at line 183 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work, jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_.

◆ process_the_work()

template<unsigned long GSSkSz, class WQ , class Stats >

template<class UpdStats >

void FORCE_INLINE jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_the_work	(	UpdStats &&	update_stats,
		typename cfg_type::edge_annotation_t const	e_details
	)

inlineprotectednoexcept

Definition at line 138 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item.

◆ refill_batch()

template<unsigned long GSSkSz, class WQ , class Stats >

void __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::refill_batch ( signalled_work_queue_type & signalled_work_queue )

inlinenoexcept

Definition at line 170 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::reload_batch_if_empty_nochk_nolk().

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch().

◆ reload_batch_if_empty_nochk_nolk()

template<unsigned long GSSkSz, class WQ , class Stats >

void __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::reload_batch_if_empty_nochk_nolk ( signalled_work_queue_type & signalled_work_queue )

inlineprotectednoexcept

Definition at line 129 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work, and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::refill_batch().

◆ statistics() [1/2]

template<unsigned long GSSkSz, class WQ , class Stats >

statistics_type const& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics ( ) const

inlinenoexcept

Definition at line 201 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_.

◆ statistics() [2/2]

template<unsigned long GSSkSz, class WQ , class Stats >

statistics_type& __fastcall jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics ( )

inlinenoexcept

Definition at line 204 of file thread_client_context.hpp.

References jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_.

Member Data Documentation

◆ batched_work

template<unsigned long GSSkSz, class WQ , class Stats >

signalled_work_queue_type::value_ret_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batched_work

protected

Definition at line 210 of file thread_client_context.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::add_work_to_batch(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_details(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch_item(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::reload_batch_if_empty_nochk_nolk().

◆ current_work_item

template<unsigned long GSSkSz, class WQ , class Stats >

signalled_work_queue_type::value_ret_type::iterator jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::current_work_item

protected

Definition at line 211 of file thread_client_context.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::add_work_to_batch(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_details(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_empty(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch_item(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_the_work(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::reload_batch_if_empty_nochk_nolk().

◆ GSSk

template<unsigned long GSSkSz, class WQ , class Stats >

constexpr unsigned long jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::GSSk =GSSkSz

staticconstexpr

Definition at line 107 of file thread_client_context.hpp.

◆ memory_access_mode

template<unsigned long GSSkSz, class WQ , class Stats >

constexpr ppd::generic_traits::memory_access_modes jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::memory_access_mode =eval_shared_del_t::memory_access_mode

staticconstexpr

To assist in allowing compile-time computation of the algorithmic order of the threading model.

Definition at line 112 of file thread_client_context.hpp.

◆ statistics_

template<unsigned long GSSkSz, class WQ , class Stats >

statistics_type jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics_

protected

Definition at line 209 of file thread_client_context.hpp.

Referenced by jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::batch_details(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch(), jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::process_a_batch_item(), and jmmcg::LIBJMMCG_VER_NAMESPACE::ppd::private_::batch_details< GSSkSz, WQ, Stats >::statistics().

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

core/private_/thread_client_context.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ cfg_type

◆ eval_shared_del_t

◆ no_ref_counting

◆ signalled_work_queue_type

◆ statistics_type

Constructor & Destructor Documentation

◆ batch_details()

Member Function Documentation

◆ add_work_to_batch()

◆ batch_empty()

◆ BOOST_STATIC_ASSERT()

◆ process_a_batch()

◆ process_a_batch_item()

◆ process_the_work()

◆ refill_batch()

◆ reload_batch_if_empty_nochk_nolk()

◆ statistics() [1/2]

◆ statistics() [2/2]

Member Data Documentation

◆ batched_work

◆ current_work_item

◆ GSSk

◆ memory_access_mode

◆ statistics_