src/polypcore/pdispatch.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as
   8   published by the Free Software Foundation; either version 2.1 of the
   9   License, or (at your option) any later version.
  10
  11   polypaudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with polypaudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <assert.h>
  29
  30 #include <polyp/xmalloc.h>
  31
  32 #include <polypcore/native-common.h>
  33 #include <polypcore/llist.h>
  34 #include <polypcore/log.h>
  35 #include <polypcore/core-util.h>
  36
  37 #include "pdispatch.h"
  38
  39 /*#define DEBUG_OPCODES */
  40
  41 #ifdef DEBUG_OPCODES
  42
  43 static const char *command_names[PA_COMMAND_MAX] = {
  44     [PA_COMMAND_ERROR] = "ERROR",
  45     [PA_COMMAND_TIMEOUT] = "TIMEOUT",
  46     [PA_COMMAND_REPLY] = "REPLY",
  47     [PA_COMMAND_CREATE_PLAYBACK_STREAM] = "CREATE_PLAYBACK_STREAM",
  48     [PA_COMMAND_DELETE_PLAYBACK_STREAM] = "DELETE_PLAYBACK_STREAM",
  49     [PA_COMMAND_CREATE_RECORD_STREAM] = "CREATE_RECORD_STREAM",
  50     [PA_COMMAND_DELETE_RECORD_STREAM] = "DELETE_RECORD_STREAM",
  51     [PA_COMMAND_AUTH] = "AUTH",
  52     [PA_COMMAND_REQUEST] = "REQUEST",
  53     [PA_COMMAND_EXIT] = "EXIT",
  54     [PA_COMMAND_SET_CLIENT_NAME] = "SET_CLIENT_NAME",
  55     [PA_COMMAND_LOOKUP_SINK] = "LOOKUP_SINK",
  56     [PA_COMMAND_LOOKUP_SOURCE] = "LOOKUP_SOURCE",
  57     [PA_COMMAND_DRAIN_PLAYBACK_STREAM] = "DRAIN_PLAYBACK_STREAM",
  58     [PA_COMMAND_PLAYBACK_STREAM_KILLED] = "PLAYBACK_STREAM_KILLED",
  59     [PA_COMMAND_RECORD_STREAM_KILLED] = "RECORD_STREAM_KILLED",
  60     [PA_COMMAND_STAT] = "STAT",
  61     [PA_COMMAND_GET_PLAYBACK_LATENCY] = "PLAYBACK_LATENCY",
  62     [PA_COMMAND_CREATE_UPLOAD_STREAM] = "CREATE_UPLOAD_STREAM",
  63     [PA_COMMAND_DELETE_UPLOAD_STREAM] = "DELETE_UPLOAD_STREAM",
  64     [PA_COMMAND_FINISH_UPLOAD_STREAM] = "FINISH_UPLOAD_STREAM",
  65     [PA_COMMAND_PLAY_SAMPLE] = "PLAY_SAMPLE",
  66     [PA_COMMAND_REMOVE_SAMPLE] = "REMOVE_SAMPLE",
  67     [PA_COMMAND_GET_SERVER_INFO] = "GET_SERVER_INFO",
  68     [PA_COMMAND_GET_SINK_INFO] = "GET_SINK_INFO",
  69     [PA_COMMAND_GET_SINK_INFO_LIST] = "GET_SINK_INFO_LIST",
  70     [PA_COMMAND_GET_SOURCE_INFO] = "GET_SOURCE_INFO",
  71     [PA_COMMAND_GET_SOURCE_INFO_LIST] = "GET_SOURCE_INFO_LIST",
  72     [PA_COMMAND_GET_MODULE_INFO] = "GET_MODULE_INFO",
  73     [PA_COMMAND_GET_MODULE_INFO_LIST] = "GET_MODULE_INFO_LIST",
  74     [PA_COMMAND_GET_CLIENT_INFO] = "GET_CLIENT_INFO",
  75     [PA_COMMAND_GET_CLIENT_INFO_LIST] = "GET_CLIENT_INFO_LIST",
  76     [PA_COMMAND_GET_SAMPLE_INFO] = "GET_SAMPLE_INFO",
  77     [PA_COMMAND_GET_SAMPLE_INFO_LIST] = "GET_SAMPLE_INFO_LIST",
  78     [PA_COMMAND_GET_SINK_INPUT_INFO] = "GET_SINK_INPUT_INFO",
  79     [PA_COMMAND_GET_SINK_INPUT_INFO_LIST] = "GET_SINK_INPUT_INFO_LIST",
  80     [PA_COMMAND_GET_SOURCE_OUTPUT_INFO] = "GET_SOURCE_OUTPUT_INFO",
  81     [PA_COMMAND_GET_SOURCE_OUTPUT_INFO_LIST] = "GET_SOURCE_OUTPUT_INFO_LIST",
  82     [PA_COMMAND_SUBSCRIBE] = "SUBSCRIBE",
  83     [PA_COMMAND_SUBSCRIBE_EVENT] = "SUBSCRIBE_EVENT",
  84     [PA_COMMAND_SET_SINK_VOLUME] = "SET_SINK_VOLUME",
  85     [PA_COMMAND_SET_SINK_INPUT_VOLUME] = "SET_SINK_INPUT_VOLUME",
  86     [PA_COMMAND_SET_SOURCE_VOLUME] = "SET_SOURCE_VOLME",
  87     [PA_COMMAND_TRIGGER_PLAYBACK_STREAM] = "TRIGGER_PLAYBACK_STREAM",
  88     [PA_COMMAND_FLUSH_PLAYBACK_STREAM] = "FLUSH_PLAYBACK_STREAM",
  89     [PA_COMMAND_CORK_PLAYBACK_STREAM] = "CORK_PLAYBACK_STREAM",
  90     [PA_COMMAND_GET_AUTOLOAD_INFO] = "GET_AUTOLOAD_INFO",
  91     [PA_COMMAND_GET_AUTOLOAD_INFO_LIST] = "GET_AUTOLOAD_INFO_LIST",
  92 };
  93
  94 #endif
  95
  96 struct reply_info {
  97     pa_pdispatch *pdispatch;
  98     PA_LLIST_FIELDS(struct reply_info);
  99     pa_pdispatch_cb_t callback;
 100     void *userdata;
 101     pa_free_cb_t free_cb;
 102     uint32_t tag;
 103     pa_time_event *time_event;
 104 };
 105
 106 struct pa_pdispatch {
 107     int ref;
 108     pa_mainloop_api *mainloop;
 109     const pa_pdispatch_cb_t *callback_table;
 110     unsigned n_commands;
 111     PA_LLIST_HEAD(struct reply_info, replies);
 112     pa_pdispatch_drain_callback drain_callback;
 113     void *drain_userdata;
 114     const void *creds;
 115 };
 116
 117 static void reply_info_free(struct reply_info *r) {
 118     assert(r && r->pdispatch && r->pdispatch->mainloop);
 119
 120     if (r->time_event)
 121         r->pdispatch->mainloop->time_free(r->time_event);
 122
 123     PA_LLIST_REMOVE(struct reply_info, r->pdispatch->replies, r);
 124
 125     pa_xfree(r);
 126 }
 127
 128 pa_pdispatch* pa_pdispatch_new(pa_mainloop_api *mainloop, const pa_pdispatch_cb_t*table, unsigned entries) {
 129     pa_pdispatch *pd;
 130     assert(mainloop);
 131
 132     assert((entries && table) || (!entries && !table));
 133
 134     pd = pa_xmalloc(sizeof(pa_pdispatch));
 135     pd->ref = 1;
 136     pd->mainloop = mainloop;
 137     pd->callback_table = table;
 138     pd->n_commands = entries;
 139     PA_LLIST_HEAD_INIT(pa_reply_info, pd->replies);
 140     pd->drain_callback = NULL;
 141     pd->drain_userdata = NULL;
 142     pd->creds = NULL;
 143
 144     return pd;
 145 }
 146
 147 static void pdispatch_free(pa_pdispatch *pd) {
 148     assert(pd);
 149
 150     while (pd->replies) {
 151         if (pd->replies->free_cb)
 152             pd->replies->free_cb(pd->replies->userdata);
 153
 154         reply_info_free(pd->replies);
 155     }
 156
 157     pa_xfree(pd);
 158 }
 159
 160 static void run_action(pa_pdispatch *pd, struct reply_info *r, uint32_t command, pa_tagstruct *ts) {
 161     pa_pdispatch_cb_t callback;
 162     void *userdata;
 163     uint32_t tag;
 164     assert(r);
 165
 166     pa_pdispatch_ref(pd);
 167
 168     callback = r->callback;
 169     userdata = r->userdata;
 170     tag = r->tag;
 171
 172     reply_info_free(r);
 173
 174     callback(pd, command, tag, ts, userdata);
 175
 176     if (pd->drain_callback && !pa_pdispatch_is_pending(pd))
 177         pd->drain_callback(pd, pd->drain_userdata);
 178
 179     pa_pdispatch_unref(pd);
 180 }
 181
 182 int pa_pdispatch_run(pa_pdispatch *pd, pa_packet*packet, const void *creds, void *userdata) {
 183     uint32_t tag, command;
 184     pa_tagstruct *ts = NULL;
 185     int ret = -1;
 186     assert(pd && packet && packet->data);
 187
 188     pa_pdispatch_ref(pd);
 189
 190     if (packet->length <= 8)
 191         goto finish;
 192
 193     ts = pa_tagstruct_new(packet->data, packet->length);
 194     assert(ts);
 195
 196     if (pa_tagstruct_getu32(ts, &command) < 0 ||
 197         pa_tagstruct_getu32(ts, &tag) < 0)
 198         goto finish;
 199
 200 #ifdef DEBUG_OPCODES
 201 {
 202     char t[256];
 203     char const *p;
 204     if (!(p = command_names[command]))
 205         snprintf((char*) (p = t), sizeof(t), "%u", command);
 206
 207     pa_log(__FILE__": Recieved opcode <%s>", p);
 208 }
 209 #endif
 210
 211     pd->creds = creds;
 212
 213     if (command == PA_COMMAND_ERROR || command == PA_COMMAND_REPLY) {
 214         struct reply_info *r;
 215
 216         for (r = pd->replies; r; r = r->next)
 217             if (r->tag == tag)
 218                 break;
 219
 220         if (r)
 221             run_action(pd, r, command, ts);
 222
 223     } else if (pd->callback_table && (command < pd->n_commands) && pd->callback_table[command]) {
 224         const pa_pdispatch_cb_t *c = pd->callback_table+command;
 225
 226         (*c)(pd, command, tag, ts, userdata);
 227     } else {
 228         pa_log(__FILE__": Recieved unsupported command %u", command);
 229         goto finish;
 230     }
 231
 232     ret = 0;
 233
 234 finish:
 235     pd->creds = NULL;
 236
 237     if (ts)
 238         pa_tagstruct_free(ts);
 239
 240     pa_pdispatch_unref(pd);
 241
 242     return ret;
 243 }
 244
 245 static void timeout_callback(pa_mainloop_api*m, pa_time_event*e, PA_GCC_UNUSED const struct timeval *tv, void *userdata) {
 246     struct reply_info*r = userdata;
 247     assert(r && r->time_event == e && r->pdispatch && r->pdispatch->mainloop == m && r->callback);
 248
 249     run_action(r->pdispatch, r, PA_COMMAND_TIMEOUT, NULL);
 250 }
 251
 252 void pa_pdispatch_register_reply(pa_pdispatch *pd, uint32_t tag, int timeout, pa_pdispatch_cb_t cb, void *userdata, pa_free_cb_t free_cb) {
 253     struct reply_info *r;
 254     struct timeval tv;
 255     assert(pd && pd->ref >= 1 && cb);
 256
 257     r = pa_xmalloc(sizeof(struct reply_info));
 258     r->pdispatch = pd;
 259     r->callback = cb;
 260     r->userdata = userdata;
 261     r->free_cb = free_cb;
 262     r->tag = tag;
 263
 264     pa_gettimeofday(&tv);
 265     tv.tv_sec += timeout;
 266
 267     r->time_event = pd->mainloop->time_new(pd->mainloop, &tv, timeout_callback, r);
 268     assert(r->time_event);
 269
 270     PA_LLIST_PREPEND(struct reply_info, pd->replies, r);
 271 }
 272
 273 int pa_pdispatch_is_pending(pa_pdispatch *pd) {
 274     assert(pd);
 275
 276     return !!pd->replies;
 277 }
 278
 279 void pa_pdispatch_set_drain_callback(pa_pdispatch *pd, void (*cb)(pa_pdispatch *pd, void *userdata), void *userdata) {
 280     assert(pd);
 281     assert(!cb || pa_pdispatch_is_pending(pd));
 282
 283     pd->drain_callback = cb;
 284     pd->drain_userdata = userdata;
 285 }
 286
 287 void pa_pdispatch_unregister_reply(pa_pdispatch *pd, void *userdata) {
 288     struct reply_info *r, *n;
 289     assert(pd);
 290
 291     for (r = pd->replies; r; r = n) {
 292         n = r->next;
 293
 294         if (r->userdata == userdata)
 295             reply_info_free(r);
 296     }
 297 }
 298
 299 void pa_pdispatch_unref(pa_pdispatch *pd) {
 300     assert(pd && pd->ref >= 1);
 301
 302     if (!(--(pd->ref)))
 303         pdispatch_free(pd);
 304 }
 305
 306 pa_pdispatch* pa_pdispatch_ref(pa_pdispatch *pd) {
 307     assert(pd && pd->ref >= 1);
 308     pd->ref++;
 309     return pd;
 310 }
 311
 312 const void * pa_pdispatch_creds(pa_pdispatch *pd) {
 313     assert(pd);
 314     assert(pd->ref >= 1);
 315
 316     return pd->creds;
 317 }