Bdtyk

When initializing a struct in C, we can allocate memory inside the main function or within another function and return a pointer to the newly created struct. This first example shows the latter; memory is allocated in Buffer_create and a pointer is returned:

#include <stdio.h>

#include "buffer.h"



int main(int argc, char *argv)

{

    struct Buffer *tx_buffer = Buffer_create(8);



    Buffer_destroy(tx_buffer);



    return 0;

}

And this one shows how all memory allocations can be done within the main function:

#include <stdio.h>

#include "buffer.h"



int main(int argc, char *argv)

{    

    uint8_t *ptr_rx_buffer = malloc(sizeof(uint8_t)*8);

    struct Buffer *rx_buffer = malloc(sizeof(struct Buffer));

    Buffer2_create(rx_buffer, ptr_rx_buffer, 8);



    Buffer2_destroy(rx_buffer);



    return 0;

}

And here are the contents of the header file buffer.h:

#ifndef _buffer_h

#define _buffer_h



#include <stdint.h>

#include <stdlib.h>



struct Buffer {

    uint8_t *buffer;

    size_t size;

};



struct Buffer *Buffer_create(size_t size);



void Buffer_destroy(struct Buffer *who);



void Buffer2_create(struct Buffer *who, uint8_t *buffer, size_t size);



void Buffer2_destroy(struct Buffer *who);



#endif

And buffer.c:

#include <stdint.h>

#include <assert.h>

#include <stdlib.h>

#include "buffer.h"



struct Buffer *Buffer_create(size_t size)

{

    struct Buffer *who = malloc(sizeof(struct Buffer));

    assert(who != NULL);



    who->buffer = malloc(sizeof(uint8_t)*size);

    who->size = size;



    return who;

}



void Buffer_destroy(struct Buffer *who)

{

    assert(who != NULL);

    free(who->buffer);

    free(who);

}



void Buffer2_create(struct Buffer *who, uint8_t *buffer, size_t size)

{

    assert(who != NULL);



    who->buffer = buffer;

    who->size = size;

}



void Buffer2_destroy(struct Buffer *who)

{

    assert(who != NULL);

    free(who->buffer);

    free(who);

}

The Result

Both approaches work and the executable files for both end up being the same size.

My Question

Will either of these approaches result in memory leaks or poor performance?

Looking at the performance, the two versions should perform just about identically. The second version has one less call/return, which can save a couple of CPU cycles, but if you have it multiple places in your code the additional code bytes and cache misses can overshadow that. Either way you probably won't notice a difference.

Looking at readability and maintainability, the first version is much better. You know at a glance what it is doing (rather than looking at several lines to figure it all out), you won't forget any important steps, and error checking is much easier since most of it can be handled in one place (excepting the last check for successful creation of the buffer). Debugging can also be easier, since you can set a breakpoint on the creation or destruction functions if necessary.

In the first case, the caller is not given any control over allocation. This limits freedom and (therefore) performance: there is no control over the number of dynamic allocations or over which memory is used for what purpose, and there are limits on how the handle to the buffer can be stored (the returned pointer to Buffer must be kept around somehow, even if we would really just want to store the Buffer by value and avoid some unnecessary double-indirection).

In the second case, the caller does have control, but Buffer2_destroy makes a very limiting assumption about how the memory was allocated so in the end the caller still has no choice. Of course by looking into the implementation details, one could see that simply not calling Buffer2_destroy enables some freedom again, but this would probably be considered a hack. All in all this approach violates the guideline "allocate and free memory in the same module, at the same level of abstraction", and doesn't get much in return.

Practically what a user of some buffer may want to do is for example:

• Having the Buffer as a local variable but its data malloc-ed.


• Having the Buffer as a local variable and making its data refer to a local array.


• Save the Buffer into some other struct or array (by value, not a pointer to a Buffer which then points to the data).


• Using (part of) a static array as the data.


• Various other such combinations..


• Allocate both the buffer data and the instance of Buffer in the same allocation.

Which is why a common advice is, where possible, do not allocate or deallocate memory, use memory supplied by the caller. This applies especially to performance-sensitive settings, where "secret malloc" is not appreciated, and custom allocators are commonly used.