session.c

   1 /*
   2  * This file is part of the libsigrokdecode project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include "libsigrokdecode.h"
  24 #include <inttypes.h>
  25 #include <glib.h>
  26
  27 /**
  28  * @file
  29  *
  30  * Session handling.
  31  */
  32
  33 /**
  34  * @defgroup grp_session Session handling
  35  *
  36  * Starting and handling decoding sessions.
  37  *
  38  * @{
  39  */
  40
  41 /** @cond PRIVATE */
  42
  43 SRD_PRIV GSList *sessions = NULL;
  44 SRD_PRIV int max_session_id = -1;
  45
  46 /** @endcond */
  47
  48 /** @private */
  49 SRD_PRIV int session_is_valid(struct srd_session *sess)
  50 {
  51
  52         if (!sess || sess->session_id < 1)
  53                 return SRD_ERR;
  54
  55         return SRD_OK;
  56 }
  57
  58 /**
  59  * Create a decoding session.
  60  *
  61  * A session holds all decoder instances, their stack relationships and
  62  * output callbacks.
  63  *
  64  * @param sess A pointer which will hold a pointer to a newly
  65  *             initialized session on return.
  66  *
  67  * @return SRD_OK upon success, a (negative) error code otherwise.
  68  *
  69  * @since 0.3.0
  70  */
  71 SRD_API int srd_session_new(struct srd_session **sess)
  72 {
  73
  74         if (!sess) {
  75                 srd_err("Invalid session pointer.");
  76                 return SRD_ERR_ARG;
  77         }
  78
  79         *sess = g_malloc(sizeof(struct srd_session));
  80         (*sess)->session_id = ++max_session_id;
  81         (*sess)->di_list = (*sess)->callbacks = NULL;
  82
  83         /* Keep a list of all sessions, so we can clean up as needed. */
  84         sessions = g_slist_append(sessions, *sess);
  85
  86         srd_dbg("Created session %d.", (*sess)->session_id);
  87
  88         return SRD_OK;
  89 }
  90
  91 /**
  92  * Start a decoding session.
  93  *
  94  * Decoders, instances and stack must have been prepared beforehand,
  95  * and all SRD_CONF parameters set.
  96  *
  97  * @param sess The session to start.
  98  *
  99  * @return SRD_OK upon success, a (negative) error code otherwise.
 100  *
 101  * @since 0.3.0
 102  */
 103 SRD_API int srd_session_start(struct srd_session *sess)
 104 {
 105         GSList *d;
 106         struct srd_decoder_inst *di;
 107         int ret;
 108
 109         if (session_is_valid(sess) != SRD_OK) {
 110                 srd_err("Invalid session pointer.");
 111                 return SRD_ERR;
 112         }
 113
 114         srd_dbg("Calling start() on all instances in session %d.", sess->session_id);
 115
 116         /* Run the start() method on all decoders receiving frontend data. */
 117         ret = SRD_OK;
 118         for (d = sess->di_list; d; d = d->next) {
 119                 di = d->data;
 120                 if ((ret = srd_inst_start(di)) != SRD_OK)
 121                         break;
 122         }
 123
 124         return ret;
 125 }
 126
 127 static int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
 128                 GVariant *data)
 129 {
 130         PyObject *py_ret;
 131         GSList *l;
 132         struct srd_decoder_inst *next_di;
 133         int ret;
 134
 135         if (key != SRD_CONF_SAMPLERATE)
 136                 /* This is the only key we pass on to the decoder for now. */
 137                 return SRD_OK;
 138
 139         if (PyObject_HasAttrString(di->py_inst, "metadata")) {
 140                 py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK",
 141                                 (long)SRD_CONF_SAMPLERATE,
 142                                 (unsigned long long)g_variant_get_uint64(data));
 143                 Py_XDECREF(py_ret);
 144         }
 145
 146         /* Push metadata to all the PDs stacked on top of this one. */
 147         for (l = di->next_di; l; l = l->next) {
 148                 next_di = l->data;
 149                 if ((ret = srd_inst_send_meta(next_di, key, data)) != SRD_OK)
 150                         return ret;
 151         }
 152
 153         return SRD_OK;
 154 }
 155
 156 /**
 157  * Set a metadata configuration key in a session.
 158  *
 159  * @param sess The session to configure.
 160  * @param key The configuration key (SRD_CONF_*).
 161  * @param data The new value for the key, as a GVariant with GVariantType
 162  *             appropriate to that key. A floating reference can be passed
 163  *             in; its refcount will be sunk and unreferenced after use.
 164  *
 165  * @return SRD_OK upon success, a (negative) error code otherwise.
 166  *
 167  * @since 0.3.0
 168  */
 169 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
 170                 GVariant *data)
 171 {
 172         GSList *l;
 173         int ret;
 174
 175         if (session_is_valid(sess) != SRD_OK) {
 176                 srd_err("Invalid session.");
 177                 return SRD_ERR_ARG;
 178         }
 179
 180         if (!key) {
 181                 srd_err("Invalid key.");
 182                 return SRD_ERR_ARG;
 183         }
 184
 185         if (!data) {
 186                 srd_err("Invalid value.");
 187                 return SRD_ERR_ARG;
 188         }
 189
 190         /* Hardcoded to samplerate/uint64 for now. */
 191
 192         if (key != SRD_CONF_SAMPLERATE) {
 193                 srd_err("Unknown config key %d.", key);
 194                 return SRD_ERR_ARG;
 195         }
 196         if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
 197                 srd_err("Invalid value type: expected uint64, got %s",
 198                                 g_variant_get_type_string(data));
 199                 return SRD_ERR_ARG;
 200         }
 201
 202         srd_dbg("Setting session %d samplerate to %"PRIu64".",
 203                         sess->session_id, g_variant_get_uint64(data));
 204
 205         ret = SRD_OK;
 206         for (l = sess->di_list; l; l = l->next) {
 207                 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
 208                         break;
 209         }
 210
 211         g_variant_unref(data);
 212
 213         return ret;
 214 }
 215
 216 /**
 217  * Send a chunk of logic sample data to a running decoder session.
 218  *
 219  * If no channel map has been set up, the logic samples must be arranged
 220  * in channel order, in the least amount of space possible. The default
 221  * channel set consists of all required channels + all optional channels.
 222  *
 223  * The size of a sample in inbuf is 'unitsize' bytes. If no channel map
 224  * has been configured, it is the minimum number of bytes needed to store
 225  * the default channels.
 226  *
 227  * @param sess The session to use.
 228  * @param start_samplenum The sample number of the first sample in this chunk.
 229  * @param end_samplenum The sample number of the last sample in this chunk.
 230  * @param inbuf Pointer to sample data.
 231  * @param inbuflen Length in bytes of the buffer.
 232  * @param unitsize The number of bytes per sample.
 233  *
 234  * @return SRD_OK upon success, a (negative) error code otherwise.
 235  *
 236  * @since 0.4.0
 237  */
 238 SRD_API int srd_session_send(struct srd_session *sess,
 239                 uint64_t start_samplenum, uint64_t end_samplenum,
 240                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
 241 {
 242         GSList *d;
 243         int ret;
 244
 245         if (session_is_valid(sess) != SRD_OK) {
 246                 srd_err("Invalid session.");
 247                 return SRD_ERR_ARG;
 248         }
 249
 250         for (d = sess->di_list; d; d = d->next) {
 251                 if ((ret = srd_inst_decode(d->data, start_samplenum,
 252                                 end_samplenum, inbuf, inbuflen, unitsize)) != SRD_OK)
 253                         return ret;
 254         }
 255
 256         return SRD_OK;
 257 }
 258
 259 /**
 260  * Destroy a decoding session.
 261  *
 262  * All decoder instances and output callbacks are properly released.
 263  *
 264  * @param sess The session to be destroyed.
 265  *
 266  * @return SRD_OK upon success, a (negative) error code otherwise.
 267  *
 268  * @since 0.3.0
 269  */
 270 SRD_API int srd_session_destroy(struct srd_session *sess)
 271 {
 272         int session_id;
 273
 274         if (!sess) {
 275                 srd_err("Invalid session.");
 276                 return SRD_ERR_ARG;
 277         }
 278
 279         session_id = sess->session_id;
 280         if (sess->di_list)
 281                 srd_inst_free_all(sess, NULL);
 282         if (sess->callbacks)
 283                 g_slist_free_full(sess->callbacks, g_free);
 284         sessions = g_slist_remove(sessions, sess);
 285         g_free(sess);
 286
 287         srd_dbg("Destroyed session %d.", session_id);
 288
 289         return SRD_OK;
 290 }
 291
 292 /**
 293  * Register/add a decoder output callback function.
 294  *
 295  * The function will be called when a protocol decoder sends output back
 296  * to the PD controller (except for Python objects, which only go up the
 297  * stack).
 298  *
 299  * @param sess The output session in which to register the callback.
 300  * @param output_type The output type this callback will receive. Only one
 301  *                    callback per output type can be registered.
 302  * @param cb The function to call. Must not be NULL.
 303  * @param cb_data Private data for the callback function. Can be NULL.
 304  *
 305  * @since 0.3.0
 306  */
 307 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
 308                 int output_type, srd_pd_output_callback cb, void *cb_data)
 309 {
 310         struct srd_pd_callback *pd_cb;
 311
 312         if (session_is_valid(sess) != SRD_OK) {
 313                 srd_err("Invalid session.");
 314                 return SRD_ERR_ARG;
 315         }
 316
 317         srd_dbg("Registering new callback for output type %d.", output_type);
 318
 319         pd_cb = g_malloc(sizeof(struct srd_pd_callback));
 320         pd_cb->output_type = output_type;
 321         pd_cb->cb = cb;
 322         pd_cb->cb_data = cb_data;
 323         sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
 324
 325         return SRD_OK;
 326 }
 327
 328 /** @private */
 329 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
 330                 struct srd_session *sess, int output_type)
 331 {
 332         GSList *l;
 333         struct srd_pd_callback *tmp, *pd_cb;
 334
 335         if (session_is_valid(sess) != SRD_OK) {
 336                 srd_err("Invalid session.");
 337                 return NULL;
 338         }
 339
 340         pd_cb = NULL;
 341         for (l = sess->callbacks; l; l = l->next) {
 342                 tmp = l->data;
 343                 if (tmp->output_type == output_type) {
 344                         pd_cb = tmp;
 345                         break;
 346                 }
 347         }
 348
 349         return pd_cb;
 350 }
 351
 352 /** @} */