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());
 
    ~buffer_double_mapped() override;
 
    /*!
     * \brief return the buffer's buffer_type
     */
    buffer_type get_buffer_type() const override { return buffer_double_mapped::type; }
 
    /*!
     * \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;
 
protected:
    /*!
     * \brief constructor is protected.  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);
 
    /*!
     * \brief Tag type for derived-class constructors that handle their own
     *        buffer allocation (skipping the default vmcircbuf path).
     */
    enum class defer_alloc_t { defer_alloc };
 
    /*!
     * \brief Protected constructor that defers buffer allocation.
     *
     * Initialises the base buffer state and loggers but does NOT call
     * allocate_buffer().  Derived classes that provide their own memory
     * (e.g. CUDA VMM) use this constructor and perform allocation in
     * their own constructor body, where virtual dispatch is available.
     */
    buffer_double_mapped(int nitems,
                         size_t sizeof_item,
                         uint64_t downstream_lcm_nitems,
                         uint32_t downstream_max_out_mult,
                         block_sptr link,
                         defer_alloc_t);
};
 
} /* namespace gr */
 
 
#endif /* INCLUDED_GR_RUNTIME_BUFFER_DOUBLE_MAPPED_H */