Initialize/reset struct to zero/null
Asked Answered
S

11

111
struct x {
    char a[10];
    char b[20];
    int i;
    char *c;
    char *d[10];
};

I am filling this struct and then using the values. On the next iteration, I want to reset all the fields to 0 or null before I start reusing it.

How can I do that? Can I use memset or I have to go through all the members and then do it individually?

Sulphurize answered 31/7, 2011 at 19:20 Comment(0)
V
131

Define a const static instance of the struct with the initial values and then simply assign this value to your variable whenever you want to reset it.

For example:

static const struct x EmptyStruct;

Here I am relying on static initialization to set my initial values, but you could use a struct initializer if you want different initial values.

Then, each time round the loop you can write:

myStructVariable = EmptyStruct;
Venery answered 31/7, 2011 at 19:22 Comment(20)
@David Heffernan: is this better than using memset if I only want to reset everything to 0??Sulphurize
@Sulphurize I'd prefer this approch myself. Using memset makes me feel dirty. I prefer to let the compiler worry about memory layout wherever possible. Strictly speaking such use of memset is non-portable but in practice I'd be astounded if you ever compiled your code anywhere that mattered. So, you can likely use memset safely if you prefer it.Venery
@hari, it is conceptually better, as you provide a default initialization values (something like a object factory pattern.)Assr
David Heffernan and @Diego Sevilla Thanks to both of you.Sulphurize
@David Heffernan: for my education, why you declared EmptyStruct as static const?Sulphurize
const so that it can't be modified. static is optional. If you want to link to it from other translation units then don't use static.Venery
Well, if the struct contains some floats, memset won't be much help to zero them.Mcfall
@Mcfall actually 0 bits equals 0.0 in all floating point representations I know.Venery
@David Heffernan See the C FAQ: c-faq.com/malloc/calloc.html ... "But it does not guarantee useful null pointer values (see section 5 of this list) or floating-point zero values".Mcfall
@Mcfall I know this. Note that my answer recommends not using memset. Note also the comment about where I point out the non-portability of using memset as a means to assign null values. My previous comment just points out the reality that 0 bits invariably does correspond to floating point zeros.Venery
@David Heffernan I am sorry I didn't take the time to carefully read the comments. Of course, you are completely correct.Mcfall
@David Heffernan: Also, I need to: EmptyStruct.a[0] = '\0'; EmptyStruct.b[0] = '\0'; EmptyStruct.i = 0; EmptyStruct.c = NULL; EmptyStruct.d = {0}; ---- and then use is later on, correcT?Sulphurize
write it like I did or EmptyStruct = { 0 } and all the fields will be initialised to null valuesVenery
Assignment of structure variables calls 'memcpy' internally.Thermophone
@Thermophone citation pleaseVenery
Works fine on C, but not on C++Sewer
@Devid : had an error while trying C++ version with g++. Complain about lack of constructor, or lack of implicit construction values. (Note : can't use a constructors, as I'm trying to write a code which compiles on both C & C++ compilers without modification)Sewer
@Sewer This question is about C.Venery
After reading your answer, I wasn't sure if it would work for structs with floating point members when the implementation is not IEEE-compliant, or for structs with pointers when the implementation has non-zero null pointers. But according to this other SO question, static initialization assigns to each type its correct zero no matter if its not all-bits-zero: #17013207 BTW, maybe you could edit your answer adding this clarification, so that it's more complete.Lombroso
@Lombroso I'd be very happy for you to edit the answer. Then when the edit got approved you would get credited.Venery
C
110

The way to do such a thing when you have modern C (C99) is to use a compound literal.

a = (const struct x){ 0 };

This is somewhat similar to David's solution, only that you don't have to worry to declare an the empty structure or whether to declare it static. If you use the const as I did, the compiler is free to allocate the compound literal statically in read-only storage if appropriate.

