mirror of
https://github.com/openvswitch/ovs
synced 2025-10-29 15:28:56 +00:00
e7ae59f990
Geneve options are variable length and up to 124 bytes long, which means that they can't be easily manipulated by the integer string functions like we do for other fields. This adds a few helper routines to make these operations easier. Signed-off-by: Jesse Gross <jesse@nicira.com> Acked-by: Andy Zhou <azhou@nicira.com>
94 lines
3.2 KiB
C
94 lines
3.2 KiB
C
/*
|
||
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at:
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
#ifndef DYNAMIC_STRING_H
|
||
#define DYNAMIC_STRING_H 1
|
||
|
||
#include <stdarg.h>
|
||
#include <stdbool.h>
|
||
#include <stddef.h>
|
||
#include <stdint.h>
|
||
#include <stdio.h>
|
||
#include <time.h>
|
||
#include "compiler.h"
|
||
|
||
/* A "dynamic string", that is, a buffer that can be used to construct a
|
||
* string across a series of operations that extend or modify it.
|
||
*
|
||
* The 'string' member does not always point to a null-terminated string.
|
||
* Initially it is NULL, and even when it is nonnull, some operations do not
|
||
* ensure that it is null-terminated. Use ds_cstr() to ensure that memory is
|
||
* allocated for the string and that it is null-terminated. */
|
||
struct ds {
|
||
char *string; /* Null-terminated string. */
|
||
size_t length; /* Bytes used, not including null terminator. */
|
||
size_t allocated; /* Bytes allocated, not including null terminator. */
|
||
};
|
||
|
||
#define DS_EMPTY_INITIALIZER { NULL, 0, 0 }
|
||
|
||
void ds_init(struct ds *);
|
||
void ds_clear(struct ds *);
|
||
void ds_truncate(struct ds *, size_t new_length);
|
||
void ds_reserve(struct ds *, size_t min_length);
|
||
char *ds_put_uninit(struct ds *, size_t n);
|
||
static inline void ds_put_char(struct ds *, char);
|
||
void ds_put_utf8(struct ds *, int uc);
|
||
void ds_put_char_multiple(struct ds *, char, size_t n);
|
||
void ds_put_buffer(struct ds *, const char *, size_t n);
|
||
void ds_put_cstr(struct ds *, const char *);
|
||
void ds_put_and_free_cstr(struct ds *, char *);
|
||
void ds_put_format(struct ds *, const char *, ...) OVS_PRINTF_FORMAT(2, 3);
|
||
void ds_put_format_valist(struct ds *, const char *, va_list)
|
||
OVS_PRINTF_FORMAT(2, 0);
|
||
void ds_put_printable(struct ds *, const char *, size_t);
|
||
void ds_put_hex(struct ds *ds, const void *buf, size_t size);
|
||
void ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
|
||
uintptr_t ofs, bool ascii);
|
||
int ds_get_line(struct ds *, FILE *);
|
||
int ds_get_preprocessed_line(struct ds *, FILE *, int *line_number);
|
||
int ds_get_test_line(struct ds *, FILE *);
|
||
|
||
void ds_put_strftime_msec(struct ds *, const char *format, long long int when,
|
||
bool utc);
|
||
char *xastrftime_msec(const char *format, long long int when, bool utc);
|
||
|
||
char *ds_cstr(struct ds *);
|
||
const char *ds_cstr_ro(const struct ds *);
|
||
char *ds_steal_cstr(struct ds *);
|
||
void ds_destroy(struct ds *);
|
||
void ds_swap(struct ds *, struct ds *);
|
||
|
||
int ds_last(const struct ds *);
|
||
void ds_chomp(struct ds *, int c);
|
||
|
||
/* Inline functions. */
|
||
|
||
void ds_put_char__(struct ds *, char);
|
||
|
||
static inline void
|
||
ds_put_char(struct ds *ds, char c)
|
||
{
|
||
if (ds->length < ds->allocated) {
|
||
ds->string[ds->length++] = c;
|
||
ds->string[ds->length] = '\0';
|
||
} else {
|
||
ds_put_char__(ds, c);
|
||
}
|
||
}
|
||
|
||
#endif /* dynamic-string.h */
|