BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Revise session API to allow for multiple sessions in future.

This commit is contained in:
Martin Ling 2014-05-04 23:07:00 +01:00
parent 2c1a012ed2
commit 0812c40e36
19 changed files with 283 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
backend.c
View File

@ -27,7 +27,7 @@
#define LOG_PREFIX "backend"
/** @endcond */
extern struct sr_session *session;
extern struct sr_session *sr_current_session;
/**
* @mainpage libsigrok API
@ -360,7 +360,7 @@ SR_API int sr_init(struct sr_context **ctx)
*ctx = context;
context = NULL;
session = NULL;
sr_current_session = NULL;
ret = SR_OK;
done:

1
device.c
View File

@ -232,6 +232,7 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
sdi->version = version ? g_strdup(version) : NULL;
sdi->channels = NULL;
sdi->channel_groups = NULL;
sdi->session = NULL;
sdi->conn = NULL;
sdi->priv = NULL;

2
hardware/asix-sigma/asix-sigma.c
View File

@ -726,7 +726,7 @@ static int convert_trigger(const struct sr_dev_inst *sdi)
devc = sdi->priv;
memset(&devc->trigger, 0, sizeof(struct sigma_trigger));
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
trigger_set = 0;

2
hardware/chronovu-la/protocol.c
View File

@ -272,7 +272,7 @@ SR_PRIV int cv_convert_trigger(const struct sr_dev_inst *sdi)
devc->trigger_mask = 0x0000; /* Default to "don't care". */
devc->trigger_edgemask = 0x0000; /* Default to "state triggered". */
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
if (g_slist_length(trigger->stages) > 1) {

4
hardware/common/serial.c
View File

@ -744,7 +744,7 @@ SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
if (mask & SP_EVENT_ERROR)
serial->pollfds[i].events |= G_IO_ERR;
if (sr_session_source_add_pollfd(&serial->pollfds[i],
if (sr_source_add_pollfd(&serial->pollfds[i],
timeout, cb, cb_data) != SR_OK)
return SR_ERR;
}
@ -757,7 +757,7 @@ SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial)
unsigned int i;
for (i = 0; i < serial->event_set->count; i++)
if (sr_session_source_remove_pollfd(&serial->pollfds[i]) != SR_OK)
if (sr_source_remove_pollfd(&serial->pollfds[i]) != SR_OK)
return SR_ERR;
g_free(serial->pollfds);

4
hardware/demo/demo.c
View File

@ -726,7 +726,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
/* Make channels to unbuffered. */
g_io_channel_set_buffered(devc->channel, FALSE);
sr_session_source_add_channel(devc->channel, G_IO_IN | G_IO_ERR,
sr_source_add_channel(devc->channel, G_IO_IN | G_IO_ERR,
40, prepare_data, (void *)sdi);
/* Send header packet to the session bus. */
@ -748,7 +748,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
devc = sdi->priv;
sr_dbg("Stopping acquisition.");
sr_session_source_remove_channel(devc->channel);
sr_source_remove_channel(devc->channel);
g_io_channel_shutdown(devc->channel, FALSE, NULL);
g_io_channel_unref(devc->channel);
devc->channel = NULL;

2
hardware/fx2lafw/api.c
View File

@ -535,7 +535,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
devc->acq_aborted = FALSE;
devc->empty_transfer_count = 0;
if ((trigger = sr_session_trigger_get())) {
if ((trigger = sr_session_trigger_get(sdi->session))) {
devc->stl = soft_trigger_logic_new(sdi, trigger);
devc->trigger_fired = FALSE;
} else

2
hardware/ikalogic-scanalogic2/protocol.c
View File

@ -494,7 +494,7 @@ SR_PRIV int sl2_convert_trigger(const struct sr_dev_inst *sdi)
devc->trigger_channel = TRIGGER_CHANNEL_0;
devc->trigger_type = TRIGGER_TYPE_NONE;
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
if (g_slist_length(trigger->stages) > 1) {

2
hardware/openbench-logic-sniffer/protocol.c
View File

@ -88,7 +88,7 @@ SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi)
devc->trigger_value[i] = 0;
}
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
devc->num_stages = g_slist_length(trigger->stages);

2
hardware/saleae-logic16/api.c
View File

@ -726,7 +726,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
devc->cur_channel = 0;
memset(devc->channel_data, 0, sizeof(devc->channel_data));
if ((trigger = sr_session_trigger_get())) {
if ((trigger = sr_session_trigger_get(sdi->session))) {
devc->stl = soft_trigger_logic_new(sdi, trigger);
devc->trigger_fired = FALSE;
} else

2
hardware/sysclk-lwla/protocol.c
View File

@ -753,7 +753,7 @@ SR_PRIV int lwla_convert_trigger(const struct sr_dev_inst *sdi)
devc->trigger_values = 0;
devc->trigger_edge_mask = 0;
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
if (g_slist_length(trigger->stages) > 1) {

2
hardware/zeroplus-logic-cube/analyzer.c
View File

@ -499,7 +499,7 @@ SR_PRIV int analyzer_add_triggers(const struct sr_dev_inst *sdi)
devc = sdi->priv;
if (!(trigger = sr_session_trigger_get()))
if (!(trigger = sr_session_trigger_get(sdi->session)))
return SR_OK;
for (l = trigger->stages; l; l = l->next) {

43
hwdriver.c
View File

@ -127,6 +127,8 @@ static struct sr_config_info sr_config_info_data[] = {
{0, 0, NULL, NULL, NULL},
};
extern struct sr_session *sr_current_session;
/**
* Return the list of supported hardware drivers.
*
@ -472,7 +474,23 @@ SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
*/
SR_PRIV int sr_source_remove(int fd)
{
return sr_session_source_remove(fd);
return sr_session_source_remove(sr_current_session, fd);
}
/** @private
* @see sr_session_source_remove_pollfd()
*/
SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd)
{
return sr_session_source_remove_pollfd(sr_current_session, pollfd);
}
/** @private
* @see sr_session_source_remove_channel()
*/
SR_PRIV int sr_source_remove_channel(GIOChannel *channel)
{
return sr_session_source_remove_channel(sr_current_session, channel);
}
/** @private
@ -481,7 +499,28 @@ SR_PRIV int sr_source_remove(int fd)
SR_PRIV int sr_source_add(int fd, int events, int timeout,
sr_receive_data_callback cb, void *cb_data)
{
return sr_session_source_add(fd, events, timeout, cb, cb_data);
return sr_session_source_add(sr_current_session,
fd, events, timeout, cb, cb_data);
}
/** @private
* @see sr_session_source_add_pollfd()
*/
SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
sr_receive_data_callback cb, void *cb_data)
{
return sr_session_source_add_pollfd(sr_current_session,
pollfd, timeout, cb, cb_data);
}
/** @private
* @see sr_session_source_add_channel()
*/
SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events,
int timeout, sr_receive_data_callback cb, void *cb_data)
{
return sr_session_source_add_channel(sr_current_session,
channel, events, timeout, cb, cb_data);
}
/** @} */

8
libsigrok-internal.h
View File

@ -262,8 +262,14 @@ SR_PRIV void sr_hw_cleanup_all(void);
SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
SR_PRIV void sr_config_free(struct sr_config *src);
SR_PRIV int sr_source_remove(int fd);
SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
SR_PRIV int sr_source_add(int fd, int events, int timeout,
sr_receive_data_callback cb, void *cb_data);
SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
sr_receive_data_callback cb, void *cb_data);
SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
sr_receive_data_callback cb, void *cb_data);
/*--- session.c -------------------------------------------------------------*/
@ -301,7 +307,7 @@ struct sr_session {
SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
const struct sr_datafeed_packet *packet);
SR_PRIV int sr_session_stop_sync(void);
SR_PRIV int sr_session_stop_sync(struct sr_session *session);
SR_PRIV int sr_sessionfile_check(const char *filename);
/*--- std.c -----------------------------------------------------------------*/

