NanoPB: Umgang mit wiederholten Feldern (Arrays) in C

Siehe auch: C++-Version: Umgang mit wiederholten Feldern/Arrays in C++

NanoPB ist eine codegrößenoptimierte Protocol-Buffers-Implementierung für Embedded-Systeme. Dieser Beitrag zeigt, wie man wiederholte Felder (Arrays) in C mit NanoPB behandelt.

Proto-Definition

Erstellen Sie zuerst eine .proto-Datei mit wiederholten Feldern:

repeated.proto

syntax = "proto3";

package example;

message RepeatedMessage {
  repeated uint32 values = 1;
  repeated float temperatures = 2;
}

syntax = "proto3";

package example;

message RepeatedMessage {
  repeated uint32 values = 1;
  repeated float temperatures = 2;
}

NanoPB-Code generieren

Generieren Sie den NanoPB-Code mit einer .options-Datei, um Array-Größen festzulegen:

Erstellen Sie repeated.options:

repeated.options

example.RepeatedMessage.values max_count:20
example.RepeatedMessage.temperatures max_count:10

example.RepeatedMessage.values max_count:20
example.RepeatedMessage.temperatures max_count:10

Dann generieren:

generate_nanopb_repeated.sh

protoc --nanopb_out=. repeated.proto

protoc --nanopb_out=. repeated.proto

Hierdurch werden repeated.pb.h und repeated.pb.c generiert.

C-Beispiel mit Arrays fester Größe

Hier ist ein vollständiges C-Beispiel mit Arrays fester Größe:

repeated_example.c

#include <stdio.h>
#include <stdint.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Buffer for encoded message
    uint8_t buffer[256];
    size_t message_length;
    
    // --- ENCODING ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    // Set repeated field values
    message.values[0] = 10;
    message.values[1] = 20;
    message.values[2] = 30;
    message.values_count = 3;  // Important: set count
    
    message.temperatures[0] = 20.5f;
    message.temperatures[1] = 21.0f;
    message.temperatures[2] = 21.5f;
    message.temperatures_count = 3;  // Important: set count
    
    // Create stream for encoding
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Encode the message
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Print hex dump of encoded data
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODING ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    
    // Create stream for decoding
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decode the message
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Print decoded values
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded.values_count);
    for (size_t i = 0; i < decoded.values_count; i++) {
        printf("%u ", (unsigned int)decoded.values[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded.temperatures_count);
    for (size_t i = 0; i < decoded.temperatures_count; i++) {
        printf("%.1f ", decoded.temperatures[i]);
    }
    printf("\n");
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Buffer for encoded message
    uint8_t buffer[256];
    size_t message_length;
    
    // --- ENCODING ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    // Set repeated field values
    message.values[0] = 10;
    message.values[1] = 20;
    message.values[2] = 30;
    message.values_count = 3;  // Important: set count
    
    message.temperatures[0] = 20.5f;
    message.temperatures[1] = 21.0f;
    message.temperatures[2] = 21.5f;
    message.temperatures_count = 3;  // Important: set count
    
    // Create stream for encoding
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Encode the message
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Print hex dump of encoded data
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DECODING ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    
    // Create stream for decoding
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Decode the message
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Print decoded values
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded.values_count);
    for (size_t i = 0; i < decoded.values_count; i++) {
        printf("%u ", (unsigned int)decoded.values[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded.temperatures_count);
    for (size_t i = 0; i < decoded.temperatures_count; i++) {
        printf("%.1f ", decoded.temperatures[i]);
    }
    printf("\n");
    
    return 0;
}

Kompilierbefehl

Kompilieren Sie das Beispiel mit NanoPB. NanoPB wird typischerweise verwendet, indem die Quelldateien direkt in Ihr Projekt eingebunden werden:

compile_repeated_example.sh

gcc -o repeated_example repeated_example.c repeated.pb.c pb_common.c pb_encode.c pb_decode.c -I.

gcc -o repeated_example repeated_example.c repeated.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Hinweis: NanoPB-Quelldateien (pb_common.c, pb_encode.c, pb_decode.c) müssen direkt mit Ihrem Projekt kompiliert werden. Sie können diese aus dem NanoPB GitHub-Repository beziehen.

Python-Testskript

Um die Kodierung zu überprüfen, können Sie die Python-Protobuf-Bibliothek verwenden:

test_repeated.py

import repeated_pb2

# Read the binary data
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Decode
msg = repeated_pb2.RepeatedMessage()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  values: {list(msg.values)}")
print(f"  temperatures: {list(msg.temperatures)}")

import repeated_pb2

# Read the binary data
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Decode
msg = repeated_pb2.RepeatedMessage()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  values: {list(msg.values)}")
print(f"  temperatures: {list(msg.temperatures)}")

Kompilieren Sie zuerst die Python-Protobuf-Definitionen:

compile_python_repeated.sh

protoc --python_out=. repeated.proto

protoc --python_out=. repeated.proto

Modifizieren Sie dann das C-Beispiel, um die kodierten Daten in eine Datei zu speichern:

save_encoded_repeated.c

// After encoding, add this:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// After encoding, add this:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Alternative: Callback-basierte wiederholte Felder

Für dynamische Array-Verarbeitung können Sie Callbacks verwenden. Erstellen Sie repeated_callback.options:

repeated_callback.options

# Use callback for dynamic arrays
msg.RepeatedMessage.values callback
msg.RepeatedMessage.temperatures callback

# Use callback for dynamic arrays
msg.RepeatedMessage.values callback
msg.RepeatedMessage.temperatures callback

Dann regenerieren Sie den Code und verwenden Sie diesen Ansatz:

repeated_callback_example.c

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

typedef struct {
    uint32_t* data;
    size_t size;
    size_t capacity;
} dynamic_uint32_array_t;

typedef struct {
    float* data;
    size_t size;
    size_t capacity;
} dynamic_float_array_t;

// Encoder callback for uint32 array
bool uint32_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_uint32_array_t* arr = (const dynamic_uint32_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        if (!pb_encode_varint(stream, arr->data[i]))
            return false;
    }
    
    return true;
}

// Decoder callback for uint32 array
bool uint32_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_uint32_array_t* arr = (dynamic_uint32_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Resize if needed
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        uint32_t* new_data = (uint32_t*)realloc(arr->data, new_capacity * sizeof(uint32_t));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    arr->data[arr->size++] = (uint32_t)value;
    return true;
}

// Encoder callback for float array
bool float_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_float_array_t* arr = (const dynamic_float_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        // Encode float as 4 bytes
        union { float f; uint32_t u; } u;
        u.f = arr->data[i];
        if (!pb_encode_varint(stream, u.u))
            return false;
    }
    
    return true;
}

