|
Packit |
fd8b60 |
/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
|
|
Packit |
fd8b60 |
/* include/k5-input.h - k5input helper functions */
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* Copyright (C) 2014 by the Massachusetts Institute of Technology.
|
|
Packit |
fd8b60 |
* All rights reserved.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* Redistribution and use in source and binary forms, with or without
|
|
Packit |
fd8b60 |
* modification, are permitted provided that the following conditions
|
|
Packit |
fd8b60 |
* are met:
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* * Redistributions of source code must retain the above copyright
|
|
Packit |
fd8b60 |
* notice, this list of conditions and the following disclaimer.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* * Redistributions in binary form must reproduce the above copyright
|
|
Packit |
fd8b60 |
* notice, this list of conditions and the following disclaimer in
|
|
Packit |
fd8b60 |
* the documentation and/or other materials provided with the
|
|
Packit |
fd8b60 |
* distribution.
|
|
Packit |
fd8b60 |
*
|
|
Packit |
fd8b60 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
Packit |
fd8b60 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
Packit |
fd8b60 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
Packit |
fd8b60 |
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
Packit |
fd8b60 |
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
|
Packit |
fd8b60 |
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
Packit |
fd8b60 |
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
Packit |
fd8b60 |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
Packit |
fd8b60 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
Packit |
fd8b60 |
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
Packit |
fd8b60 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
Packit |
fd8b60 |
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#ifndef K5_INPUT_H
|
|
Packit |
fd8b60 |
#define K5_INPUT_H
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#include "k5-platform.h"
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/*
|
|
Packit |
fd8b60 |
* The k5input module defines helpers for safely consuming a fixed-sized block
|
|
Packit |
fd8b60 |
* of memory. If an overrun or allocation failure occurs at any step,
|
|
Packit |
fd8b60 |
* subsequent functions will return default values until the error is detected
|
|
Packit |
fd8b60 |
* by looking at the status field.
|
|
Packit |
fd8b60 |
*/
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
struct k5input {
|
|
Packit |
fd8b60 |
const unsigned char *ptr;
|
|
Packit |
fd8b60 |
size_t len;
|
|
Packit |
fd8b60 |
int32_t status;
|
|
Packit |
fd8b60 |
};
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_input_init(struct k5input *in, const void *ptr, size_t len)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
in->ptr = ptr;
|
|
Packit |
fd8b60 |
in->len = len;
|
|
Packit |
fd8b60 |
in->status = 0;
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
/* Only set the status value of in if it hasn't already been set, so status
|
|
Packit |
fd8b60 |
* reflects the first thing to go wrong. */
|
|
Packit |
fd8b60 |
static inline void
|
|
Packit |
fd8b60 |
k5_input_set_status(struct k5input *in, int32_t status)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
if (!in->status)
|
|
Packit |
fd8b60 |
in->status = status;
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline const unsigned char *
|
|
Packit |
fd8b60 |
k5_input_get_bytes(struct k5input *in, size_t len)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
if (in->len < len)
|
|
Packit |
fd8b60 |
k5_input_set_status(in, EINVAL);
|
|
Packit |
fd8b60 |
if (in->status)
|
|
Packit |
fd8b60 |
return NULL;
|
|
Packit |
fd8b60 |
in->len -= len;
|
|
Packit |
fd8b60 |
in->ptr += len;
|
|
Packit |
fd8b60 |
return in->ptr - len;
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline unsigned char
|
|
Packit |
fd8b60 |
k5_input_get_byte(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 1);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? '\0' : *ptr;
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint16_t
|
|
Packit |
fd8b60 |
k5_input_get_uint16_be(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 2);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_16_be(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint16_t
|
|
Packit |
fd8b60 |
k5_input_get_uint16_le(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 2);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_16_le(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint16_t
|
|
Packit |
fd8b60 |
k5_input_get_uint16_n(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 2);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_16_n(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint32_t
|
|
Packit |
fd8b60 |
k5_input_get_uint32_be(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 4);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_32_be(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint32_t
|
|
Packit |
fd8b60 |
k5_input_get_uint32_le(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 4);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_32_le(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint32_t
|
|
Packit |
fd8b60 |
k5_input_get_uint32_n(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 4);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_32_n(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint64_t
|
|
Packit |
fd8b60 |
k5_input_get_uint64_be(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 8);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_64_be(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
static inline uint64_t
|
|
Packit |
fd8b60 |
k5_input_get_uint64_le(struct k5input *in)
|
|
Packit |
fd8b60 |
{
|
|
Packit |
fd8b60 |
const unsigned char *ptr = k5_input_get_bytes(in, 8);
|
|
Packit |
fd8b60 |
return (ptr == NULL) ? 0 : load_64_le(ptr);
|
|
Packit |
fd8b60 |
}
|
|
Packit |
fd8b60 |
|
|
Packit |
fd8b60 |
#endif /* K5_BUF_H */
|