Blame src/shared/ringbuf.c

Packit 34410b
/*
Packit 34410b
 *
Packit 34410b
 *  BlueZ - Bluetooth protocol stack for Linux
Packit 34410b
 *
Packit 34410b
 *  Copyright (C) 2012-2014  Intel Corporation. All rights reserved.
Packit 34410b
 *
Packit 34410b
 *
Packit 34410b
 *  This library is free software; you can redistribute it and/or
Packit 34410b
 *  modify it under the terms of the GNU Lesser General Public
Packit 34410b
 *  License as published by the Free Software Foundation; either
Packit 34410b
 *  version 2.1 of the License, or (at your option) any later version.
Packit 34410b
 *
Packit 34410b
 *  This library is distributed in the hope that it will be useful,
Packit 34410b
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 34410b
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 34410b
 *  Lesser General Public License for more details.
Packit 34410b
 *
Packit 34410b
 *  You should have received a copy of the GNU Lesser General Public
Packit 34410b
 *  License along with this library; if not, write to the Free Software
Packit 34410b
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
Packit 34410b
 *
Packit 34410b
 */
Packit 34410b
Packit 34410b
#ifdef HAVE_CONFIG_H
Packit 34410b
#include <config.h>
Packit 34410b
#endif
Packit 34410b
Packit 34410b
#define _GNU_SOURCE
Packit 34410b
#include <stdio.h>
Packit 34410b
#include <string.h>
Packit 34410b
#include <sys/uio.h>
Packit 34410b
#include <sys/param.h>
Packit 34410b
Packit 34410b
#include "src/shared/util.h"
Packit 34410b
#include "src/shared/ringbuf.h"
Packit 34410b
Packit 34410b
#ifndef MIN
Packit 34410b
#define MIN(x,y) ((x)<(y)?(x):(y))
Packit 34410b
#endif
Packit 34410b
Packit 34410b
struct ringbuf {
Packit 34410b
	void *buffer;
Packit 34410b
	size_t size;
Packit 34410b
	size_t in;
Packit 34410b
	size_t out;
Packit 34410b
	ringbuf_tracing_func_t in_tracing;
Packit 34410b
	void *in_data;
Packit 34410b
};
Packit 34410b
Packit 34410b
#define RINGBUF_RESET 0
Packit 34410b
Packit 34410b
/* Find last (most siginificant) set bit */
Packit 34410b
static inline unsigned int fls(unsigned int x)
Packit 34410b
{
Packit 34410b
	return x ? sizeof(x) * 8 - __builtin_clz(x) : 0;
Packit 34410b
}
Packit 34410b
Packit 34410b
/* Round up to nearest power of two */
Packit 34410b
static inline unsigned int align_power2(unsigned int u)
Packit 34410b
{
Packit 34410b
	return 1 << fls(u - 1);
Packit 34410b
}
Packit 34410b
Packit 34410b
struct ringbuf *ringbuf_new(size_t size)
Packit 34410b
{
Packit 34410b
	struct ringbuf *ringbuf;
Packit 34410b
	size_t real_size;
Packit 34410b
Packit 34410b
	if (size < 2 || size > UINT_MAX)
Packit 34410b
		return NULL;
Packit 34410b
Packit 34410b
	/* Find the next power of two for size */
Packit 34410b
	real_size = align_power2(size);
Packit 34410b
Packit 34410b
	ringbuf = new0(struct ringbuf, 1);
Packit 34410b
	ringbuf->buffer = malloc(real_size);
Packit 34410b
	if (!ringbuf->buffer) {
Packit 34410b
		free(ringbuf);
Packit 34410b
		return NULL;
Packit 34410b
	}
Packit 34410b
Packit 34410b
	ringbuf->size = real_size;
Packit 34410b
	ringbuf->in = RINGBUF_RESET;
Packit 34410b
	ringbuf->out = RINGBUF_RESET;
Packit 34410b
Packit 34410b
	return ringbuf;
Packit 34410b
}
Packit 34410b
Packit 34410b
void ringbuf_free(struct ringbuf *ringbuf)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return;
Packit 34410b
Packit 34410b
	free(ringbuf->buffer);
Packit 34410b
	free(ringbuf);
