pcitool/pcilib/event.c

#define _POSIX_C_SOURCE 199309L
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdarg.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/ioctl.h>
#include <sys/mman.h>
#include <arpa/inet.h>
#include <errno.h>
#include <assert.h>
#include <time.h>

#include "pci.h"

#include "tools.h"
#include "error.h"

/* Newer versions of glibc guard timespec with a different definition guard, compliant to linux/time.h
 * We need to check for both definition guards to prevent accidental redifinitions of struct timespec
 */
#if (defined(__timespec_defined) && __timespec_defined) || \
    (defined(_STRUCT_TIMESPEC) && _STRUCT_TIMESPEC)
#define PCILIB_DEFINE_TIMESPEC 0
#else
#define PCILIB_DEFINE_TIMESPEC 1
#endif

#if (defined(PCILIB_DEFINE_TIMESPEC) && PCILIB_DEFINE_TIMESPEC)
struct timespec {
    time_t tv_sec;
    long tv_nsec;
};
#endif /* PCILIB_DEFINE_TIMESPEC */


pcilib_event_t pcilib_find_event(pcilib_t *ctx, const char *event) {
    int i;

    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_description_t *events = model_info->events;

    for (i = 0; events[i].name; i++) {
	if (!strcasecmp(events[i].name, event)) return events[i].evid;
    }

    return (pcilib_event_t)-1;
}

pcilib_event_data_type_t pcilib_find_event_data_type(pcilib_t *ctx, pcilib_event_t event, const char *data_type) {
    int i;
    
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_data_type_description_t *data_types = model_info->data_types;
    
    for (i = 0; data_types[i].name; i++) {
	if ((data_types[i].evid&event)&&(!strcasecmp(data_types[i].name, data_type))) return data_types[i].data_type;
    }

    return (pcilib_event_data_type_t)-1;
}

int pcilib_init_event_engine(pcilib_t *ctx) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;

    if ((api)&&(api->init)) {
	ctx->event_ctx = api->init(ctx);
	if (ctx->event_ctx) {
	    ctx->event_ctx->pcilib = ctx;
	}
    }
    
    return 0;
}

pcilib_context_t *pcilib_get_event_engine(pcilib_t *ctx) {
    return ctx->event_ctx;
}

int pcilib_reset(pcilib_t *ctx) {
    const pcilib_event_api_description_t *api;
    
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }
    
    if (api->reset) 
	return api->reset(ctx->event_ctx);
	
    return 0;
}

int pcilib_configure_rawdata_callback(pcilib_t *ctx, pcilib_event_rawdata_callback_t callback, void *user) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    ctx->event_ctx->params.rawdata.callback = callback;
    ctx->event_ctx->params.rawdata.user = user;
    
    return 0;    
}

int pcilib_configure_autostop(pcilib_t *ctx, size_t max_events, pcilib_timeout_t duration) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    ctx->event_ctx->params.autostop.max_events = max_events;
    ctx->event_ctx->params.autostop.duration = duration;
    
    return 0;    
}

int pcilib_configure_autotrigger(pcilib_t *ctx, pcilib_timeout_t interval, pcilib_event_t event, size_t trigger_size, void *trigger_data) {
	/* To support hardware without autotriggering, we need to provide in event.c a code 
	to generate multiple triggers in a thread (available in cli). The function should 
	be re-enabled afterwards: just set parameters and let implementation decide if it 
	can make triggering in hardware or will use our emulation */
	
    return PCILIB_ERROR_NOTSUPPORTED;
}

int pcilib_configure_preprocessing_threads(pcilib_t *ctx, size_t max_threads) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    ctx->event_ctx->params.parallel.max_threads = max_threads;

    return 0;
}

int pcilib_start(pcilib_t *ctx, pcilib_event_t event_mask, pcilib_event_flags_t flags) {
    int err;
    pcilib_register_value_t max_threads;

    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    err = pcilib_read_register(ctx, "conf", "max_threads", &max_threads);
    if (!err) {
	err = pcilib_configure_preprocessing_threads(ctx, max_threads);
	if (err) pcilib_warning("Error (%i) configuring number of preprocessing threads", err);
    }

    if (api->start) 
	return api->start(ctx->event_ctx, event_mask, flags);

    return 0;
}

