u-boot/lib/membuf.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (c) 2015 Google, Inc
 * Written by Simon Glass <sjg@chromium.org>
 *
 * Copyright (c) 1992 Simon Glass
 */

#include <errno.h>
#include <log.h>
#include <malloc.h>
#include <string.h>
#include <vsprintf.h>
#include "membuf.h"

static inline bool is_full(const struct membuf *mb)
{
#if MEMBUF_FULL
	return mb->full;
#else
	return false;
#endif
}

static inline void set_full(struct membuf *mb, bool full)
{
#if MEMBUF_FULL
	mb->full = full;
#endif
}

void membuf_purge(struct membuf *mb)
{
	/* set mb->head and mb->tail so the buffers look empty */
	mb->head = mb->start;
	mb->tail = mb->start;
	set_full(mb, false);
}

static int membuf_putrawflex(struct membuf *mb, int maxlen, bool update,
			     char ***data, int *offsetp)
{
	int len;

	/* always write to 'mb->head' */
	assert(data && offsetp);
	*data = &mb->start;
	*offsetp = mb->head - mb->start;

	/* if there is no buffer, we can do nothing */
	if (!mb->start)
		return 0;

	/*
	 * if head is ahead of tail, we can write from head until the end of
	 * the buffer
	 */
	if (mb->head >= mb->tail && !is_full(mb)) {
		/* work out how many bytes can fit here */
		len = mb->end - mb->head;
		if (!MEMBUF_FULL)
			len--;
		if (maxlen >= 0 && len > maxlen)
			len = maxlen;

		/* update the head pointer to mark these bytes as written */
		if (update) {
			mb->head += len;
			if (mb->head == mb->end)
				mb->head = mb->start;
			if (len && mb->head == mb->tail)
				set_full(mb, true);
		}

		/*
		 * if the tail isn't at start of the buffer, then we can
		 * write one more byte right at the end
		 */
		if (!MEMBUF_FULL && (maxlen < 0 || len < maxlen) &&
		    mb->tail != mb->start) {
			len++;
			if (update)
				mb->head = mb->start;
		}

	/* otherwise now we can write until head almost reaches tail */
	} else {
		/* work out how many bytes can fit here */
		len = mb->tail - mb->head;
		if (!MEMBUF_FULL)
			len--;
		if (maxlen >= 0 && len > maxlen)
			len = maxlen;

		/* update the head pointer to mark these bytes as written */
		if (update) {
			mb->head += len;
			if (MEMBUF_FULL && len && mb->head == mb->tail)
				set_full(mb, true);
		}
	}

	/* return the number of bytes which can be/must be written */
	return len;
}

int membuf_putraw(struct membuf *mb, int maxlen, bool update, char **data)
{
	char **datap;
	int offset;
	int size;

	size = membuf_putrawflex(mb, maxlen, update, &datap, &offset);
	*data = *datap + offset;

	return size;
}

bool membuf_putbyte(struct membuf *mb, int ch)
{
	char *data;

	if (membuf_putraw(mb, 1, true, &data) != 1)
		return false;
	*data = ch;

	return true;
}

int membuf_getraw(struct membuf *mb, int maxlen, bool update, char **data)
{
	int len;

	/* assume for now there is no data to get */
	len = 0;

	/*
	 * in this case head is ahead of tail, so we must return data between
	 *'tail' and 'head'
	 */
	if (mb->head > mb->tail) {
		/* work out the amount of data */
		*data = mb->tail;
		len = mb->head - mb->tail;

		/* check it isn't too much */
		if (maxlen >= 0 && len > maxlen)
			len = maxlen;

		/* & mark it as read from the buffer */
		if (update)
			mb->tail += len;
	}

	/*
	 * if head is before tail, then we have data between 'tail' and 'end'
	 * and some more data between 'start' and 'head'(which we can't
	 * return this time
	 */
	else if (is_full(mb) || mb->head < mb->tail) {
		/* work out the amount of data */
		*data = mb->tail;
		len = mb->end - mb->tail;
		if (maxlen >= 0 && len > maxlen)
			len = maxlen;
		if (update) {
			mb->tail += len;
			if (mb->tail == mb->end)
				mb->tail = mb->start;
			if (len)
				set_full(mb, false);
		}
	}

	debug("getraw: maxlen=%d, update=%d, head=%d, tail=%d, data=%d, len=%d",
	      maxlen, update, (int)(mb->head - mb->start),
	      (int)(mb->tail - mb->start), (int)(*data - mb->start), len);

	/* return the number of bytes we found */
	return len;
}

int membuf_getbyte(struct membuf *mb)
{
	char *data = 0;

	return membuf_getraw(mb, 1, true, &data) != 1 ? -1 : *(uint8_t *)data;
}

int membuf_peekbyte(struct membuf *mb)
{
	char *data = 0;

	return membuf_getraw(mb, 1, false, &data) != 1 ? -1 : *(uint8_t *)data;
}

int membuf_get(struct membuf *mb, char *buff, int maxlen)
{
	char *data = 0, *buffptr = buff;
	int len = 1, i;

	/*
	 * do this in up to two lots(see GetRaw for why) stopping when there
	 * is no more data
	 */
	for (i = 0; len && i < 2; i++) {
		/* get a pointer to the data available */
		len = membuf_getraw(mb, maxlen, true, &data);

		/* copy it into the buffer */
		memcpy(buffptr, data, len);
		buffptr += len;
		maxlen -= len;
	}

	/* return the number of bytes read */
	return buffptr - buff;
}

int membuf_put(struct membuf *mb, const char *buff, int length)
{
	char *data;
	int towrite, i, written;

	for (i = written = 0; i < 2; i++) {
		/* ask where some data can be written */
		towrite = membuf_putraw(mb, length, true, &data);

		/* and write it, updating the bytes length */
		memcpy(data, buff, towrite);
		written += towrite;
		buff += towrite;
		length -= towrite;
	}

	/* return the number of bytes written */
	return written;
}

