USRP Hardware Driver and USRP Manual: zero_copy.hpp Source File

| USRP Hardware Driver and USRP Manual Version: 4.9.0.makepkg-0-g9ec1f582 UHD and USRP Manual |

Loading...
Searching...
No Matches
zero_copy.hpp
Go to the documentation of this file.
1//
2// Copyright 2010-2012,2015 Ettus Research LLC
3// Copyright 2018 Ettus Research, a National Instruments Company
4//
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
7
8#pragma once
9
10#include <uhd/config.hpp>
11#include <uhd/utils/noncopyable.hpp>
12#include <boost/intrusive_ptr.hpp>
13#include <boost/smart_ptr/detail/atomic_count.hpp>
14#include <boost/utility.hpp>
15#include <memory>
16
17namespace uhd { namespace transport {
18
20 class UHD_API managed_buffer
21{
22public:
23 managed_buffer(void) : _ref_count(0), _buffer(NULL), _length(0) {}
24
25 virtual ~managed_buffer(void) {}
26
32 virtual void release(void) = 0;
33
38 UHD_INLINE void commit(size_t num_bytes)
39 {
40 _length = num_bytes;
41 }
42
47 template <class T>
48 UHD_INLINE T cast(void) const
49 {
50 return static_cast<T>(_buffer);
51 }
52
57 UHD_INLINE size_t size(void) const
58 {
59 return _length;
60 }
61
63 template <typename T>
64 UHD_INLINE boost::intrusive_ptr<T> make(T* p, void* buffer, size_t length)
65 {
66 _buffer = buffer;
67 _length = length;
68 return boost::intrusive_ptr<T>(p);
69 }
70
71 boost::detail::atomic_count _ref_count;
72 typedef boost::intrusive_ptr<managed_buffer> sptr;
73
74 int ref_count()
75 {
76 return (int)_ref_count;
77 }
78
79protected:
80 void* _buffer;
81 size_t _length;
82
83private:
84};
85
86 UHD_INLINE void intrusive_ptr_add_ref(managed_buffer* p)
87{
88 ++(p->_ref_count);
89}
90
91 UHD_INLINE void intrusive_ptr_release(managed_buffer* p)
92{
93 if (--(p->_ref_count) == 0)
94 p->release();
95}
96
102 class UHD_API managed_recv_buffer : public managed_buffer
103{
104public:
105 typedef boost::intrusive_ptr<managed_recv_buffer> sptr;
106};
107
113 class UHD_API managed_send_buffer : public managed_buffer
114{
115public:
116 typedef boost::intrusive_ptr<managed_send_buffer> sptr;
117};
118
122 struct zero_copy_xport_params
123{
124 zero_copy_xport_params()
125 : recv_frame_size(0)
126 , send_frame_size(0)
127 , num_recv_frames(0)
128 , num_send_frames(0)
129 , recv_buff_size(0)
130 , send_buff_size(0)
131 { /* NOP */
132 }
133 size_t recv_frame_size;
134 size_t send_frame_size;
135 size_t num_recv_frames;
136 size_t num_send_frames;
137 size_t recv_buff_size;
138 size_t send_buff_size;
139};
140
146 class UHD_API zero_copy_if : uhd::noncopyable
147{
148public:
149 typedef std::shared_ptr<zero_copy_if> sptr;
150
154 virtual ~zero_copy_if(){};
155
161 virtual managed_recv_buffer::sptr get_recv_buff(double timeout = 0.1) = 0;
162
168 virtual size_t get_num_recv_frames(void) const = 0;
169
175 virtual size_t get_recv_frame_size(void) const = 0;
176
182 virtual managed_send_buffer::sptr get_send_buff(double timeout = 0.1) = 0;
183
189 virtual size_t get_num_send_frames(void) const = 0;
190
196 virtual size_t get_send_frame_size(void) const = 0;
197};
198
199}} // namespace uhd::transport
uhd::transport::managed_buffer
Simple managed buffer with release interface.
Definition zero_copy.hpp:21
uhd::transport::managed_buffer::ref_count
int ref_count()
Definition zero_copy.hpp:74
uhd::transport::managed_buffer::commit
UHD_INLINE void commit(size_t num_bytes)
Definition zero_copy.hpp:38
uhd::transport::managed_buffer::_ref_count
boost::detail::atomic_count _ref_count
Definition zero_copy.hpp:71
uhd::transport::managed_buffer::managed_buffer
managed_buffer(void)
Definition zero_copy.hpp:23
uhd::transport::managed_buffer::_length
size_t _length
Definition zero_copy.hpp:81
uhd::transport::managed_buffer::~managed_buffer
virtual ~managed_buffer(void)
Definition zero_copy.hpp:25
uhd::transport::managed_buffer::size
UHD_INLINE size_t size(void) const
Definition zero_copy.hpp:57
uhd::transport::managed_buffer::make
UHD_INLINE boost::intrusive_ptr< T > make(T *p, void *buffer, size_t length)
Create smart pointer to a reusable managed buffer.
Definition zero_copy.hpp:64
uhd::transport::managed_buffer::sptr
boost::intrusive_ptr< managed_buffer > sptr
Definition zero_copy.hpp:72
uhd::transport::managed_buffer::_buffer
void * _buffer
Definition zero_copy.hpp:80
uhd::transport::managed_buffer::cast
UHD_INLINE T cast(void) const
Definition zero_copy.hpp:48
uhd::transport::managed_buffer::release
virtual void release(void)=0
uhd::transport::managed_recv_buffer
Definition zero_copy.hpp:103
uhd::transport::managed_recv_buffer::sptr
boost::intrusive_ptr< managed_recv_buffer > sptr
Definition zero_copy.hpp:105
uhd::transport::managed_send_buffer
Definition zero_copy.hpp:114
uhd::transport::managed_send_buffer::sptr
boost::intrusive_ptr< managed_send_buffer > sptr
Definition zero_copy.hpp:116
uhd::transport::zero_copy_if
Definition zero_copy.hpp:147
uhd::transport::zero_copy_if::get_send_buff
virtual managed_send_buffer::sptr get_send_buff(double timeout=0.1)=0
uhd::transport::zero_copy_if::get_num_send_frames
virtual size_t get_num_send_frames(void) const =0
uhd::transport::zero_copy_if::get_recv_buff
virtual managed_recv_buffer::sptr get_recv_buff(double timeout=0.1)=0
uhd::transport::zero_copy_if::sptr
std::shared_ptr< zero_copy_if > sptr
Definition zero_copy.hpp:149
uhd::transport::zero_copy_if::get_recv_frame_size
virtual size_t get_recv_frame_size(void) const =0
uhd::transport::zero_copy_if::get_send_frame_size
virtual size_t get_send_frame_size(void) const =0
uhd::transport::zero_copy_if::~zero_copy_if
virtual ~zero_copy_if()
Definition zero_copy.hpp:154
uhd::transport::zero_copy_if::get_num_recv_frames
virtual size_t get_num_recv_frames(void) const =0
UHD_INLINE
#define UHD_INLINE
Definition config.h:65
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
uhd::transport
Definition adapter_id.hpp:11
uhd::transport::intrusive_ptr_add_ref
UHD_INLINE void intrusive_ptr_add_ref(managed_buffer *p)
Definition zero_copy.hpp:86
uhd::transport::intrusive_ptr_release
UHD_INLINE void intrusive_ptr_release(managed_buffer *p)
Definition zero_copy.hpp:91
uhd
Definition build_info.hpp:12
uhd::noncopyable
boost::noncopyable noncopyable
Definition noncopyable.hpp:45
noncopyable.hpp
uhd::transport::zero_copy_xport_params::num_recv_frames
size_t num_recv_frames
Definition zero_copy.hpp:135
uhd::transport::zero_copy_xport_params::recv_frame_size
size_t recv_frame_size
Definition zero_copy.hpp:133
uhd::transport::zero_copy_xport_params::send_buff_size
size_t send_buff_size
Definition zero_copy.hpp:138
uhd::transport::zero_copy_xport_params::send_frame_size
size_t send_frame_size
Definition zero_copy.hpp:134
uhd::transport::zero_copy_xport_params::recv_buff_size
size_t recv_buff_size
Definition zero_copy.hpp:137
uhd::transport::zero_copy_xport_params::zero_copy_xport_params
zero_copy_xport_params()
Definition zero_copy.hpp:124
uhd::transport::zero_copy_xport_params::num_send_frames
size_t num_send_frames
Definition zero_copy.hpp:136