Cramp answered 31/7, 2011 at 20:12 Comment(13)
Does that create an instance of x on the stack to then copy it to a? For big structures/small stacks that could be a problem.Langill
Like all optimizations, this is completely compiler dependent, so you'd have to check what your compiler produces. "Usually" on modern compilers it doesn't, these can trace initializations very well and only do what is necessary, not more. (And don't think that such things are problems before you measure a real slow down. They usually aren't.)Cramp
With problem I meant stack overflow, thank you for your answer!Langill
What is so special about new notation that it is supported only by C99?Omland
@Trismegistos, I am not sure that I understand your question. Compound literals were introduced by C99, so compilers that only support ancient versions of the the standard, don't support that feature.Cramp
@JensGustedt Compound Literals is what I meant. I will google what it is exactly.Omland
The problem with this approach is, that it may give a 'missing initializer' warning for something like struct x { int prop[3]; }; struct x a = (const struct x){ 0 }; while the startic const struct x EMPTY_STUCT method does not.Horbal
"missing initializer" warnings are really bogus. The C standard prescribes exactly what has to happen than, and forsees the { 0 } as the default initializer. Switch that warning off, it is spurious false alarm.Cramp
Is the "const" really necessary? Surely the compiler could optimize it properly from the fact that it is a literal that is only used for this assignment.Selenite
If you're using GCC, you can even do *ptr = (typeof(*ptr)){};Togoland
@JensGustedt Does this typecasting really needed? Can't I write it like this? struct x a = (const){0};Wiliness
@Patrick, although the syntax is similar this is not a cast but a "compound literal". And you are mixing up initialization and assignment.Cramp
Can we do this for an array or matrix of struct?Azilian
J
69

Better than all above is ever to use Standard C specification for struct initialization:

struct StructType structVar = {0};

Here are all bits zero (ever).

Juneberry answered 31/7, 2011 at 19:30 Comment(7)
I don't think you can do that each time around a loop thoughVenery
This is indeed suppose to work. But unfortunately, gcc & g++ complain about it. gcc generates warnings, while g++ generate an error. I know that gcc & g++ are at fault on this (they are supposed to follow Standard C specification), but nonetheless, for good portability, it is mandatory to take such limitation in consideration.Sewer
@Sewer You can use {} in C++. The gcc devs seem unsure whether C++ is supposed to support {0} and I'm not familiar with that part of the standard myself.Interlocutress
@Matthew : Yes, actually, I ended up using memset(), because there were too many portability issues with {0} or {}. Not sure if the C & C++ standards are clear and in sync on this issue, but apparently, compilers are not.Sewer
will this work in such a case? struct StructType structVar = malloc (sizeof(StructType)); structVar ={0}Jin
I am curious, why is this not appropriate? x = malloc(sizeof(x)); memset(&x, 0, sizeof(x));Hereon
Combined with the accepted answer this method works well.Contravention
C
41

In C, it is a common idiom to zero out the memory for a struct using memset:

struct x myStruct;
memset(&myStruct, 0, sizeof(myStruct));

Technically speaking, I don't believe that this is portable because it assumes that the NULL pointer on a machine is represented by the integer value 0, but it's used widely because on most machines this is the case.

If you move from C to C++, be careful not to use this technique on every object. C++ only makes this legal on objects with no member functions and no inheritance.

Comradery answered 31/7, 2011 at 19:23 Comment(5)
The C standard states that NULL is always 0. If the machine is designed such that a predetermined invalid address is not literally 0, the compiler for that architecture must adjust during compilation.Crosstie
@KevinM Yes, the symbol "0" always correspond to the the NULL pointer even if it is all-zero; but there is nothing the compiler can do if you set the bits to zero using memset.Rochelle
"C++ only makes this legal on objects with no member functions and no inheritance." It's about whether the type is considered 'plain old data'. The criteria depend on the version of the C++ language.Bollay
@MaxBarraclough If I use this in C++ only for resetting structures, will it work?Amadis
@Amadis Very little hinges on whether you use the class keyword or struct. The only difference is the default access control level: private by default with class, public by default with struct. For the elaborate rules for what counts as 'plain old data', see stackoverflow.com/a/7189821Bollay
B
24

