tbb::internal::input_buffer Class Reference

A buffer of input items for a filter. More...

Inheritance diagram for tbb::internal::input_buffer:

Collaboration diagram for tbb::internal::input_buffer:

Public Member Functions
	input_buffer (bool is_ordered_, bool is_bound_)
	Construct empty buffer. More...
	~input_buffer ()
	Destroy the buffer. More...
bool	put_token (task_info &info_, bool force_put=false)
	Put a token into the buffer. More...
template<typename StageTask >
void	note_done (Token token, StageTask &spawner)
	Note that processing of a token is finished. More...
bool	return_item (task_info &info, bool advance)
	return an item, invalidate the queued item, but only advance if the filter More...
bool	has_item ()
	true if the current low_token is valid. More...
void	create_my_tls ()
void	destroy_my_tls ()
bool	my_tls_end_of_input ()
void	set_my_tls_end_of_input ()

Private Types
typedef Token	size_type
typedef basic_tls< intptr_t >	end_of_input_tls_t
	for parallel filters that accepts NULLs, thread-local flag for reaching end_of_input More...

Private Member Functions
void	grow (size_type minimum_size)
	Resize "array". More...
void	create_sema (size_t initial_tokens)
void	free_sema ()
void	sema_P ()
void	sema_V ()
Private Member Functions inherited from tbb::internal::no_copy
	no_copy (const no_copy &)=delete
	no_copy ()=default

Private Attributes
task_info *	array
	Array of deferred tasks that cannot yet start executing. More...
semaphore *	my_sem
	for thread-bound filter, semaphore for waiting, NULL otherwise. More...
size_type	array_size
	Size of array. More...
Token	low_token
	Lowest token that can start executing. More...
spin_mutex	array_mutex
	Serializes updates. More...
Token	high_token
	Used for out of order buffer, and for assigning my_token if is_ordered and my_token not already assigned. More...
bool	is_ordered
	True for ordered filter, false otherwise. More...
bool	is_bound
	True for thread-bound filter, false otherwise. More...
end_of_input_tls_t	end_of_input_tls
bool	end_of_input_tls_allocated

Static Private Attributes
static const size_type	initial_buffer_size = 4
	Initial size for "array". More...

Friends
class	tbb::internal::pipeline_root_task
class	tbb::filter
class	tbb::thread_bound_filter
class	tbb::internal::stage_task
class	tbb::pipeline

Detailed Description

A buffer of input items for a filter.

Each item is a task_info, inserted into a position in the buffer corresponding to a Token.

Definition at line 48 of file pipeline.cpp.

Member Typedef Documentation

end_of_input_tls_t

typedef basic_tls<intptr_t> tbb::internal::input_buffer::end_of_input_tls_t

private

for parallel filters that accepts NULLs, thread-local flag for reaching end_of_input

Definition at line 92 of file pipeline.cpp.

size_type

typedef Token tbb::internal::input_buffer::size_type

private

Definition at line 55 of file pipeline.cpp.

Constructor & Destructor Documentation

input_buffer()

tbb::internal::input_buffer::input_buffer ( bool  is_ordered_, bool  is_bound_  )

inline

Construct empty buffer.

Definition at line 103 of file pipeline.cpp.

                                                     :
            array(NULL), my_sem(NULL), array_size(0),
            low_token(0), high_token(0),
            is_ordered(is_ordered_), is_bound(is_bound_),
            end_of_input_tls_allocated(false) {
        grow(initial_buffer_size);
        __TBB_ASSERT( array, NULL );
        if(is_bound) create_sema(0);
    }

References __TBB_ASSERT, array, create_sema(), grow(), initial_buffer_size, and is_bound.

Here is the call graph for this function:

~input_buffer()

tbb::internal::input_buffer::~input_buffer ( )

inline

Destroy the buffer.

Definition at line 114 of file pipeline.cpp.

                    {
        __TBB_ASSERT( array, NULL );
        cache_aligned_allocator<task_info>().deallocate(array,array_size);
        poison_pointer( array );
        if(my_sem) {
            free_sema();
        }
        if(end_of_input_tls_allocated) {
            destroy_my_tls();
        }
    }

