2 * Copyright © 2007, 2008 Ryan Lortie
3 * Copyright © 2010 Codethink Limited
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library 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 GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include <glib/gvariant-core.h>
23 #include <glib/gvariant-serialiser.h>
24 #include <glib/gtestutils.h>
25 #include <glib/gbitlock.h>
26 #include <glib/gatomic.h>
27 #include <glib/gbytes.h>
28 #include <glib/gslice.h>
29 #include <glib/gmem.h>
34 * This file includes the structure definition for GVariant and a small
35 * set of functions that are allowed to access the structure directly.
37 * This minimises the amount of code that can possibly touch a GVariant
38 * structure directly to a few simple fundamental operations. These few
39 * operations are written to be completely threadsafe with respect to
40 * all possible outside access. This means that we only need to be
41 * concerned about thread safety issues in this one small file.
43 * Most GVariant API functions are in gvariant.c.
49 * #GVariant is an opaque data structure and can only be accessed
50 * using the following functions.
55 /* see below for field member documentation */
57 GVariantTypeInfo *type_info;
81 * There are two primary forms of GVariant instances: "serialised form"
84 * "serialised form": A serialised GVariant instance stores its value in
85 * the GVariant serialisation format. All
86 * basic-typed instances (ie: non-containers) are in
87 * serialised format, as are some containers.
89 * "tree form": Some containers are in "tree form". In this case,
90 * instead of containing the serialised data for the
91 * container, the instance contains an array of pointers to
92 * the child values of the container (thus forming a tree).
94 * It is possible for an instance to transition from tree form to
95 * serialised form. This happens, implicitly, if the serialised data is
96 * requested (eg: via g_variant_get_data()). Serialised form instances
97 * never transition into tree form.
100 * The fields of the structure are documented here:
102 * type_info: this is a reference to a GVariantTypeInfo describing the
103 * type of the instance. When the instance is freed, this
104 * reference must be released with g_variant_type_info_unref().
106 * The type_info field never changes during the life of the
107 * instance, so it can be accessed without a lock.
109 * size: this is the size of the serialised form for the instance. It
110 * is known for serialised instances and also tree-form instances
111 * (for which it is calculated at construction time, from the
112 * known sizes of the children used). After construction, it
113 * never changes and therefore can be accessed without a lock.
115 * contents: a union containing either the information associated with
116 * holding a value in serialised form or holding a value in
119 * .serialised: Only valid when the instance is in serialised form.
121 * Since an instance can never transition away from
122 * serialised form, once these fields are set, they will
123 * never be changed. It is therefore valid to access
124 * them without holding a lock.
126 * .bytes: the #GBytes that contains the memory pointed to by
127 * .data, or %NULL if .data is %NULL. In the event that
128 * the instance was deserialised from another instance,
129 * then the bytes will be shared by both of them. When
130 * the instance is freed, this reference must be released
131 * with g_bytes_unref().
133 * .data: the serialised data (of size 'size') of the instance.
134 * This pointer should not be freed or modified in any way.
135 * #GBytes is responsible for memory management.
137 * This pointer may be %NULL in two cases:
139 * - if the serialised size of the instance is 0
141 * - if the instance is of a fixed-sized type and was
142 * deserialised out of a corrupted container such that
143 * the container contains too few bytes to point to the
144 * entire proper fixed-size of this instance. In this
145 * case, 'size' will still be equal to the proper fixed
146 * size, but this pointer will be %NULL. This is exactly
147 * the reason that g_variant_get_data() sometimes returns
148 * %NULL. For all other calls, the effect should be as
149 * if .data pointed to the appropriate number of nul
152 * .tree: Only valid when the instance is in tree form.
154 * Note that accesses from other threads could result in
155 * conversion of the instance from tree form to serialised form
156 * at any time. For this reason, the instance lock must always
157 * be held while performing any operations on 'contents.tree'.
159 * .children: the array of the child instances of this instance.
160 * When the instance is freed (or converted to serialised
161 * form) then each child must have g_variant_unref()
162 * called on it and the array must be freed using
165 * .n_children: the number of items in the .children array.
167 * state: a bitfield describing the state of the instance. It is a
168 * bitwise-or of the following STATE_* constants:
170 * STATE_LOCKED: the instance lock is held. This is the bit used by
173 * STATE_SERIALISED: the instance is in serialised form. If this
174 * flag is not set then the instance is in tree
177 * STATE_TRUSTED: for serialised form instances, this means that the
178 * serialised data is known to be in normal form (ie:
181 * For tree form instances, this means that all of the
182 * child instances in the contents.tree.children array
183 * are trusted. This means that if the container is
184 * serialised then the resulting data will be in
187 * If this flag is unset it does not imply that the
188 * data is corrupted. It merely means that we're not
189 * sure that it's valid. See g_variant_is_trusted().
191 * STATE_FLOATING: if this flag is set then the object has a floating
192 * reference. See g_variant_ref_sink().
194 * ref_count: the reference count of the instance
196 #define STATE_LOCKED 1
197 #define STATE_SERIALISED 2
198 #define STATE_TRUSTED 4
199 #define STATE_FLOATING 8
204 * @value: a #GVariant
206 * Locks @value for performing sensitive operations.
209 g_variant_lock (GVariant *value)
211 g_bit_lock (&value->state, 0);
216 * @value: a #GVariant
218 * Unlocks @value after performing sensitive operations.
221 g_variant_unlock (GVariant *value)
223 g_bit_unlock (&value->state, 0);
227 * g_variant_release_children:
228 * @value: a #GVariant
230 * Releases the reference held on each child in the 'children' array of
231 * @value and frees the array itself. @value must be in tree form.
233 * This is done when freeing a tree-form instance or converting it to
236 * The current thread must hold the lock on @value.
239 g_variant_release_children (GVariant *value)
243 g_assert (value->state & STATE_LOCKED);
244 g_assert (~value->state & STATE_SERIALISED);
246 for (i = 0; i < value->contents.tree.n_children; i++)
247 g_variant_unref (value->contents.tree.children[i]);
249 g_free (value->contents.tree.children);
253 * g_variant_lock_in_tree_form:
254 * @value: a #GVariant
256 * Locks @value if it is in tree form.
258 * Returns: %TRUE if @value is now in tree form with the lock acquired
261 g_variant_lock_in_tree_form (GVariant *value)
263 if (g_atomic_int_get (&value->state) & STATE_SERIALISED)
266 g_variant_lock (value);
268 if (value->state & STATE_SERIALISED)
270 g_variant_unlock (value);
277 /* This begins the main body of the recursive serialiser.
279 * There are 3 functions here that work as a team with the serialiser to
280 * get things done. g_variant_store() has a trivial role, but as a
281 * public API function, it has its definition elsewhere.
283 * Note that "serialisation" of an instance does not mean that the
284 * instance is converted to serialised form -- it means that the
285 * serialised form of an instance is written to an external buffer.
286 * g_variant_ensure_serialised() (which is not part of this set of
287 * functions) is the function that is responsible for converting an
288 * instance to serialised form.
290 * We are only concerned here with container types since non-container
291 * instances are always in serialised form. For these instances,
292 * storing their serialised form merely involves a memcpy().
294 * Converting to serialised form:
296 * The first step in the process of converting a GVariant to
297 * serialised form is to allocate a buffer. The size of the buffer is
298 * always known because we computed at construction time of the
301 * After the buffer has been allocated, g_variant_serialise() is
302 * called on the container. This invokes the serialiser code to write
303 * the bytes to the container. The serialiser is passed
304 * g_variant_fill_gvs() as a callback.
306 * At the time that g_variant_fill_gvs() is called for each child, the
307 * child is given a pointer to a sub-region of the allocated buffer
308 * where it should write its data. This is done by calling
309 * g_variant_store(). In the event that the instance is in serialised
310 * form this means a memcpy() of the serialised data into the
311 * allocated buffer. In the event that the instance is in tree form
312 * this means a recursive call back into g_variant_serialise().
315 * The forward declaration here allows corecursion via callback:
317 static void g_variant_fill_gvs (GVariantSerialised *, gpointer);
320 * g_variant_serialise:
321 * @value: a #GVariant
322 * @data: an appropriately-sized buffer
324 * Serialises @value into @data. @value must be in tree form.
326 * No change is made to @value.
328 * The current thread must hold the lock on @value.
331 g_variant_serialise (GVariant *value,
334 GVariantSerialised serialised = { 0, };
338 g_assert (~value->state & STATE_SERIALISED);
339 g_assert (value->state & STATE_LOCKED);
341 serialised.type_info = value->type_info;
342 serialised.size = value->size;
343 serialised.data = data;
345 children = (gpointer *) value->contents.tree.children;
346 n_children = value->contents.tree.n_children;
348 g_variant_serialiser_serialise (serialised, g_variant_fill_gvs,
349 children, n_children);
353 * g_variant_fill_gvs:
354 * @serialised: a pointer to a #GVariantSerialised
355 * @data: a #GVariant instance
357 * This is the callback that is passed by a tree-form container instance
358 * to the serialiser. This callback gets called on each child of the
359 * container. Each child is responsible for performing the following
362 * - reporting its type
364 * - reporting its serialised size
366 * - possibly storing its serialised form into the provided buffer
368 * This callback is also used during g_variant_new_from_children() in
369 * order to discover the size and type of each child.
372 g_variant_fill_gvs (GVariantSerialised *serialised,
375 GVariant *value = data;
377 if (serialised->type_info == NULL)
378 serialised->type_info = value->type_info;
379 g_assert (serialised->type_info == value->type_info);
381 if (serialised->size == 0)
382 serialised->size = value->size;
383 g_assert (serialised->size == value->size);
385 if (serialised->data)
386 /* g_variant_store() is a public API, so it
387 * it will reacquire the lock if it needs to.
389 g_variant_store (value, serialised->data);
392 /* this ends the main body of the recursive serialiser */
395 * g_variant_ensure_serialised:
396 * @value: a #GVariant
398 * Ensures that @value is in serialised form.
400 * If @value is in tree form then this function allocates a buffer of
401 * that size and serialises the instance into the buffer. The
402 * 'children' array is then released and the instance is set to
403 * serialised form based on the contents of the buffer.
406 g_variant_ensure_serialised (GVariant *value)
408 if (g_variant_lock_in_tree_form (value))
413 data = g_malloc (value->size);
414 g_variant_serialise (value, data);
416 g_variant_release_children (value);
418 bytes = g_bytes_new_take (data, value->size);
419 value->contents.serialised.data = g_bytes_get_data (bytes, NULL);
420 value->contents.serialised.bytes = bytes;
421 value->state |= STATE_SERIALISED;
423 g_variant_unlock (value);
429 * @type: the type of the new instance
430 * @serialised: if the instance will be in serialised form
431 * @trusted: if the instance will be trusted
433 * Allocates a #GVariant instance and does some common work (such as
434 * looking up and filling in the type info), setting the state field,
435 * and setting the ref_count to 1.
437 * Returns: a new #GVariant with a floating reference
440 g_variant_alloc (const GVariantType *type,
446 value = g_slice_new (GVariant);
447 value->type_info = g_variant_type_info_get (type);
448 value->state = (serialised ? STATE_SERIALISED : 0) |
449 (trusted ? STATE_TRUSTED : 0) |
451 value->ref_count = 1;
457 * g_variant_new_from_bytes:
458 * @type: a #GVariantType
460 * @trusted: if the contents of @bytes are trusted
462 * Constructs a new serialised-mode #GVariant instance. This is the
463 * inner interface for creation of new serialised values that gets
464 * called from various functions in gvariant.c.
466 * A reference is taken on @bytes.
468 * Returns: (transfer none): a new #GVariant with a floating reference
473 g_variant_new_from_bytes (const GVariantType *type,
481 value = g_variant_alloc (type, TRUE, trusted);
483 value->contents.serialised.bytes = g_bytes_ref (bytes);
485 g_variant_type_info_query (value->type_info,
488 if (size && g_bytes_get_size (bytes) != size)
490 /* Creating a fixed-sized GVariant with a bytes of the wrong
493 * We should do the equivalent of pulling a fixed-sized child out
494 * of a brozen container (ie: data is NULL size is equal to the correct
497 value->contents.serialised.data = NULL;
502 value->contents.serialised.data = g_bytes_get_data (bytes, &value->size);
511 * g_variant_new_from_children:
512 * @type: a #GVariantType
513 * @children: an array of #GVariant pointers. Consumed.
514 * @n_children: the length of @children
515 * @trusted: %TRUE if every child in @children in trusted
517 * Constructs a new tree-mode #GVariant instance. This is the inner
518 * interface for creation of new serialised values that gets called from
519 * various functions in gvariant.c.
521 * @children is consumed by this function. g_free() will be called on
522 * it some time later.
524 * Returns: a new #GVariant with a floating reference
527 g_variant_new_from_children (const GVariantType *type,
534 value = g_variant_alloc (type, FALSE, trusted);
535 value->contents.tree.children = children;
536 value->contents.tree.n_children = n_children;
537 value->size = g_variant_serialiser_needed_size (value->type_info, g_variant_fill_gvs,
538 (gpointer *) children, n_children);
544 * g_variant_get_type_info:
545 * @value: a #GVariant
547 * Returns the #GVariantTypeInfo corresponding to the type of @value. A
548 * reference is not added, so the return value is only good for the
549 * duration of the life of @value.
551 * Returns: the #GVariantTypeInfo for @value
554 g_variant_get_type_info (GVariant *value)
556 return value->type_info;
560 * g_variant_is_trusted:
561 * @value: a #GVariant
563 * Determines if @value is trusted by #GVariant to contain only
564 * fully-valid data. All values constructed solely via #GVariant APIs
565 * are trusted, but values containing data read in from other sources
566 * are usually not trusted.
568 * The main advantage of trusted data is that certain checks can be
569 * skipped. For example, we don't need to check that a string is
570 * properly nul-terminated or that an object path is actually a
571 * properly-formatted object path.
573 * Returns: if @value is trusted
576 g_variant_is_trusted (GVariant *value)
578 return (value->state & STATE_TRUSTED) != 0;
585 * @value: a #GVariant
587 * Decreases the reference count of @value. When its reference count
588 * drops to 0, the memory used by the variant is freed.
593 g_variant_unref (GVariant *value)
595 g_return_if_fail (value != NULL);
596 g_return_if_fail (value->ref_count > 0);
598 if (g_atomic_int_dec_and_test (&value->ref_count))
600 if G_UNLIKELY (value->state & STATE_LOCKED)
601 g_critical ("attempting to free a locked GVariant instance. "
602 "This should never happen.");
604 value->state |= STATE_LOCKED;
606 g_variant_type_info_unref (value->type_info);
608 if (value->state & STATE_SERIALISED)
609 g_bytes_unref (value->contents.serialised.bytes);
611 g_variant_release_children (value);
613 memset (value, 0, sizeof (GVariant));
614 g_slice_free (GVariant, value);
620 * @value: a #GVariant
622 * Increases the reference count of @value.
624 * Returns: the same @value
629 g_variant_ref (GVariant *value)
631 g_return_val_if_fail (value != NULL, NULL);
632 g_return_val_if_fail (value->ref_count > 0, NULL);
634 g_atomic_int_inc (&value->ref_count);
640 * g_variant_ref_sink:
641 * @value: a #GVariant
643 * #GVariant uses a floating reference count system. All functions with
644 * names starting with `g_variant_new_` return floating
647 * Calling g_variant_ref_sink() on a #GVariant with a floating reference
648 * will convert the floating reference into a full reference. Calling
649 * g_variant_ref_sink() on a non-floating #GVariant results in an
650 * additional normal reference being added.
652 * In other words, if the @value is floating, then this call "assumes
653 * ownership" of the floating reference, converting it to a normal
654 * reference. If the @value is not floating, then this call adds a
655 * new normal reference increasing the reference count by one.
657 * All calls that result in a #GVariant instance being inserted into a
658 * container will call g_variant_ref_sink() on the instance. This means
659 * that if the value was just created (and has only its floating
660 * reference) then the container will assume sole ownership of the value
661 * at that point and the caller will not need to unreference it. This
662 * makes certain common styles of programming much easier while still
663 * maintaining normal refcounting semantics in situations where values
666 * Returns: the same @value
671 g_variant_ref_sink (GVariant *value)
673 g_return_val_if_fail (value != NULL, NULL);
674 g_return_val_if_fail (value->ref_count > 0, NULL);
676 g_variant_lock (value);
678 if (~value->state & STATE_FLOATING)
679 g_variant_ref (value);
681 value->state &= ~STATE_FLOATING;
683 g_variant_unlock (value);
689 * g_variant_take_ref:
690 * @value: a #GVariant
692 * If @value is floating, sink it. Otherwise, do nothing.
694 * Typically you want to use g_variant_ref_sink() in order to
695 * automatically do the correct thing with respect to floating or
696 * non-floating references, but there is one specific scenario where
697 * this function is helpful.
699 * The situation where this function is helpful is when creating an API
700 * that allows the user to provide a callback function that returns a
701 * #GVariant. We certainly want to allow the user the flexibility to
702 * return a non-floating reference from this callback (for the case
703 * where the value that is being returned already exists).
705 * At the same time, the style of the #GVariant API makes it likely that
706 * for newly-created #GVariant instances, the user can be saved some
707 * typing if they are allowed to return a #GVariant with a floating
710 * Using this function on the return value of the user's callback allows
711 * the user to do whichever is more convenient for them. The caller
712 * will alway receives exactly one full reference to the value: either
713 * the one that was returned in the first place, or a floating reference
714 * that has been converted to a full reference.
716 * This function has an odd interaction when combined with
717 * g_variant_ref_sink() running at the same time in another thread on
718 * the same #GVariant instance. If g_variant_ref_sink() runs first then
719 * the result will be that the floating reference is converted to a hard
720 * reference. If g_variant_take_ref() runs first then the result will
721 * be that the floating reference is converted to a hard reference and
722 * an additional reference on top of that one is added. It is best to
723 * avoid this situation.
725 * Returns: the same @value
728 g_variant_take_ref (GVariant *value)
730 g_return_val_if_fail (value != NULL, NULL);
731 g_return_val_if_fail (value->ref_count > 0, NULL);
733 g_atomic_int_and (&value->state, ~STATE_FLOATING);
739 * g_variant_is_floating:
740 * @value: a #GVariant
742 * Checks whether @value has a floating reference count.
744 * This function should only ever be used to assert that a given variant
745 * is or is not floating, or for debug purposes. To acquire a reference
746 * to a variant that might be floating, always use g_variant_ref_sink()
747 * or g_variant_take_ref().
749 * See g_variant_ref_sink() for more information about floating reference
752 * Returns: whether @value is floating
757 g_variant_is_floating (GVariant *value)
759 g_return_val_if_fail (value != NULL, FALSE);
761 return (value->state & STATE_FLOATING) != 0;
765 * g_variant_get_size:
766 * @value: a #GVariant instance
768 * Determines the number of bytes that would be required to store @value
769 * with g_variant_store().
771 * If @value has a fixed-sized type then this function always returned
774 * In the case that @value is already in serialised form or the size has
775 * already been calculated (ie: this function has been called before)
776 * then this function is O(1). Otherwise, the size is calculated, an
777 * operation which is approximately O(n) in the number of values
780 * Returns: the serialised size of @value
785 g_variant_get_size (GVariant *value)
791 * g_variant_get_data:
792 * @value: a #GVariant instance
794 * Returns a pointer to the serialised form of a #GVariant instance.
795 * The returned data may not be in fully-normalised form if read from an
796 * untrusted source. The returned data must not be freed; it remains
797 * valid for as long as @value exists.
799 * If @value is a fixed-sized value that was deserialised from a
800 * corrupted serialised container then %NULL may be returned. In this
801 * case, the proper thing to do is typically to use the appropriate
802 * number of nul bytes in place of @value. If @value is not fixed-sized
803 * then %NULL is never returned.
805 * In the case that @value is already in serialised form, this function
806 * is O(1). If the value is not already in serialised form,
807 * serialisation occurs implicitly and is approximately O(n) in the size
810 * To deserialise the data returned by this function, in addition to the
811 * serialised data, you must know the type of the #GVariant, and (if the
812 * machine might be different) the endianness of the machine that stored
813 * it. As a result, file formats or network messages that incorporate
814 * serialised #GVariants must include this information either
815 * implicitly (for instance "the file always contains a
816 * %G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or
817 * explicitly (by storing the type and/or endianness in addition to the
820 * Returns: (transfer none): the serialised form of @value, or %NULL
825 g_variant_get_data (GVariant *value)
827 g_variant_ensure_serialised (value);
829 return value->contents.serialised.data;
833 * g_variant_get_data_as_bytes:
834 * @value: a #GVariant
836 * Returns a pointer to the serialised form of a #GVariant instance.
837 * The semantics of this function are exactly the same as
838 * g_variant_get_data(), except that the returned #GBytes holds
839 * a reference to the variant data.
841 * Returns: (transfer full): A new #GBytes representing the variant data
846 g_variant_get_data_as_bytes (GVariant *value)
848 const gchar *bytes_data;
853 g_variant_ensure_serialised (value);
855 bytes_data = g_bytes_get_data (value->contents.serialised.bytes, &bytes_size);
856 data = value->contents.serialised.data;
859 if (data == bytes_data && size == bytes_size)
860 return g_bytes_ref (value->contents.serialised.bytes);
862 return g_bytes_new_from_bytes (value->contents.serialised.bytes,
863 data - bytes_data, size);
868 * g_variant_n_children:
869 * @value: a container #GVariant
871 * Determines the number of children in a container #GVariant instance.
872 * This includes variants, maybes, arrays, tuples and dictionary
873 * entries. It is an error to call this function on any other type of
876 * For variants, the return value is always 1. For values with maybe
877 * types, it is always zero or one. For arrays, it is the length of the
878 * array. For tuples it is the number of tuple items (which depends
879 * only on the type). For dictionary entries, it is always 2
881 * This function is O(1).
883 * Returns: the number of children in the container
888 g_variant_n_children (GVariant *value)
892 if (g_variant_lock_in_tree_form (value))
894 n_children = value->contents.tree.n_children;
895 g_variant_unlock (value);
899 GVariantSerialised serialised = {
901 (gpointer) value->contents.serialised.data,
905 n_children = g_variant_serialised_n_children (serialised);
912 * g_variant_get_child_value:
913 * @value: a container #GVariant
914 * @index_: the index of the child to fetch
916 * Reads a child item out of a container #GVariant instance. This
917 * includes variants, maybes, arrays, tuples and dictionary
918 * entries. It is an error to call this function on any other type of
921 * It is an error if @index_ is greater than the number of child items
922 * in the container. See g_variant_n_children().
924 * The returned value is never floating. You should free it with
925 * g_variant_unref() when you're done with it.
927 * This function is O(1).
929 * Returns: (transfer full): the child at the specified index
934 g_variant_get_child_value (GVariant *value,
939 g_return_val_if_fail (index_ < g_variant_n_children (value), NULL);
941 if (g_variant_lock_in_tree_form (value))
944 child = g_variant_ref (value->contents.tree.children[index_]);
945 g_variant_unlock (value);
949 GVariantSerialised serialised = {
951 (gpointer) value->contents.serialised.data,
954 GVariantSerialised s_child;
956 /* get the serialiser to extract the serialised data for the child
957 * from the serialised data for the container
959 s_child = g_variant_serialised_get_child (serialised, index_);
961 /* create a new serialised instance out of it */
962 child = g_slice_new (GVariant);
963 child->type_info = s_child.type_info;
964 child->state = (value->state & STATE_TRUSTED) |
966 child->size = s_child.size;
967 child->ref_count = 1;
968 child->contents.serialised.bytes =
969 g_bytes_ref (value->contents.serialised.bytes);
970 child->contents.serialised.data = s_child.data;
978 * @value: the #GVariant to store
979 * @data: the location to store the serialised data at
981 * Stores the serialised form of @value at @data. @data should be
982 * large enough. See g_variant_get_size().
984 * The stored data is in machine native byte order but may not be in
985 * fully-normalised form if read from an untrusted source. See
986 * g_variant_get_normal_form() for a solution.
988 * As with g_variant_get_data(), to be able to deserialise the
989 * serialised variant successfully, its type and (if the destination
990 * machine might be different) its endianness must also be available.
992 * This function is approximately O(n) in the size of @data.
997 g_variant_store (GVariant *value,
1000 if (g_variant_lock_in_tree_form (value))
1002 g_variant_serialise (value, data);
1003 g_variant_unlock (value);
1007 if (value->contents.serialised.data != NULL)
1008 memcpy (data, value->contents.serialised.data, value->size);
1010 memset (data, 0, value->size);
1015 * g_variant_is_normal_form:
1016 * @value: a #GVariant instance
1018 * Checks if @value is in normal form.
1020 * The main reason to do this is to detect if a given chunk of
1021 * serialised data is in normal form: load the data into a #GVariant
1022 * using g_variant_new_from_data() and then use this function to
1025 * If @value is found to be in normal form then it will be marked as
1026 * being trusted. If the value was already marked as being trusted then
1027 * this function will immediately return %TRUE.
1029 * Returns: %TRUE if @value is in normal form
1034 g_variant_is_normal_form (GVariant *value)
1036 if (g_atomic_int_get (&value->state) & STATE_TRUSTED)
1039 /* We always take the lock here because we expect to find that the
1040 * value is in normal form and in that case, we need to update the
1041 * state, which requires holding the lock.
1043 g_variant_lock (value);
1045 if (value->state & STATE_SERIALISED)
1047 GVariantSerialised serialised = {
1049 (gpointer) value->contents.serialised.data,
1053 if (g_variant_serialised_is_normal (serialised))
1054 value->state |= STATE_TRUSTED;
1058 gboolean normal = TRUE;
1061 for (i = 0; i < value->contents.tree.n_children; i++)
1062 normal &= g_variant_is_normal_form (value->contents.tree.children[i]);
1065 value->state |= STATE_TRUSTED;
1068 g_variant_unlock (value);
1070 return (value->state & STATE_TRUSTED) != 0;