12
libsigrok.h
View File

@ -377,6 +377,16 @@ struct sr_trigger_match {
*/
struct sr_context;
/**
* @struct sr_session
* Opaque structure representing a libsigrok session.
*
* None of the fields of this structure are meant to be accessed directly.
*
* @see sr_session_new(), sr_session_destroy().
*/
struct sr_session;
/** Packet in a sigrok data feed. */
struct sr_datafeed_packet {
uint16_t type;
@ -923,6 +933,8 @@ struct sr_dev_inst {
void *conn;
/** Device instance private data (used?) */
void *priv;
/** Session to which this device is currently assigned. */
struct sr_session *session;
};
/** Types of device instance, struct sr_dev_inst.type */

62
proto.h
View File

@ -80,41 +80,47 @@ SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
const struct sr_datafeed_packet *packet, void *cb_data);
SR_API struct sr_trigger *sr_session_trigger_get(void);
SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
/* Session setup */
SR_API int sr_session_load(const char *filename);
SR_API struct sr_session *sr_session_new(void);
SR_API int sr_session_destroy(void);
SR_API int sr_session_dev_remove_all(void);
SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
SR_API int sr_session_dev_list(GSList **devlist);
SR_API int sr_session_trigger_set(struct sr_trigger *trig);
SR_API int sr_session_load(const char *filename, struct sr_session **session);
SR_API int sr_session_new(struct sr_session **session);
SR_API int sr_session_destroy(struct sr_session *session);
SR_API int sr_session_dev_remove_all(struct sr_session *session);
SR_API int sr_session_dev_add(struct sr_session *session,
struct sr_dev_inst *sdi);
SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
/* Datafeed setup */
SR_API int sr_session_datafeed_callback_remove_all(void);
SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb,
void *cb_data);
SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
sr_datafeed_callback cb, void *cb_data);
/* Session control */
SR_API int sr_session_start(void);
SR_API int sr_session_run(void);
SR_API int sr_session_stop(void);
SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
unsigned char *buf, int unitsize, int units);
SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
char **channels);
SR_API int sr_session_append(const char *filename, unsigned char *buf,
int unitsize, int units);
SR_API int sr_session_source_add(int fd, int events, int timeout,
SR_API int sr_session_start(struct sr_session *session);
SR_API int sr_session_run(struct sr_session *session);
SR_API int sr_session_stop(struct sr_session *session);
SR_API int sr_session_save(struct sr_session *session, const char *filename,
const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
int units);
SR_API int sr_session_save_init(struct sr_session *session,
const char *filename, uint64_t samplerate, char **channels);
SR_API int sr_session_append(struct sr_session *session,
const char *filename, unsigned char *buf, int unitsize, int units);
SR_API int sr_session_source_add(struct sr_session *session, int fd,
int events, int timeout, sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_add_pollfd(struct sr_session *session,
GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
void *cb_data);
SR_API int sr_session_source_add_channel(struct sr_session *session,
GIOChannel *channel, int events, int timeout,
sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
int timeout, sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_remove(int fd);
SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
SR_API int sr_session_source_remove_channel(GIOChannel *channel);
SR_API int sr_session_source_remove(struct sr_session *session, int fd);
SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
GPollFD *pollfd);
SR_API int sr_session_source_remove_channel(struct sr_session *session,
GIOChannel *channel);
/*--- input/input.c ---------------------------------------------------------*/

260
session.c
View File

@ -59,79 +59,91 @@ struct datafeed_callback {
void *cb_data;
};
/* There can only be one session at a time. */
/* 'session' is not static, it's used elsewhere (via 'extern'). */
struct sr_session *session;
/* There can currently only be one session at a time. */
/* 'sr_current_session' is not static, it's used elsewhere (via 'extern'). */
struct sr_session *sr_current_session;
/**
* Create a new session.
*
* @todo Should it use the file-global "session" variable or take an argument?
* The same question applies to all the other session functions.
*
* @retval NULL Error.
* @retval other A pointer to the newly allocated session.
*
* @since 0.1.0
*/
SR_API struct sr_session *sr_session_new(void)
{
if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
sr_err("Session malloc failed.");
return NULL;
}
session->source_timeout = -1;
session->running = FALSE;
session->abort_session = FALSE;
g_mutex_init(&session->stop_mutex);
return session;
}
/**
* Destroy the current session.
* This frees up all memory used by the session.
* Currently, there can be only one session at a time within the same process.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG No session exists.
* @retval SR_ERR_BUG A session exists already.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_destroy(void)
SR_API int sr_session_new(struct sr_session **session)
{
if (!session) {
sr_err("%s: session was NULL", __func__);
if (sr_current_session) {
sr_err("%s: session already exists", __func__);
return SR_ERR_BUG;
}
sr_session_dev_remove_all();
g_mutex_clear(&session->stop_mutex);
if (session->trigger)
sr_trigger_free(session->trigger);
sr_current_session = g_malloc0(sizeof(struct sr_session));
g_free(session);
session = NULL;
sr_current_session->source_timeout = -1;
sr_current_session->running = FALSE;
sr_current_session->abort_session = FALSE;
g_mutex_init(&sr_current_session->stop_mutex);
*session = sr_current_session;
return SR_OK;
}
/**
* Remove all the devices from the current session.
* Destroy a session.
* This frees up all memory used by the session.
*
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
* @since 0.4.0
*/
SR_API int sr_session_destroy(struct sr_session *session)
{
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_ARG;
}
sr_session_dev_remove_all(session);
g_mutex_clear(&session->stop_mutex);
if (session->trigger)
sr_trigger_free(session->trigger);
g_free(session);
if (session == sr_current_session)
sr_current_session = NULL;
return SR_OK;
}
/**
* Remove all the devices from a session.
*
* The session itself (i.e., the struct sr_session) is not free'd and still
* exists after this function returns.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG No session exists.
* @retval SR_ERR_BUG Invalid session passed.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_dev_remove_all(void)
SR_API int sr_session_dev_remove_all(struct sr_session *session)
{
struct sr_dev_inst *sdi;
GSList *l;
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
for (l = session->devs; l; l = l->next) {
sdi = (struct sr_dev_inst *) l->data;
sdi->session = NULL;
}
g_slist_free(session->devs);
@ -141,19 +153,19 @@ SR_API int sr_session_dev_remove_all(void)
}
/**
* Add a device instance to the current session.
* Add a device instance to a session.
*
* @param sdi The device instance to add to the current session. Must not
* @param sdi The device instance to add to a session. Must not
* be NULL. Also, sdi->driver and sdi->driver->dev_open must
* not be NULL.
*
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid argument.
* @retval SR_ERR_BUG No session exists.
*
* @since 0.2.0
* @since 0.4.0
*/
SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
SR_API int sr_session_dev_add(struct sr_session *session,
struct sr_dev_inst *sdi)
{
int ret;
@ -164,7 +176,14 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
/* If sdi->session is not NULL, the device is already in this or
* another session. */
if (sdi->session) {
sr_err("%s: already assigned to session", __func__);
return SR_ERR_ARG;
}
/* If sdi->driver is NULL, this is a virtual device. */
@ -173,6 +192,7 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
"a virtual device; continuing", __func__);
/* Just add the device, don't run dev_open(). */
session->devs = g_slist_append(session->devs, (gpointer)sdi);
sdi->session = session;
return SR_OK;
}
@ -183,6 +203,7 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
}
session->devs = g_slist_append(session->devs, (gpointer)sdi);
sdi->session = session;
if (session->running) {
/* Adding a device to a running session. Commit settings
@ -205,7 +226,7 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
}
/**
* List all device instances attached to the current session.
* List all device instances attached to a session.
*
* @param devlist A pointer where the device instance list will be
* stored on return. If no devices are in the session,
@ -215,17 +236,17 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
* elements pointed to.
*
* @retval SR_OK Success.
* @retval SR_ERR Invalid argument.
* @retval SR_ERR_ARG Invalid argument.
*
* @since 0.3.0
* @since 0.4.0
*/
SR_API int sr_session_dev_list(GSList **devlist)
SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
{
*devlist = NULL;
if (!session)
return SR_ERR;
return SR_ERR_ARG;
if (!devlist)
return SR_ERR_ARG;
*devlist = g_slist_copy(session->devs);
@ -233,18 +254,18 @@ SR_API int sr_session_dev_list(GSList **devlist)
}
/**
* Remove all datafeed callbacks in the current session.
* Remove all datafeed callbacks in a session.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG No session exists.
* @retval SR_ERR_ARG Invalid session passed.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_datafeed_callback_remove_all(void)
SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
{
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
g_slist_free_full(session->datafeed_callbacks, g_free);
@ -254,7 +275,7 @@ SR_API int sr_session_datafeed_callback_remove_all(void)
}
/**
* Add a datafeed callback to the current session.
* Add a datafeed callback to a session.
*
* @param cb Function to call when a chunk of data is received.
* Must not be NULL.
@ -265,7 +286,8 @@ SR_API int sr_session_datafeed_callback_remove_all(void)
*
* @since 0.3.0
*/
SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data)
SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
sr_datafeed_callback cb, void *cb_data)
{
struct datafeed_callback *cb_struct;
@ -291,12 +313,12 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_da
return SR_OK;
}
SR_API struct sr_trigger *sr_session_trigger_get(void)
SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
{
return session->trigger;
}
SR_API int sr_session_trigger_set(struct sr_trigger *trig)
SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
{
session->trigger = trig;
@ -304,7 +326,7 @@ SR_API int sr_session_trigger_set(struct sr_trigger *trig)
}
/**
* Call every device in the session's callback.
* Call every device in the current session's callback.
*
* For sessions not driven by select loops such as sr_session_run(),
* but driven by another scheduler, this can be used to poll the devices
@ -322,6 +344,7 @@ SR_API int sr_session_trigger_set(struct sr_trigger *trig)
*/
static int sr_session_iteration(gboolean block)
{
struct sr_session *session = sr_current_session;
unsigned int i;
int ret;
@ -338,7 +361,8 @@ static int sr_session_iteration(gboolean block)
if (!session->sources[i].cb(session->pollfds[i].fd,
session->pollfds[i].revents,
session->sources[i].cb_data))
sr_session_source_remove(session->sources[i].poll_object);
sr_session_source_remove(session,
session->sources[i].poll_object);
}
/*
* We want to take as little time as possible to stop
@ -348,7 +372,7 @@ static int sr_session_iteration(gboolean block)
*/
g_mutex_lock(&session->stop_mutex);
if (session->abort_session) {
sr_session_stop_sync();
sr_session_stop_sync(session);
/* But once is enough. */
session->abort_session = FALSE;
}
@ -397,29 +421,26 @@ static int verify_trigger(struct sr_trigger *trigger)
/**
* Start a session.
*
* There can only be one session at a time.
*
* @retval SR_OK Success.
* @retval SR_ERR Error occured.
* @retval SR_ERR_ARG Invalid session passed.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_start(void)
SR_API int sr_session_start(struct sr_session *session)
{
struct sr_dev_inst *sdi;
GSList *l;
int ret;
if (!session) {
sr_err("%s: session was NULL; a session must be "
"created before starting it.", __func__);
return SR_ERR_BUG;
sr_err("%s: session was NULL", __func__);
return SR_ERR_ARG;
}
if (!session->devs) {
sr_err("%s: session->devs was NULL; a session "
"cannot be started without devices.", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
if (session->trigger && verify_trigger(session->trigger) != SR_OK)
@ -448,26 +469,25 @@ SR_API int sr_session_start(void)
}
/**
* Run the session.
* Run a session.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG Error occured.
* @retval SR_ERR_ARG Invalid session passed.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_run(void)
SR_API int sr_session_run(struct sr_session *session)
{
if (!session) {
sr_err("%s: session was NULL; a session must be "
"created first, before running it.", __func__);
return SR_ERR_BUG;
sr_err("%s: session was NULL", __func__);
return SR_ERR_ARG;
}
if (!session->devs) {
/* TODO: Actually the case? */
sr_err("%s: session->devs was NULL; a session "
"cannot be run without devices.", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
session->running = TRUE;
@ -488,27 +508,27 @@ SR_API int sr_session_run(void)
}
/**
* Stop the current session.
* Stop a session.
*
* The current session is stopped immediately, with all acquisition sessions
* being stopped and hardware drivers cleaned up.
* The session is stopped immediately, with all acquisition sessions stopped
* and hardware drivers cleaned up.
*
* This must be called from within the session thread, to prevent freeing
* resources that the session thread will try to use.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG No session exists.
* @retval SR_ERR_ARG Invalid session passed.
*
* @private
*/
SR_PRIV int sr_session_stop_sync(void)
SR_PRIV int sr_session_stop_sync(struct sr_session *session)
{
struct sr_dev_inst *sdi;
GSList *l;
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
sr_info("Stopping.");
@ -526,10 +546,10 @@ SR_PRIV int sr_session_stop_sync(void)
}
/**
* Stop the current session.
* Stop a session.
*
* The current session is stopped immediately, with all acquisition sessions
* being stopped and hardware drivers cleaned up.
* The session is stopped immediately, with all acquisition sessions being
* stopped and hardware drivers cleaned up.
*
* If the session is run in a separate thread, this function will not block
* until the session is finished executing. It is the caller's responsibility
@ -537,11 +557,11 @@ SR_PRIV int sr_session_stop_sync(void)
* completely decommissioned.
*
* @retval SR_OK Success.
* @retval SR_ERR_BUG No session exists.
* @retval SR_ERR_ARG Invalid session passed.
*
* @since 0.1.0
* @since 0.4.0
*/
SR_API int sr_session_stop(void)
SR_API int sr_session_stop(struct sr_session *session)
{
if (!session) {
sr_err("%s: session was NULL", __func__);
@ -629,7 +649,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
return SR_ERR_ARG;
}
for (l = session->datafeed_callbacks; l; l = l->next) {
for (l = sr_current_session->datafeed_callbacks; l; l = l->next) {
if (sr_log_loglevel_get() >= SR_LOG_DBG)
datafeed_dump(packet);
cb_struct = l->data;
@ -656,6 +676,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
static int _sr_session_source_add(GPollFD *pollfd, int timeout,
sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
{
struct sr_session *session = sr_current_session;
struct source *new_sources, *s;
GPollFD *new_pollfds;
@ -711,11 +732,13 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout,
*
* @since 0.3.0
*/
SR_API int sr_session_source_add(int fd, int events, int timeout,
sr_receive_data_callback cb, void *cb_data)
SR_API int sr_session_source_add(struct sr_session *session, int fd,
int events, int timeout, sr_receive_data_callback cb, void *cb_data)
{
GPollFD p;
(void) session;
p.fd = fd;
p.events = events;
@ -736,9 +759,12 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
*
* @since 0.3.0
*/
SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
sr_receive_data_callback cb, void *cb_data)
SR_API int sr_session_source_add_pollfd(struct sr_session *session,
GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
void *cb_data)
{
(void) session;
return _sr_session_source_add(pollfd, timeout, cb,
cb_data, (gintptr)pollfd);
}
@ -758,11 +784,14 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
*
* @since 0.3.0
*/
SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
int timeout, sr_receive_data_callback cb, void *cb_data)
SR_API int sr_session_source_add_channel(struct sr_session *session,
GIOChannel *channel, int events, int timeout,
sr_receive_data_callback cb, void *cb_data)
{
GPollFD p;
(void) session;
#ifdef _WIN32
g_io_channel_win32_make_pollfd(channel, events, &p);
#else
@ -787,6 +816,7 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
*/
static int _sr_session_source_remove(gintptr poll_object)
{
struct sr_session *session = sr_current_session;
struct source *new_sources;
GPollFD *new_pollfds;
unsigned int old;
@ -844,8 +874,10 @@ static int _sr_session_source_remove(gintptr poll_object)
*
* @since 0.3.0
*/
SR_API int sr_session_source_remove(int fd)
SR_API int sr_session_source_remove(struct sr_session *session, int fd)
{
(void) session;
return _sr_session_source_remove((gintptr)fd);
}
@ -860,8 +892,11 @@ SR_API int sr_session_source_remove(int fd)
*
* @since 0.2.0
*/
SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
GPollFD *pollfd)
{
(void) session;
return _sr_session_source_remove((gintptr)pollfd);
}
@ -877,8 +912,11 @@ SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
*
* @since 0.2.0
*/
SR_API int sr_session_source_remove_channel(GIOChannel *channel)
SR_API int sr_session_source_remove_channel(struct sr_session *session,
GIOChannel *channel)
{
(void) session;
return _sr_session_source_remove((gintptr)channel);
}

6
session_driver.c
View File

@ -53,6 +53,8 @@ static const int hwcaps[] = {
SR_CONF_SAMPLERATE,
};
extern struct sr_session *sr_current_session;
static int receive_data(int fd, int revents, void *cb_data)
{
struct sr_dev_inst *sdi;
@ -160,7 +162,7 @@ static int receive_data(int fd, int revents, void *cb_data)
if (!got_data) {
packet.type = SR_DF_END;
sr_session_send(cb_data, &packet);
sr_session_source_remove(-1);
sr_session_source_remove(sr_current_session, -1);
}
return TRUE;
@ -311,7 +313,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
std_session_send_df_header(cb_data, LOG_PREFIX);
/* freewheeling source */
sr_session_source_add(-1, 0, 0, receive_data, cb_data);
sr_session_source_add(sr_current_session, -1, 0, 0, receive_data, cb_data);
return SR_OK;
}

35
session_file.c
View File

@ -107,7 +107,7 @@ SR_PRIV int sr_sessionfile_check(const char *filename)
* SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
* other errors.
*/
SR_API int sr_session_load(const char *filename)
SR_API int sr_session_load(const char *filename, struct sr_session **session)
{
GKeyFile *kf;
GPtrArray *capturefiles;
@ -145,7 +145,8 @@ SR_API int sr_session_load(const char *filename)
return SR_ERR;
}
sr_session_new();
if ((ret = sr_session_new(session)) != SR_OK)
return ret;
devcnt = 0;
capturefiles = g_ptr_array_new_with_free_func(g_free);
@ -168,7 +169,7 @@ SR_API int sr_session_load(const char *filename)
/* first device, init the driver */
sdi->driver->init(NULL);
sr_dev_open(sdi);
sr_session_dev_add(sdi);
sr_session_dev_add(*session, sdi);
sdi->driver->config_set(SR_CONF_SESSIONFILE,
g_variant_new_string(filename), sdi, NULL);
sdi->driver->config_set(SR_CONF_CAPTUREFILE,
@ -217,9 +218,9 @@ SR_API int sr_session_load(const char *filename)
}
/**
* Save the current session to the specified file.
* Save a session to the specified file.
*
* @param filename The name of the filename to save the current session as.
* @param filename The name of the filename to save the session as.
* Must not be NULL.
* @param sdi The device instance from which the data was captured.
* @param buf The data to be saved.
@ -232,8 +233,9 @@ SR_API int sr_session_load(const char *filename)
*
* @since 0.2.0
*/
SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
unsigned char *buf, int unitsize, int units)
SR_API int sr_session_save(struct sr_session *session, const char *filename,
const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
int units)
{
struct sr_channel *ch;
GSList *l;
@ -265,10 +267,11 @@ SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
channel_names[cnt++] = ch->name;
}
if ((ret = sr_session_save_init(filename, samplerate, channel_names)) != SR_OK)
if ((ret = sr_session_save_init(session, filename, samplerate,
channel_names)) != SR_OK)
return ret;
ret = sr_session_append(filename, buf, unitsize, units);
ret = sr_session_append(session, filename, buf, unitsize, units);
return ret;
}
@ -276,7 +279,7 @@ SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
/**
* Initialize a saved session file.
*
* @param filename The name of the filename to save the current session as.
* @param filename The name of the filename to save the session as.
* Must not be NULL.
* @param samplerate The samplerate to store for this session.
* @param channels A NULL-terminated array of strings containing the names
@ -288,8 +291,8 @@ SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
*
* @since 0.3.0
*/
SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
char **channels)
SR_API int sr_session_save_init(struct sr_session *session,
const char *filename, uint64_t samplerate, char **channels)
{
FILE *meta;
struct zip *zipfile;
@ -297,6 +300,8 @@ SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
int tmpfile, cnt, ret, i;
char version[1], metafile[32], *s;
(void) session;
if (!filename) {
sr_err("%s: filename was NULL", __func__);
return SR_ERR_ARG;
@ -381,8 +386,8 @@ SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
*
* @since 0.3.0
*/
SR_API int sr_session_append(const char *filename, unsigned char *buf,
int unitsize, int units)
SR_API int sr_session_append(struct sr_session *session, const char *filename,
unsigned char *buf, int unitsize, int units)
{
struct zip *archive;
struct zip_source *logicsrc;
@ -397,6 +402,8 @@ SR_API int sr_session_append(const char *filename, unsigned char *buf,
const char *entry_name;
char *metafile, tmpname[32], chunkname[16];
(void) session;
if ((ret = sr_sessionfile_check(filename)) != SR_OK)
return ret;