References __TBB_ASSERT, array, array_size, tbb::cache_aligned_allocator< T >::deallocate(), destroy_my_tls(), end_of_input_tls_allocated, free_sema(), my_sem, and tbb::internal::poison_pointer().

Here is the call graph for this function:

Member Function Documentation

create_my_tls()

void tbb::internal::input_buffer::create_my_tls ( )

inline

Definition at line 225 of file pipeline.cpp.

{ int status = end_of_input_tls.create(); if(status) handle_perror(status, "TLS not allocated for filter"); end_of_input_tls_allocated = true; }

References tbb::internal::basic_tls< T >::create(), end_of_input_tls, end_of_input_tls_allocated, and tbb::internal::handle_perror().

Here is the call graph for this function:

create_sema()

void tbb::internal::input_buffer::create_sema ( size_t  initial_tokens )

inlineprivate

Definition at line 96 of file pipeline.cpp.

{ __TBB_ASSERT(!my_sem,NULL); my_sem = new internal::semaphore(initial_tokens); }

References __TBB_ASSERT, and my_sem.

Referenced by input_buffer().

Here is the caller graph for this function:

destroy_my_tls()

void tbb::internal::input_buffer::destroy_my_tls ( )

inline

Definition at line 226 of file pipeline.cpp.

{ int status = end_of_input_tls.destroy(); if(status) handle_perror(status, "Failed to destroy filter TLS"); }

References tbb::internal::basic_tls< T >::destroy(), end_of_input_tls, and tbb::internal::handle_perror().

Referenced by ~input_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

free_sema()

void tbb::internal::input_buffer::free_sema ( )

inlineprivate

Definition at line 97 of file pipeline.cpp.

{ __TBB_ASSERT(my_sem,NULL); delete my_sem; }

References __TBB_ASSERT, and my_sem.

Referenced by ~input_buffer().

Here is the caller graph for this function:

grow()

void tbb::internal::input_buffer::grow ( size_type  minimum_size )

private

Resize "array".

Caller is responsible to acquiring a lock on "array_mutex".

Definition at line 231 of file pipeline.cpp.

                                                {
    size_type old_size = array_size;
    size_type new_size = old_size ? 2*old_size : initial_buffer_size;
    while( new_size<minimum_size )
        new_size*=2;
    task_info* new_array = cache_aligned_allocator<task_info>().allocate(new_size);
    task_info* old_array = array;
    for( size_type i=0; i<new_size; ++i )
        new_array[i].is_valid = false;
    long t=low_token;
    for( size_type i=0; i<old_size; ++i, ++t )
        new_array[t&(new_size-1)] = old_array[t&(old_size-1)];
    array = new_array;
    array_size = new_size;
    if( old_array )
        cache_aligned_allocator<task_info>().deallocate(old_array,old_size);
}

References tbb::cache_aligned_allocator< T >::allocate(), array, array_size, tbb::cache_aligned_allocator< T >::deallocate(), initial_buffer_size, low_token, and new_size.

Referenced by input_buffer(), and put_token().

Here is the call graph for this function:

Here is the caller graph for this function:

has_item()

bool tbb::internal::input_buffer::has_item ( )

inline

true if the current low_token is valid.

Definition at line 222 of file pipeline.cpp.

{ spin_mutex::scoped_lock lock(array_mutex); return array[low_token&(array_size -1)].is_valid; }

References array, array_mutex, array_size, lock, and low_token.

my_tls_end_of_input()

bool tbb::internal::input_buffer::my_tls_end_of_input ( )

inline

Definition at line 227 of file pipeline.cpp.

{ return end_of_input_tls.get() != 0; }

References end_of_input_tls, and tbb::internal::basic_tls< T >::get().

Referenced by tbb::internal::stage_task::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

note_done()

template<typename StageTask >