int pcilib_stop(pcilib_t *ctx, pcilib_event_flags_t flags) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->stop) 
	return api->stop(ctx->event_ctx, flags);

    return 0;
}

int pcilib_stream(pcilib_t *ctx, pcilib_event_callback_t callback, void *user) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->stream)
	return api->stream(ctx->event_ctx, callback, user);

    if (api->next_event) {
	pcilib_error("Streaming using next_event API is not implemented yet");
    }

    pcilib_error("Event enumeration is not suppored by API");
    return PCILIB_ERROR_NOTSUPPORTED;
}
/*
typedef struct {
    pcilib_event_id_t event_id;
    pcilib_event_info_t *info;
} pcilib_return_event_callback_context_t;

static int pcilib_return_event_callback(pcilib_event_id_t event_id, pcilib_event_info_t *info, void *user) {
    pcilib_return_event_callback_context_t *ctx = (pcilib_return_event_callback_context_t*)user;
    ctx->event_id = event_id;
    ctx->info = info;
}
*/

int pcilib_get_next_event(pcilib_t *ctx, pcilib_timeout_t timeout, pcilib_event_id_t *evid, size_t info_size, pcilib_event_info_t *info) {
    const pcilib_event_api_description_t *api;
//    pcilib_return_event_callback_context_t user;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->next_event) 
	return api->next_event(ctx->event_ctx, timeout, evid, info_size, info);

/*	
    if (api->stream) {
	err = api->stream(ctx->event_ctx, 1, timeout, pcilib_return_event_callback, &user);
	if (err) return err;
	
	if (evid) *evid = user->event_id;
	if (info) *info = user->info;

	return 0;
    }
*/

    pcilib_error("Event enumeration is not suppored by API");
    return PCILIB_ERROR_NOTSUPPORTED;
}

int pcilib_trigger(pcilib_t *ctx, pcilib_event_t event, size_t trigger_size, void *trigger_data) {
    const pcilib_event_api_description_t *api;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);

    api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->trigger) 
	return api->trigger(ctx->event_ctx, event, trigger_size, trigger_data);

    pcilib_error("Self triggering is not supported by the selected model");
    return PCILIB_ERROR_NOTSUPPORTED;
}


void *pcilib_get_data_with_argument(pcilib_t *ctx, pcilib_event_id_t event_id, pcilib_event_data_type_t data_type, size_t arg_size, void *arg, size_t *size) {
    int err;
    void *res = NULL;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_api_description_t *api = model_info->api;
    if (!api) {
	if (size) *size = (size_t)PCILIB_ERROR_NOTSUPPORTED;
	pcilib_error("Event API is not supported by the selected model");
	return NULL;
    }

    if (api->get_data) {
	err = api->get_data(ctx->event_ctx, event_id, data_type, arg_size, arg, size, &res);
	if (err) {
	    if (size) *size = (size_t)err;
	    return NULL;
	}
	return res;
    }
    
    if (size) *size = (size_t)PCILIB_ERROR_NOTSUPPORTED;
    return NULL;
}

int pcilib_copy_data_with_argument(pcilib_t *ctx, pcilib_event_id_t event_id, pcilib_event_data_type_t data_type, size_t arg_size, void *arg, size_t size, void *buf, size_t *retsize) {
    int err;
    void *res = buf;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_api_description_t *api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->get_data) {
	err = api->get_data(ctx->event_ctx, event_id, data_type, arg_size, arg, &size, &res);
	if (err) return err;
	
	if (buf != res) memcpy(buf, res, size);
	
	if (retsize) *retsize = size;
	return 0;
    }	

    return PCILIB_ERROR_NOTSUPPORTED;
}


