memory: handle -1 size in unmap
[platform/upstream/gstreamer.git] / gst / gstmemory.c
1 /* GStreamer
2  * Copyright (C) 2011 Wim Taymans <wim.taymans@gmail.be>
3  *
4  * gstmemory.c: memory block handling
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /**
23  * SECTION:gstmemory
24  * @short_description: refcounted wrapper for memory blocks
25  * @see_also: #GstBuffer
26  *
27  * GstMemory is a lightweight refcounted object that wraps a region of memory.
28  * They are typically used to manage the data of a #GstBuffer.
29  *
30  * Memory is usually created by allocators with a gst_allocator_alloc()
31  * method call. When NULL is used as the allocator, the default allocator will
32  * be used.
33  *
34  * New allocators can be registered with gst_allocator_register().
35  * Allocators are identified by name and can be retrieved with
36  * gst_allocator_find().
37  *
38  * New memory can be created with gst_memory_new_wrapped() that wraps the memory
39  * allocated elsewhere.
40  *
41  * Refcounting of the memory block is performed with gst_memory_ref() and
42  * gst_memory_unref().
43  *
44  * The size of the memory can be retrieved and changed with
45  * gst_memory_get_sizes() and gst_memory_resize() respectively.
46  *
47  * Getting access to the data of the memory is performed with gst_memory_map().
48  * After the memory access is completed, gst_memory_unmap() should be called.
49  *
50  * Memory can be copied with gst_memory_copy(), which will returnn a writable
51  * copy. gst_memory_share() will create a new memory block that shares the
52  * memory with an existing memory block at a custom offset and with a custom
53  * size.
54  *
55  * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
56  *
57  * Last reviewed on 2011-06-08 (0.11.0)
58  */
59
60 #include "config.h"
61 #include "gst_private.h"
62 #include "gstmemory.h"
63
64 G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
65     (GBoxedFreeFunc) gst_memory_unref);
66
67 /**
68  * gst_memory_alignment:
69  *
70  * The default memory alignment in bytes - 1
71  * an alignment of 7 would be the same as what malloc() guarantees.
72  */
73 #if defined(MEMORY_ALIGNMENT_MALLOC)
74 size_t gst_memory_alignment = 7;
75 #elif defined(MEMORY_ALIGNMENT_PAGESIZE)
76 /* we fill this in in the _init method */
77 size_t gst_memory_alignment = 0;
78 #elif defined(MEMORY_ALIGNMENT)
79 size_t gst_memory_alignment = MEMORY_ALIGNMENT - 1;
80 #else
81 #error "No memory alignment configured"
82 size_t gst_memory_alignment = 0;
83 #endif
84
85 struct _GstAllocator
86 {
87   GQuark name;
88
89   GstMemoryInfo info;
90 };
91
92 /* default memory implementation */
93 typedef struct
94 {
95   GstMemory mem;
96   gsize slice_size;
97   guint8 *data;
98   GFreeFunc free_func;
99   gsize maxsize;
100   gsize offset;
101   gsize size;
102 } GstMemoryDefault;
103
104 /* the default allocator */
105 static const GstAllocator *_default_allocator;
106
107 /* our predefined allocators */
108 static const GstAllocator *_default_mem_impl;
109
110 /* initialize the fields */
111 static void
112 _default_mem_init (GstMemoryDefault * mem, GstMemoryFlags flags,
113     GstMemory * parent, gsize slice_size, gpointer data,
114     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
115 {
116   mem->mem.allocator = _default_mem_impl;
117   mem->mem.flags = flags;
118   mem->mem.refcount = 1;
119   mem->mem.parent = parent ? gst_memory_ref (parent) : NULL;
120   mem->slice_size = slice_size;
121   mem->data = data;
122   mem->free_func = free_func;
123   mem->maxsize = maxsize;
124   mem->offset = offset;
125   mem->size = size;
126 }
127
128 /* create a new memory block that manages the given memory */
129 static GstMemoryDefault *
130 _default_mem_new (GstMemoryFlags flags, GstMemory * parent, gpointer data,
131     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
132 {
133   GstMemoryDefault *mem;
134   gsize slice_size;
135
136   slice_size = sizeof (GstMemoryDefault);
137
138   mem = g_slice_alloc (slice_size);
139   _default_mem_init (mem, flags, parent, slice_size,
140       data, free_func, maxsize, offset, size);
141
142   return mem;
143 }
144
145 /* allocate the memory and structure in one block */
146 static GstMemoryDefault *
147 _default_mem_new_block (gsize maxsize, gsize align, gsize offset, gsize size)
148 {
149   GstMemoryDefault *mem;
150   gsize aoffset, slice_size;
151   guint8 *data;
152
153   /* ensure configured alignment */
154   align |= gst_memory_alignment;
155   /* allocate more to compensate for alignment */
156   maxsize += align;
157   /* alloc header and data in one block */
158   slice_size = sizeof (GstMemoryDefault) + maxsize;
159
160   mem = g_slice_alloc (slice_size);
161   if (mem == NULL)
162     return NULL;
163
164   data = (guint8 *) mem + sizeof (GstMemoryDefault);
165
166   if ((aoffset = ((guintptr) data & align)))
167     aoffset = (align + 1) - aoffset;
168
169   _default_mem_init (mem, 0, NULL, slice_size, data, NULL, maxsize,
170       aoffset + offset, size);
171
172   return mem;
173 }
174
175 static GstMemory *
176 _default_mem_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
177 {
178   return (GstMemory *) _default_mem_new_block (maxsize, align, 0, maxsize);
179 }
180
181 static gsize
182 _default_mem_get_sizes (GstMemoryDefault * mem, gsize * offset, gsize * maxsize)
183 {
184   if (offset)
185     *offset = mem->offset;
186   if (maxsize)
187     *maxsize = mem->maxsize;
188
189   return mem->size;
190 }
191
192 static void
193 _default_mem_resize (GstMemoryDefault * mem, gssize offset, gsize size)
194 {
195   g_return_if_fail (offset >= 0 || mem->offset >= -offset);
196   g_return_if_fail (size + mem->offset + offset <= mem->maxsize);
197
198   mem->offset += offset;
199   mem->size = size;
200 }
201
202 static gpointer
203 _default_mem_map (GstMemoryDefault * mem, gsize * size, gsize * maxsize,
204     GstMapFlags flags)
205 {
206   if (size)
207     *size = mem->size;
208   if (maxsize)
209     *maxsize = mem->maxsize - mem->offset;
210
211   return mem->data + mem->offset;
212 }
213
214 static gboolean
215 _default_mem_unmap (GstMemoryDefault * mem, gpointer data, gsize size)
216 {
217   g_return_val_if_fail ((guint8 *) data >= mem->data
218       && (guint8 *) data < mem->data + mem->maxsize, FALSE);
219
220   if (mem->data + mem->offset != data) {
221     gsize newoffset = (guint8 *) data - mem->data;
222     if (size == -1)
223       size = mem->offset + mem->size - newoffset;
224     mem->offset = newoffset;
225   }
226
227   if (size != -1) {
228     g_return_val_if_fail (mem->offset + size <= mem->maxsize, FALSE);
229     mem->size = size;
230   }
231
232   return TRUE;
233 }
234
235 static void
236 _default_mem_free (GstMemoryDefault * mem)
237 {
238   if (mem->mem.parent)
239     gst_memory_unref (mem->mem.parent);
240
241   if (mem->free_func)
242     mem->free_func (mem->data);
243
244   g_slice_free1 (mem->slice_size, mem);
245 }
246
247 static GstMemoryDefault *
248 _default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
249 {
250   GstMemoryDefault *copy;
251
252   if (size == -1)
253     size = mem->size > offset ? mem->size - offset : 0;
254
255   copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
256   memcpy (copy->data, mem->data, mem->maxsize);
257
258   return copy;
259 }
260
261 static GstMemoryDefault *
262 _default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
263 {
264   GstMemoryDefault *sub;
265   GstMemory *parent;
266
267   /* find the real parent */
268   if ((parent = mem->mem.parent) == NULL)
269     parent = (GstMemory *) mem;
270
271   if (size == -1)
272     size = mem->size - offset;
273
274   sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
275       mem->offset + offset, size);
276
277   return sub;
278 }
279
280 static gboolean
281 _default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
282     gsize * offset)
283 {
284
285   if (offset) {
286     GstMemoryDefault *parent;
287
288     parent = (GstMemoryDefault *) mem1->mem.parent;
289
290     *offset = mem1->offset - parent->offset;
291   }
292
293   /* and memory is contiguous */
294   return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
295 }
296
297 static GstMemory *
298 _fallback_copy (GstMemory * mem, gssize offset, gssize size)
299 {
300   GstMemory *copy;
301   guint8 *data, *dest;
302   gsize msize;
303
304   data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
305   if (size == -1)
306     size = msize > offset ? msize - offset : 0;
307   /* use the same allocator as the memory we copy, FIXME, alignment?  */
308   copy = gst_allocator_alloc (mem->allocator, size, 0);
309   dest = gst_memory_map (copy, NULL, NULL, GST_MAP_WRITE);
310   memcpy (dest, data + offset, size);
311   gst_memory_unmap (copy, dest, size);
312
313   gst_memory_unmap (mem, data, msize);
314
315   return (GstMemory *) copy;
316 }
317
318 static gboolean
319 _fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
320 {
321   return FALSE;
322 }
323
324 static GStaticRWLock lock = G_STATIC_RW_LOCK_INIT;
325 static GHashTable *allocators;
326
327 void
328 _priv_gst_memory_initialize (void)
329 {
330   static const GstMemoryInfo _mem_info = {
331     (GstMemoryAllocFunction) _default_mem_alloc,
332     (GstMemoryGetSizesFunction) _default_mem_get_sizes,
333     (GstMemoryResizeFunction) _default_mem_resize,
334     (GstMemoryMapFunction) _default_mem_map,
335     (GstMemoryUnmapFunction) _default_mem_unmap,
336     (GstMemoryFreeFunction) _default_mem_free,
337     (GstMemoryCopyFunction) _default_mem_copy,
338     (GstMemoryShareFunction) _default_mem_share,
339     (GstMemoryIsSpanFunction) _default_mem_is_span,
340     NULL
341   };
342
343   allocators = g_hash_table_new (g_str_hash, g_str_equal);
344
345 #ifdef HAVE_GETPAGESIZE
346 #ifdef MEMORY_ALIGNMENT_PAGESIZE
347   gst_memory_alignment = getpagesize () - 1;
348 #endif
349 #endif
350
351   GST_DEBUG ("memory alignment: %" G_GSIZE_FORMAT, gst_memory_alignment);
352
353   _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
354
355   _default_allocator = _default_mem_impl;
356 }
357
358 /**
359  * gst_memory_new_wrapped:
360  * @flags: #GstMemoryFlags
361  * @data: data to wrap
362  * @free_func: function to free @data
363  * @maxsize: allocated size of @data
364  * @offset: offset in @data
365  * @size: size of valid data
366  *
367  * Allocate a new memory block that wraps the given @data.
368  *
369  * Returns: a new #GstMemory.
370  */
371 GstMemory *
372 gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
373     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
374 {
375   GstMemoryDefault *mem;
376
377   g_return_val_if_fail (data != NULL, NULL);
378   g_return_val_if_fail (offset + size <= maxsize, NULL);
379
380   mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);
381
382   return (GstMemory *) mem;
383 }
384
385 /**
386  * gst_memory_ref:
387  * @mem: a #GstMemory
388  *
389  * Increases the refcount of @mem.
390  *
391  * Returns: @mem with increased refcount
392  */
393 GstMemory *
394 gst_memory_ref (GstMemory * mem)
395 {
396   g_return_val_if_fail (mem != NULL, NULL);
397
398   g_atomic_int_inc (&mem->refcount);
399
400   return mem;
401 }
402
403 /**
404  * gst_memory_unref:
405  * @mem: a #GstMemory
406  *
407  * Decreases the refcount of @mem. When the refcount reaches 0, the free
408  * function of @mem will be called.
409  */
410 void
411 gst_memory_unref (GstMemory * mem)
412 {
413   g_return_if_fail (mem != NULL);
414   g_return_if_fail (mem->allocator != NULL);
415
416   if (g_atomic_int_dec_and_test (&mem->refcount))
417     mem->allocator->info.free (mem);
418 }
419
420 /**
421  * gst_memory_get_sizes:
422  * @mem: a #GstMemory
423  * @offset: pointer to offset
424  * @maxsize: pointer to maxsize
425  *
426  * Get the current @size, @offset and @maxsize of @mem.
427  *
428  * Returns: the current sizes of @mem
429  */
430 gsize
431 gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
432 {
433   g_return_val_if_fail (mem != NULL, 0);
434
435   return mem->allocator->info.get_sizes (mem, offset, maxsize);
436 }
437
438 /**
439  * gst_memory_resize:
440  * @mem: a #GstMemory
441  * @offset: a new offset
442  * @size: a new size
443  *
444  * Resize the memory region. @mem should be writable and offset + size should be
445  * less than the maxsize of @mem.
446  */
447 void
448 gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
449 {
450   g_return_if_fail (mem != NULL);
451   g_return_if_fail (GST_MEMORY_IS_WRITABLE (mem));
452
453   mem->allocator->info.resize (mem, offset, size);
454 }
455
456 /**
457  * gst_memory_map:
458  * @mem: a #GstMemory
459  * @size: (out) (allow-none): pointer for size
460  * @maxsize: (out) (allow-none): pointer for maxsize
461  * @flags: mapping flags
462  *
463  * Get a pointer to the memory of @mem that can be accessed according to @flags.
464  *
465  * @size and @maxsize will contain the size of the memory and the maximum
466  * allocated memory of @mem respectively. They can be set to NULL.
467  *
468  * Returns: (transfer none): a pointer to the memory of @mem.
469  */
470 gpointer
471 gst_memory_map (GstMemory * mem, gsize * size, gsize * maxsize,
472     GstMapFlags flags)
473 {
474   g_return_val_if_fail (mem != NULL, NULL);
475   g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
476       GST_MEMORY_IS_WRITABLE (mem), NULL);
477
478   return mem->allocator->info.map (mem, size, maxsize, flags);
479 }
480
481 /**
482  * gst_memory_unmap:
483  * @mem: a #GstMemory
484  * @data: data to unmap
485  * @size: new size of @mem, or -1
486  *
487  * Release the memory pointer obtained with gst_memory_map() and set the size of
488  * the memory to @size. @size can be set to -1 when the size should not be
489  * updated.
490  *
491  * It is possible to pass a different @data than that obtained from
492  * gst_memory_map() in which case the offset of @mem will be updated.
493  *
494  * Returns: TRUE when the memory was release successfully.
495  */
496 gboolean
497 gst_memory_unmap (GstMemory * mem, gpointer data, gssize size)
498 {
499   g_return_val_if_fail (mem != NULL, FALSE);
500
501   return mem->allocator->info.unmap (mem, data, size);
502 }
503
504 /**
505  * gst_memory_copy:
506  * @mem: a #GstMemory
507  * @offset: an offset to copy
508  * @size: size to copy or -1 to copy all bytes from offset
509  *
510  * Return a copy of @size bytes from @mem starting from @offset. This copy is
511  * guaranteed to be writable. @size can be set to -1 to return a copy all bytes
512  * from @offset.
513  *
514  * Returns: a new #GstMemory.
515  */
516 GstMemory *
517 gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
518 {
519   g_return_val_if_fail (mem != NULL, NULL);
520
521   return mem->allocator->info.copy (mem, offset, size);
522 }
523
524 /**
525  * gst_memory_share:
526  * @mem: a #GstMemory
527  * @offset: an offset to share
528  * @size: size to share or -1 to share bytes from offset
529  *
530  * Return a shared copy of @size bytes from @mem starting from @offset. No
531  * memory copy is performed and the memory region is simply shared. The result
532  * is guaranteed to be not-writable. @size can be set to -1 to return a share
533  * all bytes from @offset.
534  *
535  * Returns: a new #GstMemory.
536  */
537 GstMemory *
538 gst_memory_share (GstMemory * mem, gssize offset, gssize size)
539 {
540   g_return_val_if_fail (mem != NULL, NULL);
541
542   return mem->allocator->info.share (mem, offset, size);
543 }
544
545 /**
546  * gst_memory_is_span:
547  * @mem1: a #GstMemory
548  * @mem2: a #GstMemory
549  * @offset: a pointer to a result offset
550  *
551  * Check if @mem1 and mem2 share the memory with a common parent memory object
552  * and that the memory is contiguous.
553  *
554  * If this is the case, the memory of @mem1 and @mem2 can be merged
555  * efficiently by performing gst_memory_share() on the parent object from
556  * the returned @offset.
557  *
558  * Returns: %TRUE if the memory is contiguous and of a common parent.
559  */
560 gboolean
561 gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
562 {
563   g_return_val_if_fail (mem1 != NULL, FALSE);
564   g_return_val_if_fail (mem2 != NULL, FALSE);
565
566   /* need to have the same allocators */
567   if (mem1->allocator != mem2->allocator)
568     return FALSE;
569
570   /* need to have the same parent */
571   if (mem1->parent == NULL || mem1->parent != mem2->parent)
572     return FALSE;
573
574   /* and memory is contiguous */
575   if (!mem1->allocator->info.is_span (mem1, mem2, offset))
576     return FALSE;
577
578   return TRUE;
579 }
580
581 /**
582  * gst_allocator_register:
583  * @name: the name of the allocator
584  * @info: #GstMemoryInfo
585  *
586  * Registers the memory allocator with @name and implementation functions
587  * @info.
588  *
589  * All functions in @info are mandatory exept the copy and is_span
590  * functions, which will have a default implementation when left NULL.
591  *
592  * The user_data field in @info will be passed to all calls of the alloc
593  * function.
594  *
595  * Returns: a new #GstAllocator.
596  */
597 const GstAllocator *
598 gst_allocator_register (const gchar * name, const GstMemoryInfo * info)
599 {
600   GstAllocator *allocator;
601
602 #define INSTALL_FALLBACK(_t) \
603   if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;
604
605   g_return_val_if_fail (name != NULL, NULL);
606   g_return_val_if_fail (info != NULL, NULL);
607   g_return_val_if_fail (info->alloc != NULL, NULL);
608   g_return_val_if_fail (info->get_sizes != NULL, NULL);
609   g_return_val_if_fail (info->resize != NULL, NULL);
610   g_return_val_if_fail (info->map != NULL, NULL);
611   g_return_val_if_fail (info->unmap != NULL, NULL);
612   g_return_val_if_fail (info->free != NULL, NULL);
613   g_return_val_if_fail (info->share != NULL, NULL);
614
615   allocator = g_slice_new (GstAllocator);
616   allocator->name = g_quark_from_string (name);
617   allocator->info = *info;
618   INSTALL_FALLBACK (copy);
619   INSTALL_FALLBACK (is_span);
620 #undef INSTALL_FALLBACK
621
622   GST_DEBUG ("registering allocator \"%s\"", name);
623
624   g_static_rw_lock_writer_lock (&lock);
625   g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
626   g_static_rw_lock_writer_unlock (&lock);
627
628   return allocator;
629 }
630
631 /**
632  * gst_allocator_find:
633  * @name: the name of the allocator
634  *
635  * Find a previously registered allocator with @name. When @name is NULL, the
636  * default allocator will be returned.
637  *
638  * Returns: a #GstAllocator or NULL when the allocator with @name was not
639  * registered.
640  */
641 const GstAllocator *
642 gst_allocator_find (const gchar * name)
643 {
644   const GstAllocator *allocator;
645
646   g_static_rw_lock_reader_lock (&lock);
647   if (name) {
648     allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
649   } else {
650     allocator = _default_allocator;
651   }
652   g_static_rw_lock_reader_unlock (&lock);
653
654   return allocator;
655 }
656
657 /**
658  * gst_allocator_set_default:
659  * @allocator: a #GstAllocator
660  *
661  * Set the default allocator.
662  */
663 void
664 gst_allocator_set_default (const GstAllocator * allocator)
665 {
666   g_return_if_fail (allocator != NULL);
667
668   g_static_rw_lock_writer_lock (&lock);
669   _default_allocator = allocator;
670   g_static_rw_lock_writer_unlock (&lock);
671 }
672
673 /**
674  * gst_allocator_alloc:
675  * @allocator: (transfer none) (allow-none): a #GstAllocator to use
676  * @maxsize: allocated size of @data
677  * @align: alignment for the data
678  *
679  * Use @allocator to allocate a new memory block with memory that is at least
680  * @maxsize big and has the given alignment.
681  *
682  * When @allocator is NULL, the default allocator will be used.
683  *
684  * @align is given as a bitmask so that @align + 1 equals the amount of bytes to
685  * align to. For example, to align to 8 bytes, use an alignment of 7.
686  *
687  * Returns: (transfer full): a new #GstMemory.
688  */
689 GstMemory *
690 gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
691 {
692   g_return_val_if_fail (((align + 1) & align) == 0, NULL);
693
694   if (allocator == NULL)
695     allocator = _default_allocator;
696
697   return allocator->info.alloc (allocator, maxsize, align,
698       allocator->info.user_data);
699 }