void tbb::internal::input_buffer::note_done ( Token  token, StageTask &  spawner  )

inline

Note that processing of a token is finished.

Fires up processing of the next token, if processing was deferred.

Definition at line 174 of file pipeline.cpp.

                                                      {
        task_info wakee;
        wakee.reset();
        {
            spin_mutex::scoped_lock lock( array_mutex );
            if( !is_ordered || token==low_token ) {
                // Wake the next task
                task_info& item = array[++low_token & (array_size-1)];
                ITT_NOTIFY( sync_acquired, this );
                wakee = item;
                item.is_valid = false;
            }
        }
        if( wakee.is_valid )
            spawner.spawn_stage_task(wakee);
    }

References array, array_mutex, array_size, is_ordered, tbb::internal::task_info::is_valid, ITT_NOTIFY, lock, low_token, and tbb::internal::task_info::reset().

Referenced by tbb::internal::stage_task::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

put_token()

bool tbb::internal::input_buffer::put_token ( task_info &  info_, bool  force_put = false  )

inline

Put a token into the buffer.

If task information was placed into buffer, returns true; otherwise returns false, informing the caller to create and spawn a task. If input buffer owned by thread-bound filter and the item at low_token was not valid, issue a V() If the input_buffer is owned by a successor to a thread-bound filter, the force_put parameter should be true to ensure the token is inserted in the buffer.

Definition at line 135 of file pipeline.cpp.

                                                               {
        {
            info_.is_valid = true;
            spin_mutex::scoped_lock lock( array_mutex );
            Token token;
            bool was_empty = !array[low_token&(array_size-1)].is_valid;
            if( is_ordered ) {
                if( !info_.my_token_ready ) {
                    info_.my_token = high_token++;
                    info_.my_token_ready = true;
                }
                token = info_.my_token;
            } else
                token = high_token++;
            __TBB_ASSERT( (tokendiff_t)(token-low_token)>=0, NULL );
            if( token!=low_token || is_bound || force_put ) {
                // Trying to put token that is beyond low_token.
                // Need to wait until low_token catches up before dispatching.
                if( token-low_token>=array_size )
                    grow( token-low_token+1 );
                ITT_NOTIFY( sync_releasing, this );
                array[token&(array_size-1)] = info_;
                if(was_empty && is_bound) {
                    sema_V();
                }
                return true;
            }
        }
        return false;
    }

References __TBB_ASSERT, array, array_mutex, array_size, grow(), high_token, is_bound, is_ordered, tbb::internal::task_info::is_valid, ITT_NOTIFY, lock, low_token, tbb::internal::task_info::my_token, tbb::internal::task_info::my_token_ready, sema_V(), and sync_releasing.

Referenced by tbb::internal::stage_task::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

return_item()

bool tbb::internal::input_buffer::return_item ( task_info &  info, bool  advance  )

inline

return an item, invalidate the queued item, but only advance if the filter

Definition at line 208 of file pipeline.cpp.

                                                    {
        spin_mutex::scoped_lock lock( array_mutex );
        task_info& item = array[low_token&(array_size-1)];
        ITT_NOTIFY( sync_acquired, this );
        if( item.is_valid ) {
            info = item;
            item.is_valid = false;
            if (advance) low_token++;
            return true;
        }
        return false;
    }

References array, array_mutex, array_size, tbb::internal::task_info::is_valid, ITT_NOTIFY, lock, and low_token.

Referenced by tbb::internal::stage_task::execute(), and tbb::internal::pipeline_root_task::execute().

Here is the caller graph for this function:

sema_P()

void tbb::internal::input_buffer::sema_P ( )

inlineprivate

Definition at line 98 of file pipeline.cpp.

{ __TBB_ASSERT(my_sem,NULL); my_sem->P(); }

References __TBB_ASSERT, my_sem, and tbb::internal::semaphore::P().

Here is the call graph for this function:

sema_V()

void tbb::internal::input_buffer::sema_V ( )

inlineprivate

Definition at line 99 of file pipeline.cpp.

