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
|
/* -*- c++ -*- */
/*
* Copyright 2003,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef GR_VMCIRCBUF_H
#define GR_VMCIRCBUF_H
#include <gnuradio/api.h>
#include <gnuradio/thread/thread.h>
#include <vector>
extern gr::thread::mutex s_vm_mutex;
namespace gr {
/*!
* \brief abstract class to implement doubly mapped virtual memory circular buffers
* \ingroup internal
*/
class GR_RUNTIME_API vmcircbuf
{
protected:
int d_size;
char *d_base;
// CREATORS
vmcircbuf(int size) : d_size(size), d_base(0) {};
public:
virtual ~vmcircbuf();
// ACCESSORS
void *pointer_to_first_copy() const{ return d_base; }
void *pointer_to_second_copy() const{ return d_base + d_size; }
};
/*!
* \brief abstract factory for creating circular buffers
*/
class GR_RUNTIME_API vmcircbuf_factory
{
protected:
vmcircbuf_factory() {};
virtual ~vmcircbuf_factory();
public:
/*!
* \brief return name of this factory
*/
virtual const char *name() const = 0;
/*!
* \brief return granularity of mapping, typically equal to page size
*/
virtual int granularity() = 0;
/*!
* \brief return a gr::vmcircbuf, or 0 if unable.
*
* Call this to create a doubly mapped circular buffer.
*/
virtual vmcircbuf *make(int size) = 0;
};
/*
* \brief pulls together all implementations of gr::vmcircbuf
*/
class GR_RUNTIME_API vmcircbuf_sysconfig
{
public:
/*
* \brief return the single instance of the default factory.
*
* returns the default factory to use if it's already defined,
* else find the first working factory and use it.
*/
static vmcircbuf_factory *get_default_factory();
static int granularity() { return get_default_factory()->granularity(); }
static vmcircbuf *make(int size) { return get_default_factory()->make(size); }
// N.B. not all factories are guaranteed to work.
// It's too hard to check everything at config time, so we check at runtime
static std::vector<vmcircbuf_factory*> all_factories();
// make this factory the default
static void set_default_factory(vmcircbuf_factory *f);
/*!
* \brief Does this factory really work?
*
* verbose = 0: silent
* verbose = 1: names of factories tested and results
* verbose = 2: all intermediate results
*/
static bool test_factory(vmcircbuf_factory *f, int verbose);
/*!
* \brief Test all factories, return true if at least one of them works
* verbose = 0: silent
* verbose = 1: names of factories tested and results
* verbose = 2: all intermediate results
*/
static bool test_all_factories(int verbose);
};
} /* namespace gr */
#endif /* GR_VMCIRCBUF_H */
|