// Decoder callback for float array
bool float_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_float_array_t* arr = (dynamic_float_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Resize if needed
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        float* new_data = (float*)realloc(arr->data, new_capacity * sizeof(float));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    union { float f; uint32_t u; } u;
    u.u = (uint32_t)value;
    arr->data[arr->size++] = u.f;
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    uint32_t values_data[] = {10, 20, 30};
    float temperatures_data[] = {20.5f, 21.0f, 21.5f};
    
    dynamic_uint32_array_t values = {values_data, 3, 3};
    dynamic_float_array_t temperatures = {temperatures_data, 3, 3};
    
    // --- ENCODING ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    message.values.funcs.encode = uint32_array_encode_callback;
    message.values.arg = &values;
    
    message.temperatures.funcs.encode = float_array_encode_callback;
    message.temperatures.arg = &temperatures;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // --- DECODING ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    dynamic_uint32_array_t decoded_values = {NULL, 0, 0};
    dynamic_float_array_t decoded_temperatures = {NULL, 0, 0};
    
    decoded.values.funcs.decode = uint32_array_decode_callback;
    decoded.values.arg = &decoded_values;
    
    decoded.temperatures.funcs.decode = float_array_decode_callback;
    decoded.temperatures.arg = &decoded_temperatures;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded_values.size);
    for (size_t i = 0; i < decoded_values.size; i++) {
        printf("%u ", decoded_values.data[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded_temperatures.size);
    for (size_t i = 0; i < decoded_temperatures.size; i++) {
        printf("%.1f ", decoded_temperatures.data[i]);
    }
    printf("\n");
    
    // Free allocated memory
    free(decoded_values.data);
    free(decoded_temperatures.data);
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

typedef struct {
    uint32_t* data;
    size_t size;
    size_t capacity;
} dynamic_uint32_array_t;

typedef struct {
    float* data;
    size_t size;
    size_t capacity;
} dynamic_float_array_t;

// Encoder callback for uint32 array
bool uint32_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_uint32_array_t* arr = (const dynamic_uint32_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        if (!pb_encode_varint(stream, arr->data[i]))
            return false;
    }
    
    return true;
}

// Decoder callback for uint32 array
bool uint32_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_uint32_array_t* arr = (dynamic_uint32_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Resize if needed
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        uint32_t* new_data = (uint32_t*)realloc(arr->data, new_capacity * sizeof(uint32_t));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    arr->data[arr->size++] = (uint32_t)value;
    return true;
}

// Encoder callback for float array
bool float_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_float_array_t* arr = (const dynamic_float_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        // Encode float as 4 bytes
        union { float f; uint32_t u; } u;
        u.f = arr->data[i];
        if (!pb_encode_varint(stream, u.u))
            return false;
    }
    
    return true;
}