If you have a C99 compliant compiler, you can use

mystruct = (struct x){0};

otherwise you should do what David Heffernan wrote, i.e. declare:

struct x empty = {0};

And in the loop:

mystruct = empty;
Biophysics answered 31/7, 2011 at 20:18 Comment(0)
A
8

You can use memset with the size of the struct:

struct x x_instance;
memset (&x_instance, 0, sizeof(x_instance));
Assr answered 31/7, 2011 at 19:22 Comment(7)
I don't think the cast is necessary here. Is it?Comradery
Well, I'm so used to C++ that... well, it will work also in C++, so I don't see it as a burden.Assr
Yeah, I wasn't specific enough. It's any pointer to cv qualified T can be converted to cv qualified void*. Any data pointer, function pointers are a different matter altogether. Kudos @KevinShade
memset is an option, but when using it, you have to make sure that the memory written to is exactly the same size as the third parameter, that's why it's better to refer to the size of the actual object, not the size of the type you know it currently is. IOW memset (&x_instance, 0, sizeof(x_instance)); is a much better choice. BTW: the (void*) cast is superfluous in C++ too.Nephogram
(sorry I missed to look after the question, it's better now)Nephogram
I'm surprised no-one has pointed out that this isn't correct. C does not guarantee that NULL has a bit-representation of zero, and you shouldn't use memset/calloc/etc to assign null to pointers. softwareengineering.stackexchange.com/a/128447Bollay
Several compilers will generate a warning if you do not cast this. IMHO this warning is usefull to draw attention to this function call and make sure that your operands are correct. I even need to cast the return value in some compilers that warn that the return value is not used. To indicate that this is intentional, I have to write (void) memset(...). That is good to draw attention to function calls that return a success/fail value that was not taken into account.Roderick
B
2

I believe you can just assign the empty set ({}) to your variable.

struct x instance;

for(i = 0; i < n; i++) {
    instance = {};
    /* Do Calculations */
}
Brunella answered 27/5, 2017 at 23:49 Comment(1)
This is not valid C, not even C99. It needs to be a compound literal like in JensGustedt's answer above.Compass
K
2

I asked a compiler engineer at work about which option is better (memset vs {0}). Instead of giving my an opinion he pointed me to Compiler Explorer. It's interesting to see how all three options compile out:

https://godbolt.org/z/bPfKeG9Yh

Here's a preview of the code:

// Type your code here, or load an example.
#include "string.h"

struct MyStruct {
    int age;
    int sin;
    char *name;
    int cats;
    char something[64];
};

const struct MyStruct empty_struct = {0};

int test() {
    struct MyStruct blah = {0};
    memset(&blah, 0, sizeof(blah));
    blah = empty_struct;

    blah.age = 99;
    blah.sin = 123456789;
}

The compiler makes different decisions on how to zero memory depending on the member types of the struct. Try commenting out something for example or choosing a non-x86 target.

Kattiekatuscha answered 18/5, 2021 at 19:38 Comment(0)
F
0
 struct x myX;
 ...
 memset(&x, 0, sizeof(myX));
Fredi answered 31/7, 2011 at 19:23 Comment(1)
I think OP knows how to call memset, but rather the issue is whether or not doing so is wiseVenery
O
0

Memset with NULL is dangerous function.

For C++ better by this way for most simple data structures >>

template<class T>
void Null_MyType(T &obj)
{
    constexpr T o_null = T{};
    obj = o_null;
}
Opener answered 8/11, 2021 at 18:28 Comment(0)
S
-1

debugger screenshot

Take a surprise from gnu11!

typedef struct {
    uint8_t messType;
    uint8_t ax;  //axis
    uint32_t position;
    uint32_t velocity;
}TgotoData;

TgotoData tmpData = { 0 };

nothing is zero.

Sixteenmo answered 21/7, 2020 at 22:34 Comment(1)
This does not attempt to answer the question of "How can I reset all fields to 0"Confer

© 2022 - 2024 — McMap. All rights reserved.