memory: improve semantics of 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     mem->offset = (guint8 *) data - mem->data;
222
223   if (size != -1) {
224     g_return_val_if_fail (mem->offset + size <= mem->maxsize, FALSE);
225     mem->size = size;
226   }
227
228   return TRUE;
229 }
230
231 static void
232 _default_mem_free (GstMemoryDefault * mem)
233 {
234   if (mem->mem.parent)
235     gst_memory_unref (mem->mem.parent);
236
237   if (mem->free_func)
238     mem->free_func (mem->data);
239
240   g_slice_free1 (mem->slice_size, mem);
241 }
242
243 static GstMemoryDefault *
244 _default_mem_copy (GstMemoryDefault * mem, gssize offset, gsize size)
245 {
246   GstMemoryDefault *copy;
247
248   if (size == -1)
249     size = mem->size > offset ? mem->size - offset : 0;
250
251   copy = _default_mem_new_block (mem->maxsize, 0, mem->offset + offset, size);
252   memcpy (copy->data, mem->data, mem->maxsize);
253
254   return copy;
255 }
256
257 static GstMemoryDefault *
258 _default_mem_share (GstMemoryDefault * mem, gssize offset, gsize size)
259 {
260   GstMemoryDefault *sub;
261   GstMemory *parent;
262
263   /* find the real parent */
264   if ((parent = mem->mem.parent) == NULL)
265     parent = (GstMemory *) mem;
266
267   if (size == -1)
268     size = mem->size - offset;
269
270   sub = _default_mem_new (parent->flags, parent, mem->data, NULL, mem->maxsize,
271       mem->offset + offset, size);
272
273   return sub;
274 }
275
276 static gboolean
277 _default_mem_is_span (GstMemoryDefault * mem1, GstMemoryDefault * mem2,
278     gsize * offset)
279 {
280
281   if (offset) {
282     GstMemoryDefault *parent;
283
284     parent = (GstMemoryDefault *) mem1->mem.parent;
285
286     *offset = mem1->offset - parent->offset;
287   }
288
289   /* and memory is contiguous */
290   return mem1->data + mem1->offset + mem1->size == mem2->data + mem2->offset;
291 }
292
293 static GstMemory *
294 _fallback_copy (GstMemory * mem, gssize offset, gssize size)
295 {
296   GstMemory *copy;
297   guint8 *data, *dest;
298   gsize msize;
299
300   data = gst_memory_map (mem, &msize, NULL, GST_MAP_READ);
301   if (size == -1)
302     size = msize > offset ? msize - offset : 0;
303   /* use the same allocator as the memory we copy, FIXME, alignment?  */
304   copy = gst_allocator_alloc (mem->allocator, size, 0);
305   dest = gst_memory_map (copy, NULL, NULL, GST_MAP_WRITE);
306   memcpy (dest, data + offset, size);
307   gst_memory_unmap (copy, dest, size);
308
309   gst_memory_unmap (mem, data, msize);
310
311   return (GstMemory *) copy;
312 }
313
314 static gboolean
315 _fallback_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
316 {
317   return FALSE;
318 }
319
320 static GStaticRWLock lock = G_STATIC_RW_LOCK_INIT;
321 static GHashTable *allocators;
322
323 void
324 _priv_gst_memory_initialize (void)
325 {
326   static const GstMemoryInfo _mem_info = {
327     (GstMemoryAllocFunction) _default_mem_alloc,
328     (GstMemoryGetSizesFunction) _default_mem_get_sizes,
329     (GstMemoryResizeFunction) _default_mem_resize,
330     (GstMemoryMapFunction) _default_mem_map,
331     (GstMemoryUnmapFunction) _default_mem_unmap,
332     (GstMemoryFreeFunction) _default_mem_free,
333     (GstMemoryCopyFunction) _default_mem_copy,
334     (GstMemoryShareFunction) _default_mem_share,
335     (GstMemoryIsSpanFunction) _default_mem_is_span,
336     NULL
337   };
338
339   allocators = g_hash_table_new (g_str_hash, g_str_equal);
340
341 #ifdef HAVE_GETPAGESIZE
342 #ifdef MEMORY_ALIGNMENT_PAGESIZE
343   gst_memory_alignment = getpagesize () - 1;
344 #endif
345 #endif
346
347   GST_DEBUG ("memory alignment: %" G_GSIZE_FORMAT, gst_memory_alignment);
348
349   _default_mem_impl = gst_allocator_register (GST_ALLOCATOR_SYSMEM, &_mem_info);
350
351   _default_allocator = _default_mem_impl;
352 }
353
354 /**
355  * gst_memory_new_wrapped:
356  * @flags: #GstMemoryFlags
357  * @data: data to wrap
358  * @free_func: function to free @data
359  * @maxsize: allocated size of @data
360  * @offset: offset in @data
361  * @size: size of valid data
362  *
363  * Allocate a new memory block that wraps the given @data.
364  *
365  * Returns: a new #GstMemory.
366  */
367 GstMemory *
368 gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,
369     GFreeFunc free_func, gsize maxsize, gsize offset, gsize size)
370 {
371   GstMemoryDefault *mem;
372
373   g_return_val_if_fail (data != NULL, NULL);
374   g_return_val_if_fail (offset + size <= maxsize, NULL);
375
376   mem = _default_mem_new (flags, NULL, data, free_func, maxsize, offset, size);
377
378   return (GstMemory *) mem;
379 }
380
381 /**
382  * gst_memory_ref:
383  * @mem: a #GstMemory
384  *
385  * Increases the refcount of @mem.
386  *
387  * Returns: @mem with increased refcount
388  */
389 GstMemory *
390 gst_memory_ref (GstMemory * mem)
391 {
392   g_return_val_if_fail (mem != NULL, NULL);
393
394   g_atomic_int_inc (&mem->refcount);
395
396   return mem;
397 }
398
399 /**
400  * gst_memory_unref:
401  * @mem: a #GstMemory
402  *
403  * Decreases the refcount of @mem. When the refcount reaches 0, the free
404  * function of @mem will be called.
405  */
406 void
407 gst_memory_unref (GstMemory * mem)
408 {
409   g_return_if_fail (mem != NULL);
410   g_return_if_fail (mem->allocator != NULL);
411
412   if (g_atomic_int_dec_and_test (&mem->refcount))
413     mem->allocator->info.free (mem);
414 }
415
416 /**
417  * gst_memory_get_sizes:
418  * @mem: a #GstMemory
419  * @offset: pointer to offset
420  * @maxsize: pointer to maxsize
421  *
422  * Get the current @size, @offset and @maxsize of @mem.
423  *
424  * Returns: the current sizes of @mem
425  */
426 gsize
427 gst_memory_get_sizes (GstMemory * mem, gsize * offset, gsize * maxsize)
428 {
429   g_return_val_if_fail (mem != NULL, 0);
430
431   return mem->allocator->info.get_sizes (mem, offset, maxsize);
432 }
433
434 /**
435  * gst_memory_resize:
436  * @mem: a #GstMemory
437  * @offset: a new offset
438  * @size: a new size
439  *
440  * Resize the memory region. @mem should be writable and offset + size should be
441  * less than the maxsize of @mem.
442  */
443 void
444 gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
445 {
446   g_return_if_fail (mem != NULL);
447   g_return_if_fail (GST_MEMORY_IS_WRITABLE (mem));
448
449   mem->allocator->info.resize (mem, offset, size);
450 }
451
452 /**
453  * gst_memory_map:
454  * @mem: a #GstMemory
455  * @size: (out) (allow-none): pointer for size
456  * @maxsize: (out) (allow-none): pointer for maxsize
457  * @flags: mapping flags
458  *
459  * Get a pointer to the memory of @mem that can be accessed according to @flags.
460  *
461  * @size and @maxsize will contain the size of the memory and the maximum
462  * allocated memory of @mem respectively. They can be set to NULL.
463  *
464  * Returns: (transfer none): a pointer to the memory of @mem.
465  */
466 gpointer
467 gst_memory_map (GstMemory * mem, gsize * size, gsize * maxsize,
468     GstMapFlags flags)
469 {
470   g_return_val_if_fail (mem != NULL, NULL);
471   g_return_val_if_fail (!(flags & GST_MAP_WRITE) ||
472       GST_MEMORY_IS_WRITABLE (mem), NULL);
473
474   return mem->allocator->info.map (mem, size, maxsize, flags);
475 }
476
477 /**
478  * gst_memory_unmap:
479  * @mem: a #GstMemory
480  * @data: data to unmap
481  * @size: new size of @mem, or -1
482  *
483  * Release the memory pointer obtained with gst_memory_map() and set the size of
484  * the memory to @size. @size can be set to -1 when the size should not be
485  * updated.
486  *
487  * It is possible to pass a different @data than that obtained from
488  * gst_memory_map() in which case the offset of @mem will be updated.
489  *
490  * Returns: TRUE when the memory was release successfully.
491  */
492 gboolean
493 gst_memory_unmap (GstMemory * mem, gpointer data, gssize size)
494 {
495   g_return_val_if_fail (mem != NULL, FALSE);
496
497   return mem->allocator->info.unmap (mem, data, size);
498 }
499
500 /**
501  * gst_memory_copy:
502  * @mem: a #GstMemory
503  * @offset: an offset to copy
504  * @size: size to copy or -1 to copy all bytes from offset
505  *
506  * Return a copy of @size bytes from @mem starting from @offset. This copy is
507  * guaranteed to be writable. @size can be set to -1 to return a copy all bytes
508  * from @offset.
509  *
510  * Returns: a new #GstMemory.
511  */
512 GstMemory *
513 gst_memory_copy (GstMemory * mem, gssize offset, gssize size)
514 {
515   g_return_val_if_fail (mem != NULL, NULL);
516
517   return mem->allocator->info.copy (mem, offset, size);
518 }
519
520 /**
521  * gst_memory_share:
522  * @mem: a #GstMemory
523  * @offset: an offset to share
524  * @size: size to share or -1 to share bytes from offset
525  *
526  * Return a shared copy of @size bytes from @mem starting from @offset. No
527  * memory copy is performed and the memory region is simply shared. The result
528  * is guaranteed to be not-writable. @size can be set to -1 to return a share
529  * all bytes from @offset.
530  *
531  * Returns: a new #GstMemory.
532  */
533 GstMemory *
534 gst_memory_share (GstMemory * mem, gssize offset, gssize size)
535 {
536   g_return_val_if_fail (mem != NULL, NULL);
537
538   return mem->allocator->info.share (mem, offset, size);
539 }
540
541 /**
542  * gst_memory_is_span:
543  * @mem1: a #GstMemory
544  * @mem2: a #GstMemory
545  * @offset: a pointer to a result offset
546  *
547  * Check if @mem1 and mem2 share the memory with a common parent memory object
548  * and that the memory is contiguous.
549  *
550  * If this is the case, the memory of @mem1 and @mem2 can be merged
551  * efficiently by performing gst_memory_share() on the parent object from
552  * the returned @offset.
553  *
554  * Returns: %TRUE if the memory is contiguous and of a common parent.
555  */
556 gboolean
557 gst_memory_is_span (GstMemory * mem1, GstMemory * mem2, gsize * offset)
558 {
559   g_return_val_if_fail (mem1 != NULL, FALSE);
560   g_return_val_if_fail (mem2 != NULL, FALSE);
561
562   /* need to have the same allocators */
563   if (mem1->allocator != mem2->allocator)
564     return FALSE;
565
566   /* need to have the same parent */
567   if (mem1->parent == NULL || mem1->parent != mem2->parent)
568     return FALSE;
569
570   /* and memory is contiguous */
571   if (!mem1->allocator->info.is_span (mem1, mem2, offset))
572     return FALSE;
573
574   return TRUE;
575 }
576
577 /**
578  * gst_allocator_register:
579  * @name: the name of the allocator
580  * @info: #GstMemoryInfo
581  *
582  * Registers the memory allocator with @name and implementation functions
583  * @info.
584  *
585  * All functions in @info are mandatory exept the copy and is_span
586  * functions, which will have a default implementation when left NULL.
587  *
588  * The user_data field in @info will be passed to all calls of the alloc
589  * function.
590  *
591  * Returns: a new #GstAllocator.
592  */
593 const GstAllocator *
594 gst_allocator_register (const gchar * name, const GstMemoryInfo * info)
595 {
596   GstAllocator *allocator;
597
598 #define INSTALL_FALLBACK(_t) \
599   if (allocator->info._t == NULL) allocator->info._t = _fallback_ ##_t;
600
601   g_return_val_if_fail (name != NULL, NULL);
602   g_return_val_if_fail (info != NULL, NULL);
603   g_return_val_if_fail (info->alloc != NULL, NULL);
604   g_return_val_if_fail (info->get_sizes != NULL, NULL);
605   g_return_val_if_fail (info->resize != NULL, NULL);
606   g_return_val_if_fail (info->map != NULL, NULL);
607   g_return_val_if_fail (info->unmap != NULL, NULL);
608   g_return_val_if_fail (info->free != NULL, NULL);
609   g_return_val_if_fail (info->share != NULL, NULL);
610
611   allocator = g_slice_new (GstAllocator);
612   allocator->name = g_quark_from_string (name);
613   allocator->info = *info;
614   INSTALL_FALLBACK (copy);
615   INSTALL_FALLBACK (is_span);
616 #undef INSTALL_FALLBACK
617
618   GST_DEBUG ("registering allocator \"%s\"", name);
619
620   g_static_rw_lock_writer_lock (&lock);
621   g_hash_table_insert (allocators, (gpointer) name, (gpointer) allocator);
622   g_static_rw_lock_writer_unlock (&lock);
623
624   return allocator;
625 }
626
627 /**
628  * gst_allocator_find:
629  * @name: the name of the allocator
630  *
631  * Find a previously registered allocator with @name. When @name is NULL, the
632  * default allocator will be returned.
633  *
634  * Returns: a #GstAllocator or NULL when the allocator with @name was not
635  * registered.
636  */
637 const GstAllocator *
638 gst_allocator_find (const gchar * name)
639 {
640   const GstAllocator *allocator;
641
642   g_static_rw_lock_reader_lock (&lock);
643   if (name) {
644     allocator = g_hash_table_lookup (allocators, (gconstpointer) name);
645   } else {
646     allocator = _default_allocator;
647   }
648   g_static_rw_lock_reader_unlock (&lock);
649
650   return allocator;
651 }
652
653 /**
654  * gst_allocator_set_default:
655  * @allocator: a #GstAllocator
656  *
657  * Set the default allocator.
658  */
659 void
660 gst_allocator_set_default (const GstAllocator * allocator)
661 {
662   g_return_if_fail (allocator != NULL);
663
664   g_static_rw_lock_writer_lock (&lock);
665   _default_allocator = allocator;
666   g_static_rw_lock_writer_unlock (&lock);
667 }
668
669 /**
670  * gst_allocator_alloc:
671  * @allocator: (transfer none) (allow-none): a #GstAllocator to use
672  * @maxsize: allocated size of @data
673  * @align: alignment for the data
674  *
675  * Use @allocator to allocate a new memory block with memory that is at least
676  * @maxsize big and has the given alignment.
677  *
678  * When @allocator is NULL, the default allocator will be used.
679  *
680  * @align is given as a bitmask so that @align + 1 equals the amount of bytes to
681  * align to. For example, to align to 8 bytes, use an alignment of 7.
682  *
683  * Returns: (transfer full): a new #GstMemory.
684  */
685 GstMemory *
686 gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)
687 {
688   g_return_val_if_fail (((align + 1) & align) == 0, NULL);
689
690   if (allocator == NULL)
691     allocator = _default_allocator;
692
693   return allocator->info.alloc (allocator, maxsize, align,
694       allocator->info.user_data);
695 }