This file is indexed.

/usr/include/raul/RingBuffer.hpp is in libraul-dev 0.8.0+dfsg0-0.1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/* This file is part of Raul.
 * Copyright (C) 2007-2009 David Robillard <http://drobilla.net>
 *
 * Raul 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 2 of the License, or (at your option) any later
 * version.
 *
 * Raul 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 details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef RAUL_RING_BUFFER_HPP
#define RAUL_RING_BUFFER_HPP

#include <stdint.h>

#include <cassert>
#include <cstdlib>
#include <cstring>
#include <iostream>

#include <glib.h>

#include "raul/log.hpp"

namespace Raul {


/** A lock-free RingBuffer.
 * Read/Write realtime safe.
 * Single-reader Single-writer thread safe.
 * \ingroup raul 
 */
class RingBuffer {
public:
	/** @param size Size in bytes.
	 */
	explicit RingBuffer(uint32_t size)
		: _buf(static_cast<char*>(malloc(size)))
		, _size(size)
	{
		reset();
		assert(read_space() == 0);
		assert(write_space() == size - 1);
	}

	virtual ~RingBuffer() {
		free(_buf);
	}

	/** Reset(empty) the ringbuffer.
	 * NOT thread safe.
	 */
	void reset() {
		g_atomic_int_set(&_write_ptr, 0);
		g_atomic_int_set(&_read_ptr, 0);
	}

	uint32_t write_space() const {
		const uint32_t w = g_atomic_int_get(&_write_ptr);
		const uint32_t r = g_atomic_int_get(&_read_ptr);

		if (w > r) {
			return ((r - w + _size) % _size) - 1;
		} else if (w < r) {
			return (r - w) - 1;
		} else {
			return _size - 1;
		}
	}

	uint32_t read_space() const {
		const uint32_t w = g_atomic_int_get(&_write_ptr);
		const uint32_t r = g_atomic_int_get(&_read_ptr);

		if (w > r) {
			return w - r;
		} else {
			return (w - r + _size) % _size;
		}
	}

	uint32_t capacity() const { return _size; }

	uint32_t peek(uint32_t size, void* dst);
	bool     full_peek(uint32_t size, void* dst);

	uint32_t read(uint32_t size, void* dst);
	bool     full_read(uint32_t size, void* dst);

	bool     skip(uint32_t size);

	void     write(uint32_t size, const void* src);

protected:
	mutable uint32_t _write_ptr;
	mutable uint32_t _read_ptr;

	char* const    _buf;  ///< Contents
	const uint32_t _size; ///< Size (capacity) in bytes
};


/** Peek at the ringbuffer (read w/o advancing read pointer).
 *
 * Note that a full read may not be done if the data wraps around.
 * Caller must check return value and call again if necessary, or use the
 * full_peek method which does this automatically.
 */
inline uint32_t
RingBuffer::peek(uint32_t size, void* dst)
{
	const uint32_t priv_read_ptr = g_atomic_int_get(&_read_ptr);

	const uint32_t read_size = (priv_read_ptr + size < _size)
			? size
			: _size - priv_read_ptr;

	memcpy(dst, &_buf[priv_read_ptr], read_size);

	return read_size;
}


inline bool
RingBuffer::full_peek(uint32_t size, void* dst)
{
	if (read_space() < size) {
		return false;
	}

	const uint32_t read_size = peek(size, dst);

	if (read_size < size) {
		peek(size - read_size, (char*)dst + read_size);
	}

	return true;
}


/** Read from the ringbuffer.
 *
 * Note that a full read may not be done if the data wraps around.
 * Caller must check return value and call again if necessary, or use the
 * full_read method which does this automatically.
 */
inline uint32_t
RingBuffer::read(uint32_t size, void* dst)
{
	const uint32_t priv_read_ptr = g_atomic_int_get(&_read_ptr);

	const uint32_t read_size = (priv_read_ptr + size < _size)
			? size
			: _size - priv_read_ptr;

	memcpy(dst, &_buf[priv_read_ptr], read_size);

	g_atomic_int_set(&_read_ptr, (priv_read_ptr + read_size) % _size);

	return read_size;
}


inline bool
RingBuffer::full_read(uint32_t size, void* dst)
{
	if (read_space() < size) {
		return false;
	}

	const uint32_t read_size = read(size, dst);

	if (read_size < size) {
		read(size - read_size, (char*)dst + read_size);
	}

	return true;
}


inline bool
RingBuffer::skip(uint32_t size)
{
	if (read_space() < size) {
		warn << "Attempt to skip past end of RingBuffer" << std::endl;
		return false;
	}

	const uint32_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
	g_atomic_int_set(&_read_ptr, (priv_read_ptr + size) % _size);

	return true;
}


inline void
RingBuffer::write(uint32_t size, const void* src)
{
	const uint32_t priv_write_ptr = g_atomic_int_get(&_write_ptr);

	if (priv_write_ptr + size <= _size) {
		memcpy(&_buf[priv_write_ptr], src, size);
		g_atomic_int_set(&_write_ptr, (priv_write_ptr + size) % _size);
	} else {
		const uint32_t this_size = _size - priv_write_ptr;
		assert(this_size < size);
		assert(priv_write_ptr + this_size <= _size);
		memcpy(&_buf[priv_write_ptr], src, this_size);
		memcpy(&_buf[0], (char*)src + this_size, size - this_size);
		g_atomic_int_set(&_write_ptr, size - this_size);
	}
}


} // namespace Raul

#endif // RAUL_RING_BUFFER_HPP