glib/gvariant-serialiser.c

   1 /*
   2  * Copyright © 2007, 2008 Ryan Lortie
   3  * Copyright © 2010 Codethink Limited
   4  *
   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.
   9  *
  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.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Ryan Lortie <desrt@desrt.ca>
  21  */
  22
  23 /* Prologue {{{1 */
  24 #include "config.h"
  25
  26 #include "gvariant-serialiser.h"
  27
  28 #include <glib/gtestutils.h>
  29 #include <glib/gstrfuncs.h>
  30 #include <glib/gtypes.h>
  31
  32 #include <string.h>
  33
  34
  35 /* GVariantSerialiser
  36  *
  37  * After this prologue section, this file has roughly 2 parts.
  38  *
  39  * The first part is split up into sections according to various
  40  * container types.  Maybe, Array, Tuple, Variant.  The Maybe and Array
  41  * sections are subdivided for element types being fixed or
  42  * variable-sized types.
  43  *
  44  * Each section documents the format of that particular type of
  45  * container and implements 5 functions for dealing with it:
  46  *
  47  *  n_children:
  48  *    - determines (according to serialised data) how many child values
  49  *      are inside a particular container value.
  50  *
  51  *  get_child:
  52  *    - gets the type of and the serialised data corresponding to a
  53  *      given child value within the container value.
  54  *
  55  *  needed_size:
  56  *    - determines how much space would be required to serialise a
  57  *      container of this type, containing the given children so that
  58  *      buffers can be preallocated before serialising.
  59  *
  60  *  serialise:
  61  *    - write the serialised data for a container of this type,
  62  *      containing the given children, to a buffer.
  63  *
  64  *  is_normal:
  65  *    - check the given data to ensure that it is in normal form.  For a
  66  *      given set of child values, there is exactly one normal form for
  67  *      the serialised data of a container.  Other forms are possible
  68  *      while maintaining the same children (for example, by inserting
  69  *      something other than zero bytes as padding) but only one form is
  70  *      the normal form.
  71  *
  72  * The second part contains the main entry point for each of the above 5
  73  * functions and logic to dispatch it to the handler for the appropriate
  74  * container type code.
  75  *
  76  * The second part also contains a routine to byteswap serialised
  77  * values.  This code makes use of the n_children() and get_child()
  78  * functions above to do its work so no extra support is needed on a
  79  * per-container-type basis.
  80  *
  81  * There is also additional code for checking for normal form.  All
  82  * numeric types are always in normal form since the full range of
  83  * values is permitted (eg: 0 to 255 is a valid byte).  Special checks
  84  * need to be performed for booleans (only 0 or 1 allowed), strings
  85  * (properly nul-terminated) and object paths and signature strings
  86  * (meeting the D-Bus specification requirements).
  87  */
  88
  89 /* < private >
  90  * GVariantSerialised:
  91  * @type_info: the #GVariantTypeInfo of this value
  92  * @data: the serialised data of this value, or %NULL
  93  * @size: the size of this value
  94  *
  95  * A structure representing a GVariant in serialised form.  This
  96  * structure is used with #GVariantSerialisedFiller functions and as the
  97  * primary interface to the serialiser.  See #GVariantSerialisedFiller
  98  * for a description of its use there.
  99  *
 100  * When used with the serialiser API functions, the following invariants
 101  * apply to all #GVariantTypeSerialised structures passed to and
 102  * returned from the serialiser.
 103  *
 104  * @type_info must be non-%NULL.
 105  *
 106  * @data must be properly aligned for the type described by @type_info.
 107  *
 108  * If @type_info describes a fixed-sized type then @size must always be
 109  * equal to the fixed size of that type.
 110  *
 111  * For fixed-sized types (and only fixed-sized types), @data may be
 112  * %NULL even if @size is non-zero.  This happens when a framing error
 113  * occurs while attempting to extract a fixed-sized value out of a
 114  * variable-sized container.  There is no data to return for the
 115  * fixed-sized type, yet @size must be non-zero.  The effect of this
 116  * combination should be as if @data were a pointer to an
 117  * appropriately-sized zero-filled region.
 118  */
 119
 120 /* < private >
 121  * g_variant_serialised_check:
 122  * @serialised: a #GVariantSerialised struct
 123  *
 124  * Checks @serialised for validity according to the invariants described
 125  * above.
 126  */
 127 static void
 128 g_variant_serialised_check (GVariantSerialised serialised)
 129 {
 130   gsize fixed_size;
 131   guint alignment;
 132
 133   g_assert (serialised.type_info != NULL);
 134   g_variant_type_info_query (serialised.type_info, &alignment, &fixed_size);
 135
 136   if (fixed_size)
 137     g_assert_cmpint (serialised.size, ==, fixed_size);
 138   else
 139     g_assert (serialised.size == 0 || serialised.data != NULL);
 140
 141   /* Depending on the native alignment requirements of the machine, the
 142    * compiler will insert either 3 or 7 padding bytes after the char.
 143    * This will result in the sizeof() the struct being 12 or 16.
 144    * Subtract 9 to get 3 or 7 which is a nice bitmask to apply to get
 145    * the alignment bits that we "care about" being zero: in the
 146    * 4-aligned case, we care about 2 bits, and in the 8-aligned case, we
 147    * care about 3 bits.
 148    */
 149   alignment &= sizeof (struct {
 150                          char a;
 151                          union {
 152                            guint64 x;
 153                            void *y;
 154                            gdouble z;
 155                          } b;
 156                        }
 157                       ) - 9;
 158
 159   /* Some OSes (FreeBSD is a known example) have a malloc() that returns
 160    * unaligned memory if you request small sizes.  'malloc (1);', for
 161    * example, has been seen to return pointers aligned to 6 mod 16.
 162    *
 163    * Check if this is a small allocation and return without enforcing
 164    * the alignment assertion if this is the case.
 165    */
 166   if (serialised.size <= alignment)
 167     return;
 168
 169   g_assert_cmpint (alignment & (gsize) serialised.data, ==, 0);
 170 }
 171
 172 /* < private >
 173  * GVariantSerialisedFiller:
 174  * @serialised: a #GVariantSerialised instance to fill
 175  * @data: data from the children array
 176  *
 177  * This function is called back from g_variant_serialiser_needed_size()
 178  * and g_variant_serialiser_serialise().  It fills in missing details
 179  * from a partially-complete #GVariantSerialised.
 180  *
 181  * The @data parameter passed back to the function is one of the items
 182  * that was passed to the serialiser in the @children array.  It
 183  * represents a single child item of the container that is being
 184  * serialised.  The information filled in to @serialised is the
 185  * information for this child.
 186  *
 187  * If the @type_info field of @serialised is %NULL then the callback
 188  * function must set it to the type information corresponding to the
 189  * type of the child.  No reference should be added.  If it is non-%NULL
 190  * then the callback should assert that it is equal to the actual type
 191  * of the child.
 192  *
 193  * If the @size field is zero then the callback must fill it in with the
 194  * required amount of space to store the serialised form of the child.
 195  * If it is non-zero then the callback should assert that it is equal to
 196  * the needed size of the child.
 197  *
 198  * If @data is non-%NULL then it points to a space that is properly
 199  * aligned for and large enough to store the serialised data of the
 200  * child.  The callback must store the serialised form of the child at
 201  * @data.
 202  *
 203  * If the child value is another container then the callback will likely
 204  * recurse back into the serialiser by calling
 205  * g_variant_serialiser_needed_size() to determine @size and
 206  * g_variant_serialiser_serialise() to write to @data.
 207  */
 208
 209 /* PART 1: Container types {{{1
 210  *
 211  * This section contains the serialiser implementation functions for
 212  * each container type.
 213  */
 214
 215 /* Maybe {{{2
 216  *
 217  * Maybe types are handled depending on if the element type of the maybe
 218  * type is a fixed-sized or variable-sized type.  Although all maybe
 219  * types themselves are variable-sized types, herein, a maybe value with
 220  * a fixed-sized element type is called a "fixed-sized maybe" for
 221  * convenience and a maybe value with a variable-sized element type is
 222  * called a "variable-sized maybe".
 223  */
 224
 225 /* Fixed-sized Maybe {{{3
 226  *
 227  * The size of a maybe value with a fixed-sized element type is either 0
 228  * or equal to the fixed size of its element type.  The case where the
 229  * size of the maybe value is zero corresponds to the "Nothing" case and
 230  * the case where the size of the maybe value is equal to the fixed size
 231  * of the element type corresponds to the "Just" case; in that case, the
 232  * serialised data of the child value forms the entire serialised data
 233  * of the maybe value.
 234  *
 235  * In the event that a fixed-sized maybe value is presented with a size
 236  * that is not equal to the fixed size of the element type then the
 237  * value must be taken to be "Nothing".
 238  */
 239
 240 static gsize
 241 gvs_fixed_sized_maybe_n_children (GVariantSerialised value)
 242 {
 243   gsize element_fixed_size;
 244
 245   g_variant_type_info_query_element (value.type_info, NULL,
 246                                      &element_fixed_size);
 247
 248   return (element_fixed_size == value.size) ? 1 : 0;
 249 }
 250
 251 static GVariantSerialised
 252 gvs_fixed_sized_maybe_get_child (GVariantSerialised value,
 253                                  gsize              index_)
 254 {
 255   /* the child has the same bounds as the
 256    * container, so just update the type.
 257    */
 258   value.type_info = g_variant_type_info_element (value.type_info);
 259   g_variant_type_info_ref (value.type_info);
 260
 261   return value;
 262 }
 263
 264 static gsize
 265 gvs_fixed_sized_maybe_needed_size (GVariantTypeInfo         *type_info,
 266                                    GVariantSerialisedFiller  gvs_filler,
 267                                    const gpointer           *children,
 268                                    gsize                     n_children)
 269 {
 270   if (n_children)
 271     {
 272       gsize element_fixed_size;
 273
 274       g_variant_type_info_query_element (type_info, NULL,
 275                                          &element_fixed_size);
 276
 277       return element_fixed_size;
 278     }
 279   else
 280     return 0;
 281 }
 282
 283 static void
 284 gvs_fixed_sized_maybe_serialise (GVariantSerialised        value,
 285                                  GVariantSerialisedFiller  gvs_filler,
 286                                  const gpointer           *children,
 287                                  gsize                     n_children)
 288 {
 289   if (n_children)
 290     {
 291       GVariantSerialised child = { NULL, value.data, value.size };
 292
 293       gvs_filler (&child, children[0]);
 294     }
 295 }
 296
 297 static gboolean
 298 gvs_fixed_sized_maybe_is_normal (GVariantSerialised value)
 299 {
 300   if (value.size > 0)
 301     {
 302       gsize element_fixed_size;
 303
 304       g_variant_type_info_query_element (value.type_info,
 305                                          NULL, &element_fixed_size);
 306
 307       if (value.size != element_fixed_size)
 308         return FALSE;
 309
 310       /* proper element size: "Just".  recurse to the child. */
 311       value.type_info = g_variant_type_info_element (value.type_info);
 312
 313       return g_variant_serialised_is_normal (value);
 314     }
 315
 316   /* size of 0: "Nothing" */
 317   return TRUE;
 318 }
 319
 320 /* Variable-sized Maybe
 321  *
 322  * The size of a maybe value with a variable-sized element type is
 323  * either 0 or strictly greater than 0.  The case where the size of the
 324  * maybe value is zero corresponds to the "Nothing" case and the case
 325  * where the size of the maybe value is greater than zero corresponds to
 326  * the "Just" case; in that case, the serialised data of the child value
 327  * forms the first part of the serialised data of the maybe value and is
 328  * followed by a single zero byte.  This zero byte is always appended,
 329  * regardless of any zero bytes that may already be at the end of the
 330  * serialised ata of the child value.
 331  */
 332
 333 static gsize
 334 gvs_variable_sized_maybe_n_children (GVariantSerialised value)
 335 {
 336   return (value.size > 0) ? 1 : 0;
 337 }
 338
 339 static GVariantSerialised
 340 gvs_variable_sized_maybe_get_child (GVariantSerialised value,
 341                                     gsize              index_)
 342 {
 343   /* remove the padding byte and update the type. */
 344   value.type_info = g_variant_type_info_element (value.type_info);
 345   g_variant_type_info_ref (value.type_info);
 346   value.size--;
 347
 348   /* if it's zero-sized then it may as well be NULL */
 349   if (value.size == 0)
 350     value.data = NULL;
 351
 352   return value;
 353 }
 354
 355 static gsize
 356 gvs_variable_sized_maybe_needed_size (GVariantTypeInfo         *type_info,
 357                                       GVariantSerialisedFiller  gvs_filler,
 358                                       const gpointer           *children,
 359                                       gsize                     n_children)
 360 {
 361   if (n_children)
 362     {
 363       GVariantSerialised child = { 0, };
 364
 365       gvs_filler (&child, children[0]);
 366
 367       return child.size + 1;
 368     }
 369   else
 370     return 0;
 371 }
 372
 373 static void
 374 gvs_variable_sized_maybe_serialise (GVariantSerialised        value,
 375                                     GVariantSerialisedFiller  gvs_filler,
 376                                     const gpointer           *children,
 377                                     gsize                     n_children)
 378 {
 379   if (n_children)
 380     {
 381       GVariantSerialised child = { NULL, value.data, value.size - 1 };
 382
 383       /* write the data for the child.  */
 384       gvs_filler (&child, children[0]);
 385       value.data[child.size] = '\0';
 386     }
 387 }
 388
 389 static gboolean
 390 gvs_variable_sized_maybe_is_normal (GVariantSerialised value)
 391 {
 392   if (value.size == 0)
 393     return TRUE;
 394
 395   if (value.data[value.size - 1] != '\0')
 396     return FALSE;
 397
 398   value.type_info = g_variant_type_info_element (value.type_info);
 399   value.size--;
 400
 401   return g_variant_serialised_is_normal (value);
 402 }
 403
 404 /* Arrays {{{2
 405  *
 406  * Just as with maybe types, array types are handled depending on if the
 407  * element type of the array type is a fixed-sized or variable-sized
 408  * type.  Similar to maybe types, for convenience, an array value with a
 409  * fixed-sized element type is called a "fixed-sized array" and an array
 410  * value with a variable-sized element type is called a "variable sized
 411  * array".
 412  */
 413
 414 /* Fixed-sized Array {{{3
 415  *
 416  * For fixed sized arrays, the serialised data is simply a concatenation
 417  * of the serialised data of each element, in order.  Since fixed-sized
 418  * values always have a fixed size that is a multiple of their alignment
 419  * requirement no extra padding is required.
 420  *
 421  * In the event that a fixed-sized array is presented with a size that
 422  * is not an integer multiple of the element size then the value of the
 423  * array must be taken as being empty.
 424  */
 425
 426 static gsize
 427 gvs_fixed_sized_array_n_children (GVariantSerialised value)
 428 {
 429   gsize element_fixed_size;
 430
 431   g_variant_type_info_query_element (value.type_info, NULL,
 432                                      &element_fixed_size);
 433
 434   if (value.size % element_fixed_size == 0)
 435     return value.size / element_fixed_size;
 436
 437   return 0;
 438 }
 439
 440 static GVariantSerialised
 441 gvs_fixed_sized_array_get_child (GVariantSerialised value,
 442                                  gsize              index_)
 443 {
 444   GVariantSerialised child = { 0, };
 445
 446   child.type_info = g_variant_type_info_element (value.type_info);
 447   g_variant_type_info_query (child.type_info, NULL, &child.size);
 448   child.data = value.data + (child.size * index_);
 449   g_variant_type_info_ref (child.type_info);
 450
 451   return child;
 452 }
 453
 454 static gsize
 455 gvs_fixed_sized_array_needed_size (GVariantTypeInfo         *type_info,
 456                                    GVariantSerialisedFiller  gvs_filler,
 457                                    const gpointer           *children,
 458                                    gsize                     n_children)
 459 {
 460   gsize element_fixed_size;
 461
 462   g_variant_type_info_query_element (type_info, NULL, &element_fixed_size);
 463
 464   return element_fixed_size * n_children;
 465 }
 466
 467 static void
 468 gvs_fixed_sized_array_serialise (GVariantSerialised        value,
 469                                  GVariantSerialisedFiller  gvs_filler,
 470                                  const gpointer           *children,
 471                                  gsize                     n_children)
 472 {
 473   GVariantSerialised child = { 0, };
 474   gsize i;
 475
 476   child.type_info = g_variant_type_info_element (value.type_info);
 477   g_variant_type_info_query (child.type_info, NULL, &child.size);
 478   child.data = value.data;
 479
 480   for (i = 0; i < n_children; i++)
 481     {
 482       gvs_filler (&child, children[i]);
 483       child.data += child.size;
 484     }
 485 }
 486
 487 static gboolean
 488 gvs_fixed_sized_array_is_normal (GVariantSerialised value)
 489 {
 490   GVariantSerialised child = { 0, };
 491
 492   child.type_info = g_variant_type_info_element (value.type_info);
 493   g_variant_type_info_query (child.type_info, NULL, &child.size);
 494
 495   if (value.size % child.size != 0)
 496     return FALSE;
 497
 498   for (child.data = value.data;
 499        child.data < value.data + value.size;
 500        child.data += child.size)
 501     {
 502       if (!g_variant_serialised_is_normal (child))
 503         return FALSE;
 504     }
 505
 506   return TRUE;
 507 }
 508
 509 /* Variable-sized Array {{{3
 510  *
 511  * Variable sized arrays, containing variable-sized elements, must be
 512  * able to determine the boundaries between the elements.  The items
 513  * cannot simply be concatenated.  Additionally, we are faced with the
 514  * fact that non-fixed-sized values do not necessarily have a size that
 515  * is a multiple of their alignment requirement, so we may need to
 516  * insert zero-filled padding.
 517  *
 518  * While it is possible to find the start of an item by starting from
 519  * the end of the item before it and padding for alignment, it is not
 520  * generally possible to do the reverse operation.  For this reason, we
 521  * record the end point of each element in the array.
 522  *
 523  * GVariant works in terms of "offsets".  An offset is a pointer to a
 524  * boundary between two bytes.  In 4 bytes of serialised data, there
 525  * would be 5 possible offsets: one at the start ('0'), one between each
 526  * pair of adjacent bytes ('1', '2', '3') and one at the end ('4').
 527  *
 528  * The numeric value of an offset is an unsigned integer given relative
 529  * to the start of the serialised data of the array.  Offsets are always
 530  * stored in little endian byte order and are always only as big as they
 531  * need to be.  For example, in 255 bytes of serialised data, there are
 532  * 256 offsets.  All possibilities can be stored in an 8 bit unsigned
 533  * integer.  In 256 bytes of serialised data, however, there are 257
 534  * possible offsets so 16 bit integers must be used.  The size of an
 535  * offset is always a power of 2.
 536  *
 537  * The offsets are stored at the end of the serialised data of the
 538  * array.  They are simply concatenated on without any particular
 539  * alignment.  The size of the offsets is included in the size of the
 540  * serialised data for purposes of determining the size of the offsets.
 541  * This presents a possibly ambiguity; in certain cases, a particular
 542  * value of array could have two different serialised forms.
 543  *
 544  * Imagine an array containing a single string of 253 bytes in length
 545  * (so, 254 bytes including the nul terminator).  Now the offset must be
 546  * written.  If an 8 bit offset is written, it will bring the size of
 547  * the array's serialised data to 255 -- which means that the use of an
 548  * 8 bit offset was valid.  If a 16 bit offset is used then the total
 549  * size of the array will be 256 -- which means that the use of a 16 bit
 550  * offset was valid.  Although both of these will be accepted by the
 551  * deserialiser, only the smaller of the two is considered to be in
 552  * normal form and that is the one that the serialiser must produce.
 553  */
 554
 555 static inline gsize
 556 gvs_read_unaligned_le (guchar *bytes,
 557                        guint   size)
 558 {
 559   union
 560   {
 561     guchar bytes[GLIB_SIZEOF_SIZE_T];
 562     gsize integer;
 563   } tmpvalue;
 564
 565   tmpvalue.integer = 0;
 566   memcpy (&tmpvalue.bytes, bytes, size);
 567
 568   return GSIZE_FROM_LE (tmpvalue.integer);
 569 }
 570
 571 static inline void
 572 gvs_write_unaligned_le (guchar *bytes,
 573                         gsize   value,
 574                         guint   size)
 575 {
 576   union
 577   {
 578     guchar bytes[GLIB_SIZEOF_SIZE_T];
 579     gsize integer;
 580   } tmpvalue;
 581
 582   tmpvalue.integer = GSIZE_TO_LE (value);
 583   memcpy (bytes, &tmpvalue.bytes, size);
 584 }
 585
 586 static guint
 587 gvs_get_offset_size (gsize size)
 588 {
 589   if (size > G_MAXUINT32)
 590     return 8;
 591
 592   else if (size > G_MAXUINT16)
 593     return 4;
 594
 595   else if (size > G_MAXUINT8)
 596     return 2;
 597
 598   else if (size > 0)
 599     return 1;
 600
 601   return 0;
 602 }
 603
 604 static gsize
 605 gvs_calculate_total_size (gsize body_size,
 606                           gsize offsets)
 607 {
 608   if (body_size + 1 * offsets <= G_MAXUINT8)
 609     return body_size + 1 * offsets;
 610
 611   if (body_size + 2 * offsets <= G_MAXUINT16)
 612     return body_size + 2 * offsets;
 613
 614   if (body_size + 4 * offsets <= G_MAXUINT32)
 615     return body_size + 4 * offsets;
 616
 617   return body_size + 8 * offsets;
 618 }
 619
 620 static gsize
 621 gvs_variable_sized_array_n_children (GVariantSerialised value)
 622 {
 623   gsize offsets_array_size;
 624   gsize offset_size;
 625   gsize last_end;
 626
 627   if (value.size == 0)
 628     return 0;
 629
 630   offset_size = gvs_get_offset_size (value.size);
 631
 632   last_end = gvs_read_unaligned_le (value.data + value.size -
 633                                     offset_size, offset_size);
 634
 635   if (last_end > value.size)
 636     return 0;
 637
 638   offsets_array_size = value.size - last_end;
 639
 640   if (offsets_array_size % offset_size)
 641     return 0;
 642
 643   return offsets_array_size / offset_size;
 644 }
 645
 646 static GVariantSerialised
 647 gvs_variable_sized_array_get_child (GVariantSerialised value,
 648                                     gsize              index_)
 649 {
 650   GVariantSerialised child = { 0, };
 651   gsize offset_size;
 652   gsize last_end;
 653   gsize start;
 654   gsize end;
 655
 656   child.type_info = g_variant_type_info_element (value.type_info);
 657   g_variant_type_info_ref (child.type_info);
 658
 659   offset_size = gvs_get_offset_size (value.size);
 660
 661   last_end = gvs_read_unaligned_le (value.data + value.size -
 662                                     offset_size, offset_size);
 663
 664   if (index_ > 0)
 665     {
 666       guint alignment;
 667
 668       start = gvs_read_unaligned_le (value.data + last_end +
 669                                      (offset_size * (index_ - 1)),
 670                                      offset_size);
 671
 672       g_variant_type_info_query (child.type_info, &alignment, NULL);
 673       start += (-start) & alignment;
 674     }
 675   else
 676     start = 0;
 677
 678   end = gvs_read_unaligned_le (value.data + last_end +
 679                                (offset_size * index_),
 680                                offset_size);
 681
 682   if (start < end && end <= value.size)
 683     {
 684       child.data = value.data + start;
 685       child.size = end - start;
 686     }
 687
 688   return child;
 689 }
 690
 691 static gsize
 692 gvs_variable_sized_array_needed_size (GVariantTypeInfo         *type_info,
 693                                       GVariantSerialisedFiller  gvs_filler,
 694                                       const gpointer           *children,
 695                                       gsize                     n_children)
 696 {
 697   guint alignment;
 698   gsize offset;
 699   gsize i;
 700
 701   g_variant_type_info_query (type_info, &alignment, NULL);
 702   offset = 0;
 703
 704   for (i = 0; i < n_children; i++)
 705     {
 706       GVariantSerialised child = { 0, };
 707
 708       offset += (-offset) & alignment;
 709       gvs_filler (&child, children[i]);
 710       offset += child.size;
 711     }
 712
 713   return gvs_calculate_total_size (offset, n_children);
 714 }
 715
 716 static void
 717 gvs_variable_sized_array_serialise (GVariantSerialised        value,
 718                                     GVariantSerialisedFiller  gvs_filler,
 719                                     const gpointer           *children,
 720                                     gsize                     n_children)
 721 {
 722   guchar *offset_ptr;
 723   gsize offset_size;
 724   guint alignment;
 725   gsize offset;
 726   gsize i;
 727
 728   g_variant_type_info_query (value.type_info, &alignment, NULL);
 729   offset_size = gvs_get_offset_size (value.size);
 730   offset = 0;
 731
 732   offset_ptr = value.data + value.size - offset_size * n_children;
 733
 734   for (i = 0; i < n_children; i++)
 735     {
 736       GVariantSerialised child = { 0, };
 737
 738       while (offset & alignment)
 739         value.data[offset++] = '\0';
 740
 741       child.data = value.data + offset;
 742       gvs_filler (&child, children[i]);
 743       offset += child.size;
 744
 745       gvs_write_unaligned_le (offset_ptr, offset, offset_size);
 746       offset_ptr += offset_size;
 747     }
 748 }
 749
 750 static gboolean
 751 gvs_variable_sized_array_is_normal (GVariantSerialised value)
 752 {
 753   GVariantSerialised child = { 0, };
 754   gsize offsets_array_size;
 755   guchar *offsets_array;
 756   guint offset_size;
 757   guint alignment;
 758   gsize last_end;
 759   gsize length;
 760   gsize offset;
 761   gsize i;
 762
 763   if (value.size == 0)
 764     return TRUE;
 765
 766   offset_size = gvs_get_offset_size (value.size);
 767   last_end = gvs_read_unaligned_le (value.data + value.size -
 768                                     offset_size, offset_size);
 769
 770   if (last_end > value.size)
 771     return FALSE;
 772
 773   offsets_array_size = value.size - last_end;
 774
 775   if (offsets_array_size % offset_size)
 776     return FALSE;
 777
 778   offsets_array = value.data + value.size - offsets_array_size;
 779   length = offsets_array_size / offset_size;
 780
 781   if (length == 0)
 782     return FALSE;
 783
 784   child.type_info = g_variant_type_info_element (value.type_info);
 785   g_variant_type_info_query (child.type_info, &alignment, NULL);
 786   offset = 0;
 787
 788   for (i = 0; i < length; i++)
 789     {
 790       gsize this_end;
 791
 792       this_end = gvs_read_unaligned_le (offsets_array + offset_size * i,
 793                                         offset_size);
 794
 795       if (this_end < offset || this_end > last_end)
 796         return FALSE;
 797
 798       while (offset & alignment)
 799         {
 800           if (!(offset < this_end && value.data[offset] == '\0'))
 801             return FALSE;
 802           offset++;
 803         }
 804
 805       child.data = value.data + offset;
 806       child.size = this_end - offset;
 807
 808       if (child.size == 0)
 809         child.data = NULL;
 810
 811       if (!g_variant_serialised_is_normal (child))
 812         return FALSE;
 813
 814       offset = this_end;
 815     }
 816
 817   g_assert (offset == last_end);
 818
 819   return TRUE;
 820 }
 821
 822 /* Tuples {{{2
 823  *
 824  * Since tuples can contain a mix of variable- and fixed-sized items,
 825  * they are, in terms of serialisation, a hybrid of variable-sized and
 826  * fixed-sized arrays.
 827  *
 828  * Offsets are only stored for variable-sized items.  Also, since the
 829  * number of items in a tuple is known from its type, we are able to
 830  * know exactly how many offsets to expect in the serialised data (and
 831  * therefore how much space is taken up by the offset array).  This
 832  * means that we know where the end of the serialised data for the last
 833  * item is -- we can just subtract the size of the offset array from the
 834  * total size of the tuple.  For this reason, the last item in the tuple
 835  * doesn't need an offset stored.
 836  *
 837  * Tuple offsets are stored in reverse.  This design choice allows
 838  * iterator-based deserialisers to be more efficient.
 839  *
 840  * Most of the "heavy lifting" here is handled by the GVariantTypeInfo
 841  * for the tuple.  See the notes in gvarianttypeinfo.h.
 842  */
 843
 844 static gsize
 845 gvs_tuple_n_children (GVariantSerialised value)
 846 {
 847   return g_variant_type_info_n_members (value.type_info);
 848 }
 849
 850 static GVariantSerialised
 851 gvs_tuple_get_child (GVariantSerialised value,
 852                      gsize              index_)
 853 {
 854   const GVariantMemberInfo *member_info;
 855   GVariantSerialised child = { 0, };
 856   gsize offset_size;
 857   gsize start, end;
 858
 859   member_info = g_variant_type_info_member_info (value.type_info, index_);
 860   child.type_info = g_variant_type_info_ref (member_info->type_info);
 861   offset_size = gvs_get_offset_size (value.size);
 862
 863   /* tuples are the only (potentially) fixed-sized containers, so the
 864    * only ones that have to deal with the possibility of having %NULL
 865    * data with a non-zero %size if errors occurred elsewhere.
 866    */
 867   if G_UNLIKELY (value.data == NULL && value.size != 0)
 868     {
 869       g_variant_type_info_query (child.type_info, NULL, &child.size);
 870
 871       /* this can only happen in fixed-sized tuples,
 872        * so the child must also be fixed sized.
 873        */
 874       g_assert (child.size != 0);
 875       child.data = NULL;
 876
 877       return child;
 878     }
 879
 880   if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_OFFSET)
 881     {
 882       if (offset_size * (member_info->i + 2) > value.size)
 883         return child;
 884     }
 885   else
 886     {
 887       if (offset_size * (member_info->i + 1) > value.size)
 888         {
 889           /* if the child is fixed size, return its size.
 890            * if child is not fixed-sized, return size = 0.
 891            */
 892           g_variant_type_info_query (child.type_info, NULL, &child.size);
 893
 894           return child;
 895         }
 896     }
 897
 898   if (member_info->i + 1)
 899     start = gvs_read_unaligned_le (value.data + value.size -
 900                                    offset_size * (member_info->i + 1),
 901                                    offset_size);
 902   else
 903     start = 0;
 904
 905   start += member_info->a;
 906   start &= member_info->b;
 907   start |= member_info->c;
 908
 909   if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_LAST)
 910     end = value.size - offset_size * (member_info->i + 1);
 911
 912   else if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_FIXED)
 913     {
 914       gsize fixed_size;
 915
 916       g_variant_type_info_query (child.type_info, NULL, &fixed_size);
 917       end = start + fixed_size;
 918       child.size = fixed_size;
 919     }
 920
 921   else /* G_VARIANT_MEMEBER_ENDING_OFFSET */
 922     end = gvs_read_unaligned_le (value.data + value.size -
 923                                  offset_size * (member_info->i + 2),
 924                                  offset_size);
 925
 926   if (start < end && end <= value.size)
 927     {
 928       child.data = value.data + start;
 929       child.size = end - start;
 930     }
 931
 932   return child;
 933 }
 934
 935 static gsize
 936 gvs_tuple_needed_size (GVariantTypeInfo         *type_info,
 937                        GVariantSerialisedFiller  gvs_filler,
 938                        const gpointer           *children,
 939                        gsize                     n_children)
 940 {
 941   const GVariantMemberInfo *member_info = NULL;
 942   gsize fixed_size;
 943   gsize offset;
 944   gsize i;
 945
 946   g_variant_type_info_query (type_info, NULL, &fixed_size);
 947
 948   if (fixed_size)
 949     return fixed_size;
 950
 951   offset = 0;
 952
 953   for (i = 0; i < n_children; i++)
 954     {
 955       guint alignment;
 956
 957       member_info = g_variant_type_info_member_info (type_info, i);
 958       g_variant_type_info_query (member_info->type_info,
 959                                  &alignment, &fixed_size);
 960       offset += (-offset) & alignment;
 961
 962       if (fixed_size)
 963         offset += fixed_size;
 964       else
 965         {
 966           GVariantSerialised child = { 0, };
 967
 968           gvs_filler (&child, children[i]);
 969           offset += child.size;
 970         }
 971     }
 972
 973   return gvs_calculate_total_size (offset, member_info->i + 1);
 974 }
 975
 976 static void
 977 gvs_tuple_serialise (GVariantSerialised        value,
 978                      GVariantSerialisedFiller  gvs_filler,
 979                      const gpointer           *children,
 980                      gsize                     n_children)
 981 {
 982   gsize offset_size;
 983   gsize offset;
 984   gsize i;
 985
 986   offset_size = gvs_get_offset_size (value.size);
 987   offset = 0;
 988
 989   for (i = 0; i < n_children; i++)
 990     {
 991       const GVariantMemberInfo *member_info;
 992       GVariantSerialised child = { 0, };
 993       guint alignment;
 994
 995       member_info = g_variant_type_info_member_info (value.type_info, i);
 996       g_variant_type_info_query (member_info->type_info, &alignment, NULL);
 997
 998       while (offset & alignment)
 999         value.data[offset++] = '\0';
1000
1001       child.data = value.data + offset;
1002       gvs_filler (&child, children[i]);
1003       offset += child.size;
1004
1005       if (member_info->ending_type == G_VARIANT_MEMBER_ENDING_OFFSET)
1006         {
1007           value.size -= offset_size;
1008           gvs_write_unaligned_le (value.data + value.size,
1009                                   offset, offset_size);
1010         }
1011     }
1012
1013   while (offset < value.size)
1014     value.data[offset++] = '\0';
1015 }
1016
1017 static gboolean
1018 gvs_tuple_is_normal (GVariantSerialised value)
1019 {
1020   guint offset_size;
1021   gsize offset_ptr;
1022   gsize length;
1023   gsize offset;
1024   gsize i;
1025
1026   offset_size = gvs_get_offset_size (value.size);
1027   length = g_variant_type_info_n_members (value.type_info);
1028   offset_ptr = value.size;
1029   offset = 0;
1030
1031   for (i = 0; i < length; i++)
1032     {
1033       const GVariantMemberInfo *member_info;
1034       GVariantSerialised child;
1035       gsize fixed_size;
1036       guint alignment;
1037       gsize end;
1038
1039       member_info = g_variant_type_info_member_info (value.type_info, i);
1040       child.type_info = member_info->type_info;
1041
1042       g_variant_type_info_query (child.type_info, &alignment, &fixed_size);
1043
1044       while (offset & alignment)
1045         {
1046           if (offset > value.size || value.data[offset] != '\0')
1047             return FALSE;
1048           offset++;
1049         }
1050
1051       child.data = value.data + offset;
1052
1053       switch (member_info->ending_type)
1054         {
1055         case G_VARIANT_MEMBER_ENDING_FIXED:
1056           end = offset + fixed_size;
1057           break;
1058
1059         case G_VARIANT_MEMBER_ENDING_LAST:
1060           end = offset_ptr;
1061           break;
1062
1063         case G_VARIANT_MEMBER_ENDING_OFFSET:
1064           offset_ptr -= offset_size;
1065
1066           if (offset_ptr < offset)
1067             return FALSE;
1068
1069           end = gvs_read_unaligned_le (value.data + offset_ptr, offset_size);
1070           break;
1071
1072         default:
1073           g_assert_not_reached ();
1074         }
1075
1076       if (end < offset || end > offset_ptr)
1077         return FALSE;
1078
1079       child.size = end - offset;
1080
1081       if (child.size == 0)
1082         child.data = NULL;
1083
1084       if (!g_variant_serialised_is_normal (child))
1085         return FALSE;
1086
1087       offset = end;
1088     }
1089
1090   {
1091     gsize fixed_size;
1092     guint alignment;
1093
1094     g_variant_type_info_query (value.type_info, &alignment, &fixed_size);
1095
1096     if (fixed_size)
1097       {
1098         g_assert (fixed_size == value.size);
1099         g_assert (offset_ptr == value.size);
1100
1101         if (i == 0)
1102           {
1103             if (value.data[offset++] != '\0')
1104               return FALSE;
1105           }
1106         else
1107           {
1108             while (offset & alignment)
1109               if (value.data[offset++] != '\0')
1110                 return FALSE;
1111           }
1112
1113         g_assert (offset == value.size);
1114       }
1115   }
1116
1117   return offset_ptr == offset;
1118 }
1119
1120 /* Variants {{{2
1121  *
1122  * Variants are stored by storing the serialised data of the child,
1123  * followed by a '\0' character, followed by the type string of the
1124  * child.
1125  *
1126  * In the case that a value is presented that contains no '\0'
1127  * character, or doesn't have a single well-formed definite type string
1128  * following that character, the variant must be taken as containing the
1129  * unit tuple: ().
1130  */
1131
1132 static inline gsize
1133 gvs_variant_n_children (GVariantSerialised value)
1134 {
1135   return 1;
1136 }
1137
1138 static inline GVariantSerialised
1139 gvs_variant_get_child (GVariantSerialised value,
1140                        gsize              index_)
1141 {
1142   GVariantSerialised child = { 0, };
1143
1144   /* NOTE: not O(1) and impossible for it to be... */
1145   if (value.size)
1146     {
1147       /* find '\0' character */
1148       for (child.size = value.size - 1; child.size; child.size--)
1149         if (value.data[child.size] == '\0')
1150           break;
1151
1152       /* ensure we didn't just hit the start of the string */
1153       if (value.data[child.size] == '\0')
1154         {
1155           const gchar *type_string = (gchar *) &value.data[child.size + 1];
1156           const gchar *limit = (gchar *) &value.data[value.size];
1157           const gchar *end;
1158
1159           if (g_variant_type_string_scan (type_string, limit, &end) &&
1160               end == limit)
1161             {
1162               const GVariantType *type = (GVariantType *) type_string;
1163
1164               if (g_variant_type_is_definite (type))
1165                 {
1166                   gsize fixed_size;
1167
1168                   child.type_info = g_variant_type_info_get (type);
1169
1170                   if (child.size != 0)
1171                     /* only set to non-%NULL if size > 0 */
1172                     child.data = value.data;
1173
1174                   g_variant_type_info_query (child.type_info,
1175                                              NULL, &fixed_size);
1176
1177                   if (!fixed_size || fixed_size == child.size)
1178                     return child;
1179
1180                   g_variant_type_info_unref (child.type_info);
1181                 }
1182             }
1183         }
1184     }
1185
1186   child.type_info = g_variant_type_info_get (G_VARIANT_TYPE_UNIT);
1187   child.data = NULL;
1188   child.size = 1;
1189
1190   return child;
1191 }
1192
1193 static inline gsize
1194 gvs_variant_needed_size (GVariantTypeInfo         *type_info,
1195                          GVariantSerialisedFiller  gvs_filler,
1196                          const gpointer           *children,
1197                          gsize                     n_children)
1198 {
1199   GVariantSerialised child = { 0, };
1200   const gchar *type_string;
1201
1202   gvs_filler (&child, children[0]);
1203   type_string = g_variant_type_info_get_type_string (child.type_info);
1204
1205   return child.size + 1 + strlen (type_string);
1206 }
1207
1208 static inline void
1209 gvs_variant_serialise (GVariantSerialised        value,
1210                        GVariantSerialisedFiller  gvs_filler,
1211                        const gpointer           *children,
1212                        gsize                     n_children)
1213 {
1214   GVariantSerialised child = { 0, };
1215   const gchar *type_string;
1216
1217   child.data = value.data;
1218
1219   gvs_filler (&child, children[0]);
1220   type_string = g_variant_type_info_get_type_string (child.type_info);
1221   value.data[child.size] = '\0';
1222   memcpy (value.data + child.size + 1, type_string, strlen (type_string));
1223 }
1224
1225 static inline gboolean
1226 gvs_variant_is_normal (GVariantSerialised value)
1227 {
1228   GVariantSerialised child;
1229   gboolean normal;
1230
1231   child = gvs_variant_get_child (value, 0);
1232
1233   normal = (child.data != NULL || child.size == 0) &&
1234            g_variant_serialised_is_normal (child);
1235
1236   g_variant_type_info_unref (child.type_info);
1237
1238   return normal;
1239 }
1240
1241
1242
1243 /* PART 2: Serialiser API {{{1
1244  *
1245  * This is the implementation of the API of the serialiser as advertised
1246  * in gvariant-serialiser.h.
1247  */
1248
1249 /* Dispatch Utilities {{{2
1250  *
1251  * These macros allow a given function (for example,
1252  * g_variant_serialiser_serialise) to be dispatched to the appropriate
1253  * type-specific function above (fixed/variable-sized maybe,
1254  * fixed/variable-sized array, tuple or variant).
1255  */
1256 #define DISPATCH_FIXED(type_info, before, after) \
1257   {                                                     \
1258     gsize fixed_size;                                   \
1259                                                         \
1260     g_variant_type_info_query_element (type_info, NULL, \
1261                                        &fixed_size);    \
1262                                                         \
1263     if (fixed_size)                                     \
1264       {                                                 \
1265         before ## fixed_sized ## after                  \
1266       }                                                 \
1267     else                                                \
1268       {                                                 \
1269         before ## variable_sized ## after               \
1270       }                                                 \
1271   }
1272
1273 #define DISPATCH_CASES(type_info, before, after) \
1274   switch (g_variant_type_info_get_type_char (type_info))        \
1275     {                                                           \
1276       case G_VARIANT_TYPE_INFO_CHAR_MAYBE:                      \
1277         DISPATCH_FIXED (type_info, before, _maybe ## after)     \
1278                                                                 \
1279       case G_VARIANT_TYPE_INFO_CHAR_ARRAY:                      \
1280         DISPATCH_FIXED (type_info, before, _array ## after)     \
1281                                                                 \
1282       case G_VARIANT_TYPE_INFO_CHAR_DICT_ENTRY:                 \
1283       case G_VARIANT_TYPE_INFO_CHAR_TUPLE:                      \
1284         {                                                       \
1285           before ## tuple ## after                              \
1286         }                                                       \
1287                                                                 \
1288       case G_VARIANT_TYPE_INFO_CHAR_VARIANT:                    \
1289         {                                                       \
1290           before ## variant ## after                            \
1291         }                                                       \
1292     }
1293
1294 /* Serialiser entry points {{{2
1295  *
1296  * These are the functions that are called in order for the serialiser
1297  * to do its thing.
1298  */
1299
1300 /* < private >
1301  * g_variant_serialised_n_children:
1302  * @serialised: a #GVariantSerialised
1303  * @returns: the number of children
1304  *
1305  * For serialised data that represents a container value (maybes,
1306  * tuples, arrays, variants), determine how many child items are inside
1307  * that container.
1308  */
1309 gsize
1310 g_variant_serialised_n_children (GVariantSerialised serialised)
1311 {
1312   g_variant_serialised_check (serialised);
1313
1314   DISPATCH_CASES (serialised.type_info,
1315
1316                   return gvs_/**/,/**/_n_children (serialised);
1317
1318                  )
1319   g_assert_not_reached ();
1320 }
1321
1322 /* < private >
1323  * g_variant_serialised_get_child:
1324  * @serialised: a #GVariantSerialised
1325  * @index_: the index of the child to fetch
1326  * @returns: a #GVariantSerialised for the child
1327  *
1328  * Extracts a child from a serialised data representing a container
1329  * value.
1330  *
1331  * It is an error to call this function with an index out of bounds.
1332  *
1333  * If the result .data == %NULL and .size > 0 then there has been an
1334  * error extracting the requested fixed-sized value.  This number of
1335  * zero bytes needs to be allocated instead.
1336  *
1337  * In the case that .data == %NULL and .size == 0 then a zero-sized
1338  * item of a variable-sized type is being returned.
1339  *
1340  * .data is never non-%NULL if size is 0.
1341  */
1342 GVariantSerialised
1343 g_variant_serialised_get_child (GVariantSerialised serialised,
1344                                 gsize              index_)
1345 {
1346   GVariantSerialised child;
1347
1348   g_variant_serialised_check (serialised);
1349
1350   if G_LIKELY (index_ < g_variant_serialised_n_children (serialised))
1351     {
1352       DISPATCH_CASES (serialised.type_info,
1353
1354                       child = gvs_/**/,/**/_get_child (serialised, index_);
1355                       g_assert (child.size || child.data == NULL);
1356                       g_variant_serialised_check (child);
1357                       return child;
1358
1359                      )
1360       g_assert_not_reached ();
1361     }
1362
1363   g_error ("Attempt to access item %"G_GSIZE_FORMAT
1364            " in a container with only %"G_GSIZE_FORMAT" items",
1365            index_, g_variant_serialised_n_children (serialised));
1366 }
1367
1368 /* < private >
1369  * g_variant_serialiser_serialise:
1370  * @serialised: a #GVariantSerialised, properly set up
1371  * @gvs_filler: the filler function
1372  * @children: an array of child items
1373  * @n_children: the size of @children
1374  *
1375  * Writes data in serialised form.
1376  *
1377  * The type_info field of @serialised must be filled in to type info for
1378  * the type that we are serialising.
1379  *
1380  * The size field of @serialised must be filled in with the value
1381  * returned by a previous call to g_variant_serialiser_needed_size().
1382  *
1383  * The data field of @serialised must be a pointer to a properly-aligned
1384  * memory region large enough to serialise into (ie: at least as big as
1385  * the size field).
1386  *
1387  * This function is only resonsible for serialising the top-level
1388  * container.  @gvs_filler is called on each child of the container in
1389  * order for all of the data of that child to be filled in.
1390  */
1391 void
1392 g_variant_serialiser_serialise (GVariantSerialised        serialised,
1393                                 GVariantSerialisedFiller  gvs_filler,
1394                                 const gpointer           *children,
1395                                 gsize                     n_children)
1396 {
1397   g_variant_serialised_check (serialised);
1398
1399   DISPATCH_CASES (serialised.type_info,
1400
1401                   gvs_/**/,/**/_serialise (serialised, gvs_filler,
1402                                            children, n_children);
1403                   return;
1404
1405                  )
1406   g_assert_not_reached ();
1407 }
1408
1409 /* < private >
1410  * g_variant_serialiser_needed_size:
1411  * @type_info: the type to serialise for
1412  * @gvs_filler: the filler function
1413  * @children: an array of child items
1414  * @n_children: the size of @children
1415  *
1416  * Determines how much memory would be needed to serialise this value.
1417  *
1418  * This function is only resonsible for performing calculations for the
1419  * top-level container.  @gvs_filler is called on each child of the
1420  * container in order to determine its size.
1421  */
1422 gsize
1423 g_variant_serialiser_needed_size (GVariantTypeInfo         *type_info,
1424                                   GVariantSerialisedFiller  gvs_filler,
1425                                   const gpointer           *children,
1426                                   gsize                     n_children)
1427 {
1428   DISPATCH_CASES (type_info,
1429
1430                   return gvs_/**/,/**/_needed_size (type_info, gvs_filler,
1431                                                     children, n_children);
1432
1433                  )
1434   g_assert_not_reached ();
1435 }
1436
1437 /* Byteswapping {{{2 */
1438
1439 /* < private >
1440  * g_variant_serialised_byteswap:
1441  * @value: a #GVariantSerialised
1442  *
1443  * Byte-swap serialised data.  The result of this function is only
1444  * well-defined if the data is in normal form.
1445  */
1446 void
1447 g_variant_serialised_byteswap (GVariantSerialised serialised)
1448 {
1449   gsize fixed_size;
1450   guint alignment;
1451
1452   g_variant_serialised_check (serialised);
1453
1454   if (!serialised.data)
1455     return;
1456
1457   /* the types we potentially need to byteswap are
1458    * exactly those with alignment requirements.
1459    */
1460   g_variant_type_info_query (serialised.type_info, &alignment, &fixed_size);
1461   if (!alignment)
1462     return;
1463
1464   /* if fixed size and alignment are equal then we are down
1465    * to the base integer type and we should swap it.  the
1466    * only exception to this is if we have a tuple with a
1467    * single item, and then swapping it will be OK anyway.
1468    */
1469   if (alignment + 1 == fixed_size)
1470     {
1471       switch (fixed_size)
1472       {
1473         case 2:
1474           {
1475             guint16 *ptr = (guint16 *) serialised.data;
1476
1477             g_assert_cmpint (serialised.size, ==, 2);
1478             *ptr = GUINT16_SWAP_LE_BE (*ptr);
1479           }
1480           return;
1481
1482         case 4:
1483           {
1484             guint32 *ptr = (guint32 *) serialised.data;
1485
1486             g_assert_cmpint (serialised.size, ==, 4);
1487             *ptr = GUINT32_SWAP_LE_BE (*ptr);
1488           }
1489           return;
1490
1491         case 8:
1492           {
1493             guint64 *ptr = (guint64 *) serialised.data;
1494
1495             g_assert_cmpint (serialised.size, ==, 8);
1496             *ptr = GUINT64_SWAP_LE_BE (*ptr);
1497           }
1498           return;
1499
1500         default:
1501           g_assert_not_reached ();
1502       }
1503     }
1504
1505   /* else, we have a container that potentially contains
1506    * some children that need to be byteswapped.
1507    */
1508   else
1509     {
1510       gsize children, i;
1511
1512       children = g_variant_serialised_n_children (serialised);
1513       for (i = 0; i < children; i++)
1514         {
1515           GVariantSerialised child;
1516
1517           child = g_variant_serialised_get_child (serialised, i);
1518           g_variant_serialised_byteswap (child);
1519           g_variant_type_info_unref (child.type_info);
1520         }
1521     }
1522 }
1523
1524 /* Normal form checking {{{2 */
1525
1526 /* < private >
1527  * g_variant_serialised_is_normal:
1528  * @serialised: a #GVariantSerialised
1529  *
1530  * Determines, recursively if @serialised is in normal form.  There is
1531  * precisely one normal form of serialised data for each possible value.
1532  *
1533  * It is possible that multiple byte sequences form the serialised data
1534  * for a given value if, for example, the padding bytes are filled in
1535  * with something other than zeros, but only one form is the normal
1536  * form.
1537  */
1538 gboolean
1539 g_variant_serialised_is_normal (GVariantSerialised serialised)
1540 {
1541   DISPATCH_CASES (serialised.type_info,
1542
1543                   return gvs_/**/,/**/_is_normal (serialised);
1544
1545                  )
1546
1547   if (serialised.data == NULL)
1548     return FALSE;
1549
1550   /* some hard-coded terminal cases */
1551   switch (g_variant_type_info_get_type_char (serialised.type_info))
1552     {
1553     case 'b': /* boolean */
1554       return serialised.data[0] < 2;
1555
1556     case 's': /* string */
1557       return g_variant_serialiser_is_string (serialised.data,
1558                                              serialised.size);
1559
1560     case 'o':
1561       return g_variant_serialiser_is_object_path (serialised.data,
1562                                                   serialised.size);
1563
1564     case 'g':
1565       return g_variant_serialiser_is_signature (serialised.data,
1566                                                 serialised.size);
1567
1568     default:
1569       /* all of the other types are fixed-sized numerical types for
1570        * which all possible values are valid (including various NaN
1571        * representations for floating point values).
1572        */
1573       return TRUE;
1574     }
1575 }
1576
1577 /* Validity-checking functions {{{2
1578  *
1579  * Checks if strings, object paths and signature strings are valid.
1580  */
1581
1582 /* < private >
1583  * g_variant_serialiser_is_string:
1584  * @data: a possible string
1585  * @size: the size of @data
1586  *
1587  * Ensures that @data is a valid string with a nul terminator at the end
1588  * and no nul bytes embedded.
1589  */
1590 gboolean
1591 g_variant_serialiser_is_string (gconstpointer data,
1592                                 gsize         size)
1593 {
1594   const gchar *end;
1595
1596   g_utf8_validate (data, size, &end);
1597
1598   return data == end - (size - 1);
1599 }
1600
1601 /* < private >
1602  * g_variant_serialiser_is_object_path:
1603  * @data: a possible D-Bus object path
1604  * @size: the size of @data
1605  *
1606  * Performs the checks for being a valid string.
1607  *
1608  * Also, ensures that @data is a valid DBus object path, as per the D-Bus
1609  * specification.
1610  */
1611 gboolean
1612 g_variant_serialiser_is_object_path (gconstpointer data,
1613                                      gsize         size)
1614 {
1615   const gchar *string = data;
1616   gsize i;
1617
1618   if (!g_variant_serialiser_is_string (data, size))
1619     return FALSE;
1620
1621   /* The path must begin with an ASCII '/' (integer 47) character */
1622   if (string[0] != '/')
1623     return FALSE;
1624
1625   for (i = 1; string[i]; i++)
1626     /* Each element must only contain the ASCII characters
1627      * "[A-Z][a-z][0-9]_"
1628      */
1629     if (g_ascii_isalnum (string[i]) || string[i] == '_')
1630       ;
1631
1632     /* must consist of elements separated by slash characters. */
1633     else if (string[i] == '/')
1634       {
1635         /* No element may be the empty string. */
1636         /* Multiple '/' characters cannot occur in sequence. */
1637         if (string[i - 1] == '/')
1638           return FALSE;
1639       }
1640
1641     else
1642       return FALSE;
1643
1644   /* A trailing '/' character is not allowed unless the path is the
1645    * root path (a single '/' character).
1646    */
1647   if (i > 1 && string[i - 1] == '/')
1648     return FALSE;
1649
1650   return TRUE;
1651 }
1652
1653 /* < private >
1654  * g_variant_serialiser_is_signature:
1655  * @data: a possible D-Bus signature
1656  * @size: the size of @data
1657  *
1658  * Performs the checks for being a valid string.
1659  *
1660  * Also, ensures that @data is a valid D-Bus type signature, as per the
1661  * D-Bus specification.
1662  */
1663 gboolean
1664 g_variant_serialiser_is_signature (gconstpointer data,
1665                                    gsize         size)
1666 {
1667   const gchar *string = data;
1668   gsize first_invalid;
1669
1670   if (!g_variant_serialiser_is_string (data, size))
1671     return FALSE;
1672
1673   /* make sure no non-definite characters appear */
1674   first_invalid = strspn (string, "ybnqiuxthdvasog(){}");
1675   if (string[first_invalid])
1676     return FALSE;
1677
1678   /* make sure each type string is well-formed */
1679   while (*string)
1680     if (!g_variant_type_string_scan (string, NULL, &string))
1681       return FALSE;
1682
1683   return TRUE;
1684 }
1685
1686 /* Epilogue {{{1 */
1687 /* vim:set foldmethod=marker: */