Loading...
Searching...
No Matches
buffer_double_mapped.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2020 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_RUNTIME_BUFFER_DOUBLE_MAPPED_H
#define INCLUDED_GR_RUNTIME_BUFFER_DOUBLE_MAPPED_H
#include <gnuradio/api.h>
#include <gnuradio/buffer.h>
#include <gnuradio/buffer_type.h>
#include <gnuradio/logger.h>
#include <gnuradio/runtime_types.h>
namespace gr {
class vmcircbuf;
/*!
* \brief Single writer, multiple reader fifo.
* \ingroup internal
*/
class GR_RUNTIME_API buffer_double_mapped : public buffer
{
public:
static buffer_type type;
static buffer_sptr make_buffer(int nitems,
size_t sizeof_item,
uint64_t downstream_lcm_nitems,
uint32_t downstream_max_out_mult,
block_sptr link = block_sptr(),
block_sptr buf_owner = block_sptr());
gr::logger_ptr d_logger;
gr::logger_ptr d_debug_logger;
~buffer_double_mapped() override;
/*!
* \brief return number of items worth of space available for writing
*/
int space_available() override;
/*!
* Inherited from buffer class.
* @param nitems is the number of items produced by the general_work() function.
*/
void post_work([[maybe_unused]] int nitems) override {}
protected:
/*!
* sets d_vmcircbuf, d_base, d_bufsize.
* returns true iff successful.
*/
bool allocate_buffer(int nitems) override;
unsigned index_add(unsigned a, unsigned b) override
{
unsigned s = a + b;
if (s >= d_bufsize)
s -= d_bufsize;
assert(s < d_bufsize);
return s;
}
unsigned index_sub(unsigned a, unsigned b) override
{
int s = a - b;
if (s < 0)
s += d_bufsize;
assert((unsigned)s < d_bufsize);
return s;
}
private:
friend class buffer_reader;
friend GR_RUNTIME_API buffer_sptr make_buffer(int nitems,
size_t sizeof_item,
uint64_t downstream_lcm_nitems,
block_sptr link,
block_sptr buf_owner);
friend GR_RUNTIME_API buffer_sptr
make_buffer_double_mapped(int nitems,
size_t sizeof_item,
uint64_t downstream_lcm_nitems,
uint32_t downstream_max_out_mult,
block_sptr link,
block_sptr buf_owner);
std::unique_ptr<gr::vmcircbuf> d_vmcircbuf;
/*!
* \brief constructor is private. Use gr_make_buffer to create instances.
*
* Allocate a buffer that holds at least \p nitems of size \p sizeof_item.
*
* \param nitems is the minimum number of items the buffer will hold.
* \param sizeof_item is the size of an item in bytes.
* \param downstream_lcm_nitems is the least common multiple of the items to
* read by downstream blocks
* \param downstream_max_out_mult is the maximum output multiple of all
* downstream blocks
* \param link is the block that writes to this buffer.
*
* The total size of the buffer will be rounded up to a system
* dependent boundary. This is typically the system page size, but
* under MS windows is 64KB.
*/
buffer_double_mapped(int nitems,
size_t sizeof_item,
uint64_t downstream_lcm_nitems,
uint32_t downstream_max_out_mult,
block_sptr link);
};
} /* namespace gr */
#endif /* INCLUDED_GR_RUNTIME_BUFFER_DOUBLE_MAPPED_H */
buffer.h
buffer_type.h
gr::buffer_double_mapped::index_sub
unsigned index_sub(unsigned a, unsigned b) override
Decrement read or write index for this buffer.
Definition buffer_double_mapped.h:74
gr::buffer_double_mapped::index_add
unsigned index_add(unsigned a, unsigned b) override
Increment read or write index for this buffer.
Definition buffer_double_mapped.h:63
gr::buffer_double_mapped::make_buffer
friend GR_RUNTIME_API buffer_sptr make_buffer(int nitems, size_t sizeof_item, uint64_t downstream_lcm_nitems, block_sptr link, block_sptr buf_owner)
gr::buffer_double_mapped::make_buffer_double_mapped
friend GR_RUNTIME_API buffer_sptr make_buffer_double_mapped(int nitems, size_t sizeof_item, uint64_t downstream_lcm_nitems, uint32_t downstream_max_out_mult, block_sptr link, block_sptr buf_owner)
gr::buffer_double_mapped::~buffer_double_mapped
~buffer_double_mapped() override
gr::buffer_double_mapped::allocate_buffer
bool allocate_buffer(int nitems) override
gr::buffer_double_mapped::d_debug_logger
gr::logger_ptr d_debug_logger
Definition buffer_double_mapped.h:41
gr::buffer_double_mapped::d_logger
gr::logger_ptr d_logger
Definition buffer_double_mapped.h:40
gr::buffer_double_mapped::buffer_reader
friend class buffer_reader
Definition buffer_double_mapped.h:86
gr::buffer_double_mapped::make_buffer
static buffer_sptr make_buffer(int nitems, size_t sizeof_item, uint64_t downstream_lcm_nitems, uint32_t downstream_max_out_mult, block_sptr link=block_sptr(), block_sptr buf_owner=block_sptr())
gr::buffer_double_mapped::type
static buffer_type type
Definition buffer_double_mapped.h:31
gr::buffer_double_mapped::space_available
int space_available() override
return number of items worth of space available for writing
gr::buffer_double_mapped::post_work
void post_work(int nitems) override
Definition buffer_double_mapped.h:54
gr::buffer::d_bufsize
unsigned int d_bufsize
Definition buffer.h:295
gr::buffer::link
block_sptr link()
Return the block that writes to this buffer.
Definition buffer.h:120
gr::buffer::buffer
buffer(buffer_mapping_type buftype, int nitems, size_t sizeof_item, uint64_t downstream_lcm_nitems, uint32_t downstream_max_out_mult, block_sptr link)
constructor is private. Use gr_make_buffer to create instances.
api.h
GR_RUNTIME_API
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:18
logger.h
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
gr::buffer_type
const buffer_type_base & buffer_type
Definition buffer_type.h:85
gr::logger_ptr
std::shared_ptr< logger > logger_ptr
Definition logger.h:250
runtime_types.h