|
Packit |
fd8b60 |
/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
|
|
Packit |
fd8b60 |
/* include/k5-buf.h - k5buf interface declarations */
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Copyright 2008 Massachusetts Institute of Technology.
|
|
Packit |
fd8b60 |
* All Rights Reserved.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* Export of this software from the United States of America may
|
|
Packit |
fd8b60 |
* require a specific license from the United States Government.
|
|
Packit |
fd8b60 |
* It is the responsibility of any person or organization contemplating
|
|
Packit |
fd8b60 |
* export to obtain such a license before exporting.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
|
|
Packit |
fd8b60 |
* distribute this software and its documentation for any purpose and
|
|
Packit |
fd8b60 |
* without fee is hereby granted, provided that the above copyright
|
|
Packit |
fd8b60 |
* notice appear in all copies and that both that copyright notice and
|
|
Packit |
fd8b60 |
* this permission notice appear in supporting documentation, and that
|
|
Packit |
fd8b60 |
* the name of M.I.T. not be used in advertising or publicity pertaining
|
|
Packit |
fd8b60 |
* to distribution of the software without specific, written prior
|
|
Packit |
fd8b60 |
* permission. Furthermore if you modify this software you must label
|
|
Packit |
fd8b60 |
* your software as modified software and not distribute it in such a
|
|
Packit |
fd8b60 |
* fashion that it might be confused with the original M.I.T. software.
|
|
Packit |
fd8b60 |
* M.I.T. makes no representations about the suitability of
|
|
Packit |
fd8b60 |
* this software for any purpose. It is provided "as is" without express
|
|
Packit |
fd8b60 |
* or implied warranty.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#ifndef K5_BUF_H
|
|
Packit |
fd8b60 |
#define K5_BUF_H
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#include <stdarg.h>
|
|
Packit |
fd8b60 |
#include <string.h>
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* The k5buf module is intended to allow multi-step string construction in a
|
|
Packit |
fd8b60 |
* fixed or dynamic buffer without the need to check for a failure at each step
|
|
Packit |
fd8b60 |
* (and without aborting on malloc failure). If an allocation failure occurs
|
|
Packit |
fd8b60 |
* or the fixed buffer runs out of room, the buffer will be set to an error
|
|
Packit |
fd8b60 |
* state which can be detected with k5_buf_status. Data in a buffer is
|
|
Packit |
fd8b60 |
* terminated with a zero byte so that it can be used as a C string.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* k5buf structures are usually stack-allocated. Do not put k5buf structure
|
|
Packit |
fd8b60 |
* pointers into public APIs. It is okay to reference the data and len fields
|
|
Packit |
fd8b60 |
* of a buffer (they will be NULL/0 if the buffer is in an error state), but do
|
|
Packit |
fd8b60 |
* not change them.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Buffer type values */
|
|
Packit |
fd8b60 |
enum k5buftype { K5BUF_ERROR, K5BUF_FIXED, K5BUF_DYNAMIC, K5BUF_DYNAMIC_ZAP };
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
struct k5buf {
|
|
Packit |
fd8b60 |
enum k5buftype buftype;
|
|
Packit |
fd8b60 |
void *data;
|
|
Packit |
fd8b60 |
size_t space;
|
|
Packit |
fd8b60 |
size_t len;
|
|
Packit |
fd8b60 |
};
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#define EMPTY_K5BUF { K5BUF_ERROR }
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Initialize a k5buf using a fixed-sized, existing buffer. SPACE must be
|
|
Packit |
fd8b60 |
* more than zero, or an assertion failure will result. */
|
|
Packit |
fd8b60 |
void k5_buf_init_fixed(struct k5buf *buf, char *data, size_t space);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Initialize a k5buf using an internally allocated dynamic buffer. */
|
|
Packit |
fd8b60 |
void k5_buf_init_dynamic(struct k5buf *buf);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Initialize a k5buf using an internally allocated dynamic buffer, zeroing
|
|
Packit |
fd8b60 |
* memory when reallocating or freeing. */
|
|
Packit |
fd8b60 |
void k5_buf_init_dynamic_zap(struct k5buf *buf);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add a C string to BUF. */
|
|
Packit |
fd8b60 |
void k5_buf_add(struct k5buf *buf, const char *data);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add a counted series of bytes to BUF. */
|
|
Packit |
fd8b60 |
void k5_buf_add_len(struct k5buf *buf, const void *data, size_t len);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add sprintf-style formatted data to BUF. */
|
|
Packit |
fd8b60 |
void k5_buf_add_fmt(struct k5buf *buf, const char *fmt, ...)
|
|
Packit |
fd8b60 |
#if !defined(__cplusplus) && (__GNUC__ > 2)
|
|
Packit |
fd8b60 |
__attribute__((__format__(__printf__, 2, 3)))
|
|
Packit |
fd8b60 |
#endif
|
|
Packit |
fd8b60 |
;
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Add sprintf-style formatted data to BUF, with a va_list. The value of ap is
|
|
Packit |
fd8b60 |
* undefined after the call. */
|
|
Packit |
fd8b60 |
void k5_buf_add_vfmt(struct k5buf *buf, const char *fmt, va_list ap)
|
|
Packit |
fd8b60 |
#if !defined(__cplusplus) && (__GNUC__ > 2)
|
|
Packit |
fd8b60 |
__attribute__((__format__(__printf__, 2, 0)))
|
|
Packit |
fd8b60 |
#endif
|
|
Packit |
fd8b60 |
;
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Extend the length of buf by len and return a pointer to the reserved space,
|
|
Packit |
fd8b60 |
* to be filled in by the caller. Return NULL on error. */
|
|
Packit |
fd8b60 |
void *k5_buf_get_space(struct k5buf *buf, size_t len);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Truncate BUF. LEN must be between 0 and the existing buffer
|
|
Packit |
fd8b60 |
* length, or an assertion failure will result. */
|
|
Packit |
fd8b60 |
void k5_buf_truncate(struct k5buf *buf, size_t len);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Return ENOMEM if buf is in an error state, 0 otherwise. */
|
|
Packit |
fd8b60 |
int k5_buf_status(struct k5buf *buf);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Free the storage used in the dynamic buffer BUF. The caller may choose to
|
|
Packit |
fd8b60 |
* take responsibility for freeing the data pointer instead of using this
|
|
Packit |
fd8b60 |
* function. If BUF is a fixed buffer, an assertion failure will result.
|
|
Packit |
fd8b60 |
* Freeing a buffer in the error state, a buffer initialized with EMPTY_K5BUF,
|
|
Packit |
fd8b60 |
* or a zeroed k5buf structure is a no-op.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
void k5_buf_free(struct k5buf *buf);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint16_be(struct k5buf *buf, uint16_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 2);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_16_be(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint16_le(struct k5buf *buf, uint16_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 2);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_16_le(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint32_be(struct k5buf *buf, uint32_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 4);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_32_be(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint32_le(struct k5buf *buf, uint32_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 4);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_32_le(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint64_be(struct k5buf *buf, uint64_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 8);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_64_be(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_buf_add_uint64_le(struct k5buf *buf, uint64_t val)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
void *p = k5_buf_get_space(buf, 8);
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
if (p != NULL)
|
|
Packit |
fd8b60 |
store_64_le(val, p);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#endif /* K5_BUF_H */
|