code.delx.au - pulseaudio/blob - src/pulse/context.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2008 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   7   PulseAudio is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU Lesser General Public License as published
   9   by the Free Software Foundation; either version 2 of the License,
  10   or (at your option) any later version.
  11
  12   PulseAudio is distributed in the hope that it will be useful, but
  13   WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15   General Public License for more details.
  16
  17   You should have received a copy of the GNU Lesser General Public License
  18   along with PulseAudio; if not, write to the Free Software
  19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/types.h>
  31 #include <unistd.h>
  32 #include <sys/stat.h>
  33 #include <errno.h>
  34 #include <signal.h>
  35 #include <limits.h>
  36 #include <locale.h>
  37
  38 #ifdef HAVE_SYS_WAIT_H
  39 #include <sys/wait.h>
  40 #endif
  41
  42 #ifdef HAVE_SYS_SOCKET_H
  43 #include <sys/socket.h>
  44 #endif
  45 #ifdef HAVE_SYS_UN_H
  46 #include <sys/un.h>
  47 #endif
  48 #ifdef HAVE_NETDB_H
  49 #include <netdb.h>
  50 #endif
  51
  52 #include <pulse/version.h>
  53 #include <pulse/xmalloc.h>
  54 #include <pulse/utf8.h>
  55 #include <pulse/util.h>
  56 #include <pulse/i18n.h>
  57
  58 #include <pulsecore/winsock.h>
  59 #include <pulsecore/core-error.h>
  60
  61 #include <pulsecore/native-common.h>
  62 #include <pulsecore/pdispatch.h>
  63 #include <pulsecore/pstream.h>
  64 #include <pulsecore/dynarray.h>
  65 #include <pulsecore/socket-client.h>
  66 #include <pulsecore/pstream-util.h>
  67 #include <pulsecore/core-util.h>
  68 #include <pulsecore/log.h>
  69 #include <pulsecore/socket-util.h>
  70 #include <pulsecore/creds.h>
  71 #include <pulsecore/macro.h>
  72 #include <pulsecore/proplist-util.h>
  73
  74 #include "internal.h"
  75
  76 #include "client-conf.h"
  77
  78 #ifdef HAVE_X11
  79 #include "client-conf-x11.h"
  80 #endif
  81
  82 #include "context.h"
  83
  84 void pa_command_extension(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
  85
  86 static const pa_pdispatch_cb_t command_table[PA_COMMAND_MAX] = {
  87     [PA_COMMAND_REQUEST] = pa_command_request,
  88     [PA_COMMAND_OVERFLOW] = pa_command_overflow_or_underflow,
  89     [PA_COMMAND_UNDERFLOW] = pa_command_overflow_or_underflow,
  90     [PA_COMMAND_PLAYBACK_STREAM_KILLED] = pa_command_stream_killed,
  91     [PA_COMMAND_RECORD_STREAM_KILLED] = pa_command_stream_killed,
  92     [PA_COMMAND_PLAYBACK_STREAM_MOVED] = pa_command_stream_moved,
  93     [PA_COMMAND_RECORD_STREAM_MOVED] = pa_command_stream_moved,
  94     [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED] = pa_command_stream_suspended,
  95     [PA_COMMAND_RECORD_STREAM_SUSPENDED] = pa_command_stream_suspended,
  96     [PA_COMMAND_STARTED] = pa_command_stream_started,
  97     [PA_COMMAND_SUBSCRIBE_EVENT] = pa_command_subscribe_event,
  98     [PA_COMMAND_EXTENSION] = pa_command_extension
  99 };
 100 static void context_free(pa_context *c);
 101
 102 pa_context *pa_context_new(pa_mainloop_api *mainloop, const char *name) {
 103     return pa_context_new_with_proplist(mainloop, name, NULL);
 104 }
 105
 106 static void reset_callbacks(pa_context *c) {
 107     pa_assert(c);
 108
 109     c->state_callback = NULL;
 110     c->state_userdata = NULL;
 111
 112     c->subscribe_callback = NULL;
 113     c->subscribe_userdata = NULL;
 114
 115     c->ext_stream_restore.callback = NULL;
 116     c->ext_stream_restore.userdata = NULL;
 117 }
 118
 119 pa_context *pa_context_new_with_proplist(pa_mainloop_api *mainloop, const char *name, pa_proplist *p) {
 120     pa_context *c;
 121
 122     pa_assert(mainloop);
 123
 124     pa_init_i18n();
 125
 126     if (!name && !pa_proplist_contains(p, PA_PROP_APPLICATION_NAME))
 127         return NULL;
 128
 129     c = pa_xnew(pa_context, 1);
 130     PA_REFCNT_INIT(c);
 131
 132     c->proplist = p ? pa_proplist_copy(p) : pa_proplist_new();
 133
 134     if (name)
 135         pa_proplist_sets(c->proplist, PA_PROP_APPLICATION_NAME, name);
 136
 137     c->mainloop = mainloop;
 138     c->client = NULL;
 139     c->pstream = NULL;
 140     c->pdispatch = NULL;
 141     c->playback_streams = pa_dynarray_new();
 142     c->record_streams = pa_dynarray_new();
 143     c->client_index = PA_INVALID_INDEX;
 144
 145     PA_LLIST_HEAD_INIT(pa_stream, c->streams);
 146     PA_LLIST_HEAD_INIT(pa_operation, c->operations);
 147
 148     c->error = PA_OK;
 149     c->state = PA_CONTEXT_UNCONNECTED;
 150     c->ctag = 0;
 151     c->csyncid = 0;
 152
 153     reset_callbacks(c);
 154
 155     c->is_local = FALSE;
 156     c->server_list = NULL;
 157     c->server = NULL;
 158
 159     c->do_shm = FALSE;
 160
 161     c->do_autospawn = FALSE;
 162     memset(&c->spawn_api, 0, sizeof(c->spawn_api));
 163
 164 #ifndef MSG_NOSIGNAL
 165 #ifdef SIGPIPE
 166     pa_check_signal_is_blocked(SIGPIPE);
 167 #endif
 168 #endif
 169
 170     c->conf = pa_client_conf_new();
 171 #ifdef HAVE_X11
 172     pa_client_conf_from_x11(c->conf, NULL);
 173 #endif
 174     pa_client_conf_load(c->conf, NULL);
 175     pa_client_conf_env(c->conf);
 176
 177     if (!(c->mempool = pa_mempool_new(!c->conf->disable_shm, c->conf->shm_size))) {
 178
 179         if (!c->conf->disable_shm)
 180             c->mempool = pa_mempool_new(FALSE, c->conf->shm_size);
 181
 182         if (!c->mempool) {
 183             context_free(c);
 184             return NULL;
 185         }
 186     }
 187
 188     return c;
 189 }
 190
 191 static void context_unlink(pa_context *c) {
 192     pa_stream *s;
 193
 194     pa_assert(c);
 195
 196     s = c->streams ? pa_stream_ref(c->streams) : NULL;
 197     while (s) {
 198         pa_stream *n = s->next ? pa_stream_ref(s->next) : NULL;
 199         pa_stream_set_state(s, c->state == PA_CONTEXT_FAILED ? PA_STREAM_FAILED : PA_STREAM_TERMINATED);
 200         pa_stream_unref(s);
 201         s = n;
 202     }
 203
 204     while (c->operations)
 205         pa_operation_cancel(c->operations);
 206
 207     if (c->pdispatch) {
 208         pa_pdispatch_unref(c->pdispatch);
 209         c->pdispatch = NULL;
 210     }
 211
 212     if (c->pstream) {
 213         pa_pstream_unlink(c->pstream);
 214         pa_pstream_unref(c->pstream);
 215         c->pstream = NULL;
 216     }
 217
 218     if (c->client) {
 219         pa_socket_client_unref(c->client);
 220         c->client = NULL;
 221     }
 222
 223     reset_callbacks(c);
 224 }
 225
 226 static void context_free(pa_context *c) {
 227     pa_assert(c);
 228
 229     context_unlink(c);
 230
 231     if (c->record_streams)
 232         pa_dynarray_free(c->record_streams, NULL, NULL);
 233     if (c->playback_streams)
 234         pa_dynarray_free(c->playback_streams, NULL, NULL);
 235
 236     if (c->mempool)
 237         pa_mempool_free(c->mempool);
 238
 239     if (c->conf)
 240         pa_client_conf_free(c->conf);
 241
 242     pa_strlist_free(c->server_list);
 243
 244     if (c->proplist)
 245         pa_proplist_free(c->proplist);
 246
 247     pa_xfree(c->server);
 248     pa_xfree(c);
 249 }
 250
 251 pa_context* pa_context_ref(pa_context *c) {
 252     pa_assert(c);
 253     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 254
 255     PA_REFCNT_INC(c);
 256     return c;
 257 }
 258
 259 void pa_context_unref(pa_context *c) {
 260     pa_assert(c);
 261     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 262
 263     if (PA_REFCNT_DEC(c) <= 0)
 264         context_free(c);
 265 }
 266
 267 void pa_context_set_state(pa_context *c, pa_context_state_t st) {
 268     pa_assert(c);
 269     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 270
 271     if (c->state == st)
 272         return;
 273
 274     pa_context_ref(c);
 275
 276     c->state = st;
 277
 278     if (c->state_callback)
 279         c->state_callback(c, c->state_userdata);
 280
 281     if (st == PA_CONTEXT_FAILED || st == PA_CONTEXT_TERMINATED)
 282         context_unlink(c);
 283
 284     pa_context_unref(c);
 285 }
 286
 287 int pa_context_set_error(pa_context *c, int error) {
 288     pa_assert(error >= 0);
 289     pa_assert(error < PA_ERR_MAX);
 290
 291     if (c)
 292         c->error = error;
 293
 294     return error;
 295 }
 296
 297 void pa_context_fail(pa_context *c, int error) {
 298     pa_assert(c);
 299     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 300
 301     pa_context_set_error(c, error);
 302     pa_context_set_state(c, PA_CONTEXT_FAILED);
 303 }
 304
 305 static void pstream_die_callback(pa_pstream *p, void *userdata) {
 306     pa_context *c = userdata;
 307
 308     pa_assert(p);
 309     pa_assert(c);
 310
 311     pa_context_fail(c, PA_ERR_CONNECTIONTERMINATED);
 312 }
 313
 314 static void pstream_packet_callback(pa_pstream *p, pa_packet *packet, const pa_creds *creds, void *userdata) {
 315     pa_context *c = userdata;
 316
 317     pa_assert(p);
 318     pa_assert(packet);
 319     pa_assert(c);
 320
 321     pa_context_ref(c);
 322
 323     if (pa_pdispatch_run(c->pdispatch, packet, creds, c) < 0)
 324         pa_context_fail(c, PA_ERR_PROTOCOL);
 325
 326     pa_context_unref(c);
 327 }
 328
 329 static void pstream_memblock_callback(pa_pstream *p, uint32_t channel, int64_t offset, pa_seek_mode_t seek, const pa_memchunk *chunk, void *userdata) {
 330     pa_context *c = userdata;
 331     pa_stream *s;
 332
 333     pa_assert(p);
 334     pa_assert(chunk);
 335     pa_assert(chunk->memblock);
 336     pa_assert(chunk->length);
 337     pa_assert(c);
 338     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 339
 340     pa_context_ref(c);
 341
 342     if ((s = pa_dynarray_get(c->record_streams, channel))) {
 343
 344         pa_assert(seek == PA_SEEK_RELATIVE);
 345         pa_assert(offset == 0);
 346
 347         pa_memblockq_seek(s->record_memblockq, offset, seek);
 348         pa_memblockq_push_align(s->record_memblockq, chunk);
 349
 350         if (s->read_callback) {
 351             size_t l;
 352
 353             if ((l = pa_memblockq_get_length(s->record_memblockq)) > 0)
 354                 s->read_callback(s, l, s->read_userdata);
 355         }
 356     }
 357
 358     pa_context_unref(c);
 359 }
 360
 361 int pa_context_handle_error(pa_context *c, uint32_t command, pa_tagstruct *t, pa_bool_t fail) {
 362     uint32_t err;
 363     pa_assert(c);
 364     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 365
 366     if (command == PA_COMMAND_ERROR) {
 367         pa_assert(t);
 368
 369         if (pa_tagstruct_getu32(t, &err) < 0) {
 370             pa_context_fail(c, PA_ERR_PROTOCOL);
 371             return -1;
 372         }
 373
 374     } else if (command == PA_COMMAND_TIMEOUT)
 375         err = PA_ERR_TIMEOUT;
 376     else {
 377         pa_context_fail(c, PA_ERR_PROTOCOL);
 378         return -1;
 379     }
 380
 381     if (err == PA_OK) {
 382         pa_context_fail(c, PA_ERR_PROTOCOL);
 383         return -1;
 384     }
 385
 386     if (err >= PA_ERR_MAX)
 387         err = PA_ERR_UNKNOWN;
 388
 389     if (fail) {
 390         pa_context_fail(c, (int) err);
 391         return -1;
 392     }
 393
 394     pa_context_set_error(c, (int) err);
 395
 396     return 0;
 397 }
 398
 399 static void setup_complete_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
 400     pa_context *c = userdata;
 401
 402     pa_assert(pd);
 403     pa_assert(c);
 404     pa_assert(c->state == PA_CONTEXT_AUTHORIZING || c->state == PA_CONTEXT_SETTING_NAME);
 405
 406     pa_context_ref(c);
 407
 408     if (command != PA_COMMAND_REPLY) {
 409         pa_context_handle_error(c, command, t, TRUE);
 410         goto finish;
 411     }
 412
 413     switch(c->state) {
 414         case PA_CONTEXT_AUTHORIZING: {
 415             pa_tagstruct *reply;
 416             pa_bool_t shm_on_remote = FALSE;
 417
 418             if (pa_tagstruct_getu32(t, &c->version) < 0 ||
 419                 !pa_tagstruct_eof(t)) {
 420                 pa_context_fail(c, PA_ERR_PROTOCOL);
 421                 goto finish;
 422             }
 423
 424             /* Minimum supported version */
 425             if (c->version < 8) {
 426                 pa_context_fail(c, PA_ERR_VERSION);
 427                 goto finish;
 428             }
 429
 430             /* Starting with protocol version 13 the MSB of the version
 431                tag reflects if shm is available for this connection or
 432                not. */
 433             if (c->version >= 13) {
 434                 shm_on_remote = !!(c->version & 0x80000000U);
 435                 c->version &= 0x7FFFFFFFU;
 436             }
 437
 438             pa_log_debug("Protocol version: remote %u, local %u", c->version, PA_PROTOCOL_VERSION);
 439
 440             /* Enable shared memory support if possible */
 441             if (c->do_shm)
 442                 if (c->version < 10 || (c->version >= 13 && !shm_on_remote))
 443                     c->do_shm = FALSE;
 444
 445             if (c->do_shm) {
 446
 447                 /* Only enable SHM if both sides are owned by the same
 448                  * user. This is a security measure because otherwise
 449                  * data private to the user might leak. */
 450
 451 #ifdef HAVE_CREDS
 452                 const pa_creds *creds;
 453                 if (!(creds = pa_pdispatch_creds(pd)) || getuid() != creds->uid)
 454                     c->do_shm = FALSE;
 455 #endif
 456             }
 457
 458             pa_log_debug("Negotiated SHM: %s", pa_yes_no(c->do_shm));
 459             pa_pstream_enable_shm(c->pstream, c->do_shm);
 460
 461             reply = pa_tagstruct_command(c, PA_COMMAND_SET_CLIENT_NAME, &tag);
 462
 463             if (c->version >= 13) {
 464                 pa_init_proplist(c->proplist);
 465                 pa_tagstruct_put_proplist(reply, c->proplist);
 466             } else
 467                 pa_tagstruct_puts(reply, pa_proplist_gets(c->proplist, PA_PROP_APPLICATION_NAME));
 468
 469             pa_pstream_send_tagstruct(c->pstream, reply);
 470             pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, setup_complete_callback, c, NULL);
 471
 472             pa_context_set_state(c, PA_CONTEXT_SETTING_NAME);
 473             break;
 474         }
 475
 476         case PA_CONTEXT_SETTING_NAME :
 477
 478             if ((c->version >= 13 && (pa_tagstruct_getu32(t, &c->client_index) < 0 ||
 479                                       c->client_index == PA_INVALID_INDEX)) ||
 480                 !pa_tagstruct_eof(t)) {
 481                 pa_context_fail(c, PA_ERR_PROTOCOL);
 482                 goto finish;
 483             }
 484
 485             pa_context_set_state(c, PA_CONTEXT_READY);
 486             break;
 487
 488         default:
 489             pa_assert_not_reached();
 490     }
 491
 492 finish:
 493     pa_context_unref(c);
 494 }
 495
 496 static void setup_context(pa_context *c, pa_iochannel *io) {
 497     pa_tagstruct *t;
 498     uint32_t tag;
 499
 500     pa_assert(c);
 501     pa_assert(io);
 502
 503     pa_context_ref(c);
 504
 505     pa_assert(!c->pstream);
 506     c->pstream = pa_pstream_new(c->mainloop, io, c->mempool);
 507
 508     pa_pstream_set_die_callback(c->pstream, pstream_die_callback, c);
 509     pa_pstream_set_recieve_packet_callback(c->pstream, pstream_packet_callback, c);
 510     pa_pstream_set_recieve_memblock_callback(c->pstream, pstream_memblock_callback, c);
 511
 512     pa_assert(!c->pdispatch);
 513     c->pdispatch = pa_pdispatch_new(c->mainloop, command_table, PA_COMMAND_MAX);
 514
 515     if (!c->conf->cookie_valid)
 516         pa_log_info(_("No cookie loaded. Attempting to connect without."));
 517
 518     t = pa_tagstruct_command(c, PA_COMMAND_AUTH, &tag);
 519
 520     c->do_shm =
 521         pa_mempool_is_shared(c->mempool) &&
 522         c->is_local;
 523
 524     pa_log_debug("SHM possible: %s", pa_yes_no(c->do_shm));
 525
 526     /* Starting with protocol version 13 we use the MSB of the version
 527      * tag for informing the other side if we could do SHM or not */
 528     pa_tagstruct_putu32(t, PA_PROTOCOL_VERSION | (c->do_shm ? 0x80000000U : 0));
 529     pa_tagstruct_put_arbitrary(t, c->conf->cookie, sizeof(c->conf->cookie));
 530
 531 #ifdef HAVE_CREDS
 532 {
 533     pa_creds ucred;
 534
 535     if (pa_iochannel_creds_supported(io))
 536         pa_iochannel_creds_enable(io);
 537
 538     ucred.uid = getuid();
 539     ucred.gid = getgid();
 540
 541     pa_pstream_send_tagstruct_with_creds(c->pstream, t, &ucred);
 542 }
 543 #else
 544     pa_pstream_send_tagstruct(c->pstream, t);
 545 #endif
 546
 547     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, setup_complete_callback, c, NULL);
 548
 549     pa_context_set_state(c, PA_CONTEXT_AUTHORIZING);
 550
 551     pa_context_unref(c);
 552 }
 553
 554 static char *get_old_legacy_runtime_dir(void) {
 555     char *p, u[128];
 556     struct stat st;
 557
 558     if (!pa_get_user_name(u, sizeof(u)))
 559         return NULL;
 560
 561     p = pa_sprintf_malloc("/tmp/pulse-%s", u);
 562
 563     if (stat(p, &st) < 0) {
 564         pa_xfree(p);
 565         return NULL;
 566     }
 567
 568     if (st.st_uid != getuid()) {
 569         pa_xfree(p);
 570         return NULL;
 571     }
 572
 573     return p;
 574 }
 575
 576 static char *get_very_old_legacy_runtime_dir(void) {
 577     char *p, h[128];
 578     struct stat st;
 579
 580     if (!pa_get_home_dir(h, sizeof(h)))
 581         return NULL;
 582
 583     p = pa_sprintf_malloc("%s/.pulse", h);
 584
 585     if (stat(p, &st) < 0) {
 586         pa_xfree(p);
 587         return NULL;
 588     }
 589
 590     if (st.st_uid != getuid()) {
 591         pa_xfree(p);
 592         return NULL;
 593     }
 594
 595     return p;
 596 }
 597
 598
 599 static pa_strlist *prepend_per_user(pa_strlist *l) {
 600     char *ufn;
 601     static char *legacy_dir;
 602
 603     /* The very old per-user instance path (< 0.9.11). This is supported only to ease upgrades */
 604     if ((legacy_dir = get_very_old_legacy_runtime_dir())) {
 605         char *p = pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET, legacy_dir);
 606         l = pa_strlist_prepend(l, p);
 607         pa_xfree(p);
 608         pa_xfree(legacy_dir);
 609     }
 610
 611     /* The old per-user instance path (< 0.9.12). This is supported only to ease upgrades */
 612     if ((legacy_dir = get_old_legacy_runtime_dir())) {
 613         char *p = pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET, legacy_dir);
 614         l = pa_strlist_prepend(l, p);
 615         pa_xfree(p);
 616         pa_xfree(legacy_dir);
 617     }
 618
 619     /* The per-user instance */
 620     if ((ufn = pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET))) {
 621         l = pa_strlist_prepend(l, ufn);
 622         pa_xfree(ufn);
 623     }
 624
 625     return l;
 626 }
 627
 628 #ifndef OS_IS_WIN32
 629
 630 static int context_autospawn(pa_context *c) {
 631     pid_t pid;
 632     int status, r;
 633
 634     pa_log_debug("Trying to autospawn...");
 635
 636     pa_context_ref(c);
 637
 638     if (c->spawn_api.prefork)
 639         c->spawn_api.prefork();
 640
 641     if ((pid = fork()) < 0) {
 642         pa_log_error(_("fork(): %s"), pa_cstrerror(errno));
 643         pa_context_fail(c, PA_ERR_INTERNAL);
 644
 645         if (c->spawn_api.postfork)
 646             c->spawn_api.postfork();
 647
 648         goto fail;
 649     } else if (!pid) {
 650         /* Child */
 651
 652         const char *state = NULL;
 653 #define MAX_ARGS 64
 654         const char * argv[MAX_ARGS+1];
 655         int n;
 656
 657         if (c->spawn_api.atfork)
 658             c->spawn_api.atfork();
 659
 660         pa_close_all(-1);
 661
 662         /* Setup argv */
 663
 664         n = 0;
 665
 666         argv[n++] = c->conf->daemon_binary;
 667         argv[n++] = "--start";
 668
 669         while (n < MAX_ARGS) {
 670             char *a;
 671
 672             if (!(a = pa_split_spaces(c->conf->extra_arguments, &state)))
 673                 break;
 674
 675             argv[n++] = a;
 676         }
 677
 678         argv[n++] = NULL;
 679
 680         execv(argv[0], (char * const *) argv);
 681         _exit(1);
 682 #undef MAX_ARGS
 683     }
 684
 685     /* Parent */
 686
 687     if (c->spawn_api.postfork)
 688         c->spawn_api.postfork();
 689
 690     do {
 691         r = waitpid(pid, &status, 0);
 692     } while (r < 0 && errno == EINTR);
 693
 694     if (r < 0) {
 695         pa_log(_("waitpid(): %s"), pa_cstrerror(errno));
 696         pa_context_fail(c, PA_ERR_INTERNAL);
 697         goto fail;
 698     } else if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 699         pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
 700         goto fail;
 701     }
 702
 703     pa_context_unref(c);
 704
 705     return 0;
 706
 707 fail:
 708
 709     pa_context_unref(c);
 710
 711     return -1;
 712 }
 713
 714 #endif /* OS_IS_WIN32 */
 715
 716 static void on_connection(pa_socket_client *client, pa_iochannel*io, void *userdata);
 717
 718 static int try_next_connection(pa_context *c) {
 719     char *u = NULL;
 720     int r = -1;
 721
 722     pa_assert(c);
 723     pa_assert(!c->client);
 724
 725     for (;;) {
 726         pa_xfree(u);
 727         u = NULL;
 728
 729         c->server_list = pa_strlist_pop(c->server_list, &u);
 730
 731         if (!u) {
 732
 733 #ifndef OS_IS_WIN32
 734             if (c->do_autospawn) {
 735
 736                 if ((r = context_autospawn(c)) < 0)
 737                     goto finish;
 738
 739                 /* Autospawn only once */
 740                 c->do_autospawn = FALSE;
 741
 742                 /* Connect only to per-user sockets this time */
 743                 c->server_list = prepend_per_user(c->server_list);
 744
 745                 /* Retry connection */
 746                 continue;
 747             }
 748 #endif
 749
 750             pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
 751             goto finish;
 752         }
 753
 754         pa_log_debug("Trying to connect to %s...", u);
 755
 756         pa_xfree(c->server);
 757         c->server = pa_xstrdup(u);
 758
 759         if (!(c->client = pa_socket_client_new_string(c->mainloop, u, PA_NATIVE_DEFAULT_PORT)))
 760             continue;
 761
 762         c->is_local = !!pa_socket_client_is_local(c->client);
 763         pa_socket_client_set_callback(c->client, on_connection, c);
 764         break;
 765     }
 766
 767     r = 0;
 768
 769 finish:
 770     pa_xfree(u);
 771
 772     return r;
 773 }
 774
 775 static void on_connection(pa_socket_client *client, pa_iochannel*io, void *userdata) {
 776     pa_context *c = userdata;
 777     int saved_errno = errno;
 778
 779     pa_assert(client);
 780     pa_assert(c);
 781     pa_assert(c->state == PA_CONTEXT_CONNECTING);
 782
 783     pa_context_ref(c);
 784
 785     pa_socket_client_unref(client);
 786     c->client = NULL;
 787
 788     if (!io) {
 789         /* Try the item in the list */
 790         if (saved_errno == ECONNREFUSED ||
 791             saved_errno == ETIMEDOUT ||
 792             saved_errno == EHOSTUNREACH) {
 793             try_next_connection(c);
 794             goto finish;
 795         }
 796
 797         pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
 798         goto finish;
 799     }
 800
 801     setup_context(c, io);
 802
 803 finish:
 804     pa_context_unref(c);
 805 }
 806
 807 int pa_context_connect(
 808         pa_context *c,
 809         const char *server,
 810         pa_context_flags_t flags,
 811         const pa_spawn_api *api) {
 812
 813     int r = -1;
 814
 815     pa_assert(c);
 816     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 817
 818     PA_CHECK_VALIDITY(c, c->state == PA_CONTEXT_UNCONNECTED, PA_ERR_BADSTATE);
 819     PA_CHECK_VALIDITY(c, !(flags & ~PA_CONTEXT_NOAUTOSPAWN), PA_ERR_INVALID);
 820     PA_CHECK_VALIDITY(c, !server || *server, PA_ERR_INVALID);
 821
 822     if (!server)
 823         server = c->conf->default_server;
 824
 825     pa_context_ref(c);
 826
 827     pa_assert(!c->server_list);
 828
 829     if (server) {
 830         if (!(c->server_list = pa_strlist_parse(server))) {
 831             pa_context_fail(c, PA_ERR_INVALIDSERVER);
 832             goto finish;
 833         }
 834
 835     } else {
 836         char *d;
 837
 838         /* Prepend in reverse order */
 839
 840         /* Follow the X display */
 841         if ((d = getenv("DISPLAY"))) {
 842             char *e;
 843             d = pa_xstrdup(d);
 844             if ((e = strchr(d, ':')))
 845                 *e = 0;
 846
 847             if (*d)
 848                 c->server_list = pa_strlist_prepend(c->server_list, d);
 849
 850             pa_xfree(d);
 851         }
 852
 853         /* Add TCP/IP on the localhost */
 854         c->server_list = pa_strlist_prepend(c->server_list, "tcp6:[::1]");
 855         c->server_list = pa_strlist_prepend(c->server_list, "tcp4:127.0.0.1");
 856
 857         /* The system wide instance via PF_LOCAL */
 858         c->server_list = pa_strlist_prepend(c->server_list, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET);
 859
 860         /* The user instance via PF_LOCAL */
 861         c->server_list = prepend_per_user(c->server_list);
 862
 863         /* Set up autospawning */
 864         if (!(flags & PA_CONTEXT_NOAUTOSPAWN) && c->conf->autospawn) {
 865
 866             if (getuid() == 0)
 867                 pa_log_debug("Not doing autospawn since we are root.");
 868             else {
 869                 c->do_autospawn = TRUE;
 870
 871                 if (api)
 872                     c->spawn_api = *api;
 873             }
 874         }
 875     }
 876
 877     pa_context_set_state(c, PA_CONTEXT_CONNECTING);
 878     r = try_next_connection(c);
 879
 880 finish:
 881     pa_context_unref(c);
 882
 883     return r;
 884 }
 885
 886 void pa_context_disconnect(pa_context *c) {
 887     pa_assert(c);
 888     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 889
 890     if (PA_CONTEXT_IS_GOOD(c->state))
 891         pa_context_set_state(c, PA_CONTEXT_TERMINATED);
 892 }
 893
 894 pa_context_state_t pa_context_get_state(pa_context *c) {
 895     pa_assert(c);
 896     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 897
 898     return c->state;
 899 }
 900
 901 int pa_context_errno(pa_context *c) {
 902     pa_assert(c);
 903     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 904
 905     return c->error;
 906 }
 907
 908 void pa_context_set_state_callback(pa_context *c, pa_context_notify_cb_t cb, void *userdata) {
 909     pa_assert(c);
 910     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 911
 912     if (c->state == PA_CONTEXT_TERMINATED || c->state == PA_CONTEXT_FAILED)
 913         return;
 914
 915     c->state_callback = cb;
 916     c->state_userdata = userdata;
 917 }
 918
 919 int pa_context_is_pending(pa_context *c) {
 920     pa_assert(c);
 921     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 922
 923     PA_CHECK_VALIDITY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE);
 924
 925     return (c->pstream && pa_pstream_is_pending(c->pstream)) ||
 926         (c->pdispatch && pa_pdispatch_is_pending(c->pdispatch)) ||
 927         c->client;
 928 }
 929
 930 static void set_dispatch_callbacks(pa_operation *o);
 931
 932 static void pdispatch_drain_callback(pa_pdispatch*pd, void *userdata) {
 933     set_dispatch_callbacks(userdata);
 934 }
 935
 936 static void pstream_drain_callback(pa_pstream *s, void *userdata) {
 937     set_dispatch_callbacks(userdata);
 938 }
 939
 940 static void set_dispatch_callbacks(pa_operation *o) {
 941     int done = 1;
 942
 943     pa_assert(o);
 944     pa_assert(PA_REFCNT_VALUE(o) >= 1);
 945     pa_assert(o->context);
 946     pa_assert(PA_REFCNT_VALUE(o->context) >= 1);
 947     pa_assert(o->context->state == PA_CONTEXT_READY);
 948
 949     pa_pstream_set_drain_callback(o->context->pstream, NULL, NULL);
 950     pa_pdispatch_set_drain_callback(o->context->pdispatch, NULL, NULL);
 951
 952     if (pa_pdispatch_is_pending(o->context->pdispatch)) {
 953         pa_pdispatch_set_drain_callback(o->context->pdispatch, pdispatch_drain_callback, o);
 954         done = 0;
 955     }
 956
 957     if (pa_pstream_is_pending(o->context->pstream)) {
 958         pa_pstream_set_drain_callback(o->context->pstream, pstream_drain_callback, o);
 959         done = 0;
 960     }
 961
 962     if (done) {
 963         if (o->callback) {
 964             pa_context_notify_cb_t cb = (pa_context_notify_cb_t) o->callback;
 965             cb(o->context, o->userdata);
 966         }
 967
 968         pa_operation_done(o);
 969         pa_operation_unref(o);
 970     }
 971 }
 972
 973 pa_operation* pa_context_drain(pa_context *c, pa_context_notify_cb_t cb, void *userdata) {
 974     pa_operation *o;
 975
 976     pa_assert(c);
 977     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 978
 979     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
 980     PA_CHECK_VALIDITY_RETURN_NULL(c, pa_context_is_pending(c), PA_ERR_BADSTATE);
 981
 982     o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
 983     set_dispatch_callbacks(pa_operation_ref(o));
 984
 985     return o;
 986 }
 987
 988 void pa_context_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
 989     pa_operation *o = userdata;
 990     int success = 1;
 991
 992     pa_assert(pd);
 993     pa_assert(o);
 994     pa_assert(PA_REFCNT_VALUE(o) >= 1);
 995
 996     if (!o->context)
 997         goto finish;
 998
 999     if (command != PA_COMMAND_REPLY) {
1000         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1001             goto finish;
1002
1003         success = 0;
1004     } else if (!pa_tagstruct_eof(t)) {
1005         pa_context_fail(o->context, PA_ERR_PROTOCOL);
1006         goto finish;
1007     }
1008
1009     if (o->callback) {
1010         pa_context_success_cb_t cb = (pa_context_success_cb_t) o->callback;
1011         cb(o->context, success, o->userdata);
1012     }
1013
1014 finish:
1015     pa_operation_done(o);
1016     pa_operation_unref(o);
1017 }
1018
1019 pa_operation* pa_context_send_simple_command(pa_context *c, uint32_t command, pa_pdispatch_cb_t internal_cb, pa_operation_cb_t cb, void *userdata) {
1020     pa_tagstruct *t;
1021     pa_operation *o;
1022     uint32_t tag;
1023
1024     pa_assert(c);
1025     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1026
1027     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1028
1029     o = pa_operation_new(c, NULL, cb, userdata);
1030
1031     t = pa_tagstruct_command(c, command, &tag);
1032     pa_pstream_send_tagstruct(c->pstream, t);
1033     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, internal_cb, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1034
1035     return o;
1036 }
1037
1038 pa_operation* pa_context_exit_daemon(pa_context *c, pa_context_success_cb_t cb, void *userdata) {
1039     pa_assert(c);
1040     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1041
1042     return pa_context_send_simple_command(c, PA_COMMAND_EXIT, pa_context_simple_ack_callback, (pa_operation_cb_t) cb, userdata);
1043 }
1044
1045 pa_operation* pa_context_set_default_sink(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1046     pa_tagstruct *t;
1047     pa_operation *o;
1048     uint32_t tag;
1049
1050     pa_assert(c);
1051     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1052
1053     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1054
1055     o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1056     t = pa_tagstruct_command(c, PA_COMMAND_SET_DEFAULT_SINK, &tag);
1057     pa_tagstruct_puts(t, name);
1058     pa_pstream_send_tagstruct(c->pstream, t);
1059     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT,  pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1060
1061     return o;
1062 }
1063
1064 pa_operation* pa_context_set_default_source(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1065     pa_tagstruct *t;
1066     pa_operation *o;
1067     uint32_t tag;
1068
1069     pa_assert(c);
1070     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1071
1072     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1073
1074     o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1075     t = pa_tagstruct_command(c, PA_COMMAND_SET_DEFAULT_SOURCE, &tag);
1076     pa_tagstruct_puts(t, name);
1077     pa_pstream_send_tagstruct(c->pstream, t);
1078     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT,  pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1079
1080     return o;
1081 }
1082
1083 int pa_context_is_local(pa_context *c) {
1084     pa_assert(c);
1085     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1086
1087     PA_CHECK_VALIDITY_RETURN_ANY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE, -1);
1088
1089     return !!c->is_local;
1090 }
1091
1092 pa_operation* pa_context_set_name(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1093     pa_operation *o;
1094
1095     pa_assert(c);
1096     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1097     pa_assert(name);
1098
1099     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1100
1101     if (c->version >= 13) {
1102         pa_proplist *p = pa_proplist_new();
1103
1104         pa_proplist_sets(p, PA_PROP_APPLICATION_NAME, name);
1105         o = pa_context_proplist_update(c, PA_UPDATE_REPLACE, p, cb, userdata);
1106         pa_proplist_free(p);
1107     } else {
1108         pa_tagstruct *t;
1109         uint32_t tag;
1110
1111         o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1112         t = pa_tagstruct_command(c, PA_COMMAND_SET_CLIENT_NAME, &tag);
1113         pa_tagstruct_puts(t, name);
1114         pa_pstream_send_tagstruct(c->pstream, t);
1115         pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT,  pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1116     }
1117
1118     return o;
1119 }
1120
1121 const char* pa_get_library_version(void) {
1122     return PACKAGE_VERSION;
1123 }
1124
1125 const char* pa_context_get_server(pa_context *c) {
1126     pa_assert(c);
1127     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1128
1129     if (!c->server)
1130         return NULL;
1131
1132     if (*c->server == '{') {
1133         char *e = strchr(c->server+1, '}');
1134         return e ? e+1 : c->server;
1135     }
1136
1137     return c->server;
1138 }
1139
1140 uint32_t pa_context_get_protocol_version(pa_context *c) {
1141     return PA_PROTOCOL_VERSION;
1142 }
1143
1144 uint32_t pa_context_get_server_protocol_version(pa_context *c) {
1145     pa_assert(c);
1146     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1147
1148     PA_CHECK_VALIDITY_RETURN_ANY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE, PA_INVALID_INDEX);
1149
1150     return c->version;
1151 }
1152
1153 pa_tagstruct *pa_tagstruct_command(pa_context *c, uint32_t command, uint32_t *tag) {
1154     pa_tagstruct *t;
1155
1156     pa_assert(c);
1157     pa_assert(tag);
1158
1159     t = pa_tagstruct_new(NULL, 0);
1160     pa_tagstruct_putu32(t, command);
1161     pa_tagstruct_putu32(t, *tag = c->ctag++);
1162
1163     return t;
1164 }
1165
1166 uint32_t pa_context_get_index(pa_context *c) {
1167     pa_assert(c);
1168     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1169
1170     PA_CHECK_VALIDITY_RETURN_ANY(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
1171     PA_CHECK_VALIDITY_RETURN_ANY(c, c->version >= 13, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
1172
1173     return c->client_index;
1174 }
1175
1176 pa_operation *pa_context_proplist_update(pa_context *c, pa_update_mode_t mode, pa_proplist *p, pa_context_success_cb_t cb, void *userdata) {
1177     pa_operation *o;
1178     pa_tagstruct *t;
1179     uint32_t tag;
1180
1181     pa_assert(c);
1182     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1183
1184     PA_CHECK_VALIDITY_RETURN_NULL(c, mode == PA_UPDATE_SET || mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE, PA_ERR_INVALID);
1185     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1186     PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 13, PA_ERR_NOTSUPPORTED);
1187
1188     o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1189
1190     t = pa_tagstruct_command(c, PA_COMMAND_UPDATE_CLIENT_PROPLIST, &tag);
1191     pa_tagstruct_putu32(t, (uint32_t) mode);
1192     pa_tagstruct_put_proplist(t, p);
1193
1194     pa_pstream_send_tagstruct(c->pstream, t);
1195     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1196
1197     /* Please note that we don't update c->proplist here, because we
1198      * don't export that field */
1199
1200     return o;
1201 }
1202
1203 pa_operation *pa_context_proplist_remove(pa_context *c, const char *const keys[], pa_context_success_cb_t cb, void *userdata) {
1204     pa_operation *o;
1205     pa_tagstruct *t;
1206     uint32_t tag;
1207     const char * const *k;
1208
1209     pa_assert(c);
1210     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1211
1212     PA_CHECK_VALIDITY_RETURN_NULL(c, keys && keys[0], PA_ERR_INVALID);
1213     PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1214     PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 13, PA_ERR_NOTSUPPORTED);
1215
1216     o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1217
1218     t = pa_tagstruct_command(c, PA_COMMAND_REMOVE_CLIENT_PROPLIST, &tag);
1219
1220     for (k = keys; *k; k++)
1221         pa_tagstruct_puts(t, *k);
1222
1223     pa_tagstruct_puts(t, NULL);
1224
1225     pa_pstream_send_tagstruct(c->pstream, t);
1226     pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1227
1228     /* Please note that we don't update c->proplist here, because we
1229      * don't export that field */
1230
1231     return o;
1232 }
1233
1234 void pa_command_extension(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1235     pa_context *c = userdata;
1236     uint32_t idx;
1237     const char *name;
1238
1239     pa_assert(pd);
1240     pa_assert(command == PA_COMMAND_EXTENSION);
1241     pa_assert(t);
1242     pa_assert(c);
1243     pa_assert(PA_REFCNT_VALUE(c) >= 1);
1244
1245     pa_context_ref(c);
1246
1247     if (pa_tagstruct_getu32(t, &idx) < 0 ||
1248         pa_tagstruct_gets(t, &name) < 0) {
1249         pa_context_fail(c, PA_ERR_PROTOCOL);
1250         goto finish;
1251     }
1252
1253     if (!strcmp(name, "module-stream-restore"))
1254         pa_ext_stream_restore_command(c, tag, t);
1255     else
1256         pa_log(_("Received message for unknown extension '%s'"), name);
1257
1258 finish:
1259     pa_context_unref(c);
1260 }