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 "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  22 #include "libsigrokdecode.h"
  23 #include "config.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
 132         if (key != SRD_CONF_SAMPLERATE)
 133                 /* This is the only key we pass on to the decoder for now. */
 134                 return SRD_OK;
 135
 136         if (!PyObject_HasAttrString(di->py_inst, "metadata"))
 137                 /* This decoder doesn't want metadata, that's fine. */
 138                 return SRD_OK;
 139
 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         return SRD_OK;
 146 }
 147
 148 /**
 149  * Set a metadata configuration key in a session.
 150  *
 151  * @param sess The session to configure.
 152  * @param key The configuration key (SRD_CONF_*).
 153  * @param data The new value for the key, as a GVariant with GVariantType
 154  *             appropriate to that key. A floating reference can be passed
 155  *             in; its refcount will be sunk and unreferenced after use.
 156  *
 157  * @return SRD_OK upon success, a (negative) error code otherwise.
 158  *
 159  * @since 0.3.0
 160  */
 161 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
 162                 GVariant *data)
 163 {
 164         GSList *l;
 165         int ret;
 166
 167         if (session_is_valid(sess) != SRD_OK) {
 168                 srd_err("Invalid session.");
 169                 return SRD_ERR_ARG;
 170         }
 171
 172         if (!key) {
 173                 srd_err("Invalid key.");
 174                 return SRD_ERR_ARG;
 175         }
 176
 177         if (!data) {
 178                 srd_err("Invalid value.");
 179                 return SRD_ERR_ARG;
 180         }
 181
 182         /* Hardcoded to samplerate/uint64 for now. */
 183
 184         if (key != SRD_CONF_SAMPLERATE) {
 185                 srd_err("Unknown config key %d.", key);
 186                 return SRD_ERR_ARG;
 187         }
 188         if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
 189                 srd_err("Invalid value type: expected uint64, got %s",
 190                                 g_variant_get_type_string(data));
 191                 return SRD_ERR_ARG;
 192         }
 193
 194         srd_dbg("Setting session %d samplerate to %"PRIu64".",
 195                         sess->session_id, g_variant_get_uint64(data));
 196
 197         ret = SRD_OK;
 198         for (l = sess->di_list; l; l = l->next) {
 199                 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
 200                         break;
 201         }
 202
 203         g_variant_unref(data);
 204
 205         return ret;
 206 }
 207
 208 /**
 209  * Send a chunk of logic sample data to a running decoder session.
 210  *
 211  * If no channel map has been set up, the logic samples must be arranged
 212  * in channel order, in the least amount of space possible. The default
 213  * channel set consists of all required channels + all optional channels.
 214  *
 215  * The size of a sample in inbuf is the unit size passed to
 216  * srd_inst_channel_set_all(). If no channel map has been configured, it is
 217  * the minimum number of bytes needed to store the default channels.
 218  *
 219  * @param sess The session to use.
 220  * @param start_samplenum The sample number of the first sample in this chunk.
 221  * @param end_samplenum The sample number of the last sample in this chunk.
 222  * @param inbuf Pointer to sample data.
 223  * @param inbuflen Length in bytes of the buffer.
 224  *
 225  * @return SRD_OK upon success, a (negative) error code otherwise.
 226  *
 227  * @since 0.3.0
 228  */
 229 SRD_API int srd_session_send(struct srd_session *sess,
 230                 uint64_t start_samplenum, uint64_t end_samplenum,
 231                 const uint8_t *inbuf, uint64_t inbuflen)
 232 {
 233         GSList *d;
 234         int ret;
 235
 236         if (session_is_valid(sess) != SRD_OK) {
 237                 srd_err("Invalid session.");
 238                 return SRD_ERR_ARG;
 239         }
 240
 241         srd_dbg("Calling decode() on all instances with starting sample "
 242                         "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
 243                         start_samplenum, inbuflen, inbuf);
 244
 245         for (d = sess->di_list; d; d = d->next) {
 246                 if ((ret = srd_inst_decode(d->data, start_samplenum,
 247                                 end_samplenum, inbuf, inbuflen)) != SRD_OK)
 248                         return ret;
 249         }
 250
 251         return SRD_OK;
 252 }
 253
 254 /**
 255  * Destroy a decoding session.
 256  *
 257  * All decoder instances and output callbacks are properly released.
 258  *
 259  * @param sess The session to be destroyed.
 260  *
 261  * @return SRD_OK upon success, a (negative) error code otherwise.
 262  *
 263  * @since 0.3.0
 264  */
 265 SRD_API int srd_session_destroy(struct srd_session *sess)
 266 {
 267         int session_id;
 268
 269         if (!sess) {
 270                 srd_err("Invalid session.");
 271                 return SRD_ERR_ARG;
 272         }
 273
 274         session_id = sess->session_id;
 275         if (sess->di_list)
 276                 srd_inst_free_all(sess, NULL);
 277         if (sess->callbacks)
 278                 g_slist_free_full(sess->callbacks, g_free);
 279         sessions = g_slist_remove(sessions, sess);
 280         g_free(sess);
 281
 282         srd_dbg("Destroyed session %d.", session_id);
 283
 284         return SRD_OK;
 285 }
 286
 287 /**
 288  * Register/add a decoder output callback function.
 289  *
 290  * The function will be called when a protocol decoder sends output back
 291  * to the PD controller (except for Python objects, which only go up the
 292  * stack).
 293  *
 294  * @param sess The output session in which to register the callback.
 295  * @param output_type The output type this callback will receive. Only one
 296  *                    callback per output type can be registered.
 297  * @param cb The function to call. Must not be NULL.
 298  * @param cb_data Private data for the callback function. Can be NULL.
 299  *
 300  * @since 0.3.0
 301  */
 302 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
 303                 int output_type, srd_pd_output_callback cb, void *cb_data)
 304 {
 305         struct srd_pd_callback *pd_cb;
 306
 307         if (session_is_valid(sess) != SRD_OK) {
 308                 srd_err("Invalid session.");
 309                 return SRD_ERR_ARG;
 310         }
 311
 312         srd_dbg("Registering new callback for output type %d.", output_type);
 313
 314         pd_cb = g_malloc(sizeof(struct srd_pd_callback));
 315         pd_cb->output_type = output_type;
 316         pd_cb->cb = cb;
 317         pd_cb->cb_data = cb_data;
 318         sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
 319
 320         return SRD_OK;
 321 }
 322
 323 /** @private */
 324 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
 325                 struct srd_session *sess, int output_type)
 326 {
 327         GSList *l;
 328         struct srd_pd_callback *tmp, *pd_cb;
 329
 330         if (session_is_valid(sess) != SRD_OK) {
 331                 srd_err("Invalid session.");
 332                 return NULL;
 333         }
 334
 335         pd_cb = NULL;
 336         for (l = sess->callbacks; l; l = l->next) {
 337                 tmp = l->data;
 338                 if (tmp->output_type == output_type) {
 339                         pd_cb = tmp;
 340                         break;
 341                 }
 342         }
 343
 344         return pd_cb;
 345 }
 346
 347 /** @} */