<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>RAUL: RingBuffer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>RingBuffer.hpp</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of Raul.</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 David Robillard <http://drobilla.net></span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Raul is free software; you can redistribute it and/or modify it under the</span>
<a name="l00005"></a>00005 <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span>
<a name="l00006"></a>00006 <span class="comment"> * Foundation; either version 2 of the License, or (at your option) any later</span>
<a name="l00007"></a>00007 <span class="comment"> * version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Raul is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00010"></a>00010 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00011"></a>00011 <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00014"></a>00014 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00015"></a>00015 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef RAUL_RING_BUFFER_HPP</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define RAUL_RING_BUFFER_HPP</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <cassert></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <cstring></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <cstdlib></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <iostream></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <glib.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "raul/log.hpp"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>Raul {
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00035"></a>00035 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00036"></a><a class="code" href="classRaul_1_1RingBuffer.html">00036</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a> {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00040"></a><a class="code" href="classRaul_1_1RingBuffer.html#ac0700662407afe3fa5049e10a465d5bc">00040</a> <a class="code" href="classRaul_1_1RingBuffer.html#ac0700662407afe3fa5049e10a465d5bc">RingBuffer</a>(<span class="keywordtype">size_t</span> size)
<a name="l00041"></a>00041 : <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>(size)
<a name="l00042"></a>00042 , <a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>(static_cast<char*>(malloc(size)))
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <a class="code" href="classRaul_1_1RingBuffer.html#aeb1cfff7e8ffa799d01c4d51e48ce829" title="Reset(empty) the ringbuffer.">reset</a>();
<a name="l00045"></a>00045 assert(read_space() == 0);
<a name="l00046"></a>00046 assert(write_space() == size - 1);
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">virtual</span> ~<a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer</a>() {
<a name="l00050"></a>00050 free(<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>);
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052
<a name="l00056"></a><a class="code" href="classRaul_1_1RingBuffer.html#aeb1cfff7e8ffa799d01c4d51e48ce829">00056</a> <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1RingBuffer.html#aeb1cfff7e8ffa799d01c4d51e48ce829" title="Reset(empty) the ringbuffer.">reset</a>() {
<a name="l00057"></a>00057 g_atomic_int_set(&_write_ptr, 0);
<a name="l00058"></a>00058 g_atomic_int_set(&_read_ptr, 0);
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keywordtype">size_t</span> write_space()<span class="keyword"> const </span>{
<a name="l00062"></a>00062 <span class="keyword">const</span> <span class="keywordtype">size_t</span> w = g_atomic_int_get(&_write_ptr);
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">size_t</span> r = g_atomic_int_get(&_read_ptr);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordflow">if</span> (w > r) {
<a name="l00066"></a>00066 <span class="keywordflow">return</span> ((r - w + <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>) % <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>) - 1;
<a name="l00067"></a>00067 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (w < r) {
<a name="l00068"></a>00068 <span class="keywordflow">return</span> (r - w) - 1;
<a name="l00069"></a>00069 } <span class="keywordflow">else</span> {
<a name="l00070"></a>00070 <span class="keywordflow">return</span> <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a> - 1;
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072 }
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keywordtype">size_t</span> read_space()<span class="keyword"> const </span>{
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">size_t</span> w = g_atomic_int_get(&_write_ptr);
<a name="l00076"></a>00076 <span class="keyword">const</span> <span class="keywordtype">size_t</span> r = g_atomic_int_get(&_read_ptr);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordflow">if</span> (w > r) {
<a name="l00079"></a>00079 <span class="keywordflow">return</span> w - r;
<a name="l00080"></a>00080 } <span class="keywordflow">else</span> {
<a name="l00081"></a>00081 <span class="keywordflow">return</span> (w - r + <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>) % <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>;
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keywordtype">size_t</span> capacity()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>; }
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordtype">size_t</span> <a class="code" href="classRaul_1_1RingBuffer.html#a0473dcfb13214088e5296df68bcd3b92" title="Peek at the ringbuffer (read w/o advancing read pointer).">peek</a>(<span class="keywordtype">size_t</span> size, T* dst);
<a name="l00088"></a>00088 <span class="keywordtype">bool</span> full_peek(<span class="keywordtype">size_t</span> size, T* dst);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">size_t</span> <a class="code" href="classRaul_1_1RingBuffer.html#a99cd33072ab3af795acc9a30fe931a1b" title="Read from the ringbuffer.">read</a>(<span class="keywordtype">size_t</span> size, T* dst);
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> full_read(<span class="keywordtype">size_t</span> size, T* dst);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">bool</span> skip(<span class="keywordtype">size_t</span> size);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordtype">void</span> write(<span class="keywordtype">size_t</span> size, <span class="keyword">const</span> T* src);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">protected</span>:
<a name="l00098"></a>00098 <span class="keyword">mutable</span> <span class="keywordtype">int</span> _write_ptr;
<a name="l00099"></a>00099 <span class="keyword">mutable</span> <span class="keywordtype">int</span> _read_ptr;
<a name="l00100"></a>00100
<a name="l00101"></a><a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581">00101</a> <span class="keywordtype">size_t</span> <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>;
<a name="l00102"></a><a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0">00102</a> <span class="keywordtype">char</span>* <a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>;
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105
<a name="l00112"></a>00112 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00113"></a>00113 <span class="keywordtype">size_t</span>
<a name="l00114"></a><a class="code" href="classRaul_1_1RingBuffer.html#a0473dcfb13214088e5296df68bcd3b92">00114</a> <a class="code" href="classRaul_1_1RingBuffer.html#a0473dcfb13214088e5296df68bcd3b92" title="Peek at the ringbuffer (read w/o advancing read pointer).">RingBuffer<T>::peek</a>(<span class="keywordtype">size_t</span> size, T* dst)
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116 <span class="keyword">const</span> <span class="keywordtype">size_t</span> priv_read_ptr = g_atomic_int_get(&_read_ptr);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">const</span> <span class="keywordtype">size_t</span> read_size = (priv_read_ptr + size < <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>)
<a name="l00119"></a>00119 ? size
<a name="l00120"></a>00120 : <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a> - priv_read_ptr;
<a name="l00121"></a>00121
<a name="l00122"></a>00122 memcpy(dst, &<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>[priv_read_ptr], read_size);
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordflow">return</span> read_size;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00129"></a>00129 <span class="keywordtype">bool</span>
<a name="l00130"></a>00130 <a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer<T>::full_peek</a>(<span class="keywordtype">size_t</span> size, T* dst)
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <span class="keywordflow">if</span> (read_space() < size) {
<a name="l00133"></a>00133 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00134"></a>00134 }
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">const</span> <span class="keywordtype">size_t</span> read_size = <a class="code" href="classRaul_1_1RingBuffer.html#a0473dcfb13214088e5296df68bcd3b92" title="Peek at the ringbuffer (read w/o advancing read pointer).">peek</a>(size, dst);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="keywordflow">if</span> (read_size < size) {
<a name="l00139"></a>00139 <a class="code" href="classRaul_1_1RingBuffer.html#a0473dcfb13214088e5296df68bcd3b92" title="Peek at the ringbuffer (read w/o advancing read pointer).">peek</a>(size - read_size, dst + read_size);
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145
<a name="l00152"></a>00152 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00153"></a>00153 <span class="keywordtype">size_t</span>
<a name="l00154"></a><a class="code" href="classRaul_1_1RingBuffer.html#a99cd33072ab3af795acc9a30fe931a1b">00154</a> <a class="code" href="classRaul_1_1RingBuffer.html#a99cd33072ab3af795acc9a30fe931a1b" title="Read from the ringbuffer.">RingBuffer<T>::read</a>(<span class="keywordtype">size_t</span> size, T* dst)
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 <span class="keyword">const</span> <span class="keywordtype">size_t</span> priv_read_ptr = g_atomic_int_get(&_read_ptr);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">const</span> <span class="keywordtype">size_t</span> read_size = (priv_read_ptr + size < <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>)
<a name="l00159"></a>00159 ? size
<a name="l00160"></a>00160 : <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a> - priv_read_ptr;
<a name="l00161"></a>00161
<a name="l00162"></a>00162 memcpy(dst, &<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>[priv_read_ptr], read_size);
<a name="l00163"></a>00163
<a name="l00164"></a>00164 g_atomic_int_set(&_read_ptr, (priv_read_ptr + read_size) % <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="keywordflow">return</span> read_size;
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00171"></a>00171 <span class="keywordtype">bool</span>
<a name="l00172"></a>00172 <a class="code" href="classRaul_1_1RingBuffer.html" title="A lock-free RingBuffer.">RingBuffer<T>::full_read</a>(<span class="keywordtype">size_t</span> size, T* dst)
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="keywordflow">if</span> (read_space() < size) {
<a name="l00175"></a>00175 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keyword">const</span> <span class="keywordtype">size_t</span> read_size = <a class="code" href="classRaul_1_1RingBuffer.html#a99cd33072ab3af795acc9a30fe931a1b" title="Read from the ringbuffer.">read</a>(size, dst);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keywordflow">if</span> (read_size < size) {
<a name="l00181"></a>00181 <a class="code" href="classRaul_1_1RingBuffer.html#a99cd33072ab3af795acc9a30fe931a1b" title="Read from the ringbuffer.">read</a>(size - read_size, dst + read_size);
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183
<a name="l00184"></a>00184 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00189"></a>00189 <span class="keywordtype">bool</span>
<a name="l00190"></a>00190 RingBuffer<T>::skip(<span class="keywordtype">size_t</span> size)
<a name="l00191"></a>00191 {
<a name="l00192"></a>00192 <span class="keywordflow">if</span> (read_space() < size) {
<a name="l00193"></a>00193 warn << <span class="stringliteral">"Attempt to skip past end of RingBuffer"</span> << std::endl;
<a name="l00194"></a>00194 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="keyword">const</span> <span class="keywordtype">size_t</span> priv_read_ptr = g_atomic_int_get(&_read_ptr);
<a name="l00198"></a>00198 g_atomic_int_set(&_read_ptr, (priv_read_ptr + size) % <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>);
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00205"></a>00205 <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00206"></a>00206 RingBuffer<T>::write(<span class="keywordtype">size_t</span> size, <span class="keyword">const</span> T* src)
<a name="l00207"></a>00207 {
<a name="l00208"></a>00208 <span class="keyword">const</span> <span class="keywordtype">size_t</span> priv_write_ptr = g_atomic_int_get(&_write_ptr);
<a name="l00209"></a>00209
<a name="l00210"></a>00210 <span class="keywordflow">if</span> (priv_write_ptr + size <= <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>) {
<a name="l00211"></a>00211 memcpy(&<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>[priv_write_ptr], src, size);
<a name="l00212"></a>00212 g_atomic_int_set(&_write_ptr, (priv_write_ptr + size) % <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>);
<a name="l00213"></a>00213 } <span class="keywordflow">else</span> {
<a name="l00214"></a>00214 <span class="keyword">const</span> <span class="keywordtype">size_t</span> this_size = <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a> - priv_write_ptr;
<a name="l00215"></a>00215 assert(this_size < size);
<a name="l00216"></a>00216 assert(priv_write_ptr + this_size <= <a class="code" href="classRaul_1_1RingBuffer.html#af982500577bb0d4273f71aa960f73581" title="Size (capacity) in bytes.">_size</a>);
<a name="l00217"></a>00217 memcpy(&<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>[priv_write_ptr], src, this_size);
<a name="l00218"></a>00218 memcpy(&<a class="code" href="classRaul_1_1RingBuffer.html#a675f1904ea2ee8118f06dcd1403b55e0" title="Contents.">_buf</a>[0], src+this_size, size - this_size);
<a name="l00219"></a>00219 g_atomic_int_set(&_write_ptr, size - this_size);
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221 }
<a name="l00222"></a>00222
<a name="l00223"></a>00223
<a name="l00224"></a>00224 } <span class="comment">// namespace Raul</span>
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="preprocessor">#endif // RAUL_RING_BUFFER_HPP</span>
<a name="l00227"></a>00227 <span class="preprocessor"></span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
65
