/*
* posix_os.c
*
* POSIX OS-handlers for OpenIPMI
*
* Author: MontaVista Software, Inc.
* Corey Minyard <minyard@mvista.com>
* source@mvista.com
*
* Copyright 2002,2003 MontaVista Software Inc.
*
* This program 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 2 of
* the License, or (at your option) any later version.
*
*
* THIS SOFTWARE IS PROVIDED ``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 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <config.h>
#include <stdlib.h>
#include <errno.h>
#include <stdio.h>
#include <OpenIPMI/os_handler.h>
#include <OpenIPMI/selector.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#ifdef HAVE_GDBM
#include <gdbm.h>
#endif
#include <OpenIPMI/ipmi_posix.h>
/* CHEAP HACK - we don't want the user to have to provide this any
more. */
extern void posix_vlog(char *format,
enum ipmi_log_type_e log_type,
va_list ap);
#pragma weak posix_vlog
typedef struct iposix_info_s
{
struct selector_s *sel;
os_vlog_t log_handler;
#ifdef HAVE_GDBM
char *gdbm_filename;
GDBM_FILE gdbmf;
#endif
} iposix_info_t;
struct os_hnd_fd_id_s
{
int fd;
void *cb_data;
os_data_ready_t data_ready;
os_data_ready_t write_ready;
os_data_ready_t except_ready;
os_handler_t *handler;
os_fd_data_freed_t freed;
};
static void
fd_handler(int fd, void *data)
{
os_hnd_fd_id_t *fd_data = (os_hnd_fd_id_t *) data;
fd_data->data_ready(fd, fd_data->cb_data, fd_data);
}
static void
fd_write_handler(int fd, void *data)
{
os_hnd_fd_id_t *fd_data = (os_hnd_fd_id_t *) data;
fd_data->write_ready(fd, fd_data->cb_data, fd_data);
}
static void
fd_except_handler(int fd, void *data)
{
os_hnd_fd_id_t *fd_data = (os_hnd_fd_id_t *) data;
fd_data->except_ready(fd, fd_data->cb_data, fd_data);
}
static void
free_fd_data(int fd, void *data)
{
os_hnd_fd_id_t *fd_data = data;
if (fd_data->freed)
fd_data->freed(fd, fd_data->cb_data);
free(data);
}
static int
add_fd(os_handler_t *handler,
int fd,
os_data_ready_t data_ready,
void *cb_data,
os_fd_data_freed_t freed,
os_hnd_fd_id_t **id)
{
os_hnd_fd_id_t *fd_data;
int rv;
iposix_info_t *info = handler->internal_data;
struct selector_s *posix_sel = info->sel;
fd_data = malloc(sizeof(*fd_data));
if (!fd_data)
return ENOMEM;
fd_data->fd = fd;
fd_data->cb_data = cb_data;
fd_data->data_ready = data_ready;
fd_data->handler = handler;
fd_data->freed = freed;
sel_set_fd_write_handler(posix_sel, fd, SEL_FD_HANDLER_DISABLED);
sel_set_fd_except_handler(posix_sel, fd, SEL_FD_HANDLER_DISABLED);
rv = sel_set_fd_handlers(posix_sel, fd, fd_data, fd_handler,
fd_write_handler, fd_except_handler,
free_fd_data);
if (rv) {
free(fd_data);
return rv;
}
sel_set_fd_read_handler(posix_sel, fd, SEL_FD_HANDLER_ENABLED);
*id = fd_data;
return 0;
}
static int
remove_fd(os_handler_t *handler, os_hnd_fd_id_t *fd_data)
{
iposix_info_t *info = handler->internal_data;
struct selector_s *posix_sel = info->sel;
sel_set_fd_read_handler(posix_sel, fd_data->fd, SEL_FD_HANDLER_DISABLED);
sel_clear_fd_handlers(posix_sel, fd_data->fd);
/* fd_data gets freed in the free_fd_data callback registered at
set time. */
return 0;
}
static void
set_fd_handlers(os_handler_t *handler, os_hnd_fd_id_t *id,
os_data_ready_t write_ready,
os_data_ready_t except_ready)
{
id->write_ready = write_ready;
id->except_ready = except_ready;
}
static int
set_fd_enables(os_handler_t *handler, os_hnd_fd_id_t *id,
int read, int write, int except)
{
iposix_info_t *info = handler->internal_data;
struct selector_s *posix_sel = info->sel;
if (read)
read = SEL_FD_HANDLER_ENABLED;
else
read = SEL_FD_HANDLER_DISABLED;
if (write)
write = SEL_FD_HANDLER_ENABLED;
else
write = SEL_FD_HANDLER_DISABLED;
if (except)
except = SEL_FD_HANDLER_ENABLED;
else
except = SEL_FD_HANDLER_DISABLED;
sel_set_fd_read_handler(posix_sel, id->fd, read);
sel_set_fd_write_handler(posix_sel, id->fd, write);
sel_set_fd_except_handler(posix_sel, id->fd, except);
return 0;
}
struct os_hnd_timer_id_s
{
void *cb_data;
os_timed_out_t timed_out;
sel_timer_t *timer;
int running;
os_handler_t *handler;
};
static void
timer_handler(struct selector_s *sel,
sel_timer_t *timer,
void *data)
{
os_hnd_timer_id_t *timer_data = (os_hnd_timer_id_t *) data;
/* Make a copy of this, because the handler may delete the timer
data. */
void *cb_data;
os_timed_out_t timed_out;
timed_out = timer_data->timed_out;
cb_data = timer_data->cb_data;
timer_data->running = 0;
timed_out(cb_data, timer_data);
}
static int
start_timer(os_handler_t *handler,
os_hnd_timer_id_t *id,
struct timeval *timeout,
os_timed_out_t timed_out,
void *cb_data)
{
struct timeval now;
int rv;
if (id->running)
return EBUSY;
id->running = 1;
id->cb_data = cb_data;
id->timed_out = timed_out;
rv = handler->get_monotonic_time(handler, &now);
if (rv)
return rv;
now.tv_sec += timeout->tv_sec;
now.tv_usec += timeout->tv_usec;
while (now.tv_usec >= 1000000) {
now.tv_usec -= 1000000;
now.tv_sec += 1;
}
return sel_start_timer(id->timer, &now);
}
static int
stop_timer(os_handler_t *handler, os_hnd_timer_id_t *timer_data)
{
int rv = sel_stop_timer(timer_data->timer);
if (rv == 0)
timer_data->running = 0;
return rv;
}
static int
alloc_timer(os_handler_t *handler,
os_hnd_timer_id_t **id)
{
os_hnd_timer_id_t *timer_data;
int rv;
iposix_info_t *info = handler->internal_data;
struct selector_s *posix_sel = info->sel;
timer_data = malloc(sizeof(*timer_data));
if (!timer_data)
return ENOMEM;
timer_data->running = 0;
timer_data->timed_out = NULL;
timer_data->handler = handler;
rv = sel_alloc_timer(posix_sel, timer_handler, timer_data,
&(timer_data->timer));
if (rv) {
free(timer_data);
return rv;
}
*id = timer_data;
return 0;
}
static int
free_timer(os_handler_t *handler, os_hnd_timer_id_t *timer_data)
{
sel_free_timer(timer_data->timer);
free(timer_data);
return 0;
}
static int
get_random(os_handler_t *handler, void *data, unsigned int len)
{
int fd = open("/dev/urandom", O_RDONLY);
int rv = 0;
if (fd == -1)
return errno;
while (len > 0) {
rv = read(fd, data, len);
if (rv < 0) {
rv = errno;
goto out;
}
len -= rv;
data += rv;
}
rv = 0;
out:
close(fd);
return rv;
}
static void
default_vlog(const char *format,
enum ipmi_log_type_e log_type,
va_list ap)
{
int do_nl = 1;
switch(log_type)
{
case IPMI_LOG_INFO:
fprintf(stderr, "INFO: ");
break;
case IPMI_LOG_WARNING:
fprintf(stderr, "WARN: ");
break;
case IPMI_LOG_SEVERE:
fprintf(stderr, "SEVR: ");
break;
case IPMI_LOG_FATAL:
fprintf(stderr, "FATL: ");
break;
case IPMI_LOG_ERR_INFO:
fprintf(stderr, "EINF: ");
break;
case IPMI_LOG_DEBUG_START:
do_nl = 0;
/* FALLTHROUGH */
case IPMI_LOG_DEBUG:
fprintf(stderr, "DEBG: ");
break;
case IPMI_LOG_DEBUG_CONT:
do_nl = 0;
/* FALLTHROUGH */
case IPMI_LOG_DEBUG_END:
break;
}
vfprintf(stderr, format, ap);
if (do_nl)
fprintf(stderr, "\n");
}
static void
sposix_vlog(os_handler_t *handler,
enum ipmi_log_type_e log_type,
const char *format,
va_list ap)
{
iposix_info_t *info = handler->internal_data;
os_vlog_t log_handler = info->log_handler;
if (log_handler)
log_handler(handler, format, log_type, ap);
else if (posix_vlog)
posix_vlog((char *) format, log_type, ap);
else
default_vlog(format, log_type, ap);
}
static void
sposix_log(os_handler_t *handler,
enum ipmi_log_type_e log_type,
const char *format,
...)
{
va_list ap;
va_start(ap, format);
sposix_vlog(handler, log_type, format, ap);
va_end(ap);
}
static int
perform_one_op(os_handler_t *os_hnd,
struct timeval *timeout)
{
iposix_info_t *info = os_hnd->internal_data;
int rv;
rv = sel_select(info->sel, NULL, 0, NULL, timeout);
if (rv == -1)
return errno;
return 0;
}
static void
operation_loop(os_handler_t *os_hnd)
{
iposix_info_t *info = os_hnd->internal_data;
sel_select_loop(info->sel, NULL, 0, NULL);
}
static void
free_os_handler(os_handler_t *os_hnd)
{
iposix_info_t *info = os_hnd->internal_data;
sel_free_selector(info->sel);
ipmi_posix_free_os_handler(os_hnd);
}
static void *
posix_malloc(int size)
{
return malloc(size);
}
static void
posix_free(void *data)
{
free(data);
}
#ifdef HAVE_GDBM
#define GDBM_FILE ".OpenIPMI_db"
static void
init_gdbm(iposix_info_t *info)
{
if (!info->gdbm_filename) {
char *home = getenv("HOME");
if (!home)
return;
info->gdbm_filename = malloc(strlen(home)+strlen(GDBM_FILE)+2);
if (!info->gdbm_filename)
return;
strcpy(info->gdbm_filename, home);
strcat(info->gdbm_filename, "/");
strcat(info->gdbm_filename, GDBM_FILE);
}
info->gdbmf = gdbm_open(info->gdbm_filename, 512, GDBM_WRCREAT, 0600,
NULL);
/* gdbmf will be NULL on error, which is what reports an error. */
}
static int
database_store(os_handler_t *handler,
char *key,
unsigned char *data,
unsigned int data_len)
{
iposix_info_t *info = handler->internal_data;
datum gkey, gdata;
int rv;
if (!info->gdbmf) {
init_gdbm(info);
if (!info->gdbmf)
return EINVAL;
}
gkey.dptr = key;
gkey.dsize = strlen(key);
gdata.dptr = (char *) data;
gdata.dsize = data_len;
rv = gdbm_store(info->gdbmf, gkey, gdata, GDBM_REPLACE);
if (rv)
return EINVAL;
return 0;
}
static int
database_find(os_handler_t *handler,
char *key,
unsigned int *fetch_completed,
unsigned char **data,
unsigned int *data_len,
void (*got_data)(void *cb_data,
int err,
unsigned char *data,
unsigned int data_len),
void *cb_data)
{
iposix_info_t *info = handler->internal_data;
datum gkey, gdata;
if (!info->gdbmf) {
init_gdbm(info);
if (!info->gdbmf)
return EINVAL;
}
gkey.dptr = key;
gkey.dsize = strlen(key);
gdata = gdbm_fetch(info->gdbmf, gkey);
if (!gdata.dptr)
return EINVAL;
*data = (unsigned char *) gdata.dptr;
*data_len = gdata.dsize;
*fetch_completed = 1;
return 0;
}
static void
database_free(os_handler_t *handler,
unsigned char *data)
{
free(data);
}
static int
set_gdbm_filename(os_handler_t *os_hnd, char *name)
{
iposix_info_t *info = os_hnd->internal_data;
char *nname;
nname = strdup(name);
if (!nname)
return ENOMEM;
if (info->gdbm_filename)
free(info->gdbm_filename);
info->gdbm_filename = nname;
return 0;
}
#endif
static void sset_log_handler(os_handler_t *handler,
os_vlog_t log_handler)
{
iposix_info_t *info = handler->internal_data;
info->log_handler = log_handler;
}
static int get_posix_time(clockid_t clock,
struct timeval *tv)
{
struct timespec ts;
int rv;
rv = clock_gettime(clock, &ts);
if (rv)
return rv;
tv->tv_sec = ts.tv_sec;
tv->tv_usec = (ts.tv_nsec + 500) / 1000;
return 0;
}
static int get_monotonic_time(os_handler_t *handler,
struct timeval *tv)
{
return get_posix_time(CLOCK_MONOTONIC, tv);
}
static int get_real_time(os_handler_t *handler,
struct timeval *tv)
{
return get_posix_time(CLOCK_REALTIME, tv);
}
static os_handler_t ipmi_posix_os_handler =
{
.mem_alloc = posix_malloc,
.mem_free = posix_free,
.add_fd_to_wait_for = add_fd,
.remove_fd_to_wait_for = remove_fd,
.set_fd_handlers = set_fd_handlers,
.set_fd_enables = set_fd_enables,
.start_timer = start_timer,
.stop_timer = stop_timer,
.alloc_timer = alloc_timer,
.free_timer = free_timer,
.get_random = get_random,
.log = sposix_log,
.vlog = sposix_vlog,
.free_os_handler = free_os_handler,
.perform_one_op = perform_one_op,
.operation_loop = operation_loop,
#ifdef HAVE_GDBM
.database_store = database_store,
.database_find = database_find,
.database_free = database_free,
.database_set_filename = set_gdbm_filename,
#endif
.set_log_handler = sset_log_handler,
.get_monotonic_time = get_monotonic_time,
.get_real_time = get_real_time
};
os_handler_t *
ipmi_posix_get_os_handler(void)
{
os_handler_t *rv;
iposix_info_t *info;
rv = malloc(sizeof(*rv));
if (!rv)
return NULL;
memcpy(rv, &ipmi_posix_os_handler, sizeof(*rv));
info = malloc(sizeof(*info));
if (!info) {
free(rv);
return NULL;
}
memset(info, 0, sizeof(*info));
rv->internal_data = info;
return rv;
}
void
ipmi_posix_free_os_handler(os_handler_t *os_hnd)
{
iposix_info_t *info = os_hnd->internal_data;
#ifdef HAVE_GDBM
if (info->gdbm_filename)
free(info->gdbm_filename);
if (info->gdbmf)
gdbm_close(info->gdbmf);
#endif
free(info);
free(os_hnd);
}
void
ipmi_posix_os_handler_set_sel(os_handler_t *os_hnd, struct selector_s *sel)
{
iposix_info_t *info = os_hnd->internal_data;
info->sel = sel;
}
struct selector_s *
ipmi_posix_os_handler_get_sel(os_handler_t *os_hnd)
{
iposix_info_t *info = os_hnd->internal_data;
return info->sel;
}
os_handler_t *
ipmi_posix_setup_os_handler(void)
{
os_handler_t *os_hnd;
struct selector_s *sel;
int rv;
iposix_info_t *info;
os_hnd = ipmi_posix_get_os_handler();
if (!os_hnd)
return NULL;
rv = sel_alloc_selector_nothread(&sel);
if (rv) {
ipmi_posix_free_os_handler(os_hnd);
os_hnd = NULL;
goto out;
}
info = os_hnd->internal_data;
info->sel = sel;
out:
return os_hnd;
}
/*
* Cruft below, do not use.
*/
int
ipmi_posix_sel_select(os_handler_t *os_hnd,
struct timeval *timeout)
{
return perform_one_op(os_hnd, timeout);
}
void
ipmi_posix_sel_select_loop(os_handler_t *os_hnd)
{
operation_loop(os_hnd);
}
void
ipmi_posix_cleanup_os_handler(os_handler_t *os_hnd)
{
free_os_handler(os_hnd);
}