4 This file is part of PulseAudio.
6 PulseAudio 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.
11 PulseAudio 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.
16 You should have received a copy of the GNU Lesser General Public
17 License along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include <pulse/xmalloc.h>
34 #include <pulsecore/shm.h>
35 #include <pulsecore/log.h>
36 #include <pulsecore/hashmap.h>
40 #define PA_MEMPOOL_SLOTS_MAX 128
41 #define PA_MEMPOOL_SLOT_SIZE (16*1024)
43 #define PA_MEMEXPORT_SLOTS_MAX 128
45 #define PA_MEMIMPORT_SLOTS_MAX 128
46 #define PA_MEMIMPORT_SEGMENTS_MAX 16
48 struct pa_memimport_segment
{
59 /* Called whenever an imported memory block is no longer
61 pa_memimport_release_cb_t release_cb
;
64 PA_LLIST_FIELDS(pa_memimport
);
67 struct memexport_slot
{
68 PA_LLIST_FIELDS(struct memexport_slot
);
75 struct memexport_slot slots
[PA_MEMEXPORT_SLOTS_MAX
];
76 PA_LLIST_HEAD(struct memexport_slot
, free_slots
);
77 PA_LLIST_HEAD(struct memexport_slot
, used_slots
);
80 /* Called whenever a client from which we imported a memory block
81 which we in turn exported to another client dies and we need to
82 revoke the memory block accordingly */
83 pa_memexport_revoke_cb_t revoke_cb
;
86 PA_LLIST_FIELDS(pa_memexport
);
90 PA_LLIST_FIELDS(struct mempool_slot
);
91 /* the actual data follows immediately hereafter */
97 unsigned n_blocks
, n_init
;
99 PA_LLIST_HEAD(pa_memimport
, imports
);
100 PA_LLIST_HEAD(pa_memexport
, exports
);
102 /* A list of free slots that may be reused */
103 PA_LLIST_HEAD(struct mempool_slot
, free_slots
);
104 PA_LLIST_HEAD(struct mempool_slot
, used_slots
);
106 pa_mempool_stat stat
;
109 static void segment_detach(pa_memimport_segment
*seg
);
111 static void stat_add(pa_memblock
*b
) {
115 b
->pool
->stat
.n_allocated
++;
116 b
->pool
->stat
.n_accumulated
++;
117 b
->pool
->stat
.allocated_size
+= b
->length
;
118 b
->pool
->stat
.accumulated_size
+= b
->length
;
120 if (b
->type
== PA_MEMBLOCK_IMPORTED
) {
121 b
->pool
->stat
.n_imported
++;
122 b
->pool
->stat
.imported_size
+= b
->length
;
126 static void stat_remove(pa_memblock
*b
) {
130 assert(b
->pool
->stat
.n_allocated
> 0);
131 assert(b
->pool
->stat
.allocated_size
>= b
->length
);
133 b
->pool
->stat
.n_allocated
--;
134 b
->pool
->stat
.allocated_size
-= b
->length
;
136 if (b
->type
== PA_MEMBLOCK_IMPORTED
) {
137 assert(b
->pool
->stat
.n_imported
> 0);
138 assert(b
->pool
->stat
.imported_size
>= b
->length
);
140 b
->pool
->stat
.n_imported
--;
141 b
->pool
->stat
.imported_size
-= b
->length
;
145 static pa_memblock
*memblock_new_appended(pa_mempool
*p
, size_t length
);
147 pa_memblock
*pa_memblock_new(pa_mempool
*p
, size_t length
) {
153 if (!(b
= pa_memblock_new_pool(p
, length
)))
154 b
= memblock_new_appended(p
, length
);
159 static pa_memblock
*memblock_new_appended(pa_mempool
*p
, size_t length
) {
165 b
= pa_xmalloc(sizeof(pa_memblock
) + length
);
166 b
->type
= PA_MEMBLOCK_APPENDED
;
170 b
->data
= (uint8_t*) b
+ sizeof(pa_memblock
);
177 static struct mempool_slot
* mempool_allocate_slot(pa_mempool
*p
) {
178 struct mempool_slot
*slot
;
182 slot
= p
->free_slots
;
183 PA_LLIST_REMOVE(struct mempool_slot
, p
->free_slots
, slot
);
184 } else if (p
->n_init
< p
->n_blocks
)
185 slot
= (struct mempool_slot
*) ((uint8_t*) p
->memory
.ptr
+ (p
->block_size
* p
->n_init
++));
187 pa_log_debug("Pool full");
188 p
->stat
.n_pool_full
++;
192 PA_LLIST_PREPEND(struct mempool_slot
, p
->used_slots
, slot
);
196 static void* mempool_slot_data(struct mempool_slot
*slot
) {
199 return (uint8_t*) slot
+ sizeof(struct mempool_slot
);
202 static unsigned mempool_slot_idx(pa_mempool
*p
, void *ptr
) {
204 assert((uint8_t*) ptr
>= (uint8_t*) p
->memory
.ptr
);
205 assert((uint8_t*) ptr
< (uint8_t*) p
->memory
.ptr
+ p
->memory
.size
);
207 return ((uint8_t*) ptr
- (uint8_t*) p
->memory
.ptr
) / p
->block_size
;
210 static struct mempool_slot
* mempool_slot_by_ptr(pa_mempool
*p
, void *ptr
) {
213 if ((idx
= mempool_slot_idx(p
, ptr
)) == (unsigned) -1)
216 return (struct mempool_slot
*) ((uint8_t*) p
->memory
.ptr
+ (idx
* p
->block_size
));
219 pa_memblock
*pa_memblock_new_pool(pa_mempool
*p
, size_t length
) {
220 pa_memblock
*b
= NULL
;
221 struct mempool_slot
*slot
;
226 if (p
->block_size
- sizeof(struct mempool_slot
) >= sizeof(pa_memblock
) + length
) {
228 if (!(slot
= mempool_allocate_slot(p
)))
231 b
= mempool_slot_data(slot
);
232 b
->type
= PA_MEMBLOCK_POOL
;
233 b
->data
= (uint8_t*) b
+ sizeof(pa_memblock
);
235 } else if (p
->block_size
- sizeof(struct mempool_slot
) >= length
) {
237 if (!(slot
= mempool_allocate_slot(p
)))
240 b
= pa_xnew(pa_memblock
, 1);
241 b
->type
= PA_MEMBLOCK_POOL_EXTERNAL
;
242 b
->data
= mempool_slot_data(slot
);
244 pa_log_debug("Memory block to large for pool: %u > %u", length
, p
->block_size
- sizeof(struct mempool_slot
));
245 p
->stat
.n_too_large_for_pool
++;
258 pa_memblock
*pa_memblock_new_fixed(pa_mempool
*p
, void *d
, size_t length
, int read_only
) {
265 b
= pa_xnew(pa_memblock
, 1);
266 b
->type
= PA_MEMBLOCK_FIXED
;
267 b
->read_only
= read_only
;
277 pa_memblock
*pa_memblock_new_user(pa_mempool
*p
, void *d
, size_t length
, void (*free_cb
)(void *p
), int read_only
) {
285 b
= pa_xnew(pa_memblock
, 1);
286 b
->type
= PA_MEMBLOCK_USER
;
287 b
->read_only
= read_only
;
291 b
->per_type
.user
.free_cb
= free_cb
;
298 pa_memblock
* pa_memblock_ref(pa_memblock
*b
) {
306 void pa_memblock_unref(pa_memblock
*b
) {
310 if ((--(b
->ref
)) > 0)
316 case PA_MEMBLOCK_USER
:
317 assert(b
->per_type
.user
.free_cb
);
318 b
->per_type
.user
.free_cb(b
->data
);
322 case PA_MEMBLOCK_FIXED
:
323 case PA_MEMBLOCK_APPENDED
:
327 case PA_MEMBLOCK_IMPORTED
: {
328 pa_memimport_segment
*segment
;
330 segment
= b
->per_type
.imported
.segment
;
332 assert(segment
->import
);
334 pa_hashmap_remove(segment
->import
->blocks
, PA_UINT32_TO_PTR(b
->per_type
.imported
.id
));
335 segment
->import
->release_cb(segment
->import
, b
->per_type
.imported
.id
, segment
->import
->userdata
);
337 if (-- segment
->n_blocks
<= 0)
338 segment_detach(segment
);
344 case PA_MEMBLOCK_POOL_EXTERNAL
:
345 case PA_MEMBLOCK_POOL
: {
346 struct mempool_slot
*slot
;
348 slot
= mempool_slot_by_ptr(b
->pool
, b
->data
);
351 PA_LLIST_REMOVE(struct mempool_slot
, b
->pool
->used_slots
, slot
);
352 PA_LLIST_PREPEND(struct mempool_slot
, b
->pool
->free_slots
, slot
);
354 if (b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
)
360 static void memblock_make_local(pa_memblock
*b
) {
363 if (b
->length
<= b
->pool
->block_size
- sizeof(struct mempool_slot
)) {
364 struct mempool_slot
*slot
;
366 if ((slot
= mempool_allocate_slot(b
->pool
))) {
368 /* We can move it into a local pool, perfect! */
370 b
->type
= PA_MEMBLOCK_POOL_EXTERNAL
;
373 new_data
= mempool_slot_data(slot
);
374 memcpy(new_data
, b
->data
, b
->length
);
380 /* Humm, not enough space in the pool, so lets allocate the memory with malloc() */
381 b
->type
= PA_MEMBLOCK_USER
;
382 b
->per_type
.user
.free_cb
= pa_xfree
;
384 b
->data
= pa_xmemdup(b
->data
, b
->length
);
387 void pa_memblock_unref_fixed(pa_memblock
*b
) {
390 assert(b
->type
== PA_MEMBLOCK_FIXED
);
393 memblock_make_local(b
);
395 pa_memblock_unref(b
);
398 static void memblock_replace_import(pa_memblock
*b
) {
399 pa_memimport_segment
*seg
;
402 assert(b
->type
== PA_MEMBLOCK_IMPORTED
);
404 assert(b
->pool
->stat
.n_imported
> 0);
405 assert(b
->pool
->stat
.imported_size
>= b
->length
);
406 b
->pool
->stat
.n_imported
--;
407 b
->pool
->stat
.imported_size
-= b
->length
;
409 seg
= b
->per_type
.imported
.segment
;
415 PA_UINT32_TO_PTR(b
->per_type
.imported
.id
));
417 memblock_make_local(b
);
419 if (-- seg
->n_blocks
<= 0)
423 pa_mempool
* pa_mempool_new(int shared
) {
427 p
= pa_xnew(pa_mempool
, 1);
429 ps
= (size_t) sysconf(_SC_PAGESIZE
);
431 p
->block_size
= (PA_MEMPOOL_SLOT_SIZE
/ps
)*ps
;
433 if (p
->block_size
< ps
)
436 p
->n_blocks
= PA_MEMPOOL_SLOTS_MAX
;
438 assert(p
->block_size
> sizeof(struct mempool_slot
));
440 if (pa_shm_create_rw(&p
->memory
, p
->n_blocks
* p
->block_size
, shared
, 0700) < 0) {
447 PA_LLIST_HEAD_INIT(pa_memimport
, p
->imports
);
448 PA_LLIST_HEAD_INIT(pa_memexport
, p
->exports
);
449 PA_LLIST_HEAD_INIT(struct mempool_slot
, p
->free_slots
);
450 PA_LLIST_HEAD_INIT(struct mempool_slot
, p
->used_slots
);
452 memset(&p
->stat
, 0, sizeof(p
->stat
));
457 void pa_mempool_free(pa_mempool
*p
) {
461 pa_memimport_free(p
->imports
);
464 pa_memexport_free(p
->exports
);
466 if (p
->stat
.n_allocated
> 0)
467 pa_log_warn("WARNING! Memory pool destroyed but not all memory blocks freed!");
469 pa_shm_free(&p
->memory
);
473 const pa_mempool_stat
* pa_mempool_get_stat(pa_mempool
*p
) {
479 void pa_mempool_vacuum(pa_mempool
*p
) {
480 struct mempool_slot
*slot
;
484 for (slot
= p
->free_slots
; slot
; slot
= slot
->next
) {
485 pa_shm_punch(&p
->memory
, (uint8_t*) slot
+ sizeof(struct mempool_slot
) - (uint8_t*) p
->memory
.ptr
, p
->block_size
- sizeof(struct mempool_slot
));
489 int pa_mempool_get_shm_id(pa_mempool
*p
, uint32_t *id
) {
492 if (!p
->memory
.shared
)
500 /* For recieving blocks from other nodes */
501 pa_memimport
* pa_memimport_new(pa_mempool
*p
, pa_memimport_release_cb_t cb
, void *userdata
) {
507 i
= pa_xnew(pa_memimport
, 1);
509 i
->segments
= pa_hashmap_new(NULL
, NULL
);
510 i
->blocks
= pa_hashmap_new(NULL
, NULL
);
512 i
->userdata
= userdata
;
514 PA_LLIST_PREPEND(pa_memimport
, p
->imports
, i
);
518 static void memexport_revoke_blocks(pa_memexport
*e
, pa_memimport
*i
);
520 static pa_memimport_segment
* segment_attach(pa_memimport
*i
, uint32_t shm_id
) {
521 pa_memimport_segment
* seg
;
523 if (pa_hashmap_size(i
->segments
) >= PA_MEMIMPORT_SEGMENTS_MAX
)
526 seg
= pa_xnew(pa_memimport_segment
, 1);
528 if (pa_shm_attach_ro(&seg
->memory
, shm_id
) < 0) {
536 pa_hashmap_put(i
->segments
, PA_UINT32_TO_PTR(shm_id
), seg
);
540 static void segment_detach(pa_memimport_segment
*seg
) {
543 pa_hashmap_remove(seg
->import
->segments
, PA_UINT32_TO_PTR(seg
->memory
.id
));
544 pa_shm_free(&seg
->memory
);
548 void pa_memimport_free(pa_memimport
*i
) {
554 /* If we've exported this block further we need to revoke that export */
555 for (e
= i
->pool
->exports
; e
; e
= e
->next
)
556 memexport_revoke_blocks(e
, i
);
558 while ((b
= pa_hashmap_get_first(i
->blocks
)))
559 memblock_replace_import(b
);
561 assert(pa_hashmap_size(i
->segments
) == 0);
563 pa_hashmap_free(i
->blocks
, NULL
, NULL
);
564 pa_hashmap_free(i
->segments
, NULL
, NULL
);
566 PA_LLIST_REMOVE(pa_memimport
, i
->pool
->imports
, i
);
570 pa_memblock
* pa_memimport_get(pa_memimport
*i
, uint32_t block_id
, uint32_t shm_id
, size_t offset
, size_t size
) {
572 pa_memimport_segment
*seg
;
576 if (pa_hashmap_size(i
->blocks
) >= PA_MEMIMPORT_SLOTS_MAX
)
579 if (!(seg
= pa_hashmap_get(i
->segments
, PA_UINT32_TO_PTR(shm_id
))))
580 if (!(seg
= segment_attach(i
, shm_id
)))
583 if (offset
+size
> seg
->memory
.size
)
586 b
= pa_xnew(pa_memblock
, 1);
587 b
->type
= PA_MEMBLOCK_IMPORTED
;
591 b
->data
= (uint8_t*) seg
->memory
.ptr
+ offset
;
593 b
->per_type
.imported
.id
= block_id
;
594 b
->per_type
.imported
.segment
= seg
;
596 pa_hashmap_put(i
->blocks
, PA_UINT32_TO_PTR(block_id
), b
);
605 int pa_memimport_process_revoke(pa_memimport
*i
, uint32_t id
) {
609 if (!(b
= pa_hashmap_get(i
->blocks
, PA_UINT32_TO_PTR(id
))))
612 memblock_replace_import(b
);
616 /* For sending blocks to other nodes */
617 pa_memexport
* pa_memexport_new(pa_mempool
*p
, pa_memexport_revoke_cb_t cb
, void *userdata
) {
623 if (!p
->memory
.shared
)
626 e
= pa_xnew(pa_memexport
, 1);
628 PA_LLIST_HEAD_INIT(struct memexport_slot
, e
->free_slots
);
629 PA_LLIST_HEAD_INIT(struct memexport_slot
, e
->used_slots
);
632 e
->userdata
= userdata
;
634 PA_LLIST_PREPEND(pa_memexport
, p
->exports
, e
);
638 void pa_memexport_free(pa_memexport
*e
) {
641 while (e
->used_slots
)
642 pa_memexport_process_release(e
, e
->used_slots
- e
->slots
);
644 PA_LLIST_REMOVE(pa_memexport
, e
->pool
->exports
, e
);
648 int pa_memexport_process_release(pa_memexport
*e
, uint32_t id
) {
654 if (!e
->slots
[id
].block
)
657 /* pa_log("Processing release for %u", id); */
659 assert(e
->pool
->stat
.n_exported
> 0);
660 assert(e
->pool
->stat
.exported_size
>= e
->slots
[id
].block
->length
);
662 e
->pool
->stat
.n_exported
--;
663 e
->pool
->stat
.exported_size
-= e
->slots
[id
].block
->length
;
665 pa_memblock_unref(e
->slots
[id
].block
);
666 e
->slots
[id
].block
= NULL
;
668 PA_LLIST_REMOVE(struct memexport_slot
, e
->used_slots
, &e
->slots
[id
]);
669 PA_LLIST_PREPEND(struct memexport_slot
, e
->free_slots
, &e
->slots
[id
]);
674 static void memexport_revoke_blocks(pa_memexport
*e
, pa_memimport
*i
) {
675 struct memexport_slot
*slot
, *next
;
679 for (slot
= e
->used_slots
; slot
; slot
= next
) {
683 if (slot
->block
->type
!= PA_MEMBLOCK_IMPORTED
||
684 slot
->block
->per_type
.imported
.segment
->import
!= i
)
687 idx
= slot
- e
->slots
;
688 e
->revoke_cb(e
, idx
, e
->userdata
);
689 pa_memexport_process_release(e
, idx
);
693 static pa_memblock
*memblock_shared_copy(pa_mempool
*p
, pa_memblock
*b
) {
699 if (b
->type
== PA_MEMBLOCK_IMPORTED
||
700 b
->type
== PA_MEMBLOCK_POOL
||
701 b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
) {
702 assert(b
->pool
== p
);
703 return pa_memblock_ref(b
);
706 if (!(n
= pa_memblock_new_pool(p
, b
->length
)))
709 memcpy(n
->data
, b
->data
, b
->length
);
713 int pa_memexport_put(pa_memexport
*e
, pa_memblock
*b
, uint32_t *block_id
, uint32_t *shm_id
, size_t *offset
, size_t * size
) {
715 struct memexport_slot
*slot
;
723 assert(b
->pool
== e
->pool
);
725 if (!(b
= memblock_shared_copy(e
->pool
, b
)))
729 slot
= e
->free_slots
;
730 PA_LLIST_REMOVE(struct memexport_slot
, e
->free_slots
, slot
);
731 } else if (e
->n_init
< PA_MEMEXPORT_SLOTS_MAX
) {
732 slot
= &e
->slots
[e
->n_init
++];
734 pa_memblock_unref(b
);
738 PA_LLIST_PREPEND(struct memexport_slot
, e
->used_slots
, slot
);
740 *block_id
= slot
- e
->slots
;
742 /* pa_log("Got block id %u", *block_id); */
744 if (b
->type
== PA_MEMBLOCK_IMPORTED
) {
745 assert(b
->per_type
.imported
.segment
);
746 memory
= &b
->per_type
.imported
.segment
->memory
;
748 assert(b
->type
== PA_MEMBLOCK_POOL
|| b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
);
750 memory
= &b
->pool
->memory
;
753 assert(b
->data
>= memory
->ptr
);
754 assert((uint8_t*) b
->data
+ b
->length
<= (uint8_t*) memory
->ptr
+ memory
->size
);
756 *shm_id
= memory
->id
;
757 *offset
= (uint8_t*) b
->data
- (uint8_t*) memory
->ptr
;
760 e
->pool
->stat
.n_exported
++;
761 e
->pool
->stat
.exported_size
+= b
->length
;