/*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * 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.
#include <config.h>
#include "dynamic-string.h"
-#include <assert.h>
+#include <inttypes.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include "timeval.h"
#include "util.h"
+/* Initializes 'ds' as an empty string buffer. */
void
ds_init(struct ds *ds)
{
ds->allocated = 0;
}
+/* Sets 'ds''s length to 0, effectively clearing any existing content. Does
+ * not free any memory. */
void
-ds_clear(struct ds *ds)
+ds_clear(struct ds *ds)
{
ds->length = 0;
}
+/* Reduces 'ds''s length to no more than 'new_length'. (If its length is
+ * already 'new_length' or less, does nothing.) */
void
ds_truncate(struct ds *ds, size_t new_length)
{
}
}
+/* Ensures that at least 'min_length + 1' bytes (including space for a null
+ * terminator) are allocated for ds->string, allocating or reallocating memory
+ * as necessary. */
void
ds_reserve(struct ds *ds, size_t min_length)
{
}
}
+/* Appends space for 'n' bytes to the end of 'ds->string', increasing
+ * 'ds->length' by the same amount, and returns the first appended byte. The
+ * caller should fill in all 'n' bytes starting at the return value. */
char *
ds_put_uninit(struct ds *ds, size_t n)
{
}
void
-ds_put_char(struct ds *ds, char c)
+ds_put_char__(struct ds *ds, char c)
{
*ds_put_uninit(ds, 1) = c;
}
memcpy(ds_put_uninit(ds, s_len), s, s_len);
}
+void
+ds_put_and_free_cstr(struct ds *ds, char *s)
+{
+ ds_put_cstr(ds, s);
+ free(s);
+}
+
void
ds_put_format(struct ds *ds, const char *format, ...)
{
if (needed < available) {
ds->length += needed;
} else {
- size_t available;
-
ds_reserve(ds, ds->length + needed);
va_copy(args, args_);
needed = vsnprintf(&ds->string[ds->length], available, format, args);
va_end(args);
- assert(needed < available);
+ ovs_assert(needed < available);
ds->length += needed;
}
}
void
-ds_put_printable(struct ds *ds, const char *s, size_t n)
+ds_put_printable(struct ds *ds, const char *s, size_t n)
{
ds_reserve(ds, ds->length + n);
while (n-- > 0) {
}
}
+/* Writes the current time with optional millisecond resolution to 'string'
+ * based on 'template'.
+ * The current time is either localtime or UTC based on 'utc'. */
void
-ds_put_strftime(struct ds *ds, const char *template, const struct tm *tm)
+ds_put_strftime_msec(struct ds *ds, const char *template, long long int when,
+ bool utc)
{
- if (!tm) {
- time_t now = time_now();
- tm = localtime(&now);
+ struct tm_msec tm;
+ if (utc) {
+ gmtime_msec(when, &tm);
+ } else {
+ localtime_msec(when, &tm);
}
+
for (;;) {
size_t avail = ds->string ? ds->allocated - ds->length + 1 : 0;
- size_t used = strftime(&ds->string[ds->length], avail, template, tm);
+ size_t used = strftime_msec(&ds->string[ds->length], avail, template,
+ &tm);
if (used) {
ds->length += used;
return;
}
- ds_reserve(ds, ds->length + (avail < 32 ? 64 : 2 * avail));
+ ds_reserve(ds, ds->length + (avail < 32 ? 64 : 2 * avail));
}
}
+/* Returns a malloc()'d string for time 'when' based on 'template', in local
+ * time or UTC based on 'utc'. */
+char *
+xastrftime_msec(const char *template, long long int when, bool utc)
+{
+ struct ds s;
+
+ ds_init(&s);
+ ds_put_strftime_msec(&s, template, when, utc);
+ return s.string;
+}
+
int
ds_get_line(struct ds *ds, FILE *file)
{
}
}
+/* Reads a line from 'file' into 'ds', clearing anything initially in 'ds'.
+ * Deletes comments introduced by "#" and skips lines that contains only white
+ * space (after deleting comments).
+ *
+ * If 'line_numberp' is nonnull, increments '*line_numberp' by the number of
+ * lines read from 'file'.
+ *
+ * Returns 0 if successful, EOF if no non-blank line was found. */
+int
+ds_get_preprocessed_line(struct ds *ds, FILE *file, int *line_numberp)
+{
+ while (!ds_get_line(ds, file)) {
+ char *line = ds_cstr(ds);
+ char *comment;
+
+ if (line_numberp) {
+ ++*line_numberp;
+ }
+
+ /* Delete comments. */
+ comment = strchr(line, '#');
+ if (comment) {
+ *comment = '\0';
+ }
+
+ /* Return successfully unless the line is all spaces. */
+ if (line[strspn(line, " \t\n")] != '\0') {
+ return 0;
+ }
+ }
+ return EOF;
+}
+
+/* Reads a line from 'file' into 'ds' and does some preprocessing on it:
+ *
+ * - If the line begins with #, prints it on stdout and reads the next line.
+ *
+ * - Otherwise, if the line contains an # somewhere else, strips it and
+ * everything following it (as a comment).
+ *
+ * - If (after comment removal) the line contains only white space, prints
+ * a blank line on stdout and reads the next line.
+ *
+ * - Otherwise, returns the line to the caller.
+ *
+ * This is useful in some of the OVS tests, where we want to check that parsing
+ * and then re-formatting some kind of data does not change it, but we also
+ * want to be able to put comments in the input.
+ *
+ * Returns 0 if successful, EOF if no non-blank line was found. */
+int
+ds_get_test_line(struct ds *ds, FILE *file)
+{
+ for (;;) {
+ char *s, *comment;
+ int retval;
+
+ retval = ds_get_line(ds, file);
+ if (retval) {
+ return retval;
+ }
+
+ s = ds_cstr(ds);
+ if (*s == '#') {
+ puts(s);
+ continue;
+ }
+
+ comment = strchr(s, '#');
+ if (comment) {
+ *comment = '\0';
+ }
+ if (s[strspn(s, " \t\n")] == '\0') {
+ putchar('\n');
+ continue;
+ }
+
+ return 0;
+ }
+}
+
char *
ds_cstr(struct ds *ds)
{
return ds->string;
}
+const char *
+ds_cstr_ro(const struct ds *ds)
+{
+ return ds_cstr(CONST_CAST(struct ds *, ds));
+}
+
/* Returns a null-terminated string representing the current contents of 'ds',
* which the caller is expected to free with free(), then clears the contents
* of 'ds'. */
free(ds->string);
}
+/* Swaps the content of 'a' and 'b'. */
+void
+ds_swap(struct ds *a, struct ds *b)
+{
+ struct ds temp = *a;
+ *a = *b;
+ *b = temp;
+}
+
/* Writes the 'size' bytes in 'buf' to 'string' as hex bytes arranged 16 per
* line. Numeric offsets are also included, starting at 'ofs' for the first
* byte in 'buf'. If 'ascii' is true then the corresponding ASCII characters
ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
uintptr_t ofs, bool ascii)
{
- const uint8_t *buf = buf_;
- const size_t per_line = 16; /* Maximum bytes per line. */
-
- while (size > 0)
- {
- size_t start, end, n;
- size_t i;
-
- /* Number of bytes on this line. */
- start = ofs % per_line;
- end = per_line;
- if (end - start > size)
- end = start + size;
- n = end - start;
-
- /* Print line. */
- ds_put_format(ds, "%08jx ", (uintmax_t) ROUND_DOWN(ofs, per_line));
- for (i = 0; i < start; i++)
- ds_put_format(ds, " ");
- for (; i < end; i++)
- ds_put_format(ds, "%02hhx%c",
- buf[i - start], i == per_line / 2 - 1? '-' : ' ');
- if (ascii)
- {
- for (; i < per_line; i++)
+ const uint8_t *buf = buf_;
+ const size_t per_line = 16; /* Maximum bytes per line. */
+
+ while (size > 0) {
+ size_t start, end, n;
+ size_t i;
+
+ /* Number of bytes on this line. */
+ start = ofs % per_line;
+ end = per_line;
+ if (end - start > size)
+ end = start + size;
+ n = end - start;
+
+ /* Print line. */
+ ds_put_format(ds, "%08"PRIxMAX" ",
+ (uintmax_t) ROUND_DOWN(ofs, per_line));
+ for (i = 0; i < start; i++) {
ds_put_format(ds, " ");
- ds_put_format(ds, "|");
- for (i = 0; i < start; i++)
- ds_put_format(ds, " ");
- for (; i < end; i++) {
- int c = buf[i - start];
- ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
- }
- for (; i < per_line; i++)
- ds_put_format(ds, " ");
- ds_put_format(ds, "|");
}
- ds_put_format(ds, "\n");
+ for (; i < end; i++) {
+ ds_put_format(ds, "%02x%c",
+ buf[i - start], i == per_line / 2 - 1? '-' : ' ');
+ }
+ if (ascii) {
+ for (; i < per_line; i++)
+ ds_put_format(ds, " ");
+ ds_put_format(ds, "|");
+ for (i = 0; i < start; i++)
+ ds_put_format(ds, " ");
+ for (; i < end; i++) {
+ int c = buf[i - start];
+ ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
+ }
+ for (; i < per_line; i++)
+ ds_put_format(ds, " ");
+ ds_put_format(ds, "|");
+ } else {
+ ds_chomp(ds, ' ');
+ }
+ ds_put_format(ds, "\n");
- ofs += n;
- buf += n;
- size -= n;
+ ofs += n;
+ buf += n;
+ size -= n;
}
}