// Decoder callback for float array
bool float_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_float_array_t* arr = (dynamic_float_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Resize if needed
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        float* new_data = (float*)realloc(arr->data, new_capacity * sizeof(float));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    union { float f; uint32_t u; } u;
    u.u = (uint32_t)value;
    arr->data[arr->size++] = u.f;
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    uint32_t values_data[] = {10, 20, 30};
    float temperatures_data[] = {20.5f, 21.0f, 21.5f};
    
    dynamic_uint32_array_t values = {values_data, 3, 3};
    dynamic_float_array_t temperatures = {temperatures_data, 3, 3};
    
    // --- ENCODING ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    message.values.funcs.encode = uint32_array_encode_callback;
    message.values.arg = &values;
    
    message.temperatures.funcs.encode = float_array_encode_callback;
    message.temperatures.arg = &temperatures;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // --- DECODING ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    dynamic_uint32_array_t decoded_values = {NULL, 0, 0};
    dynamic_float_array_t decoded_temperatures = {NULL, 0, 0};
    
    decoded.values.funcs.decode = uint32_array_decode_callback;
    decoded.values.arg = &decoded_values;
    
    decoded.temperatures.funcs.decode = float_array_decode_callback;
    decoded.temperatures.arg = &decoded_temperatures;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded_values.size);
    for (size_t i = 0; i < decoded_values.size; i++) {
        printf("%u ", decoded_values.data[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded_temperatures.size);
    for (size_t i = 0; i < decoded_temperatures.size; i++) {
        printf("%.1f ", decoded_temperatures.data[i]);
    }
    printf("\n");
    
    // Free allocated memory
    free(decoded_values.data);
    free(decoded_temperatures.data);
    
    return 0;
}

Wichtige Punkte

Arrays fester Größe: Verwenden Sie max_count in der .options-Datei für einfache, statische Speicherzuweisung
Callback-basiert: Verwenden Sie callback in .options für dynamische Array-Verarbeitung
Feste Größe: Setzen Sie das *_count-Feld, um die Anzahl der Elemente festzulegen
Callback-basiert: Implementieren Sie Encode/Decode-Callbacks mit manueller Speicherverwaltung
Arrays werden als wiederholte Feld-Tags mit Werten kodiert
Verwenden Sie malloc/realloc/free in C für dynamische Array-Verarbeitung
Überprüfen Sie immer Array-Anzahlen, um Overflow zu verhindern
Denken Sie daran, zugewiesenen Speicher im Callback-basierten Ansatz freizugeben

Wann welcher Ansatz verwendet werden sollte

Arrays fester Größe: Wenn Sie die maximale Array-Größe kennen und einfachen Code wünschen
Callback-basiert: Wenn die Array-Größe variabel ist oder Sie dynamische Speicherzuweisung benötigen

Erwartete Ausgabe

repeated_expected_output.txt

Encoded 15 bytes
Encoded data: 08 0a 08 14 08 1e 15 00 00 a4 41 15 00 00 a8 41 15 00 00 ac 41 
Decoded values:
  values (3 items): 10 20 30 
  temperatures (3 items): 20.5 21.0 21.5 

Encoded 15 bytes
Encoded data: 08 0a 08 14 08 1e 15 00 00 a4 41 15 00 00 a8 41 15 00 00 ac 41 
Decoded values:
  values (3 items): 10 20 30 
  temperatures (3 items): 20.5 21.0 21.5

Unterschiede zu C++

Die C-Version ist nahezu identisch mit der C++-Version, mit folgenden wesentlichen Unterschieden:

Verwenden Sie malloc/realloc/free statt std::vector für dynamische Arrays
Manuelle Speicherverwaltung erforderlich (keine Destruktoren)
Verwenden Sie ein Struct als Wrapper für dynamische Arrays statt std::vector
Denken Sie daran, zugewiesenen Speicher nach der Verwendung freizugeben
Keine automatische Speicherverwaltung in C

Weitere NanoPB-Beiträge

Check out similar posts by category: Embedded, C/C++, Protocol Buffers

If this post helped you, please consider buying me a coffee or donating via PayPal to support research & publishing of new posts on TechOverflow

Buy me a coffee