The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed by creating a tree of hierarchical blocks, which at any level may also contain terminal nodes that actually implement signal processing functions. This is the base class for all such leaf nodes. More...
#include <gnuradio/block.h>
Public Types | |
enum | { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 } |
Magic return values from general_work. More... | |
enum | tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 } |
Public Member Functions | |
virtual | ~block () |
unsigned | history () const |
void | set_history (unsigned history) |
void | declare_sample_delay (int which, unsigned delay) |
void | declare_sample_delay (unsigned delay) |
unsigned | sample_delay (int which) const |
bool | fixed_rate () const |
Return true if this block has a fixed input to output rate. More... | |
virtual void | forecast (int noutput_items, gr_vector_int &ninput_items_required) |
Estimate input requirements given output request. More... | |
virtual int | general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) |
compute output items from input items More... | |
virtual bool | start () |
Called to enable drivers, etc for i/o devices. More... | |
virtual bool | stop () |
Called to disable drivers, etc for i/o devices. More... | |
void | set_output_multiple (int multiple) |
Constrain the noutput_items argument passed to forecast and general_work. More... | |
int | output_multiple () const |
bool | output_multiple_set () const |
void | set_alignment (int multiple) |
Constrains buffers to work on a set item alignment (for SIMD) More... | |
int | alignment () const |
void | set_unaligned (int na) |
int | unaligned () const |
void | set_is_unaligned (bool u) |
bool | is_unaligned () const |
void | consume (int which_input, int how_many_items) |
Tell the scheduler how_many_items of input stream which_input were consumed. This function should be called at the end of work() or general_work(), after all processing is finished. More... | |
void | consume_each (int how_many_items) |
Tell the scheduler how_many_items were consumed on each input stream. More... | |
void | produce (int which_output, int how_many_items) |
Tell the scheduler how_many_items were produced on output stream which_output . More... | |
void | set_relative_rate (double relative_rate) |
Set the approximate output rate / input rate. More... | |
double | relative_rate () const |
return the approximate output rate / input rate More... | |
virtual int | fixed_rate_ninput_to_noutput (int ninput) |
Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
virtual int | fixed_rate_noutput_to_ninput (int noutput) |
Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
uint64_t | nitems_read (unsigned int which_input) |
Return the number of items read on input stream which_input. More... | |
uint64_t | nitems_written (unsigned int which_output) |
Return the number of items written on output stream which_output. More... | |
tag_propagation_policy_t | tag_propagation_policy () |
Asks for the policy used by the scheduler to moved tags downstream. More... | |
void | set_tag_propagation_policy (tag_propagation_policy_t p) |
Set the policy by the scheduler to determine how tags are moved downstream. More... | |
int | min_noutput_items () const |
Return the minimum number of output items this block can produce during a call to work. More... | |
void | set_min_noutput_items (int m) |
Set the minimum number of output items this block can produce during a call to work. More... | |
int | max_noutput_items () |
Return the maximum number of output items this block will handle during a call to work. More... | |
void | set_max_noutput_items (int m) |
Set the maximum number of output items this block will handle during a call to work. More... | |
void | unset_max_noutput_items () |
Clear the switch for using the max_noutput_items value of this block. More... | |
bool | is_set_max_noutput_items () |
Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work. More... | |
void | expand_minmax_buffer (int port) |
long | max_output_buffer (size_t i) |
Returns max buffer size on output port i . More... | |
void | set_max_output_buffer (long max_output_buffer) |
Request limit on max buffer size on all output ports. More... | |
void | set_max_output_buffer (int port, long max_output_buffer) |
Request limit on max buffer size on output port port . More... | |
long | min_output_buffer (size_t i) |
Returns min buffer size on output port i . More... | |
void | set_min_output_buffer (long min_output_buffer) |
Request limit on the mininum buffer size on all output ports. More... | |
void | set_min_output_buffer (int port, long min_output_buffer) |
Request limit on min buffer size on output port port . More... | |
float | pc_noutput_items () |
Gets instantaneous noutput_items performance counter. More... | |
float | pc_noutput_items_avg () |
Gets average noutput_items performance counter. More... | |
float | pc_noutput_items_var () |
Gets variance of noutput_items performance counter. More... | |
float | pc_nproduced () |
Gets instantaneous num items produced performance counter. More... | |
float | pc_nproduced_avg () |
Gets average num items produced performance counter. More... | |
float | pc_nproduced_var () |
Gets variance of num items produced performance counter. More... | |
float | pc_input_buffers_full (int which) |
Gets instantaneous fullness of which input buffer. More... | |
float | pc_input_buffers_full_avg (int which) |
Gets average fullness of which input buffer. More... | |
float | pc_input_buffers_full_var (int which) |
Gets variance of fullness of which input buffer. More... | |
std::vector< float > | pc_input_buffers_full () |
Gets instantaneous fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_avg () |
Gets average fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_var () |
Gets variance of fullness of all input buffers. More... | |
float | pc_output_buffers_full (int which) |
Gets instantaneous fullness of which input buffer. More... | |
float | pc_output_buffers_full_avg (int which) |
Gets average fullness of which input buffer. More... | |
float | pc_output_buffers_full_var (int which) |
Gets variance of fullness of which input buffer. More... | |
std::vector< float > | pc_output_buffers_full () |
Gets instantaneous fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_avg () |
Gets average fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_var () |
Gets variance of fullness of all output buffers. More... | |
float | pc_work_time () |
Gets instantaneous clock cycles spent in work. More... | |
float | pc_work_time_avg () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_var () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_total () |
Gets total clock cycles spent in work. More... | |
float | pc_throughput_avg () |
Gets average throughput. More... | |
void | reset_perf_counters () |
Resets the performance counters. More... | |
void | setup_pc_rpc () |
Sets up export of perf. counters to ControlPort. Only called by the scheduler. More... | |
bool | is_pc_rpc_set () |
Checks if this block is already exporting perf. counters to ControlPort. More... | |
void | no_pc_rpc () |
If the block calls this in its constructor, it's perf. counters will not be exported. More... | |
void | set_processor_affinity (const std::vector< int > &mask) |
Set the thread's affinity to processor core n . More... | |
void | unset_processor_affinity () |
Remove processor affinity to a specific core. More... | |
std::vector< int > | processor_affinity () |
Get the current processor affinity. More... | |
int | active_thread_priority () |
Get the current thread priority in use. More... | |
int | thread_priority () |
Get the current thread priority stored. More... | |
int | set_thread_priority (int priority) |
Set the current thread priority. More... | |
bool | update_rate () const |
void | system_handler (pmt::pmt_t msg) |
the system message handler More... | |
bool | finished () |
returns true when execution has completed due to a message connection More... | |
block_detail_sptr | detail () const |
void | set_detail (block_detail_sptr detail) |
void | notify_msg_neighbors () |
Tell msg neighbors we are finished. More... | |
void | clear_finished () |
Make sure we dont think we are finished. More... | |
![]() | |
pmt::pmt_t | message_subscribers (pmt::pmt_t port) |
virtual | ~basic_block () |
long | unique_id () const |
long | symbolic_id () const |
std::string | name () const |
std::string | symbol_name () const |
gr::io_signature::sptr | input_signature () const |
gr::io_signature::sptr | output_signature () const |
basic_block_sptr | to_basic_block () |
bool | alias_set () |
std::string | alias () |
pmt::pmt_t | alias_pmt () |
void | set_block_alias (std::string name) |
void | message_port_register_in (pmt::pmt_t port_id) |
void | message_port_register_out (pmt::pmt_t port_id) |
void | message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg) |
void | message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target) |
void | message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target) |
virtual bool | message_port_is_hier (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_in (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_out (pmt::pmt_t port_id) |
pmt::pmt_t | message_ports_in () |
Get input message port names. More... | |
pmt::pmt_t | message_ports_out () |
Get output message port names. More... | |
void | _post (pmt::pmt_t which_port, pmt::pmt_t msg) |
bool | empty_p (pmt::pmt_t which_port) |
is the queue empty? More... | |
bool | empty_p () |
bool | empty_handled_p (pmt::pmt_t which_port) |
are all msg ports with handlers empty? More... | |
bool | empty_handled_p () |
size_t | nmsgs (pmt::pmt_t which_port) |
How many messages in the queue? More... | |
void | insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg) |
pmt::pmt_t | delete_head_nowait (pmt::pmt_t which_port) |
pmt::pmt_t | delete_head_blocking (pmt::pmt_t which_port, unsigned int millisec=0) |
msg_queue_t::iterator | get_iterator (pmt::pmt_t which_port) |
void | erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it) |
virtual bool | has_msg_port (pmt::pmt_t which_port) |
const msg_queue_map_t & | get_msg_map (void) const |
virtual void | setup_rpc () |
Set up the RPC registered variables. More... | |
bool | is_rpc_set () |
Ask if this block has been registered to the RPC. More... | |
void | rpc_set () |
When the block is registered with the RPC, set this. More... | |
virtual bool | check_topology (int ninputs, int noutputs) |
Confirm that ninputs and noutputs is an acceptable combination. More... | |
template<typename T > | |
void | set_msg_handler (pmt::pmt_t which_port, T msg_handler) |
Set the callback that is fired when messages are available. More... | |
![]() | |
msg_accepter () | |
~msg_accepter () | |
void | post (pmt::pmt_t which_port, pmt::pmt_t msg) |
send msg to msg_accepter on port which_port More... | |
Protected Member Functions | |
block (void) | |
block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
void | set_fixed_rate (bool fixed_rate) |
void | add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
Adds a new tag onto the given output buffer. More... | |
void | add_item_tag (unsigned int which_output, const tag_t &tag) |
Adds a new tag onto the given output buffer. More... | |
void | remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
DEPRECATED. Will be removed in 3.8. More... | |
void | remove_item_tag (unsigned int which_input, const tag_t &tag) |
DEPRECATED. Will be removed in 3.8. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end) |
Given a [start,end), returns a vector of all tags in the range. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key) |
Given a [start,end), returns a vector of all tags in the range with a given key. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end) |
Gets all tags within the relative window of the current call to work. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key) |
Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified key . More... | |
void | enable_update_rate (bool en) |
![]() | |
basic_block (void) | |
basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
Protected constructor prevents instantiation by non-derived classes. More... | |
void | set_input_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_output_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_color (vcolor color) |
Allow the flowgraph to set for sorting and partitioning. More... | |
vcolor | color () const |
virtual bool | has_msg_handler (pmt::pmt_t which_port) |
Tests if there is a handler attached to port which_port . More... | |
virtual void | dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg) |
Protected Attributes | |
std::vector< long > | d_max_output_buffer |
std::vector< long > | d_min_output_buffer |
gr::thread::mutex | d_setlock |
gr::logger_ptr | d_logger |
gr::logger_ptr | d_debug_logger |
![]() | |
std::string | d_name |
gr::io_signature::sptr | d_input_signature |
gr::io_signature::sptr | d_output_signature |
long | d_unique_id |
long | d_symbolic_id |
std::string | d_symbol_name |
std::string | d_symbol_alias |
vcolor | d_color |
bool | d_rpc_set |
msg_queue_map_t | msg_queue |
std::vector< boost::any > | d_rpc_vars |
pmt::pmt_t | d_message_subscribers |
Additional Inherited Members | |
![]() | |
enum | vcolor { WHITE, GREY, BLACK } |
The abstract base class for all 'terminal' processing blocks.
A signal processing flow is constructed by creating a tree of hierarchical blocks, which at any level may also contain terminal nodes that actually implement signal processing functions. This is the base class for all such leaf nodes.
Blocks have a set of input streams and output streams. The input_signature and output_signature define the number of input streams and output streams respectively, and the type of the data items in each stream.
Although blocks may consume data on each input stream at a different rate, all outputs streams must produce data at the same rate. That rate may be different from any of the input rates.
User derived blocks override two methods, forecast and general_work, to implement their signal processing behavior. forecast is called by the system scheduler to determine how many items are required on each input stream in order to produce a given number of output items.
general_work is called to perform the signal processing in the block. It reads the input items and writes the output items.
|
virtual |
|
inlineprotected |
|
protected |
int gr::block::active_thread_priority | ( | ) |
Get the current thread priority in use.
|
inlineprotected |
Adds a new tag onto the given output buffer.
which_output | an integer of which output stream to attach the tag |
abs_offset | a uint64 number of the absolute item number assicated with the tag. Can get from nitems_written. |
key | the tag key as a PMT symbol |
value | any PMT holding any value for the given key |
srcid | optional source ID specifier; defaults to PMT_F |
References gr::tag_t::key, gr::tag_t::offset, gr::tag_t::srcid, and gr::tag_t::value.
Referenced by gr::block_gateway::block__add_item_tag().
|
protected |
Adds a new tag onto the given output buffer.
which_output | an integer of which output stream to attach the tag |
tag | the tag object to add |
|
inline |
|
inline |
Make sure we dont think we are finished.
void gr::block::consume | ( | int | which_input, |
int | how_many_items | ||
) |
Tell the scheduler how_many_items
of input stream which_input
were consumed. This function should be called at the end of work() or general_work(), after all processing is finished.
Referenced by gr::block_gateway::block__consume().
void gr::block::consume_each | ( | int | how_many_items | ) |
Tell the scheduler how_many_items
were consumed on each input stream.
Referenced by gr::block_gateway::block__consume_each().
void gr::block::declare_sample_delay | ( | int | which, |
unsigned | delay | ||
) |
Declares the block's delay in samples. Since the delay of blocks like filters is derived from the taps and not the block itself, we cannot automatically calculate this value and so leave it as a user-defined property. It defaults to 0 is not set.
This does not actively set the delay; it just tells the scheduler what the delay is.
This delay is mostly used to adjust the placement of the tags and is not currently used for any signal processing. When a tag is passed through a block with internal delay, its location should be moved based on the delay of the block. This interface allows us to tell the scheduler this value.
which | The buffer on which to set the delay. |
delay | The sample delay of the data stream. |
void gr::block::declare_sample_delay | ( | unsigned | delay | ) |
Convenience wrapper to gr::block::declare_delay(int which, unsigned delay) to set all ports to the same delay.
|
inline |
|
protected |
void gr::block::expand_minmax_buffer | ( | int | port | ) |
bool gr::block::finished | ( | ) |
returns true when execution has completed due to a message connection
|
inline |
Return true if this block has a fixed input to output rate.
If true, then fixed_rate_in_to_out and fixed_rate_out_to_in may be called.
Referenced by gr::block_gateway::block__fixed_rate().
|
virtual |
Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
Reimplemented in gr::fec::decoder, gr::sync_interpolator, gr::fec::encoder, gr::sync_decimator, and gr::sync_block.
|
virtual |
Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
Reimplemented in gr::fec::decoder, gr::sync_interpolator, gr::fec::encoder, gr::sync_decimator, and gr::sync_block.
|
virtual |
Estimate input requirements given output request.
noutput_items | number of output items to produce |
ninput_items_required | number of input items required on each input stream |
Given a request to product noutput_items
, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.
Reimplemented in gr::tagged_stream_block, gr::fec::decoder, gr::fec::encoder, atsc_bit_timing_loop, gr::sync_interpolator, gr::sync_decimator, gr::sync_block, atsc_equalizer, atsc_field_sync_demux, atsc_field_sync_mux, and atsc_pad.
|
virtual |
compute output items from input items
noutput_items | number of output items to write on each output stream |
ninput_items | number of input items available on each input stream |
input_items | vector of pointers to the input items, one entry per input stream |
output_items | vector of pointers to the output items, one entry per output stream |
general_work must call consume or consume_each to indicate how many items were consumed on each input stream.
Reimplemented in gr::tagged_stream_block, gr::fec::async_decoder, gr::fec::async_encoder, gr::fec::decoder, gr::fec::encoder, atsc_bit_timing_loop, gr::sync_interpolator, gr::sync_decimator, gr::sync_block, atsc_field_sync_demux, and atsc_field_sync_mux.
|
protected |
Given a [start,end), returns a vector of all tags in the range.
Range of counts is from start to end-1.
Tags are tuples of: (item count, source id, key, value)
v | a vector reference to return tags into |
which_input | an integer of which input stream to pull from |
abs_start | a uint64 count of the start of the range of interest |
abs_end | a uint64 count of the end of the range of interest |
Referenced by gr::block_gateway::block__get_tags_in_range().
|
protected |
Given a [start,end), returns a vector of all tags in the range with a given key.
Range of counts is from start to end-1.
Tags are tuples of: (item count, source id, key, value)
v | a vector reference to return tags into |
which_input | an integer of which input stream to pull from |
abs_start | a uint64 count of the start of the range of interest |
abs_end | a uint64 count of the end of the range of interest |
key | a PMT symbol key to filter only tags of this key |
|
protected |
Gets all tags within the relative window of the current call to work.
This opperates much like get_tags_in_range but allows us to work within the current window of items. Item range is therefore within the possible range of 0 to ninput_items[whic_input].
Range of items counts from rel_start
to rel_end-1
within current window.
Tags are tuples of: (item count, source id, key, value)
v | a vector reference to return tags into |
which_input | an integer of which input stream to pull from |
rel_start | a uint64 count of the start of the range of interest |
rel_end | a uint64 count of the end of the range of interest |
Referenced by gr::block_gateway::block__get_tags_in_window().
|
protected |
Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified key
.
v | a vector reference to return tags into |
which_input | an integer of which input stream to pull from |
rel_start | a uint64 count of the start of the range of interest |
rel_end | a uint64 count of the end of the range of interest |
key | a PMT symbol key to filter only tags of this key |
unsigned gr::block::history | ( | ) | const |
Assume block computes y_i = f(x_i, x_i-1, x_i-2, x_i-3...) History is the number of x_i's that are examined to produce one y_i. This comes in handy for FIR filters, where we use history to ensure that our input contains the appropriate "history" for the filter. History should be equal to the number of filter taps.
Referenced by gr::block_gateway::block__history().
|
inline |
Checks if this block is already exporting perf. counters to ControlPort.
bool gr::block::is_set_max_noutput_items | ( | ) |
Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work.
|
inline |
int gr::block::max_noutput_items | ( | ) |
Return the maximum number of output items this block will handle during a call to work.
long gr::block::max_output_buffer | ( | size_t | i | ) |
Returns max buffer size on output port i
.
|
inline |
Return the minimum number of output items this block can produce during a call to work.
Should be 0 for most blocks. Useful if we're dealing with packets and the block produces one packet per call to work.
long gr::block::min_output_buffer | ( | size_t | i | ) |
Returns min buffer size on output port i
.
uint64_t gr::block::nitems_read | ( | unsigned int | which_input | ) |
Return the number of items read on input stream which_input.
Referenced by gr::block_gateway::block__nitems_read().
uint64_t gr::block::nitems_written | ( | unsigned int | which_output | ) |
Return the number of items written on output stream which_output.
Referenced by gr::block_gateway::block__nitems_written().
|
inline |
If the block calls this in its constructor, it's perf. counters will not be exported.
void gr::block::notify_msg_neighbors | ( | ) |
Tell msg neighbors we are finished.
|
inline |
Referenced by gr::block_gateway::block__output_multiple().
|
inline |
float gr::block::pc_input_buffers_full | ( | int | which | ) |
Gets instantaneous fullness of which
input buffer.
std::vector<float> gr::block::pc_input_buffers_full | ( | ) |
Gets instantaneous fullness of all input buffers.
float gr::block::pc_input_buffers_full_avg | ( | int | which | ) |
Gets average fullness of which
input buffer.
std::vector<float> gr::block::pc_input_buffers_full_avg | ( | ) |
Gets average fullness of all input buffers.
float gr::block::pc_input_buffers_full_var | ( | int | which | ) |
Gets variance of fullness of which
input buffer.
std::vector<float> gr::block::pc_input_buffers_full_var | ( | ) |
Gets variance of fullness of all input buffers.
float gr::block::pc_noutput_items | ( | ) |
Gets instantaneous noutput_items performance counter.
float gr::block::pc_noutput_items_avg | ( | ) |
Gets average noutput_items performance counter.
float gr::block::pc_noutput_items_var | ( | ) |
Gets variance of noutput_items performance counter.
float gr::block::pc_nproduced | ( | ) |
Gets instantaneous num items produced performance counter.
float gr::block::pc_nproduced_avg | ( | ) |
Gets average num items produced performance counter.
float gr::block::pc_nproduced_var | ( | ) |
Gets variance of num items produced performance counter.
float gr::block::pc_output_buffers_full | ( | int | which | ) |
Gets instantaneous fullness of which
input buffer.
std::vector<float> gr::block::pc_output_buffers_full | ( | ) |
Gets instantaneous fullness of all output buffers.
float gr::block::pc_output_buffers_full_avg | ( | int | which | ) |
Gets average fullness of which
input buffer.
std::vector<float> gr::block::pc_output_buffers_full_avg | ( | ) |
Gets average fullness of all output buffers.
float gr::block::pc_output_buffers_full_var | ( | int | which | ) |
Gets variance of fullness of which
input buffer.
std::vector<float> gr::block::pc_output_buffers_full_var | ( | ) |
Gets variance of fullness of all output buffers.
float gr::block::pc_throughput_avg | ( | ) |
Gets average throughput.
float gr::block::pc_work_time | ( | ) |
Gets instantaneous clock cycles spent in work.
float gr::block::pc_work_time_avg | ( | ) |
Gets average clock cycles spent in work.
float gr::block::pc_work_time_total | ( | ) |
Gets total clock cycles spent in work.
float gr::block::pc_work_time_var | ( | ) |
Gets average clock cycles spent in work.
|
inlinevirtual |
Get the current processor affinity.
Reimplemented from gr::basic_block.
void gr::block::produce | ( | int | which_output, |
int | how_many_items | ||
) |
Tell the scheduler how_many_items
were produced on output stream which_output
.
If the block's general_work method calls produce, general_work
must return WORK_CALLED_PRODUCE.
Referenced by gr::block_gateway::block__produce().
|
inline |
return the approximate output rate / input rate
Referenced by gr::block_gateway::block__relative_rate().
|
inlineprotected |
DEPRECATED. Will be removed in 3.8.
which_input | an integer of which input stream to remove the tag from |
abs_offset | a uint64 number of the absolute item number assicated with the tag. Can get from nitems_written. |
key | the tag key as a PMT symbol |
value | any PMT holding any value for the given key |
srcid | optional source ID specifier; defaults to PMT_F |
If no such tag is found, does nothing.
References gr::tag_t::key, gr::tag_t::offset, gr::tag_t::srcid, and gr::tag_t::value.
|
protected |
DEPRECATED. Will be removed in 3.8.
which_input | an integer of which input stream to remove the tag from |
tag | the tag object to remove |
void gr::block::reset_perf_counters | ( | ) |
Resets the performance counters.
unsigned gr::block::sample_delay | ( | int | which | ) | const |
Gets the delay of the block. Since the delay of blocks like filters is derived from the taps and not the block itself, we cannot automatically calculate this value and so leave it as a user-defined property. It defaults to 0 is not set.
which | Which port from which to get the sample delay. |
void gr::block::set_alignment | ( | int | multiple | ) |
Constrains buffers to work on a set item alignment (for SIMD)
set_alignment_multiple causes the scheduler to ensure that the noutput_items argument passed to forecast and general_work will be an integer multiple of
multiple | The default value is 1. |
This control is similar to the output_multiple setting, except that if the number of items passed to the block is less than the output_multiple, this value is ignored and the block can produce like normal. The d_unaligned value is set to the number of items the block is off by. In the next call to general_work, the noutput_items is set to d_unaligned or less until d_unaligned==0. The buffers are now aligned again and the aligned calls can be performed again.
|
inline |
|
inlineprotected |
Referenced by gr::block_gateway::block__set_fixed_rate().
void gr::block::set_history | ( | unsigned | history | ) |
Referenced by gr::block_gateway::block__set_history().
void gr::block::set_is_unaligned | ( | bool | u | ) |
void gr::block::set_max_noutput_items | ( | int | m | ) |
Set the maximum number of output items this block will handle during a call to work.
m | the maximum noutput_items this block will handle. |
void gr::block::set_max_output_buffer | ( | long | max_output_buffer | ) |
Request limit on max buffer size on all output ports.
This is an advanced feature. Calling this can affect some fundamental assumptions about the system behavior and performance.
The actual buffer size is determined by a number of other factors from the block and system. This function only provides a requested maximum. The buffers will always be a multiple of the system page size, which may be larger than the value asked for here.
max_output_buffer | the requested maximum output size in items. |
void gr::block::set_max_output_buffer | ( | int | port, |
long | max_output_buffer | ||
) |
Request limit on max buffer size on output port port
.
This is an advanced feature. Calling this can affect some fundamental assumptions about the system behavior and performance.
The actual buffer size is determined by a number of other factors from the block and system. This function only provides a requested maximum. The buffers will always be a multiple of the system page size, which may be larger than the value asked for here.
port | the output port the request applies to. |
max_output_buffer | the requested maximum output size in items. |
|
inline |
Set the minimum number of output items this block can produce during a call to work.
m | the minimum noutput_items this block can produce. |
void gr::block::set_min_output_buffer | ( | long | min_output_buffer | ) |
Request limit on the mininum buffer size on all output ports.
This is an advanced feature. Calling this can affect some fundamental assumptions about the system behavior and performance.
The actual buffer size is determined by a number of other factors from the block and system. This function only provides a requested minimum. The buffers will always be a multiple of the system page size, which may be larger than the value asked for here.
min_output_buffer | the requested minimum output size in items. |
void gr::block::set_min_output_buffer | ( | int | port, |
long | min_output_buffer | ||
) |
Request limit on min buffer size on output port port
.
This is an advanced feature. Calling this can affect some fundamental assumptions about the system behavior and performance.
The actual buffer size is determined by a number of other factors from the block and system. This function only provides a requested minimum. The buffers will always be a multiple of the system page size, which may be larger than the value asked for here.
port | the output port the request applies to. |
min_output_buffer | the requested minimum output size in items. |
void gr::block::set_output_multiple | ( | int | multiple | ) |
Constrain the noutput_items argument passed to forecast and general_work.
set_output_multiple causes the scheduler to ensure that the noutput_items argument passed to forecast and general_work will be an integer multiple of
multiple | The default value of output multiple is 1. |
Referenced by gr::block_gateway::block__set_output_multiple().
|
virtual |
Set the thread's affinity to processor core n
.
mask | a vector of ints of the core numbers available to this block. |
Reimplemented from gr::basic_block.
void gr::block::set_relative_rate | ( | double | relative_rate | ) |
Set the approximate output rate / input rate.
Provide a hint to the buffer allocator and scheduler. The default relative_rate is 1.0
decimators have relative_rates < 1.0 interpolators have relative_rates > 1.0
Referenced by gr::block_gateway::block__set_relative_rate().
void gr::block::set_tag_propagation_policy | ( | tag_propagation_policy_t | p | ) |
Set the policy by the scheduler to determine how tags are moved downstream.
Referenced by gr::block_gateway::block__set_tag_propagation_policy().
int gr::block::set_thread_priority | ( | int | priority | ) |
Set the current thread priority.
void gr::block::set_unaligned | ( | int | na | ) |
void gr::block::setup_pc_rpc | ( | ) |
Sets up export of perf. counters to ControlPort. Only called by the scheduler.
|
virtual |
Called to enable drivers, etc for i/o devices.
This allows a block to enable an associated driver to begin transfering data just before we start to execute the scheduler. The end result is that this reduces latency in the pipeline when dealing with audio devices, usrps, etc.
Reimplemented in gr::blocks::probe_rate.
|
virtual |
Called to disable drivers, etc for i/o devices.
Reimplemented in gr::blocks::probe_rate.
void gr::block::system_handler | ( | pmt::pmt_t | msg | ) |
the system message handler
tag_propagation_policy_t gr::block::tag_propagation_policy | ( | ) |
Asks for the policy used by the scheduler to moved tags downstream.
Referenced by gr::block_gateway::block__tag_propagation_policy().
int gr::block::thread_priority | ( | ) |
Get the current thread priority stored.
|
inline |
void gr::block::unset_max_noutput_items | ( | ) |
Clear the switch for using the max_noutput_items value of this block.
When is_set_max_noutput_items() returns 'true', the scheduler will use the value returned by max_noutput_items() to limit the size of the number of items possible for this block's work function. If is_set_max_notput_items() returns 'false', then the scheduler ignores the internal value and uses the value set globally in the top_block.
Use this value to clear the 'is_set' flag so the scheduler will ignore this. Use the set_max_noutput_items(m) call to both set a new value for max_noutput_items and to reenable its use in the scheduler.
|
virtual |
Remove processor affinity to a specific core.
Reimplemented from gr::basic_block.
bool gr::block::update_rate | ( | ) | const |
|
protected |
|
protected |
Used by blocks to access the logger system.
|
protected |
|
protected |
|
protected |
Used by block's setters and work functions to make setting/resetting of parameters thread-safe.
Used by calling gr::thread::scoped_lock l(d_setlock);