mirror of
https://github.com/clearlinux/graphene.git
synced 2026-09-05 13:21:37 +00:00
borysp
c9742cb9cd
Sometimes we need to prevent the compiler from reading or writing to a memory location twice to prevent certain TOCTOU bugs. This can now be achieved by using the introduced macros and this commit does so in enclave_ocalls.c for Linux-SGX.
298 lines
12 KiB
C
298 lines
12 KiB
C
/* Copyright (C) 2014 Stony Brook University
|
|
This file is part of Graphene Library OS.
|
|
|
|
Graphene Library OS is free software: you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public License
|
|
as published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
Graphene Library OS 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 Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#ifndef API_H
|
|
#define API_H
|
|
|
|
#include <assert.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdarg.h>
|
|
|
|
/* WARNING: this declaration may conflict with some header files */
|
|
#ifndef ssize_t
|
|
typedef ptrdiff_t ssize_t;
|
|
#endif
|
|
|
|
/* Macros */
|
|
|
|
#ifndef MIN
|
|
#define MIN(a,b) \
|
|
({ __typeof__(a) _a = (a); \
|
|
__typeof__(b) _b = (b); \
|
|
_a < _b ? _a : _b; })
|
|
#endif
|
|
#ifndef MAX
|
|
#define MAX(a,b) \
|
|
({ __typeof__(a) _a = (a); \
|
|
__typeof__(b) _b = (b); \
|
|
_a > _b ? _a : _b; })
|
|
#endif
|
|
|
|
#define SATURATED_ADD(a, b, limit) \
|
|
({ __typeof__(a) _a = (a); \
|
|
__typeof__(b) _b = (b); \
|
|
__typeof__(limit) _limit = (limit); \
|
|
_b > _limit ? _limit : (_a > _limit - _b ? _limit : _a + _b); })
|
|
|
|
#define SATURATED_SUB(a, b, limit) \
|
|
({ __typeof__(a) _a = (a); \
|
|
__typeof__(b) _b = (b); \
|
|
__typeof__(limit) _limit = (limit); \
|
|
_a < _limit ? _limit : (_b > _a - _limit ? _limit : _a - _b); })
|
|
|
|
#define SATURATED_P_ADD(ptr_a, b, limit) \
|
|
((__typeof__(ptr_a))SATURATED_ADD((uintptr_t)(ptr_a), (uintptr_t)(b), (uintptr_t)(limit)))
|
|
|
|
#define SATURATED_P_SUB(ptr_a, b, limit) \
|
|
((__typeof__(ptr_a))SATURATED_SUB((uintptr_t)(ptr_a), (uintptr_t)(b), (uintptr_t)(limit)))
|
|
|
|
#define IS_POWER_OF_2(x) \
|
|
({ assert((x) != 0); \
|
|
(((x) & ((x) - 1)) == 0); })
|
|
|
|
#define IS_ALIGNED(val, alignment) ((val) % (alignment) == 0)
|
|
#define ALIGN_DOWN(val, alignment) ((val) - (val) % (alignment))
|
|
#define ALIGN_UP(val, alignment) ALIGN_DOWN((val) + (alignment) - 1, alignment)
|
|
#define IS_ALIGNED_PTR(val, alignment) IS_ALIGNED((uintptr_t)(val), alignment)
|
|
#define ALIGN_DOWN_PTR(ptr, alignment) ((__typeof__(ptr))(ALIGN_DOWN((uintptr_t)(ptr), alignment)))
|
|
#define ALIGN_UP_PTR(ptr, alignment) ((__typeof__(ptr))(ALIGN_UP((uintptr_t)(ptr), alignment)))
|
|
|
|
/* Useful only when the alignment is a power of two, but when that's not known compile-time. */
|
|
#define IS_ALIGNED_POW2(val, alignment) (((val) & ((alignment) - 1)) == 0)
|
|
#define ALIGN_DOWN_POW2(val, alignment) \
|
|
((val) - ((val) & ((alignment) - 1))) // `~` doesn't work if `alignment` is of a smaller type
|
|
// than `val` and unsigned.
|
|
#define ALIGN_UP_POW2(val, alignment) ALIGN_DOWN_POW2((val) + (alignment) - 1, alignment)
|
|
#define IS_ALIGNED_PTR_POW2(val, alignment) IS_ALIGNED_POW2((uintptr_t)(val), alignment)
|
|
#define ALIGN_DOWN_PTR_POW2(ptr, alignment) ((__typeof__(ptr))(ALIGN_DOWN_POW2((uintptr_t)(ptr), \
|
|
alignment)))
|
|
#define ALIGN_UP_PTR_POW2(ptr, alignment) ((__typeof__(ptr))(ALIGN_UP_POW2((uintptr_t)(ptr), \
|
|
alignment)))
|
|
|
|
#define SAME_TYPE(a, b) __builtin_types_compatible_p(__typeof__(a), __typeof__(b))
|
|
#define IS_STATIC_ARRAY(a) (!SAME_TYPE(a, &*(a)))
|
|
#define FORCE_STATIC_ARRAY(a) sizeof(int[IS_STATIC_ARRAY(a) - 1]) // evaluates to 0
|
|
|
|
#ifndef ARRAY_SIZE
|
|
#define ARRAY_SIZE(a) (FORCE_STATIC_ARRAY(a) + sizeof(a) / sizeof(a[0]))
|
|
#endif
|
|
|
|
#define DEBUG_BREAK() do { __asm__ volatile ("int $3"); } while (0)
|
|
|
|
#ifndef container_of
|
|
/**
|
|
* container_of - cast a member of a structure out to the containing structure
|
|
* @ptr: the pointer to the member.
|
|
* @type: the type of the container struct this is embedded in.
|
|
* @member: the name of the member within the struct.
|
|
*
|
|
*/
|
|
# define container_of(ptr, type, member) ((type *)((char *)(ptr) - offsetof(type, member)))
|
|
#endif
|
|
|
|
#define __alloca __builtin_alloca
|
|
|
|
#define XSTRINGIFY(x) STRINGIFY(x)
|
|
#define STRINGIFY(x) #x
|
|
|
|
/* fail build if str is not a static string */
|
|
#define FORCE_LITERAL_CSTR(str) ("" str "")
|
|
|
|
#define __UNUSED(x) do { (void)(x); } while (0)
|
|
#define static_strlen(str) (ARRAY_SIZE(FORCE_LITERAL_CSTR(str)) - 1)
|
|
|
|
/* Libc functions */
|
|
|
|
/* Libc String functions string.h/stdlib.h */
|
|
size_t strnlen (const char *str, size_t maxlen);
|
|
size_t strlen (const char *str);
|
|
int strcmp(const char* a, const char* b);
|
|
|
|
long strtol (const char *s, char **endptr, int base);
|
|
int atoi (const char *nptr);
|
|
long int atol (const char *nptr);
|
|
|
|
char * strchr (const char *s, int c_in);
|
|
|
|
void * memcpy (void *dstpp, const void *srcpp, size_t len);
|
|
void * memmove (void *dstpp, const void *srcpp, size_t len);
|
|
void * memset (void *dstpp, int c, size_t len);
|
|
int memcmp (const void *s1, const void *s2, size_t len);
|
|
|
|
bool strendswith(const char* haystack, const char* needle);
|
|
|
|
/* Libc memory allocation functions. stdlib.h. */
|
|
void *malloc(size_t size);
|
|
void free(void *ptr);
|
|
void *calloc(size_t nmemb, size_t size);
|
|
|
|
/* check if the var is exactly the same as the static string */
|
|
#define strcmp_static(var, str) \
|
|
(memcmp(var, str, MIN(strlen(var), static_strlen(str)) + 1))
|
|
|
|
/* check if the var starts with the static string */
|
|
#define strstartswith_static(var, str) \
|
|
(!memcmp(var, str, static_strlen(str)))
|
|
|
|
/* copy static string and return the address of the NUL byte (NULL if the dest
|
|
* is not large enough).*/
|
|
#define strcpy_static(var, str, max) \
|
|
(static_strlen(str) + 1 > (max) \
|
|
? NULL \
|
|
: memcpy(var, str, static_strlen(str) + 1) + static_strlen(str))
|
|
|
|
/* Copy a fixed size array. */
|
|
#define COPY_ARRAY(dst, src) \
|
|
do { \
|
|
/* Using pointers because otherwise the compiler would try to allocate \
|
|
* memory for the fixed size arrays and complain about invalid \
|
|
* initializers. \
|
|
*/ \
|
|
__typeof__(src)* _s = &(src); \
|
|
__typeof__(dst)* _d = &(dst); \
|
|
\
|
|
static_assert(SAME_TYPE((*_s)[0], (*_d)[0]), "types must match"); \
|
|
static_assert(ARRAY_SIZE(*_s) == ARRAY_SIZE(*_d), "sizes must match"); \
|
|
\
|
|
memcpy(*_d, *_s, sizeof(*_d)); \
|
|
} while (0)
|
|
|
|
#ifdef __x86_64__
|
|
#define COMPILER_BARRIER() ({ __asm__ __volatile__ ("" ::: "memory"); })
|
|
#endif // __x86_64__
|
|
|
|
/* Idea taken from: https://elixir.bootlin.com/linux/v5.6/source/include/linux/compiler.h */
|
|
#define READ_ONCE(x) ({ \
|
|
__typeof__(x) _y; \
|
|
COMPILER_BARRIER(); \
|
|
__builtin_memcpy(&_y, &(x), sizeof(x)); \
|
|
COMPILER_BARRIER(); \
|
|
_y; })
|
|
|
|
#define WRITE_ONCE(x, y) ({ \
|
|
__typeof__(x) _y = (__typeof__(x))(y); \
|
|
COMPILER_BARRIER(); \
|
|
__builtin_memcpy(&(x), &_y, sizeof(x)); \
|
|
COMPILER_BARRIER(); \
|
|
_y; })
|
|
|
|
/* Libc printf functions. stdio.h/stdarg.h. */
|
|
void fprintfmt (int (*_fputch)(void *, int, void *), void * f, void * putdat,
|
|
const char * fmt, ...) __attribute__((format(printf, 4, 5)));
|
|
|
|
void vfprintfmt (int (*_fputch)(void *, int, void *), void * f, void * putdat,
|
|
const char * fmt, va_list ap) __attribute__((format(printf, 4, 0)));
|
|
|
|
int vsnprintf(char* buf, size_t n, const char* fmt, va_list ap);
|
|
int snprintf(char* buf, size_t n, const char* fmt, ...) __attribute__((format(printf, 3, 4)));
|
|
|
|
/* Miscelleneous */
|
|
|
|
int inet_pton4 (const char *src, size_t len, void *dst);
|
|
int inet_pton6 (const char *src, size_t len, void *dst);
|
|
|
|
uint32_t __htonl (uint32_t x);
|
|
uint32_t __ntohl (uint32_t x);
|
|
uint16_t __htons (uint16_t x);
|
|
uint16_t __ntohs (uint16_t x);
|
|
|
|
extern const char * const * sys_errlist_internal;
|
|
|
|
/* Graphene functions */
|
|
|
|
int get_norm_path(const char* path, char* buf, size_t* size);
|
|
int get_base_name(const char* path, char* buf, size_t* size);
|
|
|
|
/* Loading configs / manifests */
|
|
|
|
#include <list.h>
|
|
|
|
struct config;
|
|
DEFINE_LISTP(config);
|
|
struct config_store {
|
|
LISTP_TYPE(config) root;
|
|
LISTP_TYPE(config) entries;
|
|
void * raw_data;
|
|
int raw_size;
|
|
void * (*malloc) (size_t);
|
|
void (*free) (void *);
|
|
};
|
|
|
|
int read_config (struct config_store * store, int (*filter) (const char *, int),
|
|
const char ** errstring);
|
|
int free_config (struct config_store * store);
|
|
int copy_config (struct config_store * store, struct config_store * new_store);
|
|
int write_config (void * file, int (*write) (void *, void *, int),
|
|
struct config_store * store);
|
|
ssize_t get_config (struct config_store * cfg, const char * key,
|
|
char * val_buf, size_t buf_size);
|
|
int get_config_entries (struct config_store * cfg, const char * key,
|
|
char * key_buf, size_t key_bufsize);
|
|
ssize_t get_config_entries_size (struct config_store * cfg, const char * key);
|
|
int set_config (struct config_store * cfg, const char * key, const char * val);
|
|
|
|
#define CONFIG_MAX 4096
|
|
|
|
#define URI_PREFIX_SEPARATOR ":"
|
|
|
|
#define URI_TYPE_DIR "dir"
|
|
#define URI_TYPE_TCP "tcp"
|
|
#define URI_TYPE_TCP_SRV "tcp.srv"
|
|
#define URI_TYPE_UDP "udp"
|
|
#define URI_TYPE_UDP_SRV "udp.srv"
|
|
#define URI_TYPE_PIPE "pipe"
|
|
#define URI_TYPE_PIPE_SRV "pipe.srv"
|
|
#define URI_TYPE_DEV "dev"
|
|
#define URI_TYPE_EVENTFD "eventfd"
|
|
#define URI_TYPE_FILE "file"
|
|
|
|
#define URI_PREFIX_DIR URI_TYPE_DIR URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_TCP URI_TYPE_TCP URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_TCP_SRV URI_TYPE_TCP_SRV URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_UDP URI_TYPE_UDP URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_UDP_SRV URI_TYPE_UDP_SRV URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_PIPE URI_TYPE_PIPE URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_PIPE_SRV URI_TYPE_PIPE_SRV URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_DEV URI_TYPE_DEV URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_EVENTFD URI_TYPE_EVENTFD URI_PREFIX_SEPARATOR
|
|
#define URI_PREFIX_FILE URI_TYPE_FILE URI_PREFIX_SEPARATOR
|
|
|
|
#define URI_PREFIX_FILE_LEN (static_strlen(URI_PREFIX_FILE))
|
|
|
|
#ifdef __x86_64__
|
|
static inline bool __range_not_ok(uintptr_t addr, size_t size) {
|
|
addr += size;
|
|
if (addr < size) {
|
|
/* pointer arithmetic overflow, this check is x86-64 specific */
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/* Check if pointer to memory region is valid. Return true if the memory
|
|
* region may be valid, false if it is definitely invalid. */
|
|
static inline bool access_ok(const volatile void* addr, size_t size) {
|
|
return !__range_not_ok((uintptr_t)addr, size);
|
|
}
|
|
|
|
#else
|
|
# error "Unsupported architecture"
|
|
#endif /* __x86_64__ */
|
|
|
|
#endif /* API_H */
|