summaryrefslogtreecommitdiff
path: root/lib/element_impl.hpp
blob: a9f272bfd77e7734769a99f4e30f51a7ddfcf4a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
//
// Copyright 2012 Josh Blum
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with io_sig program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef INCLUDED_LIBGRAS_ELEMENT_IMPL_HPP
#define INCLUDED_LIBGRAS_ELEMENT_IMPL_HPP

#include <gras_impl/debug.hpp>
#include <gras_impl/misc.hpp>
#include <gras_impl/vector_of_queues.hpp>
#include <gras_impl/input_buffer_queues.hpp>
#include <gras_impl/interruptible_thread.hpp>

#include <tsbe/block.hpp>
#include <tsbe/topology.hpp>
#include <tsbe/executor.hpp>
#include <gnuradio/element.hpp>
#include <gnuradio/block.hpp>
#include <gr_types.h>
#include <set>
#include <vector>
#include <queue>

namespace gnuradio
{

struct ElementImpl
{

    //deconstructor stuff
    ~ElementImpl(void);
    void top_block_cleanup(void);
    void hier_block_cleanup(void);

    //stuff for when its a block
    std::string name;
    long unique_id;

    //per port properties
    std::vector<size_t> input_items_sizes;
    std::vector<size_t> output_items_sizes;
    IOSignature input_signature;
    IOSignature output_signature;
    std::vector<size_t> input_history_items;
    std::vector<size_t> output_multiple_items;

    //keeps track of production
    std::vector<uint64_t> items_consumed;
    std::vector<uint64_t> items_produced;

    //work buffers for the classic interface
    size_t work_noutput_items;
    std::vector<const void *> work_input_items;
    std::vector<void *> work_output_items;
    std::vector<int> work_ninput_items;
    std::vector<int> fcast_ninput_items;

    //work buffers for the new work interface
    Block::InputItems input_items;
    Block::OutputItems output_items;
    ptrdiff_t work_io_ptr_mask;

    //track work's calls to produce and consume
    std::vector<size_t> produce_items;
    std::vector<size_t> consume_items;

    //track the subscriber counts
    std::vector<Token> input_tokens;
    std::vector<Token> output_tokens;
    std::set<Token> token_pool;

    std::vector<SBufferToken> output_buffer_tokens;

    //buffer queues and ready conditions
    InputBufferQueues input_queues;
    VectorOfQueues<SBuffer> output_queues;

    //tag tracking
    std::vector<bool> input_tags_changed;
    std::vector<std::vector<Tag> > input_tags;
    Block::tag_propagation_policy_t tag_prop_policy;

    //topological things
    tsbe::Block block;
    tsbe::Topology topology;
    tsbe::Executor executor;
    std::vector<boost::shared_ptr<Element> > children;
    const tsbe::Element &get_elem(void) const
    {
        if (block) return block;
        return topology;
    }
    //gets the handlers access for forecast and work
    Block *block_ptr;
    tsbe::TaskInterface work_task_iface; //only valid during work

    //interruptible thread stuff
    SharedThreadGroup thread_group;
    boost::shared_ptr<InterruptibleThread> interruptible_thread;

    //handlers
    void handle_input_msg(const tsbe::TaskInterface &, const size_t, const tsbe::Wax &);
    void handle_output_msg(const tsbe::TaskInterface &, const size_t, const tsbe::Wax &);
    void topology_update(const tsbe::TaskInterface &);
    void handle_block_msg(const tsbe::TaskInterface &, const tsbe::Wax &);
    void handle_allocation(const tsbe::TaskInterface &);
    void handle_task(const tsbe::TaskInterface &);
    void mark_done(const tsbe::TaskInterface &);
    void conclusion(const tsbe::TaskInterface &task_iface, const bool);
    void buffer_returner(const size_t index, SBuffer &buffer);

    //work helpers
    int work_ret;
    inline void task_work(void)
    {
        this->work_ret = block_ptr->Work(this->input_items, this->output_items);
    }

    //is the fg running?
    enum
    {
        BLOCK_STATE_INIT,
        BLOCK_STATE_LIVE,
        BLOCK_STATE_DONE,
    } block_state;
    Token token;
    size_t hint; //some kind of allocation hint

    //rate settings
    bool enable_fixed_rate;
    double relative_rate;
    bool forecast_fail;
    bool forecast_enable;
};

} //namespace gnuradio

#endif /*INCLUDED_LIBGRAS_ELEMENT_IMPL_HPP*/