bool membuf_isempty(struct membuf *mb)
{
	return !is_full(mb) && mb->head == mb->tail;
}

int membuf_avail(struct membuf *mb)
{
	struct membuf copy;
	int i, avail;
	char *data = 0;

	/* make a copy of this buffer's control data */
	copy = *mb;

	/* now read everything out of the copied buffer */
	for (i = avail = 0; i < 2; i++)
		avail += membuf_getraw(&copy, -1, true, &data);

	/* and return how much we read */
	return avail;
}

int membuf_size(struct membuf *mb)
{
	return mb->end - mb->start;
}

#if MEMBUF_FULL == 0
/* This has not been updated for MEMBUF_FULL */

bool membuf_makecontig(struct membuf *mb)
{
	int topsize, botsize;

	debug("makecontig: head=%d, tail=%d, size=%d",
	      (int)(mb->head - mb->start), (int)(mb->tail - mb->start),
	      (int)(mb->end - mb->start));

	/*
	 * first we move anything at the start of the buffer into the correct
	 * place some way along
	 */
	if (mb->tail > mb->head) {
		/*
		 * the data is split into two parts, from 0 to ->head and
		 * from ->tail to ->end. We move the stuff from 0 to ->head
		 * up to make space for the other data before it
		 */
		topsize = mb->end - mb->tail;
		botsize = mb->head - mb->start;

		/*
		 * must move data at bottom up by 'topsize' bytes - check if
		 * there's room
		 */
		if (mb->head + topsize >= mb->tail)
			return false;
		memmove(mb->start + topsize, mb->start, botsize);
		debug("	- memmove(%d, %d, %d)", topsize, 0, botsize);

	/* nothing at the start, so skip that step */
	} else {
		topsize = mb->head - mb->tail;
		botsize = 0;
	}

	/* now move data at top down to the bottom */
	memcpy(mb->start, mb->tail, topsize);
	debug("	- memcpy(%d, %d, %d)", 0, (int)(mb->tail - mb->start), topsize);

	/* adjust pointers */
	mb->tail = mb->start;
	mb->head = mb->start + topsize + botsize;

	debug("	- head=%d, tail=%d", (int)(mb->head - mb->start),
	      (int)(mb->tail - mb->start));

	/* all ok */
	return true;
}
#endif

int membuf_free(struct membuf *mb)
{
	return mb->end == mb->start ? 0 :
		(mb->end - mb->start) - MEMBUF_FULL - membuf_avail(mb);
}

int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch,
		    bool must_fit)
{
	int len;  /* number of bytes read (!= string length) */
	char *s, *end;
	bool ok = false;
	char *orig = str;

	end = mb->head < mb->tail || is_full(mb) ? mb->end : mb->head;
	for (len = 0, s = mb->tail; s < end && len < maxlen - 1; str++) {
		*str = *s++;
		len++;
		if (*str == '\n' || *str < minch) {
			ok = true;
			break;
		}
		if (s == end && (is_full(mb) || mb->tail > mb->head)) {
			s = mb->start;
			end = mb->head;
		}
	}

	/* couldn't get the whole string */
	if (!ok && must_fit) {
		if (maxlen)
			*orig = '\0';
		return 0;
	}

	/* terminate the string, update the membuff and return success */
	*str = '\0';
	mb->tail = s == mb->end ? mb->start : s;
	if (len)
		set_full(mb, false);

	return len;
}

int membuf_extend_by(struct membuf *mb, int by, int max)
{
	int oldhead, oldtail;
	int size, orig;
	char *ptr;

	/* double the buffer size until it is big enough */
	assert(by >= 0);
	for (orig = mb->end - mb->start, size = orig; size < orig + by;)
		size *= 2;
	if (max != -1)
		size = min(size, max);
	by = size - orig;

	/* if we're already at maximum, give up */
	if (by <= 0)
		return -E2BIG;

	oldhead = mb->head - mb->start;
	oldtail = mb->tail - mb->start;
	ptr = realloc(mb->start, size);
	if (!ptr)
		return -ENOMEM;
	mb->start = ptr;
	mb->head = mb->start + oldhead;
	mb->tail = mb->start + oldtail;

	if (is_full(mb) || mb->head < mb->tail) {
		memmove(mb->tail + by, mb->tail, orig - oldtail);
		mb->tail += by;
		set_full(mb, false);
	}
	mb->end = mb->start + size;

	return 0;
}

void membuf_init(struct membuf *mb, char *buff, int size)
{
	mb->start = buff;
	mb->end = mb->start + size;
	membuf_purge(mb);
}

void membuf_init_with_data(struct membuf *mb, char *buff, int size)
{
	char *data;

	membuf_init(mb, buff, size + !MEMBUF_FULL);
	membuf_putraw(mb, size, true, &data);
}

int membuf_new(struct membuf *mb, int size)
{
	mb->start = malloc(size);
	if (!mb->start)
		return -ENOMEM;

	membuf_init(mb, mb->start, size);
	return 0;
}

void membuf_uninit(struct membuf *mb)
{
	mb->end = NULL;
	mb->start = NULL;
	membuf_purge(mb);
}

void membuf_dispose(struct membuf *mb)
{
	free(mb->start);
	membuf_uninit(mb);
}

int membuf_printf(struct membuf *mb, const char *fmt, ...)
{
	char buf[256];
	va_list args;
	int len;

	va_start(args, fmt);
	len = vsnprintf(buf, sizeof(buf), fmt, args);
	va_end(args);

	return membuf_put(mb, buf, len);
}