void *pcilib_get_data(pcilib_t *ctx, pcilib_event_id_t event_id, pcilib_event_data_type_t data_type, size_t *size) {
    int err;
    void *res = NULL;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_api_description_t *api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	if (size) *size = (size_t)PCILIB_ERROR_NOTSUPPORTED;
	return NULL;
    }

    if (api->get_data) {
	err = api->get_data(ctx->event_ctx, event_id, data_type, 0, NULL, size, &res);
	if (err) {
	    if (size) *size = (size_t)err;
	    return NULL;
	}
	return res;
    }

    if (size) *size = (size_t)PCILIB_ERROR_NOTSUPPORTED;
    return NULL;
}

int pcilib_copy_data(pcilib_t *ctx, pcilib_event_id_t event_id, pcilib_event_data_type_t data_type, size_t size, void *buf, size_t *ret_size) {
    int err;
    void *res = buf;
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_api_description_t *api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->get_data) {
	err = api->get_data(ctx->event_ctx, event_id, data_type, 0, NULL, &size, &res);
	if (err) return err;
	
	if (buf != res) memcpy(buf, res, size);

	if (ret_size) *ret_size = size;
	return 0;
    }

    return PCILIB_ERROR_NOTSUPPORTED;
}

int pcilib_return_data(pcilib_t *ctx, pcilib_event_id_t event_id, pcilib_event_data_type_t data_type, void *data) {
    const pcilib_model_description_t *model_info = pcilib_get_model_description(ctx);
    const pcilib_event_api_description_t *api = model_info->api;
    if (!api) {
	pcilib_error("Event API is not supported by the selected model");
	return PCILIB_ERROR_NOTSUPPORTED;
    }

    if (api->return_data) 
	return api->return_data(ctx->event_ctx, event_id, data_type, data);

    return 0;
}


typedef struct {
    pcilib_t *ctx;
    
    size_t *size;
    void **data;
} pcilib_grab_callback_user_data_t;


static int pcilib_grab_callback(pcilib_event_t event, pcilib_event_id_t event_id, void *vuser) {
    int err;
    void *data;
    size_t size;
    int allocated = 0;

    pcilib_grab_callback_user_data_t *user = (pcilib_grab_callback_user_data_t*)vuser;

    data = pcilib_get_data(user->ctx, event_id, PCILIB_EVENT_DATA, &size);
    if (!data) {
	pcilib_error("Error getting event data");
	return -(int)size;
    }
    
    if (*(user->data)) {
	if ((user->size)&&(*(user->size) < size)) {
	    pcilib_error("The supplied buffer does not have enough space to hold the event data. Buffer size is %z, but %z is required", user->size, size);
	    return -PCILIB_ERROR_MEMORY;
	}

	*(user->size) = size;
    } else {
	*(user->data) = malloc(size);
	if (!*(user->data)) {
	    pcilib_error("Memory allocation (%i bytes) for event data is failed");
	    return -PCILIB_ERROR_MEMORY;
	}
	if (*(user->size)) *(user->size) = size;
	allocated = 1;
    }
    
    memcpy(*(user->data), data, size);
    
    err = pcilib_return_data(user->ctx, event_id, PCILIB_EVENT_DATA, data);
    if (err) {
	if (allocated) {
	    free(*(user->data));
	    *(user->data) = NULL;
	}
	pcilib_error("The event data had been overwritten before it was returned, data corruption may occur");
	return -err;
    }
    
    return PCILIB_STREAMING_CONTINUE;
}

int pcilib_grab(pcilib_t *ctx, pcilib_event_t event_mask, size_t *size, void **data, pcilib_timeout_t timeout) {
    int err;
    pcilib_event_id_t eid;
    
    pcilib_grab_callback_user_data_t user = {ctx, size, data};
    
    err = pcilib_start(ctx, event_mask, PCILIB_EVENT_FLAGS_DEFAULT);
    if (!err) {
	if (timeout == PCILIB_TIMEOUT_IMMEDIATE) {
	     err = pcilib_trigger(ctx, event_mask, 0, NULL);
	     timeout = PCILIB_EVENT_TIMEOUT;
	}
    }
    if (!err) {
	err = pcilib_get_next_event(ctx, timeout, &eid, 0, NULL);
	if (!err) pcilib_grab_callback(event_mask, eid, &user);
    }
    pcilib_stop(ctx, PCILIB_EVENT_FLAGS_DEFAULT);
    return err;
}