pipeline.h

/*
    Copyright 2005-2009 Intel Corporation.  All Rights Reserved.

    The source code contained or described herein and all documents related
    to the source code ("Material") are owned by Intel Corporation or its
    suppliers or licensors.  Title to the Material remains with Intel
    Corporation or its suppliers and licensors.  The Material is protected
    by worldwide copyright laws and treaty provisions.  No part of the
    Material may be used, copied, reproduced, modified, published, uploaded,
    posted, transmitted, distributed, or disclosed in any way without
    Intel's prior express written permission.

    No license under any patent, copyright, trade secret or other
    intellectual property right is granted to or conferred upon you by
    disclosure or delivery of the Materials, either expressly, by
    implication, inducement, estoppel or otherwise.  Any license under such
    intellectual property rights must be express and approved by Intel in
    writing.
*/

#ifndef __TBB_pipeline_H 
#define __TBB_pipeline_H 

#include "atomic.h"
#include "task.h"
#include <cstddef>

namespace tbb {

class pipeline;
class filter;

namespace internal {

// The argument for PIPELINE_VERSION should be an integer between 2 and 9
#define __TBB_PIPELINE_VERSION(x) (unsigned char)(x-2)<<1

typedef unsigned long Token;
typedef long tokendiff_t;
class stage_task;
class ordered_buffer;

} // namespace internal


class filter: internal::no_copy {
private:
    static filter* not_in_pipeline() {return reinterpret_cast<filter*>(internal::intptr(-1));}
    
    static const unsigned char filter_is_serial = 0x1; 

    // The bit was not set for parallel filters in TBB 2.1 and earlier,
    // but is_ordered() function always treats parallel filters as out of order
    static const unsigned char filter_is_out_of_order = 0x1<<4;  

    static const unsigned char current_version = __TBB_PIPELINE_VERSION(4);
    static const unsigned char version_mask = 0x7<<1; // bits 1-3 are for version
public:
    enum mode {
        parallel = current_version | filter_is_out_of_order, 
        serial_in_order = current_version | filter_is_serial,
        serial_out_of_order = current_version | filter_is_serial | filter_is_out_of_order,
        serial = serial_in_order
    };
protected:
    filter( bool is_serial_ ) : 
        next_filter_in_pipeline(not_in_pipeline()),
        input_buffer(NULL),
        my_filter_mode(static_cast<unsigned char>(is_serial_ ? serial : parallel)),
        prev_filter_in_pipeline(not_in_pipeline()),
        my_pipeline(NULL)
    {}
    
    filter( mode filter_mode ) :
        next_filter_in_pipeline(not_in_pipeline()),
        input_buffer(NULL),
        my_filter_mode(static_cast<unsigned char>(filter_mode)),
        prev_filter_in_pipeline(not_in_pipeline()),
        my_pipeline(NULL)
    {}

public:
    bool is_serial() const {
        return bool( my_filter_mode & filter_is_serial );
    }  
    
    // ! True if filter must receive stream in order.
    bool is_ordered() const {
        return (my_filter_mode & (filter_is_out_of_order|filter_is_serial))==filter_is_serial;
    }


    virtual void* operator()( void* item ) = 0;


    virtual __TBB_EXPORTED_METHOD ~filter();

#if __TBB_EXCEPTIONS

    virtual void finalize( void* /*item*/ ) {};
#endif

private:
    filter* next_filter_in_pipeline;

    internal::ordered_buffer* input_buffer;

    friend class internal::stage_task;
    friend class pipeline;

    const unsigned char my_filter_mode;

    filter* prev_filter_in_pipeline;

    pipeline* my_pipeline;
};


class pipeline {
public:
    __TBB_EXPORTED_METHOD pipeline();

    virtual __TBB_EXPORTED_METHOD ~pipeline();

    void __TBB_EXPORTED_METHOD add_filter( filter& filter_ );

    void __TBB_EXPORTED_METHOD run( size_t max_number_of_live_tokens );

#if __TBB_EXCEPTIONS
    void __TBB_EXPORTED_METHOD run( size_t max_number_of_live_tokens, tbb::task_group_context& context );
#endif

    void __TBB_EXPORTED_METHOD clear();

private:
    friend class internal::stage_task;
    friend class filter;

    filter* filter_list;

    filter* filter_end;

    empty_task* end_counter;

    atomic<internal::Token> input_tokens;

    internal::Token token_counter;

    bool end_of_input;

    void remove_filter( filter& filter_ );

    void __TBB_EXPORTED_METHOD inject_token( task& self );

#if __TBB_EXCEPTIONS
    void clear_filters();
#endif
};

} // tbb

#endif /* __TBB_pipeline_H */

---

Copyright © 2005-2009 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.