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
;
125 b
->pool
->stat
.n_allocated_by_type
[b
->type
]++;
126 b
->pool
->stat
.n_accumulated_by_type
[b
->type
]++;
129 static void stat_remove(pa_memblock
*b
) {
133 assert(b
->pool
->stat
.n_allocated
> 0);
134 assert(b
->pool
->stat
.allocated_size
>= b
->length
);
136 b
->pool
->stat
.n_allocated
--;
137 b
->pool
->stat
.allocated_size
-= b
->length
;
139 if (b
->type
== PA_MEMBLOCK_IMPORTED
) {
140 assert(b
->pool
->stat
.n_imported
> 0);
141 assert(b
->pool
->stat
.imported_size
>= b
->length
);
143 b
->pool
->stat
.n_imported
--;
144 b
->pool
->stat
.imported_size
-= b
->length
;
147 b
->pool
->stat
.n_allocated_by_type
[b
->type
]--;
150 static pa_memblock
*memblock_new_appended(pa_mempool
*p
, size_t length
);
152 pa_memblock
*pa_memblock_new(pa_mempool
*p
, size_t length
) {
158 if (!(b
= pa_memblock_new_pool(p
, length
)))
159 b
= memblock_new_appended(p
, length
);
164 static pa_memblock
*memblock_new_appended(pa_mempool
*p
, size_t length
) {
170 b
= pa_xmalloc(sizeof(pa_memblock
) + length
);
171 b
->type
= PA_MEMBLOCK_APPENDED
;
175 b
->data
= (uint8_t*) b
+ sizeof(pa_memblock
);
182 static struct mempool_slot
* mempool_allocate_slot(pa_mempool
*p
) {
183 struct mempool_slot
*slot
;
187 slot
= p
->free_slots
;
188 PA_LLIST_REMOVE(struct mempool_slot
, p
->free_slots
, slot
);
189 } else if (p
->n_init
< p
->n_blocks
)
190 slot
= (struct mempool_slot
*) ((uint8_t*) p
->memory
.ptr
+ (p
->block_size
* p
->n_init
++));
192 pa_log_debug("Pool full");
193 p
->stat
.n_pool_full
++;
197 PA_LLIST_PREPEND(struct mempool_slot
, p
->used_slots
, slot
);
201 static void* mempool_slot_data(struct mempool_slot
*slot
) {
204 return (uint8_t*) slot
+ sizeof(struct mempool_slot
);
207 static unsigned mempool_slot_idx(pa_mempool
*p
, void *ptr
) {
209 assert((uint8_t*) ptr
>= (uint8_t*) p
->memory
.ptr
);
210 assert((uint8_t*) ptr
< (uint8_t*) p
->memory
.ptr
+ p
->memory
.size
);
212 return ((uint8_t*) ptr
- (uint8_t*) p
->memory
.ptr
) / p
->block_size
;
215 static struct mempool_slot
* mempool_slot_by_ptr(pa_mempool
*p
, void *ptr
) {
218 if ((idx
= mempool_slot_idx(p
, ptr
)) == (unsigned) -1)
221 return (struct mempool_slot
*) ((uint8_t*) p
->memory
.ptr
+ (idx
* p
->block_size
));
224 pa_memblock
*pa_memblock_new_pool(pa_mempool
*p
, size_t length
) {
225 pa_memblock
*b
= NULL
;
226 struct mempool_slot
*slot
;
231 if (p
->block_size
- sizeof(struct mempool_slot
) >= sizeof(pa_memblock
) + length
) {
233 if (!(slot
= mempool_allocate_slot(p
)))
236 b
= mempool_slot_data(slot
);
237 b
->type
= PA_MEMBLOCK_POOL
;
238 b
->data
= (uint8_t*) b
+ sizeof(pa_memblock
);
240 } else if (p
->block_size
- sizeof(struct mempool_slot
) >= length
) {
242 if (!(slot
= mempool_allocate_slot(p
)))
245 b
= pa_xnew(pa_memblock
, 1);
246 b
->type
= PA_MEMBLOCK_POOL_EXTERNAL
;
247 b
->data
= mempool_slot_data(slot
);
249 pa_log_debug("Memory block too large for pool: %u > %u", length
, p
->block_size
- sizeof(struct mempool_slot
));
250 p
->stat
.n_too_large_for_pool
++;
263 pa_memblock
*pa_memblock_new_fixed(pa_mempool
*p
, void *d
, size_t length
, int read_only
) {
270 b
= pa_xnew(pa_memblock
, 1);
271 b
->type
= PA_MEMBLOCK_FIXED
;
272 b
->read_only
= read_only
;
282 pa_memblock
*pa_memblock_new_user(pa_mempool
*p
, void *d
, size_t length
, void (*free_cb
)(void *p
), int read_only
) {
290 b
= pa_xnew(pa_memblock
, 1);
291 b
->type
= PA_MEMBLOCK_USER
;
292 b
->read_only
= read_only
;
296 b
->per_type
.user
.free_cb
= free_cb
;
303 pa_memblock
* pa_memblock_ref(pa_memblock
*b
) {
305 assert(PA_REFCNT_VALUE(b
) > 0);
311 void pa_memblock_unref(pa_memblock
*b
) {
313 assert(PA_REFCNT_VALUE(b
) > 0);
315 if (PA_REFCNT_DEC(b
) > 0)
321 case PA_MEMBLOCK_USER
:
322 assert(b
->per_type
.user
.free_cb
);
323 b
->per_type
.user
.free_cb(b
->data
);
327 case PA_MEMBLOCK_FIXED
:
328 case PA_MEMBLOCK_APPENDED
:
332 case PA_MEMBLOCK_IMPORTED
: {
333 pa_memimport_segment
*segment
;
335 segment
= b
->per_type
.imported
.segment
;
337 assert(segment
->import
);
339 pa_hashmap_remove(segment
->import
->blocks
, PA_UINT32_TO_PTR(b
->per_type
.imported
.id
));
340 segment
->import
->release_cb(segment
->import
, b
->per_type
.imported
.id
, segment
->import
->userdata
);
342 if (-- segment
->n_blocks
<= 0)
343 segment_detach(segment
);
349 case PA_MEMBLOCK_POOL_EXTERNAL
:
350 case PA_MEMBLOCK_POOL
: {
351 struct mempool_slot
*slot
;
353 slot
= mempool_slot_by_ptr(b
->pool
, b
->data
);
356 PA_LLIST_REMOVE(struct mempool_slot
, b
->pool
->used_slots
, slot
);
357 PA_LLIST_PREPEND(struct mempool_slot
, b
->pool
->free_slots
, slot
);
359 if (b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
)
365 case PA_MEMBLOCK_TYPE_MAX
:
371 static void memblock_make_local(pa_memblock
*b
) {
374 b
->pool
->stat
.n_allocated_by_type
[b
->type
]--;
376 if (b
->length
<= b
->pool
->block_size
- sizeof(struct mempool_slot
)) {
377 struct mempool_slot
*slot
;
379 if ((slot
= mempool_allocate_slot(b
->pool
))) {
381 /* We can move it into a local pool, perfect! */
383 b
->type
= PA_MEMBLOCK_POOL_EXTERNAL
;
386 new_data
= mempool_slot_data(slot
);
387 memcpy(new_data
, b
->data
, b
->length
);
393 /* Humm, not enough space in the pool, so lets allocate the memory with malloc() */
394 b
->type
= PA_MEMBLOCK_USER
;
395 b
->per_type
.user
.free_cb
= pa_xfree
;
397 b
->data
= pa_xmemdup(b
->data
, b
->length
);
400 b
->pool
->stat
.n_allocated_by_type
[b
->type
]++;
401 b
->pool
->stat
.n_accumulated_by_type
[b
->type
]++;
404 void pa_memblock_unref_fixed(pa_memblock
*b
) {
406 assert(PA_REFCNT_VALUE(b
) > 0);
407 assert(b
->type
== PA_MEMBLOCK_FIXED
);
409 if (PA_REFCNT_VALUE(b
) > 1)
410 memblock_make_local(b
);
412 pa_memblock_unref(b
);
415 static void memblock_replace_import(pa_memblock
*b
) {
416 pa_memimport_segment
*seg
;
419 assert(b
->type
== PA_MEMBLOCK_IMPORTED
);
421 assert(b
->pool
->stat
.n_imported
> 0);
422 assert(b
->pool
->stat
.imported_size
>= b
->length
);
423 b
->pool
->stat
.n_imported
--;
424 b
->pool
->stat
.imported_size
-= b
->length
;
426 seg
= b
->per_type
.imported
.segment
;
432 PA_UINT32_TO_PTR(b
->per_type
.imported
.id
));
434 memblock_make_local(b
);
436 if (-- seg
->n_blocks
<= 0)
440 pa_mempool
* pa_mempool_new(int shared
) {
444 p
= pa_xnew(pa_mempool
, 1);
447 ps
= (size_t) sysconf(_SC_PAGESIZE
);
448 #elif defined(PAGE_SIZE)
449 ps
= (size_t) PAGE_SIZE
;
451 ps
= 4096; /* Let's hope it's like x86. */
454 p
->block_size
= (PA_MEMPOOL_SLOT_SIZE
/ps
)*ps
;
456 if (p
->block_size
< ps
)
459 p
->n_blocks
= PA_MEMPOOL_SLOTS_MAX
;
461 assert(p
->block_size
> sizeof(struct mempool_slot
));
463 if (pa_shm_create_rw(&p
->memory
, p
->n_blocks
* p
->block_size
, shared
, 0700) < 0) {
470 PA_LLIST_HEAD_INIT(pa_memimport
, p
->imports
);
471 PA_LLIST_HEAD_INIT(pa_memexport
, p
->exports
);
472 PA_LLIST_HEAD_INIT(struct mempool_slot
, p
->free_slots
);
473 PA_LLIST_HEAD_INIT(struct mempool_slot
, p
->used_slots
);
475 memset(&p
->stat
, 0, sizeof(p
->stat
));
480 void pa_mempool_free(pa_mempool
*p
) {
484 pa_memimport_free(p
->imports
);
487 pa_memexport_free(p
->exports
);
489 if (p
->stat
.n_allocated
> 0)
490 pa_log_warn("WARNING! Memory pool destroyed but not all memory blocks freed!");
492 pa_shm_free(&p
->memory
);
496 const pa_mempool_stat
* pa_mempool_get_stat(pa_mempool
*p
) {
502 void pa_mempool_vacuum(pa_mempool
*p
) {
503 struct mempool_slot
*slot
;
507 for (slot
= p
->free_slots
; slot
; slot
= slot
->next
) {
508 pa_shm_punch(&p
->memory
, (uint8_t*) slot
+ sizeof(struct mempool_slot
) - (uint8_t*) p
->memory
.ptr
, p
->block_size
- sizeof(struct mempool_slot
));
512 int pa_mempool_get_shm_id(pa_mempool
*p
, uint32_t *id
) {
515 if (!p
->memory
.shared
)
523 int pa_mempool_is_shared(pa_mempool
*p
) {
526 return !!p
->memory
.shared
;
529 /* For recieving blocks from other nodes */
530 pa_memimport
* pa_memimport_new(pa_mempool
*p
, pa_memimport_release_cb_t cb
, void *userdata
) {
536 i
= pa_xnew(pa_memimport
, 1);
538 i
->segments
= pa_hashmap_new(NULL
, NULL
);
539 i
->blocks
= pa_hashmap_new(NULL
, NULL
);
541 i
->userdata
= userdata
;
543 PA_LLIST_PREPEND(pa_memimport
, p
->imports
, i
);
547 static void memexport_revoke_blocks(pa_memexport
*e
, pa_memimport
*i
);
549 static pa_memimport_segment
* segment_attach(pa_memimport
*i
, uint32_t shm_id
) {
550 pa_memimport_segment
* seg
;
552 if (pa_hashmap_size(i
->segments
) >= PA_MEMIMPORT_SEGMENTS_MAX
)
555 seg
= pa_xnew(pa_memimport_segment
, 1);
557 if (pa_shm_attach_ro(&seg
->memory
, shm_id
) < 0) {
565 pa_hashmap_put(i
->segments
, PA_UINT32_TO_PTR(shm_id
), seg
);
569 static void segment_detach(pa_memimport_segment
*seg
) {
572 pa_hashmap_remove(seg
->import
->segments
, PA_UINT32_TO_PTR(seg
->memory
.id
));
573 pa_shm_free(&seg
->memory
);
577 void pa_memimport_free(pa_memimport
*i
) {
583 /* If we've exported this block further we need to revoke that export */
584 for (e
= i
->pool
->exports
; e
; e
= e
->next
)
585 memexport_revoke_blocks(e
, i
);
587 while ((b
= pa_hashmap_get_first(i
->blocks
)))
588 memblock_replace_import(b
);
590 assert(pa_hashmap_size(i
->segments
) == 0);
592 pa_hashmap_free(i
->blocks
, NULL
, NULL
);
593 pa_hashmap_free(i
->segments
, NULL
, NULL
);
595 PA_LLIST_REMOVE(pa_memimport
, i
->pool
->imports
, i
);
599 pa_memblock
* pa_memimport_get(pa_memimport
*i
, uint32_t block_id
, uint32_t shm_id
, size_t offset
, size_t size
) {
601 pa_memimport_segment
*seg
;
605 if (pa_hashmap_size(i
->blocks
) >= PA_MEMIMPORT_SLOTS_MAX
)
608 if (!(seg
= pa_hashmap_get(i
->segments
, PA_UINT32_TO_PTR(shm_id
))))
609 if (!(seg
= segment_attach(i
, shm_id
)))
612 if (offset
+size
> seg
->memory
.size
)
615 b
= pa_xnew(pa_memblock
, 1);
616 b
->type
= PA_MEMBLOCK_IMPORTED
;
620 b
->data
= (uint8_t*) seg
->memory
.ptr
+ offset
;
622 b
->per_type
.imported
.id
= block_id
;
623 b
->per_type
.imported
.segment
= seg
;
625 pa_hashmap_put(i
->blocks
, PA_UINT32_TO_PTR(block_id
), b
);
634 int pa_memimport_process_revoke(pa_memimport
*i
, uint32_t id
) {
638 if (!(b
= pa_hashmap_get(i
->blocks
, PA_UINT32_TO_PTR(id
))))
641 memblock_replace_import(b
);
645 /* For sending blocks to other nodes */
646 pa_memexport
* pa_memexport_new(pa_mempool
*p
, pa_memexport_revoke_cb_t cb
, void *userdata
) {
652 if (!p
->memory
.shared
)
655 e
= pa_xnew(pa_memexport
, 1);
657 PA_LLIST_HEAD_INIT(struct memexport_slot
, e
->free_slots
);
658 PA_LLIST_HEAD_INIT(struct memexport_slot
, e
->used_slots
);
661 e
->userdata
= userdata
;
663 PA_LLIST_PREPEND(pa_memexport
, p
->exports
, e
);
667 void pa_memexport_free(pa_memexport
*e
) {
670 while (e
->used_slots
)
671 pa_memexport_process_release(e
, e
->used_slots
- e
->slots
);
673 PA_LLIST_REMOVE(pa_memexport
, e
->pool
->exports
, e
);
677 int pa_memexport_process_release(pa_memexport
*e
, uint32_t id
) {
683 if (!e
->slots
[id
].block
)
686 /* pa_log("Processing release for %u", id); */
688 assert(e
->pool
->stat
.n_exported
> 0);
689 assert(e
->pool
->stat
.exported_size
>= e
->slots
[id
].block
->length
);
691 e
->pool
->stat
.n_exported
--;
692 e
->pool
->stat
.exported_size
-= e
->slots
[id
].block
->length
;
694 pa_memblock_unref(e
->slots
[id
].block
);
695 e
->slots
[id
].block
= NULL
;
697 PA_LLIST_REMOVE(struct memexport_slot
, e
->used_slots
, &e
->slots
[id
]);
698 PA_LLIST_PREPEND(struct memexport_slot
, e
->free_slots
, &e
->slots
[id
]);
703 static void memexport_revoke_blocks(pa_memexport
*e
, pa_memimport
*i
) {
704 struct memexport_slot
*slot
, *next
;
708 for (slot
= e
->used_slots
; slot
; slot
= next
) {
712 if (slot
->block
->type
!= PA_MEMBLOCK_IMPORTED
||
713 slot
->block
->per_type
.imported
.segment
->import
!= i
)
716 idx
= slot
- e
->slots
;
717 e
->revoke_cb(e
, idx
, e
->userdata
);
718 pa_memexport_process_release(e
, idx
);
722 static pa_memblock
*memblock_shared_copy(pa_mempool
*p
, pa_memblock
*b
) {
728 if (b
->type
== PA_MEMBLOCK_IMPORTED
||
729 b
->type
== PA_MEMBLOCK_POOL
||
730 b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
) {
731 assert(b
->pool
== p
);
732 return pa_memblock_ref(b
);
735 if (!(n
= pa_memblock_new_pool(p
, b
->length
)))
738 memcpy(n
->data
, b
->data
, b
->length
);
742 int pa_memexport_put(pa_memexport
*e
, pa_memblock
*b
, uint32_t *block_id
, uint32_t *shm_id
, size_t *offset
, size_t * size
) {
744 struct memexport_slot
*slot
;
752 assert(b
->pool
== e
->pool
);
754 if (!(b
= memblock_shared_copy(e
->pool
, b
)))
758 slot
= e
->free_slots
;
759 PA_LLIST_REMOVE(struct memexport_slot
, e
->free_slots
, slot
);
760 } else if (e
->n_init
< PA_MEMEXPORT_SLOTS_MAX
) {
761 slot
= &e
->slots
[e
->n_init
++];
763 pa_memblock_unref(b
);
767 PA_LLIST_PREPEND(struct memexport_slot
, e
->used_slots
, slot
);
769 *block_id
= slot
- e
->slots
;
771 /* pa_log("Got block id %u", *block_id); */
773 if (b
->type
== PA_MEMBLOCK_IMPORTED
) {
774 assert(b
->per_type
.imported
.segment
);
775 memory
= &b
->per_type
.imported
.segment
->memory
;
777 assert(b
->type
== PA_MEMBLOCK_POOL
|| b
->type
== PA_MEMBLOCK_POOL_EXTERNAL
);
779 memory
= &b
->pool
->memory
;
782 assert(b
->data
>= memory
->ptr
);
783 assert((uint8_t*) b
->data
+ b
->length
<= (uint8_t*) memory
->ptr
+ memory
->size
);
785 *shm_id
= memory
->id
;
786 *offset
= (uint8_t*) b
->data
- (uint8_t*) memory
->ptr
;
789 e
->pool
->stat
.n_exported
++;
790 e
->pool
->stat
.exported_size
+= b
->length
;