2 * ALSA sequencer Timing queue handling
3 * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Nov. 13, 1999 Takashi Iwai <iwai@ww.uni-erlangen.de>
21 * - Queues are allocated dynamically via ioctl.
22 * - When owner client is deleted, all owned queues are deleted, too.
23 * - Owner of unlocked queue is kept unmodified even if it is
24 * manipulated by other clients.
25 * - Owner field in SET_QUEUE_OWNER ioctl must be identical with the
26 * caller client. i.e. Changing owner to a third client is not
29 * Aug. 30, 2000 Takashi Iwai
30 * - Queues are managed in static array again, but with better way.
31 * The API itself is identical.
32 * - The queue is locked when struct snd_seq_queue pointer is returned via
33 * queueptr(). This pointer *MUST* be released afterward by
35 * - Addition of experimental sync support.
38 #include <linux/init.h>
39 #include <linux/slab.h>
40 #include <sound/core.h>
42 #include "seq_memory.h"
43 #include "seq_queue.h"
44 #include "seq_clientmgr.h"
46 #include "seq_timer.h"
49 /* list of allocated queues */
50 static struct snd_seq_queue *queue_list[SNDRV_SEQ_MAX_QUEUES];
51 static DEFINE_SPINLOCK(queue_list_lock);
52 /* number of queues allocated */
53 static int num_queues;
55 int snd_seq_queue_get_cur_queues(void)
60 /*----------------------------------------------------------------*/
62 /* assign queue id and insert to list */
63 static int queue_list_add(struct snd_seq_queue *q)
68 spin_lock_irqsave(&queue_list_lock, flags);
69 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
70 if (! queue_list[i]) {
74 spin_unlock_irqrestore(&queue_list_lock, flags);
78 spin_unlock_irqrestore(&queue_list_lock, flags);
82 static struct snd_seq_queue *queue_list_remove(int id, int client)
84 struct snd_seq_queue *q;
87 spin_lock_irqsave(&queue_list_lock, flags);
90 spin_lock(&q->owner_lock);
91 if (q->owner == client) {
94 spin_unlock(&q->owner_lock);
95 queue_list[id] = NULL;
97 spin_unlock_irqrestore(&queue_list_lock, flags);
100 spin_unlock(&q->owner_lock);
102 spin_unlock_irqrestore(&queue_list_lock, flags);
106 /*----------------------------------------------------------------*/
108 /* create new queue (constructor) */
109 static struct snd_seq_queue *queue_new(int owner, int locked)
111 struct snd_seq_queue *q;
113 q = kzalloc(sizeof(*q), GFP_KERNEL);
117 spin_lock_init(&q->owner_lock);
118 spin_lock_init(&q->check_lock);
119 mutex_init(&q->timer_mutex);
120 snd_use_lock_init(&q->use_lock);
123 q->tickq = snd_seq_prioq_new();
124 q->timeq = snd_seq_prioq_new();
125 q->timer = snd_seq_timer_new();
126 if (q->tickq == NULL || q->timeq == NULL || q->timer == NULL) {
127 snd_seq_prioq_delete(&q->tickq);
128 snd_seq_prioq_delete(&q->timeq);
129 snd_seq_timer_delete(&q->timer);
141 /* delete queue (destructor) */
142 static void queue_delete(struct snd_seq_queue *q)
144 /* stop and release the timer */
145 mutex_lock(&q->timer_mutex);
146 snd_seq_timer_stop(q->timer);
147 snd_seq_timer_close(q);
148 mutex_unlock(&q->timer_mutex);
149 /* wait until access free */
150 snd_use_lock_sync(&q->use_lock);
151 /* release resources... */
152 snd_seq_prioq_delete(&q->tickq);
153 snd_seq_prioq_delete(&q->timeq);
154 snd_seq_timer_delete(&q->timer);
160 /*----------------------------------------------------------------*/
163 int __init snd_seq_queues_init(void)
166 memset(queue_list, 0, sizeof(queue_list));
172 /* delete all existing queues */
173 void __exit snd_seq_queues_delete(void)
178 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
180 queue_delete(queue_list[i]);
184 static void queue_use(struct snd_seq_queue *queue, int client, int use);
186 /* allocate a new queue -
187 * return pointer to new queue or ERR_PTR(-errno) for error
188 * The new queue's use_lock is set to 1. It is the caller's responsibility to
189 * call snd_use_lock_free(&q->use_lock).
191 struct snd_seq_queue *snd_seq_queue_alloc(int client, int locked, unsigned int info_flags)
193 struct snd_seq_queue *q;
195 q = queue_new(client, locked);
197 return ERR_PTR(-ENOMEM);
198 q->info_flags = info_flags;
199 queue_use(q, client, 1);
200 snd_use_lock_use(&q->use_lock);
201 if (queue_list_add(q) < 0) {
202 snd_use_lock_free(&q->use_lock);
204 return ERR_PTR(-ENOMEM);
209 /* delete a queue - queue must be owned by the client */
210 int snd_seq_queue_delete(int client, int queueid)
212 struct snd_seq_queue *q;
214 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
216 q = queue_list_remove(queueid, client);
225 /* return pointer to queue structure for specified id */
226 struct snd_seq_queue *queueptr(int queueid)
228 struct snd_seq_queue *q;
231 if (queueid < 0 || queueid >= SNDRV_SEQ_MAX_QUEUES)
233 spin_lock_irqsave(&queue_list_lock, flags);
234 q = queue_list[queueid];
236 snd_use_lock_use(&q->use_lock);
237 spin_unlock_irqrestore(&queue_list_lock, flags);
241 /* return the (first) queue matching with the specified name */
242 struct snd_seq_queue *snd_seq_queue_find_name(char *name)
245 struct snd_seq_queue *q;
247 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
248 if ((q = queueptr(i)) != NULL) {
249 if (strncmp(q->name, name, sizeof(q->name)) == 0)
258 /* -------------------------------------------------------- */
260 #define MAX_CELL_PROCESSES_IN_QUEUE 1000
262 void snd_seq_check_queue(struct snd_seq_queue *q, int atomic, int hop)
265 struct snd_seq_event_cell *cell;
266 snd_seq_tick_time_t cur_tick;
267 snd_seq_real_time_t cur_time;
273 /* make this function non-reentrant */
274 spin_lock_irqsave(&q->check_lock, flags);
275 if (q->check_blocked) {
277 spin_unlock_irqrestore(&q->check_lock, flags);
278 return; /* other thread is already checking queues */
280 q->check_blocked = 1;
281 spin_unlock_irqrestore(&q->check_lock, flags);
284 /* Process tick queue... */
285 cur_tick = snd_seq_timer_get_cur_tick(q->timer);
287 cell = snd_seq_prioq_cell_out(q->tickq, &cur_tick);
290 snd_seq_dispatch_event(cell, atomic, hop);
291 if (++processed >= MAX_CELL_PROCESSES_IN_QUEUE)
292 goto out; /* the rest processed at the next batch */
295 /* Process time queue... */
296 cur_time = snd_seq_timer_get_cur_time(q->timer, false);
298 cell = snd_seq_prioq_cell_out(q->timeq, &cur_time);
301 snd_seq_dispatch_event(cell, atomic, hop);
302 if (++processed >= MAX_CELL_PROCESSES_IN_QUEUE)
303 goto out; /* the rest processed at the next batch */
308 spin_lock_irqsave(&q->check_lock, flags);
309 if (q->check_again) {
311 if (processed < MAX_CELL_PROCESSES_IN_QUEUE) {
312 spin_unlock_irqrestore(&q->check_lock, flags);
316 q->check_blocked = 0;
317 spin_unlock_irqrestore(&q->check_lock, flags);
321 /* enqueue a event to singe queue */
322 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop)
325 struct snd_seq_queue *q;
327 if (snd_BUG_ON(!cell))
329 dest = cell->event.queue; /* destination queue */
333 /* handle relative time stamps, convert them into absolute */
334 if ((cell->event.flags & SNDRV_SEQ_TIME_MODE_MASK) == SNDRV_SEQ_TIME_MODE_REL) {
335 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
336 case SNDRV_SEQ_TIME_STAMP_TICK:
337 cell->event.time.tick += q->timer->tick.cur_tick;
340 case SNDRV_SEQ_TIME_STAMP_REAL:
341 snd_seq_inc_real_time(&cell->event.time.time,
342 &q->timer->cur_time);
345 cell->event.flags &= ~SNDRV_SEQ_TIME_MODE_MASK;
346 cell->event.flags |= SNDRV_SEQ_TIME_MODE_ABS;
348 /* enqueue event in the real-time or midi queue */
349 switch (cell->event.flags & SNDRV_SEQ_TIME_STAMP_MASK) {
350 case SNDRV_SEQ_TIME_STAMP_TICK:
351 err = snd_seq_prioq_cell_in(q->tickq, cell);
354 case SNDRV_SEQ_TIME_STAMP_REAL:
356 err = snd_seq_prioq_cell_in(q->timeq, cell);
361 queuefree(q); /* unlock */
365 /* trigger dispatching */
366 snd_seq_check_queue(q, atomic, hop);
368 queuefree(q); /* unlock */
374 /*----------------------------------------------------------------*/
376 static inline int check_access(struct snd_seq_queue *q, int client)
378 return (q->owner == client) || (!q->locked && !q->klocked);
381 /* check if the client has permission to modify queue parameters.
382 * if it does, lock the queue
384 static int queue_access_lock(struct snd_seq_queue *q, int client)
389 spin_lock_irqsave(&q->owner_lock, flags);
390 access_ok = check_access(q, client);
393 spin_unlock_irqrestore(&q->owner_lock, flags);
397 /* unlock the queue */
398 static inline void queue_access_unlock(struct snd_seq_queue *q)
402 spin_lock_irqsave(&q->owner_lock, flags);
404 spin_unlock_irqrestore(&q->owner_lock, flags);
407 /* exported - only checking permission */
408 int snd_seq_queue_check_access(int queueid, int client)
410 struct snd_seq_queue *q = queueptr(queueid);
416 spin_lock_irqsave(&q->owner_lock, flags);
417 access_ok = check_access(q, client);
418 spin_unlock_irqrestore(&q->owner_lock, flags);
423 /*----------------------------------------------------------------*/
426 * change queue's owner and permission
428 int snd_seq_queue_set_owner(int queueid, int client, int locked)
430 struct snd_seq_queue *q = queueptr(queueid);
436 if (! queue_access_lock(q, client)) {
441 spin_lock_irqsave(&q->owner_lock, flags);
442 q->locked = locked ? 1 : 0;
444 spin_unlock_irqrestore(&q->owner_lock, flags);
445 queue_access_unlock(q);
452 /*----------------------------------------------------------------*/
455 * q->use mutex should be down before calling this function to avoid
456 * confliction with snd_seq_queue_use()
458 int snd_seq_queue_timer_open(int queueid)
461 struct snd_seq_queue *queue;
462 struct snd_seq_timer *tmr;
464 queue = queueptr(queueid);
468 if ((result = snd_seq_timer_open(queue)) < 0) {
469 snd_seq_timer_defaults(tmr);
470 result = snd_seq_timer_open(queue);
477 * q->use mutex should be down before calling this function
479 int snd_seq_queue_timer_close(int queueid)
481 struct snd_seq_queue *queue;
484 queue = queueptr(queueid);
487 snd_seq_timer_close(queue);
492 /* change queue tempo and ppq */
493 int snd_seq_queue_timer_set_tempo(int queueid, int client,
494 struct snd_seq_queue_tempo *info)
496 struct snd_seq_queue *q = queueptr(queueid);
501 if (! queue_access_lock(q, client)) {
506 result = snd_seq_timer_set_tempo(q->timer, info->tempo);
508 result = snd_seq_timer_set_ppq(q->timer, info->ppq);
509 if (result >= 0 && info->skew_base > 0)
510 result = snd_seq_timer_set_skew(q->timer, info->skew_value,
512 queue_access_unlock(q);
517 /* use or unuse this queue */
518 static void queue_use(struct snd_seq_queue *queue, int client, int use)
521 if (!test_and_set_bit(client, queue->clients_bitmap))
524 if (test_and_clear_bit(client, queue->clients_bitmap))
527 if (queue->clients) {
528 if (use && queue->clients == 1)
529 snd_seq_timer_defaults(queue->timer);
530 snd_seq_timer_open(queue);
532 snd_seq_timer_close(queue);
536 /* use or unuse this queue -
537 * if it is the first client, starts the timer.
538 * if it is not longer used by any clients, stop the timer.
540 int snd_seq_queue_use(int queueid, int client, int use)
542 struct snd_seq_queue *queue;
544 queue = queueptr(queueid);
547 mutex_lock(&queue->timer_mutex);
548 queue_use(queue, client, use);
549 mutex_unlock(&queue->timer_mutex);
555 * check if queue is used by the client
556 * return negative value if the queue is invalid.
557 * return 0 if not used, 1 if used.
559 int snd_seq_queue_is_used(int queueid, int client)
561 struct snd_seq_queue *q;
564 q = queueptr(queueid);
566 return -EINVAL; /* invalid queue */
567 result = test_bit(client, q->clients_bitmap) ? 1 : 0;
573 /*----------------------------------------------------------------*/
575 /* notification that client has left the system -
576 * stop the timer on all queues owned by this client
578 void snd_seq_queue_client_termination(int client)
582 struct snd_seq_queue *q;
585 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
586 if ((q = queueptr(i)) == NULL)
588 spin_lock_irqsave(&q->owner_lock, flags);
589 matched = (q->owner == client);
592 spin_unlock_irqrestore(&q->owner_lock, flags);
594 if (q->timer->running)
595 snd_seq_timer_stop(q->timer);
596 snd_seq_timer_reset(q->timer);
602 /* final stage notification -
603 * remove cells for no longer exist client (for non-owned queue)
604 * or delete this queue (for owned queue)
606 void snd_seq_queue_client_leave(int client)
609 struct snd_seq_queue *q;
611 /* delete own queues from queue list */
612 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
613 if ((q = queue_list_remove(i, client)) != NULL)
617 /* remove cells from existing queues -
618 * they are not owned by this client
620 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
621 if ((q = queueptr(i)) == NULL)
623 if (test_bit(client, q->clients_bitmap)) {
624 snd_seq_prioq_leave(q->tickq, client, 0);
625 snd_seq_prioq_leave(q->timeq, client, 0);
626 snd_seq_queue_use(q->queue, client, 0);
634 /*----------------------------------------------------------------*/
636 /* remove cells from all queues */
637 void snd_seq_queue_client_leave_cells(int client)
640 struct snd_seq_queue *q;
642 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
643 if ((q = queueptr(i)) == NULL)
645 snd_seq_prioq_leave(q->tickq, client, 0);
646 snd_seq_prioq_leave(q->timeq, client, 0);
651 /* remove cells based on flush criteria */
652 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info)
655 struct snd_seq_queue *q;
657 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
658 if ((q = queueptr(i)) == NULL)
660 if (test_bit(client, q->clients_bitmap) &&
661 (! (info->remove_mode & SNDRV_SEQ_REMOVE_DEST) ||
662 q->queue == info->queue)) {
663 snd_seq_prioq_remove_events(q->tickq, client, info);
664 snd_seq_prioq_remove_events(q->timeq, client, info);
670 /*----------------------------------------------------------------*/
673 * send events to all subscribed ports
675 static void queue_broadcast_event(struct snd_seq_queue *q, struct snd_seq_event *ev,
678 struct snd_seq_event sev;
682 sev.flags = SNDRV_SEQ_TIME_STAMP_TICK|SNDRV_SEQ_TIME_MODE_ABS;
683 sev.time.tick = q->timer->tick.cur_tick;
684 sev.queue = q->queue;
685 sev.data.queue.queue = q->queue;
687 /* broadcast events from Timer port */
688 sev.source.client = SNDRV_SEQ_CLIENT_SYSTEM;
689 sev.source.port = SNDRV_SEQ_PORT_SYSTEM_TIMER;
690 sev.dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
691 snd_seq_kernel_client_dispatch(SNDRV_SEQ_CLIENT_SYSTEM, &sev, atomic, hop);
695 * process a received queue-control event.
696 * this function is exported for seq_sync.c.
698 static void snd_seq_queue_process_event(struct snd_seq_queue *q,
699 struct snd_seq_event *ev,
703 case SNDRV_SEQ_EVENT_START:
704 snd_seq_prioq_leave(q->tickq, ev->source.client, 1);
705 snd_seq_prioq_leave(q->timeq, ev->source.client, 1);
706 if (! snd_seq_timer_start(q->timer))
707 queue_broadcast_event(q, ev, atomic, hop);
710 case SNDRV_SEQ_EVENT_CONTINUE:
711 if (! snd_seq_timer_continue(q->timer))
712 queue_broadcast_event(q, ev, atomic, hop);
715 case SNDRV_SEQ_EVENT_STOP:
716 snd_seq_timer_stop(q->timer);
717 queue_broadcast_event(q, ev, atomic, hop);
720 case SNDRV_SEQ_EVENT_TEMPO:
721 snd_seq_timer_set_tempo(q->timer, ev->data.queue.param.value);
722 queue_broadcast_event(q, ev, atomic, hop);
725 case SNDRV_SEQ_EVENT_SETPOS_TICK:
726 if (snd_seq_timer_set_position_tick(q->timer, ev->data.queue.param.time.tick) == 0) {
727 queue_broadcast_event(q, ev, atomic, hop);
731 case SNDRV_SEQ_EVENT_SETPOS_TIME:
732 if (snd_seq_timer_set_position_time(q->timer, ev->data.queue.param.time.time) == 0) {
733 queue_broadcast_event(q, ev, atomic, hop);
736 case SNDRV_SEQ_EVENT_QUEUE_SKEW:
737 if (snd_seq_timer_set_skew(q->timer,
738 ev->data.queue.param.skew.value,
739 ev->data.queue.param.skew.base) == 0) {
740 queue_broadcast_event(q, ev, atomic, hop);
748 * Queue control via timer control port:
749 * this function is exported as a callback of timer port.
751 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop)
753 struct snd_seq_queue *q;
757 q = queueptr(ev->data.queue.queue);
762 if (! queue_access_lock(q, ev->source.client)) {
767 snd_seq_queue_process_event(q, ev, atomic, hop);
769 queue_access_unlock(q);
775 /*----------------------------------------------------------------*/
777 #ifdef CONFIG_SND_PROC_FS
778 /* exported to seq_info.c */
779 void snd_seq_info_queues_read(struct snd_info_entry *entry,
780 struct snd_info_buffer *buffer)
783 struct snd_seq_queue *q;
784 struct snd_seq_timer *tmr;
788 for (i = 0; i < SNDRV_SEQ_MAX_QUEUES; i++) {
789 if ((q = queueptr(i)) == NULL)
794 bpm = 60000000 / tmr->tempo;
798 spin_lock_irq(&q->owner_lock);
801 spin_unlock_irq(&q->owner_lock);
803 snd_iprintf(buffer, "queue %d: [%s]\n", q->queue, q->name);
804 snd_iprintf(buffer, "owned by client : %d\n", owner);
805 snd_iprintf(buffer, "lock status : %s\n", locked ? "Locked" : "Free");
806 snd_iprintf(buffer, "queued time events : %d\n", snd_seq_prioq_avail(q->timeq));
807 snd_iprintf(buffer, "queued tick events : %d\n", snd_seq_prioq_avail(q->tickq));
808 snd_iprintf(buffer, "timer state : %s\n", tmr->running ? "Running" : "Stopped");
809 snd_iprintf(buffer, "timer PPQ : %d\n", tmr->ppq);
810 snd_iprintf(buffer, "current tempo : %d\n", tmr->tempo);
811 snd_iprintf(buffer, "current BPM : %d\n", bpm);
812 snd_iprintf(buffer, "current time : %d.%09d s\n", tmr->cur_time.tv_sec, tmr->cur_time.tv_nsec);
813 snd_iprintf(buffer, "current tick : %d\n", tmr->tick.cur_tick);
814 snd_iprintf(buffer, "\n");
818 #endif /* CONFIG_SND_PROC_FS */