C – serialization techniques

by

For each data structure, have a serialize_X function (where X is the struct name) which takes a pointer to an X and a pointer to an opaque buffer structure and calls the appropriate serializing functions. You should supply some primitives such as serialize_int which write to the buffer and update the output index.
The primitives will have to call something like reserve_space(N) where N is the number of bytes that are required before writing any data. reserve_space() will realloc the void* buffer to make it at least as big as it’s current size plus N bytes.
To make this possible, the buffer structure will need to contain a pointer to the actual data, the index to write the next byte to (output index) and the size that is allocated for the data.
With this system, all of your serialize_X functions should be pretty straightforward, for example:

struct X {
    int n, m;
    char *string;
}

void serialize_X(struct X *x, struct Buffer *output) {
    serialize_int(x->n, output);
    serialize_int(x->m, output);
    serialize_string(x->string, output);
}

And the framework code will be something like:

#define INITIAL_SIZE 32

struct Buffer {
    void *data;
    size_t next;
    size_t size;
}

struct Buffer *new_buffer() {
    struct Buffer *b = malloc(sizeof(Buffer));

    b->data = malloc(INITIAL_SIZE);
    b->size = INITIAL_SIZE;
    b->next = 0;
    
    return b;
}

void reserve_space(Buffer *b, size_t bytes) {
    if((b->next + bytes) > b->size) {
        /* double size to enforce O(lg N) reallocs */
        b->data = realloc(b->data, b->size * 2);
        b->size *= 2;
    }
}

From this, it should be pretty simple to implement all of the serialize_() functions you need.

EDIT:
For example:

void serialize_int(int x, Buffer *b) {
    /* assume int == long; how can this be done better? */
    x = htonl(x);

    reserve_space(b, sizeof(int));

    memcpy(((char *)b->data) + b->next, &x, sizeof(int));
    b->next += sizeof(int);
}

EDIT:
Also note that my code has some potential bugs. There is no provision for error handling and no function to free the Buffer after you’re done so you’ll have to do this yourself. I was just giving a demonstration of the basic architecture that I would use.

More Related Contents:

  1. Serialize Data Structures in C
  2. Convert Bytes to Int / uint in C
  3. Serialize double and float with C
  4. what the output of this code and why?
  5. why segmentation error in my program
  6. Passing values to macros by for loop
  7. (Why) is using an uninitialized variable undefined behavior?
  8. Length of array in function argument
  9. #define macro for debug printing in C?
  10. How to convert an int to string in C?
  11. Why are strlcpy and strlcat considered insecure?
  12. Why does the order of the loops affect performance when iterating over a 2D array?
  13. What does the scanf function return?
  14. Is accessing a global array outside its bound undefined behavior?
  15. Quick Way to Implement Dictionary in C
  16. Creating your own header file in C
  17. C How to “draw” a Binary Tree to the console [closed]
  18. Why is there no strtoi in stdlib.h?
  19. XmlSerializer – There was an error reflecting type
  20. Why does C# null-conditional operator not work with Unity serializable variables?
  21. scanf() variable length specifier
  22. C: how to break apart a multi digit number into separate variables?
  23. Errors using ternary operator in c
  24. Scanf/Printf double variable C
  25. How to wrap printf() into a function or macro?
  26. When an int is cast to a short and truncated, how is the new value determined?
  27. Executing code before main()
  28. In C, what’s the size of stdout buffer?
  29. Is conversion from unsigned to signed undefined?
  30. How to fgets() a specific line from a file in C?

Leave a Comment