Packit 34410b
}
Packit 34410b
Packit 34410b
bool ringbuf_set_input_tracing(struct ringbuf *ringbuf,
Packit 34410b
			ringbuf_tracing_func_t callback, void *user_data)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return false;
Packit 34410b
Packit 34410b
	ringbuf->in_tracing = callback;
Packit 34410b
	ringbuf->in_data = user_data;
Packit 34410b
Packit 34410b
	return true;
Packit 34410b
}
Packit 34410b
Packit 34410b
size_t ringbuf_capacity(struct ringbuf *ringbuf)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	return ringbuf->size;
Packit 34410b
}
Packit 34410b
Packit 34410b
size_t ringbuf_len(struct ringbuf *ringbuf)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	return ringbuf->in - ringbuf->out;
Packit 34410b
}
Packit 34410b
Packit 34410b
size_t ringbuf_drain(struct ringbuf *ringbuf, size_t count)
Packit 34410b
{
Packit 34410b
	size_t len;
Packit 34410b
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	len = MIN(count, ringbuf->in - ringbuf->out);
Packit 34410b
	if (!len)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	ringbuf->out += len;
Packit 34410b
Packit 34410b
	if (ringbuf->out == ringbuf->in) {
Packit 34410b
		ringbuf->in = RINGBUF_RESET;
Packit 34410b
		ringbuf->out = RINGBUF_RESET;
Packit 34410b
	}
Packit 34410b
Packit 34410b
	return len;
Packit 34410b
}
Packit 34410b
Packit 34410b
void *ringbuf_peek(struct ringbuf *ringbuf, size_t offset, size_t *len_nowrap)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return NULL;
Packit 34410b
Packit 34410b
	offset = (ringbuf->out + offset) & (ringbuf->size - 1);
Packit 34410b
Packit 34410b
	if (len_nowrap) {
Packit 34410b
		size_t len = ringbuf->in - ringbuf->out;
Packit 34410b
		*len_nowrap = MIN(len, ringbuf->size - offset);
Packit 34410b
	}
Packit 34410b
Packit 34410b
	return ringbuf->buffer + offset;
