/**
* @file
*
* @ingroup rtems_bsd_rtems
*
* @brief TODO.
*/
/*
* Copyright (c) 2013, 2016 embedded brains GmbH. All rights reserved.
*
* embedded brains GmbH
* Dornierstr. 4
* 82178 Puchheim
* Germany
* <rtems@embedded-brains.de>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/types.h>
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <unistd.h>
#define RTEMS_BSD_PROGRAM_NO_OPEN_WRAP
#define RTEMS_BSD_PROGRAM_NO_CLOSE_WRAP
#define RTEMS_BSD_PROGRAM_NO_FOPEN_WRAP
#define RTEMS_BSD_PROGRAM_NO_FCLOSE_WRAP
#define RTEMS_BSD_PROGRAM_NO_MALLOC_WRAP
#define RTEMS_BSD_PROGRAM_NO_CALLOC_WRAP
#define RTEMS_BSD_PROGRAM_NO_REALLOC_WRAP
#define RTEMS_BSD_PROGRAM_NO_STRDUP_WRAP
#define RTEMS_BSD_PROGRAM_NO_VASPRINTF_WRAP
#define RTEMS_BSD_PROGRAM_NO_ASPRINTF_WRAP
#define RTEMS_BSD_PROGRAM_NO_FREE_WRAP
#include <machine/rtems-bsd-program.h>
#include "program-internal.h"
static int
fd_remove(struct rtems_bsd_program_control *prog_ctrl, int fd)
{
struct program_fd_item *current;
int rv = -1;
for (current = prog_ctrl->open_fd.lh_first;
current != NULL;
current = current->entries.le_next) {
if (current->fd == fd) {
LIST_REMOVE(current, entries);
free(current);
rv = 0;
break;
}
}
return rv;
}
static int
fd_close_remove(struct rtems_bsd_program_control *prog_ctrl, int fd)
{
int rv = -1;
rv = fd_remove(prog_ctrl, fd);
if (rv == 0) {
rv = close(fd);
}
return rv;
}
static void
fd_close_all(struct rtems_bsd_program_control *prog_ctrl)
{
while(prog_ctrl->open_fd.lh_first != NULL) {
struct program_fd_item *current;
int fd;
int rv;
current = prog_ctrl->open_fd.lh_first;
fd = current->fd;
rv = fd_close_remove(prog_ctrl, fd);
if (rv != 0) {
syslog(LOG_ERR,
"BSD Program: Could not close file %d or could not remove it from list of open files",
fd);
}
}
}
static int
file_remove(struct rtems_bsd_program_control *prog_ctrl, FILE *file)
{
struct program_file_item *current;
int rv = EOF;
for (current = prog_ctrl->open_file.lh_first;
current != NULL;
current = current->entries.le_next) {
if (current->file == file) {
LIST_REMOVE(current, entries);
free(current);
rv = 0;
break;
}
}
return rv;
}
static int
file_close_remove(struct rtems_bsd_program_control *prog_ctrl, FILE *file)
{
int rv = EOF;
rv = file_remove(prog_ctrl, file);
if (rv == 0) {
rv = fclose(file);
}
return rv;
}
static void
file_close_all(struct rtems_bsd_program_control *prog_ctrl)
{
while(prog_ctrl->open_file.lh_first != NULL) {
struct program_file_item *current;
FILE *file;
int rv;
current = prog_ctrl->open_file.lh_first;
file = current->file;
rv = file_close_remove(prog_ctrl, file);
if (rv != 0) {
syslog(LOG_ERR,
"BSD Program: Could not close stream %p or could not remove it from list of open streams",
file);
}
}
}
static int
allocmem_remove(struct rtems_bsd_program_control *prog_ctrl, void *ptr)
{
struct program_allocmem_item *current;
int rv = -1;
for (current = prog_ctrl->allocated_mem.lh_first;
current != NULL;
current = current->entries.le_next) {
if (current->ptr == ptr) {
LIST_REMOVE(current, entries);
rv = 0;
break;
}
}
return rv;
}
static int
allocmem_free_remove(struct rtems_bsd_program_control *prog_ctrl, void *ptr)
{
int rv = -1;
rv = allocmem_remove(prog_ctrl, ptr);
if (rv == 0) {
free(ptr);
}
return rv;
}
static void
allocmem_free_all(struct rtems_bsd_program_control *prog_ctrl)
{
while(prog_ctrl->allocated_mem.lh_first != NULL) {
struct program_allocmem_item *current;
void *ptr;
int rv;
current = prog_ctrl->allocated_mem.lh_first;
ptr = current->ptr;
rv = allocmem_free_remove(prog_ctrl, ptr);
if (rv != 0) {
/* This should never happen. It would mean that someone
* changed the allocmem list while we are removing the
* element. */
syslog(LOG_ERR,
"BSD Program: Could not remove %p from list of allocated memory",
ptr);
}
}
}
int
rtems_bsd_program_call(const char *name, int (*prog)(void *), void *context)
{
struct rtems_bsd_program_control *prog_ctrl;
int error;
int exit_code;
prog_ctrl = calloc(1, sizeof(*prog_ctrl));
if (prog_ctrl == NULL) {
errno = ENOMEM;
return (EXIT_FAILURE);
}
error = rtems_bsd_program_set_control(prog_ctrl);
if (error != 0) {
free(prog_ctrl);
errno = error;
return (EXIT_FAILURE);
}
prog_ctrl->context = context;
prog_ctrl->name = name;
prog_ctrl->exit_code = EXIT_FAILURE;
LIST_INIT(&prog_ctrl->open_fd);
LIST_INIT(&prog_ctrl->open_file);
LIST_INIT(&prog_ctrl->allocated_mem);
if (setjmp(prog_ctrl->return_context) == 0) {
exit_code = (*prog)(context);
} else {
exit_code = prog_ctrl->exit_code;
}
rtems_bsd_program_set_control(NULL);
fd_close_all(prog_ctrl);
file_close_all(prog_ctrl);
allocmem_free_all(prog_ctrl);
free(prog_ctrl);
return (exit_code);
}
void
rtems_bsd_program_exit(int exit_code)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
if (prog_ctrl != NULL) {
prog_ctrl->exit_code = exit_code;
longjmp(prog_ctrl->return_context, 1);
}
assert(0);
}
void
rtems_bsd_program_error(const char *fmt, ...)
{
va_list list;
va_start(list, fmt);
vfprintf(stderr, fmt, list);
fprintf(stderr, "\n");
va_end(list);
rtems_bsd_program_exit(1);
}
const char *
rtems_bsd_program_get_name(void)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
const char *name = "?";
if (prog_ctrl != NULL) {
name = prog_ctrl->name;
}
return name;
}
void *
rtems_bsd_program_get_context(void)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
void *context = NULL;
if (prog_ctrl != NULL) {
context = prog_ctrl->context;
}
return context;
}
struct main_context {
int argc;
char **argv;
int (*main)(int, char **);
};
static int
call_main(void *ctx)
{
const struct main_context *mc = ctx;
return (*mc->main)(mc->argc, mc->argv);
}
int
rtems_bsd_program_call_main(const char *name, int (*main)(int, char **),
int argc, char **argv)
{
struct main_context mc = {
.argc = argc,
.argv = argv,
.main = main
};
int exit_code;
if (argv[argc] == NULL) {
exit_code = rtems_bsd_program_call(name, call_main, &mc);
} else {
errno = EFAULT;
exit_code = EXIT_FAILURE;
}
return exit_code;
}
int
rtems_bsd_program_call_main_with_data_restore(const char *name,
int (*main)(int, char **), int argc, char **argv,
void *data_buf, const size_t data_size)
{
int exit_code = EXIT_FAILURE;
void *savebuf;
savebuf = malloc(data_size);
if (savebuf == NULL) {
errno = ENOMEM;
exit_code = EXIT_FAILURE;
} else {
memcpy(savebuf, data_buf, data_size);
exit_code = rtems_bsd_program_call_main(name, main, argc,
argv);
memcpy(data_buf, savebuf, data_size);
free(savebuf);
}
return exit_code;
}
int
rtems_bsd_program_open(const char *path, int oflag, ...)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
va_list list;
mode_t mode = 0;
int fd = -1;
if (prog_ctrl != NULL) {
struct program_fd_item *item =
malloc(sizeof(*item));
if (item != NULL) {
va_start(list, oflag);
mode = va_arg(list, mode_t);
fd = open(path, oflag, mode);
va_end(list);
if (fd != -1) {
item->fd = fd;
LIST_INSERT_HEAD(&(prog_ctrl->open_fd),
item, entries);
} else {
free(item);
}
} else {
errno = ENOMEM;
}
}
return fd;
}
int
rtems_bsd_program_close(int fd)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
int rv = -1;
if (prog_ctrl != NULL) {
rv = fd_close_remove(prog_ctrl, fd);
}
return rv;
}
FILE *
rtems_bsd_program_fopen(const char *restrict filename,
const char *restrict mode)
{
FILE *file = NULL;
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
if (prog_ctrl != NULL) {
struct program_file_item *item = malloc(sizeof(*item));
if (item != NULL) {
file = fopen(filename, mode);
if (file != NULL) {
item->file = file;
LIST_INSERT_HEAD(
&(prog_ctrl->open_file), item,
entries);
} else {
free(item);
}
} else {
errno = ENOMEM;
}
}
return file;
}
int
rtems_bsd_program_fclose(FILE *file)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
int rv = EOF;
if (prog_ctrl != NULL) {
rv = file_close_remove(prog_ctrl, file);
}
return rv;
}
static void *
rtems_bsd_program_alloc(size_t size, void *org_ptr)
{
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
void *ptr = NULL;
size_t size_with_list;
size_t size_alligned;
if (prog_ctrl != NULL) {
/* align the end to the next word address */
size_alligned = size;
if ((size_alligned & 0x3) != 0) {
size_alligned = (size_alligned | 0x03) + 1;
}
size_with_list = size_alligned +
sizeof(struct program_allocmem_item);
if (org_ptr != NULL) {
/* It's a reallocation. So first remove the old pointer
* from the list */
allocmem_remove(prog_ctrl, org_ptr);
}
ptr = realloc(org_ptr, size_with_list);
if (ptr != NULL) {
struct program_allocmem_item *item;
item = ptr + size_alligned;
item->ptr = ptr;
LIST_INSERT_HEAD(&(prog_ctrl->allocated_mem),
item, entries);
}
}
return ptr;
}
void *
rtems_bsd_program_malloc(size_t size)
{
return rtems_bsd_program_alloc(size, NULL);
}
void *
rtems_bsd_program_calloc(size_t nelem, size_t elsize)
{
void *ptr;
size_t size = elsize * nelem;
ptr = rtems_bsd_program_alloc(size, NULL);
if (ptr != NULL) {
memset(ptr, 0, size);
}
return ptr;
}
void *
rtems_bsd_program_realloc(void *ptr, size_t size)
{
return rtems_bsd_program_alloc(size, ptr);
}
void *
rtems_bsd_program_reallocf(void *ptr, size_t size)
{
void *ret = rtems_bsd_program_alloc(size, ptr);
if (ret == NULL) {
free(ptr);
}
return ret;
}
char *
rtems_bsd_program_strdup(const char *s1)
{
size_t size = strlen(s1) + 1; /* add one for null termination */
char *item;
item = rtems_bsd_program_alloc(size, NULL);
if (item != NULL) {
memcpy(item, s1, size);
}
return item;
}
int
rtems_bsd_program_vasprintf(char **strp, const char *fmt, va_list ap)
{
va_list aq;
int size;
int rv = -1;
va_copy(aq, ap);
size = vsnprintf(NULL, 0, fmt, aq);
va_end(aq);
size += 1; /* Add space for terminating null byte */
*strp = rtems_bsd_program_alloc(size, NULL);
if (*strp != NULL) {
rv = vsnprintf(*strp, size, fmt, ap);
}
return rv;
}
int
rtems_bsd_program_asprintf(char **strp, const char *fmt, ...)
{
va_list ap;
int rv;
va_start(ap, fmt);
rv = rtems_bsd_program_vasprintf(strp, fmt, ap);
va_end(ap);
return rv;
}
void
rtems_bsd_program_free(void *ptr)
{
if (ptr != NULL) {
struct rtems_bsd_program_control *prog_ctrl =
rtems_bsd_program_get_control_or_null();
if (prog_ctrl != NULL) {
int rv = allocmem_free_remove(prog_ctrl, ptr);
assert(rv == 0);
} else {
/* Outside of program context. Just free it. */
free(ptr);
}
}
}