{ __TBB_ASSERT(my_sem,NULL); my_sem->V(); }

References __TBB_ASSERT, my_sem, and tbb::internal::semaphore::V().

Referenced by put_token().

Here is the call graph for this function:

Here is the caller graph for this function:

set_my_tls_end_of_input()

void tbb::internal::input_buffer::set_my_tls_end_of_input ( )

inline

Definition at line 228 of file pipeline.cpp.

{ end_of_input_tls.set(1); }

References end_of_input_tls, and tbb::internal::basic_tls< T >::set().

Here is the call graph for this function:

Friends And Related Function Documentation

tbb::filter

friend class tbb::filter

friend

Definition at line 50 of file pipeline.cpp.

tbb::internal::pipeline_root_task

friend class tbb::internal::pipeline_root_task

friend

Definition at line 49 of file pipeline.cpp.

tbb::internal::stage_task

friend class tbb::internal::stage_task

friend

Definition at line 52 of file pipeline.cpp.

tbb::pipeline

friend class tbb::pipeline

friend

Definition at line 53 of file pipeline.cpp.

tbb::thread_bound_filter

friend class tbb::thread_bound_filter

friend

Definition at line 51 of file pipeline.cpp.

Member Data Documentation

array

task_info* tbb::internal::input_buffer::array

private

Array of deferred tasks that cannot yet start executing.

Definition at line 58 of file pipeline.cpp.

Referenced by grow(), has_item(), input_buffer(), note_done(), put_token(), return_item(), and ~input_buffer().

array_mutex

spin_mutex tbb::internal::input_buffer::array_mutex

private

Serializes updates.

Definition at line 72 of file pipeline.cpp.

Referenced by has_item(), note_done(), put_token(), and return_item().

array_size

size_type tbb::internal::input_buffer::array_size

private

Size of array.

Always 0 or a power of 2

Definition at line 65 of file pipeline.cpp.

Referenced by grow(), has_item(), note_done(), put_token(), return_item(), and ~input_buffer().

end_of_input_tls

end_of_input_tls_t tbb::internal::input_buffer::end_of_input_tls

private

Definition at line 93 of file pipeline.cpp.

Referenced by create_my_tls(), destroy_my_tls(), my_tls_end_of_input(), and set_my_tls_end_of_input().

end_of_input_tls_allocated

bool tbb::internal::input_buffer::end_of_input_tls_allocated

private

Definition at line 94 of file pipeline.cpp.

Referenced by create_my_tls(), and ~input_buffer().

high_token

Token tbb::internal::input_buffer::high_token

private

Used for out of order buffer, and for assigning my_token if is_ordered and my_token not already assigned.

Definition at line 83 of file pipeline.cpp.

Referenced by put_token().

initial_buffer_size

const size_type tbb::internal::input_buffer::initial_buffer_size = 4

staticprivate

Initial size for "array".

Must be a power of 2

Definition at line 80 of file pipeline.cpp.

Referenced by grow(), and input_buffer().

is_bound

bool tbb::internal::input_buffer::is_bound

private

True for thread-bound filter, false otherwise.

Definition at line 89 of file pipeline.cpp.

Referenced by input_buffer(), and put_token().

is_ordered

bool tbb::internal::input_buffer::is_ordered

private

True for ordered filter, false otherwise.

Definition at line 86 of file pipeline.cpp.

Referenced by note_done(), and put_token().

low_token

Token tbb::internal::input_buffer::low_token

private

Lowest token that can start executing.

All prior Token have already been seen.

Definition at line 69 of file pipeline.cpp.

Referenced by grow(), has_item(), note_done(), put_token(), and return_item().

my_sem

semaphore* tbb::internal::input_buffer::my_sem

private

for thread-bound filter, semaphore for waiting, NULL otherwise.

Definition at line 61 of file pipeline.cpp.

Referenced by create_sema(), free_sema(), sema_P(), sema_V(), and ~input_buffer().

---

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

• pipeline.cpp