Packit 34410b
}
Packit 34410b
Packit 34410b
ssize_t ringbuf_write(struct ringbuf *ringbuf, int fd)
Packit 34410b
{
Packit 34410b
	size_t len, offset, end;
Packit 34410b
	struct iovec iov[2];
Packit 34410b
	ssize_t consumed;
Packit 34410b
Packit 34410b
	if (!ringbuf || fd < 0)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	/* Determine how much data is available */
Packit 34410b
	len = ringbuf->in - ringbuf->out;
Packit 34410b
	if (!len)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	/* Grab data from buffer starting at offset until the end */
Packit 34410b
	offset = ringbuf->out & (ringbuf->size - 1);
Packit 34410b
	end = MIN(len, ringbuf->size - offset);
Packit 34410b
Packit 34410b
	iov[0].iov_base = ringbuf->buffer + offset;
Packit 34410b
	iov[0].iov_len = end;
Packit 34410b
Packit 34410b
	/* Use second vector for remainder from the beginning */
Packit 34410b
	iov[1].iov_base = ringbuf->buffer;
Packit 34410b
	iov[1].iov_len = len - end;
Packit 34410b
Packit 34410b
	consumed = writev(fd, iov, 2);
Packit 34410b
	if (consumed < 0)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	ringbuf->out += consumed;
Packit 34410b
Packit 34410b
	if (ringbuf->out == ringbuf->in) {
Packit 34410b
		ringbuf->in = RINGBUF_RESET;
Packit 34410b
		ringbuf->out = RINGBUF_RESET;
Packit 34410b
	}
Packit 34410b
Packit 34410b
	return consumed;
Packit 34410b
}
Packit 34410b
Packit 34410b
size_t ringbuf_avail(struct ringbuf *ringbuf)
Packit 34410b
{
Packit 34410b
	if (!ringbuf)
Packit 34410b
		return 0;
Packit 34410b
Packit 34410b
	return ringbuf->size - ringbuf->in + ringbuf->out;
Packit 34410b
}
Packit 34410b
Packit 34410b
int ringbuf_printf(struct ringbuf *ringbuf, const char *format, ...)
Packit 34410b
{
Packit 34410b
	va_list ap;
Packit 34410b
	int len;
Packit 34410b
Packit 34410b
	va_start(ap, format);
Packit 34410b
	len = ringbuf_vprintf(ringbuf, format, ap);
Packit 34410b
	va_end(ap);
Packit 34410b
Packit 34410b
	return len;
Packit 34410b
}
Packit 34410b
Packit 34410b
int ringbuf_vprintf(struct ringbuf *ringbuf, const char *format, va_list ap)
Packit 34410b
{
Packit 34410b
	size_t avail, offset, end;
Packit 34410b
	char *str;
Packit 34410b
	int len;
Packit 34410b
Packit 34410b
	if (!ringbuf || !format)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	/* Determine maximum length available for string */
Packit 34410b
	avail = ringbuf->size - ringbuf->in + ringbuf->out;
Packit 34410b
	if (!avail)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	len = vasprintf(&str, format, ap);
Packit 34410b
	if (len < 0)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	if ((size_t) len > avail) {
Packit 34410b
		free(str);
Packit 34410b
		return -1;
Packit 34410b
	}
Packit 34410b
Packit 34410b
	/* Determine possible length of string before wrapping */
Packit 34410b
	offset = ringbuf->in & (ringbuf->size - 1);
Packit 34410b
	end = MIN((size_t) len, ringbuf->size - offset);
Packit 34410b
	memcpy(ringbuf->buffer + offset, str, end);
Packit 34410b
Packit 34410b
	if (ringbuf->in_tracing)
Packit 34410b
		ringbuf->in_tracing(ringbuf->buffer + offset, end,
Packit 34410b
							ringbuf->in_data);
Packit 34410b
Packit 34410b
	if (len - end > 0) {
Packit 34410b
		/* Put the remainder of string at the beginning */
Packit 34410b
		memcpy(ringbuf->buffer, str + end, len - end);
Packit 34410b
Packit 34410b
		if (ringbuf->in_tracing)
Packit 34410b
			ringbuf->in_tracing(ringbuf->buffer, len - end,
Packit 34410b
							ringbuf->in_data);
Packit 34410b
	}
Packit 34410b
Packit 34410b
	free(str);
Packit 34410b
Packit 34410b
	ringbuf->in += len;
Packit 34410b
Packit 34410b
	return len;
Packit 34410b
}
Packit 34410b
Packit 34410b
ssize_t ringbuf_read(struct ringbuf *ringbuf, int fd)
Packit 34410b
{
Packit 34410b
	size_t avail, offset, end;
Packit 34410b
	struct iovec iov[2];
Packit 34410b
	ssize_t consumed;
Packit 34410b
Packit 34410b
	if (!ringbuf || fd < 0)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	/* Determine how much can actually be consumed */
Packit 34410b
	avail = ringbuf->size - ringbuf->in + ringbuf->out;
Packit 34410b
	if (!avail)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	/* Determine how much to consume before wrapping */
Packit 34410b
	offset = ringbuf->in & (ringbuf->size - 1);
Packit 34410b
	end = MIN(avail, ringbuf->size - offset);
Packit 34410b
Packit 34410b
	iov[0].iov_base = ringbuf->buffer + offset;
Packit 34410b
	iov[0].iov_len = end;
Packit 34410b
Packit 34410b
	/* Now put the remainder into the second vector */
Packit 34410b
	iov[1].iov_base = ringbuf->buffer;
Packit 34410b
	iov[1].iov_len = avail - end;
Packit 34410b
Packit 34410b
	consumed = readv(fd, iov, 2);
Packit 34410b
	if (consumed < 0)
Packit 34410b
		return -1;
Packit 34410b
Packit 34410b
	if (ringbuf->in_tracing) {
Packit 34410b
		size_t len = MIN((size_t) consumed, end);
Packit 34410b
		ringbuf->in_tracing(ringbuf->buffer + offset, len,
Packit 34410b
							ringbuf->in_data);
Packit 34410b
		if (consumed - len > 0)
Packit 34410b
			ringbuf->in_tracing(ringbuf->buffer, consumed - len,
Packit 34410b
							ringbuf->in_data);
Packit 34410b
	}
Packit 34410b
Packit 34410b
	ringbuf->in += consumed;
Packit 34410b
Packit 34410b
	return consumed;
Packit 34410b
}