Loading...
Searching...
No Matches
flowgraph.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2006,2007,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_RUNTIME_FLOWGRAPH_H
#define INCLUDED_GR_RUNTIME_FLOWGRAPH_H
#include <gnuradio/api.h>
#include <gnuradio/basic_block.h>
#include <gnuradio/io_signature.h>
namespace gr {
/*!
* \brief Class representing a specific input or output graph endpoint
* \ingroup internal
*/
class GR_RUNTIME_API endpoint
{
private:
basic_block_sptr d_basic_block;
int d_port;
public:
endpoint() : d_basic_block(), d_port(0) {}
endpoint(basic_block_sptr block, int port)
{
d_basic_block = block;
d_port = port;
}
basic_block_sptr block() const { return d_basic_block; }
int port() const { return d_port; }
std::string identifier() const
{
return d_basic_block->alias() + ":" + std::to_string(d_port);
};
bool operator==(const endpoint& other) const;
};
inline bool endpoint::operator==(const endpoint& other) const
{
return (d_basic_block == other.d_basic_block && d_port == other.d_port);
}
class GR_RUNTIME_API msg_endpoint
{
private:
basic_block_sptr d_basic_block;
pmt::pmt_t d_port;
bool d_is_hier;
public:
msg_endpoint() : d_basic_block(), d_port(pmt::PMT_NIL) {}
msg_endpoint(basic_block_sptr block, pmt::pmt_t port, bool is_hier = false)
{
d_basic_block = block;
d_port = port;
d_is_hier = is_hier;
}
basic_block_sptr block() const { return d_basic_block; }
pmt::pmt_t port() const { return d_port; }
bool is_hier() const { return d_is_hier; }
void set_hier(bool h) { d_is_hier = h; }
std::string identifier() const
{
return d_basic_block->alias() + ":" + pmt::symbol_to_string(d_port);
}
bool operator==(const msg_endpoint& other) const;
};
inline bool msg_endpoint::operator==(const msg_endpoint& other) const
{
return (d_basic_block == other.d_basic_block && pmt::equal(d_port, other.d_port));
}
// Hold vectors of gr::endpoint objects
typedef std::vector<endpoint> endpoint_vector_t;
typedef std::vector<endpoint>::iterator endpoint_viter_t;
/*!
*\brief Class representing a connection between to graph endpoints
*/
class GR_RUNTIME_API edge
{
public:
edge() : d_src(), d_dst(){};
edge(const endpoint& src, const endpoint& dst) : d_src(src), d_dst(dst) {}
~edge();
const endpoint& src() const { return d_src; }
const endpoint& dst() const { return d_dst; }
std::string identifier() const
{
return d_src.identifier() + "->" + d_dst.identifier();
}
private:
endpoint d_src;
endpoint d_dst;
};
// Hold vectors of gr::edge objects
typedef std::vector<edge> edge_vector_t;
typedef std::vector<edge>::iterator edge_viter_t;
/*!
*\brief Class representing a msg connection between to graph msg endpoints
*/
class GR_RUNTIME_API msg_edge
{
public:
msg_edge() : d_src(), d_dst(){};
msg_edge(const msg_endpoint& src, const msg_endpoint& dst) : d_src(src), d_dst(dst) {}
~msg_edge() {}
const msg_endpoint& src() const { return d_src; }
const msg_endpoint& dst() const { return d_dst; }
std::string identifier() const
{
return d_src.identifier() + "->" + d_dst.identifier();
}
private:
msg_endpoint d_src;
msg_endpoint d_dst;
};
// Hold vectors of gr::msg_edge objects
typedef std::vector<msg_edge> msg_edge_vector_t;
typedef std::vector<msg_edge>::iterator msg_edge_viter_t;
// Create a shared pointer to a heap allocated flowgraph
// (types defined in runtime_types.h)
GR_RUNTIME_API flowgraph_sptr make_flowgraph();
/*!
* \brief Class representing a directed, acyclic graph of basic blocks
* \ingroup internal
*/
class GR_RUNTIME_API flowgraph
{
public:
friend GR_RUNTIME_API flowgraph_sptr make_flowgraph();
/*!
* \brief Destruct an arbitrary flowgraph
*/
virtual ~flowgraph();
/*!
* \brief Connect two endpoints
* \details
* Checks the validity of both endpoints, and whether the
* destination is unused so far, then adds the edge to the internal list of
* edges.
*/
void connect(const endpoint& src, const endpoint& dst);
/*!
* \brief Disconnect two endpoints
*/
void disconnect(const endpoint& src, const endpoint& dst);
/*!
* \brief convenience wrapper; used to connect two endpoints
*/
void connect(basic_block_sptr src_block,
int src_port,
basic_block_sptr dst_block,
int dst_port);
/*!
* \brief convenience wrapper; used to disconnect two endpoints
*/
void disconnect(basic_block_sptr src_block,
int src_port,
basic_block_sptr dst_block,
int dst_port);
/*!
* \brief Connect two message endpoints
* \details
* Checks the validity of both endpoints, then adds the edge to the
* internal list of edges.
*/
void connect(const msg_endpoint& src, const msg_endpoint& dst);
/*!
* \brief Disconnect two message endpoints
*/
void disconnect(const msg_endpoint& src, const msg_endpoint& dst);
/*!
* \brief Validate flow graph
* \details
* Gathers all used blocks, checks the contiguity of all connected in- and
* outputs, and calls the check_topology method of each block.
*/
void validate();
/*!
* \brief Clear existing flowgraph
*/
void clear();
/*!
* \brief Get vector of edges
*/
const edge_vector_t& edges() const { return d_edges; }
/*!
* \brief Get vector of message edges
*/
const msg_edge_vector_t& msg_edges() const { return d_msg_edges; }
/*!
* \brief calculates all used blocks in a flow graph
* \details
* Iterates over all message edges and stream edges, noting both endpoints in a
* vector.
*
* \return a unique vector of used blocks
*/
basic_block_vector_t calc_used_blocks();
/*!
* \brief topologically sort blocks
* \details
* Uses depth-first search to return a sorted vector of blocks
*
* \return toplogically sorted vector of blocks. All the sources come first.
*/
basic_block_vector_t topological_sort(basic_block_vector_t& blocks);
/*!
* \brief Calculate vector of disjoint graph partitions
* \return vector of disjoint vectors of topologically sorted blocks
*/
std::vector<basic_block_vector_t> partition();
protected:
basic_block_vector_t d_blocks;
edge_vector_t d_edges;
msg_edge_vector_t d_msg_edges;
gr::logger_ptr d_logger;
gr::logger_ptr d_debug_logger;
flowgraph();
std::vector<int> calc_used_ports(basic_block_sptr block, bool check_inputs);
basic_block_vector_t calc_downstream_blocks(basic_block_sptr block, int port);
edge_vector_t calc_upstream_edges(basic_block_sptr block);
bool has_block_p(basic_block_sptr block);
edge calc_upstream_edge(basic_block_sptr block, int port);
private:
void check_valid_port(gr::io_signature::sptr sig, int port);
void check_valid_port(const msg_endpoint& e);
void check_dst_not_used(const endpoint& dst);
void check_type_match(const endpoint& src, const endpoint& dst);
edge_vector_t calc_connections(basic_block_sptr block,
bool check_inputs); // false=use outputs
void check_contiguity(basic_block_sptr block,
const std::vector<int>& used_ports,
bool check_inputs);
basic_block_vector_t calc_downstream_blocks(basic_block_sptr block);
basic_block_vector_t calc_reachable_blocks(basic_block_sptr block,
basic_block_vector_t& blocks);
void reachable_dfs_visit(basic_block_sptr block, basic_block_vector_t& blocks);
basic_block_vector_t calc_adjacent_blocks(basic_block_sptr block,
basic_block_vector_t& blocks);
basic_block_vector_t sort_sources_first(basic_block_vector_t& blocks);
bool source_p(basic_block_sptr block);
void topological_dfs_visit(basic_block_sptr block, basic_block_vector_t& output);
};
// Convenience functions
inline void flowgraph::connect(basic_block_sptr src_block,
int src_port,
basic_block_sptr dst_block,
int dst_port)
{
connect(endpoint(src_block, src_port), endpoint(dst_block, dst_port));
}
inline void flowgraph::disconnect(basic_block_sptr src_block,
int src_port,
basic_block_sptr dst_block,
int dst_port)
{
disconnect(endpoint(src_block, src_port), endpoint(dst_block, dst_port));
}
inline std::ostream& operator<<(std::ostream& os, const endpoint endp)
{
os << endp.identifier();
return os;
}
inline std::ostream& operator<<(std::ostream& os, const edge edge)
{
os << edge.identifier();
return os;
}
inline std::ostream& operator<<(std::ostream& os, const msg_endpoint endp)
{
os << endp.identifier();
return os;
}
inline std::ostream& operator<<(std::ostream& os, const msg_edge edge)
{
os << edge.identifier();
return os;
}
std::string dot_graph_fg(flowgraph_sptr fg);
} /* namespace gr */
#endif /* INCLUDED_GR_RUNTIME_FLOWGRAPH_H */
basic_block.h
gr::block
The abstract base class for all 'terminal' processing blocks.
Definition gnuradio-runtime/include/gnuradio/block.h:63
gr::edge
Class representing a connection between to graph endpoints.
Definition flowgraph.h:92
gr::edge::~edge
~edge()
gr::edge::dst
const endpoint & dst() const
Definition flowgraph.h:99
gr::edge::identifier
std::string identifier() const
Definition flowgraph.h:100
gr::edge::edge
edge(const endpoint &src, const endpoint &dst)
Definition flowgraph.h:95
gr::edge::edge
edge()
Definition flowgraph.h:94
gr::edge::src
const endpoint & src() const
Definition flowgraph.h:98
gr::endpoint
Class representing a specific input or output graph endpoint.
Definition flowgraph.h:25
gr::endpoint::identifier
std::string identifier() const
Definition flowgraph.h:39
gr::endpoint::endpoint
endpoint(basic_block_sptr block, int port)
Definition flowgraph.h:32
gr::endpoint::operator==
bool operator==(const endpoint &other) const
Definition flowgraph.h:47
gr::endpoint::port
int port() const
Definition flowgraph.h:38
gr::endpoint::endpoint
endpoint()
Definition flowgraph.h:31
gr::endpoint::block
basic_block_sptr block() const
Definition flowgraph.h:37
gr::flowgraph
Class representing a directed, acyclic graph of basic blocks.
Definition flowgraph.h:150
gr::flowgraph::msg_edges
const msg_edge_vector_t & msg_edges() const
Get vector of message edges.
Definition flowgraph.h:223
gr::flowgraph::d_debug_logger
gr::logger_ptr d_debug_logger
Definition flowgraph.h:255
gr::flowgraph::d_blocks
basic_block_vector_t d_blocks
Definition flowgraph.h:251
gr::flowgraph::calc_used_blocks
basic_block_vector_t calc_used_blocks()
calculates all used blocks in a flow graph
gr::flowgraph::calc_used_ports
std::vector< int > calc_used_ports(basic_block_sptr block, bool check_inputs)
gr::flowgraph::calc_downstream_blocks
basic_block_vector_t calc_downstream_blocks(basic_block_sptr block, int port)
gr::flowgraph::connect
void connect(const msg_endpoint &src, const msg_endpoint &dst)
Connect two message endpoints.
gr::flowgraph::topological_sort
basic_block_vector_t topological_sort(basic_block_vector_t &blocks)
topologically sort blocks
gr::flowgraph::calc_upstream_edges
edge_vector_t calc_upstream_edges(basic_block_sptr block)
gr::flowgraph::d_edges
edge_vector_t d_edges
Definition flowgraph.h:252
gr::flowgraph::calc_upstream_edge
edge calc_upstream_edge(basic_block_sptr block, int port)
gr::flowgraph::disconnect
void disconnect(const msg_endpoint &src, const msg_endpoint &dst)
Disconnect two message endpoints.
gr::flowgraph::validate
void validate()
Validate flow graph.
gr::flowgraph::edges
const edge_vector_t & edges() const
Get vector of edges.
Definition flowgraph.h:218
gr::flowgraph::disconnect
void disconnect(const endpoint &src, const endpoint &dst)
Disconnect two endpoints.
gr::flowgraph::d_msg_edges
msg_edge_vector_t d_msg_edges
Definition flowgraph.h:253
gr::flowgraph::has_block_p
bool has_block_p(basic_block_sptr block)
gr::flowgraph::flowgraph
flowgraph()
gr::flowgraph::clear
void clear()
Clear existing flowgraph.
gr::flowgraph::make_flowgraph
friend GR_RUNTIME_API flowgraph_sptr make_flowgraph()
gr::flowgraph::d_logger
gr::logger_ptr d_logger
Definition flowgraph.h:254
gr::flowgraph::~flowgraph
virtual ~flowgraph()
Destruct an arbitrary flowgraph.
gr::flowgraph::connect
void connect(const endpoint &src, const endpoint &dst)
Connect two endpoints.
gr::flowgraph::partition
std::vector< basic_block_vector_t > partition()
Calculate vector of disjoint graph partitions.
gr::io_signature::sptr
std::shared_ptr< io_signature > sptr
Definition io_signature.h:52
gr::msg_edge
Class representing a msg connection between to graph msg endpoints.
Definition flowgraph.h:119
gr::msg_edge::~msg_edge
~msg_edge()
Definition flowgraph.h:123
gr::msg_edge::src
const msg_endpoint & src() const
Definition flowgraph.h:125
gr::msg_edge::identifier
std::string identifier() const
Definition flowgraph.h:127
gr::msg_edge::dst
const msg_endpoint & dst() const
Definition flowgraph.h:126
gr::msg_edge::msg_edge
msg_edge(const msg_endpoint &src, const msg_endpoint &dst)
Definition flowgraph.h:122
gr::msg_edge::msg_edge
msg_edge()
Definition flowgraph.h:121
gr::msg_endpoint
Definition flowgraph.h:53
gr::msg_endpoint::is_hier
bool is_hier() const
Definition flowgraph.h:69
gr::msg_endpoint::set_hier
void set_hier(bool h)
Definition flowgraph.h:70
gr::msg_endpoint::block
basic_block_sptr block() const
Definition flowgraph.h:67
gr::msg_endpoint::operator==
bool operator==(const msg_endpoint &other) const
Definition flowgraph.h:79
gr::msg_endpoint::port
pmt::pmt_t port() const
Definition flowgraph.h:68
gr::msg_endpoint::msg_endpoint
msg_endpoint(basic_block_sptr block, pmt::pmt_t port, bool is_hier=false)
Definition flowgraph.h:61
gr::msg_endpoint::msg_endpoint
msg_endpoint()
Definition flowgraph.h:60
gr::msg_endpoint::identifier
std::string identifier() const
Definition flowgraph.h:71
std::vector
STL class.
Definition vector_docstub.h:11
api.h
GR_RUNTIME_API
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:18
io_signature.h
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
gr::msg_edge_viter_t
std::vector< msg_edge >::iterator msg_edge_viter_t
Definition flowgraph.h:139
gr::edge_viter_t
std::vector< edge >::iterator edge_viter_t
Definition flowgraph.h:112
gr::dot_graph_fg
std::string dot_graph_fg(flowgraph_sptr fg)
gr::msg_edge_vector_t
std::vector< msg_edge > msg_edge_vector_t
Definition flowgraph.h:138
gr::operator<<
std::ostream & operator<<(std::ostream &os, basic_block_sptr basic_block)
Definition basic_block.h:436
gr::operator==
bool operator==(const io_signature &lhs, const io_signature &rhs)
gr::logger_ptr
std::shared_ptr< logger > logger_ptr
Definition logger.h:250
gr::edge_vector_t
std::vector< edge > edge_vector_t
Definition flowgraph.h:111
gr::endpoint_vector_t
std::vector< endpoint > endpoint_vector_t
Definition flowgraph.h:85
gr::endpoint_viter_t
std::vector< endpoint >::iterator endpoint_viter_t
Definition flowgraph.h:86
gr::make_flowgraph
GR_RUNTIME_API flowgraph_sptr make_flowgraph()
pmt
Definition pmt.h:38
pmt::equal
PMT_API bool equal(const pmt_t &x, const pmt_t &y)
pmt::symbol_to_string
PMT_API const std::string symbol_to_string(const pmt_t &sym)
pmt::pmt_t
std::shared_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting).
Definition pmt.h:83
PMT_NIL
#define PMT_NIL
Definition pmt.h:121