Merge remote branch 'repo/master' into stats
[openvswitch] / lib / dynamic-string.c
1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 #include "dynamic-string.h"
35 #include <assert.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include "util.h"
39
40 void
41 ds_init(struct ds *ds)
42 {
43     ds->string = NULL;
44     ds->length = 0;
45     ds->allocated = 0;
46 }
47
48 void
49 ds_reserve(struct ds *ds, size_t min_length)
50 {
51     if (min_length > ds->allocated || !ds->string) {
52         ds->allocated += MAX(min_length, ds->allocated);
53         ds->allocated = MAX(8, ds->allocated);
54         ds->string = xrealloc(ds->string, ds->allocated + 1);
55     }
56 }
57
58 void
59 ds_put_char(struct ds *ds, char c)
60 {
61     ds_reserve(ds, ds->length + 1);
62     ds->string[ds->length++] = c;
63     ds->string[ds->length] = '\0';
64 }
65
66 void
67 ds_put_cstr(struct ds *ds, const char *s)
68 {
69     size_t s_len = strlen(s);
70     ds_reserve(ds, ds->length + s_len);
71     memcpy(&ds->string[ds->length], s, s_len + 1);
72     ds->length += s_len;
73 }
74
75 void
76 ds_put_format(struct ds *ds, const char *format, ...)
77 {
78     va_list args;
79
80     va_start(args, format);
81     ds_put_format_valist(ds, format, args);
82     va_end(args);
83 }
84
85 void
86 ds_put_format_valist(struct ds *ds, const char *format, va_list args_)
87 {
88     va_list args;
89     size_t available;
90     int needed;
91
92     va_copy(args, args_);
93     available = ds->string ? ds->allocated - ds->length + 1 : 0;
94     needed = vsnprintf(&ds->string[ds->length], available, format, args);
95     va_end(args);
96
97     if (needed < available) {
98         ds->length += needed;
99     } else {
100         size_t available;
101
102         ds_reserve(ds, ds->length + needed);
103
104         va_copy(args, args_);
105         available = ds->allocated - ds->length + 1;
106         needed = vsnprintf(&ds->string[ds->length], available, format, args);
107         va_end(args);
108
109         assert(needed < available);
110         ds->length += needed;
111     }
112 }
113
114 char *
115 ds_cstr(struct ds *ds)
116 {
117     if (!ds->string) {
118         ds_reserve(ds, 0);
119         ds->string[0] = '\0';
120     }
121     return ds->string;
122 }
123
124 void
125 ds_destroy(struct ds *ds)
126 {
127     free(ds->string);
128 }
129
130 /* Writes the 'size' bytes in 'buf' to 'string' as hex bytes arranged 16 per
131  * line.  Numeric offsets are also included, starting at 'ofs' for the first
132  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
133  * are also rendered alongside. */
134 void
135 ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
136                 uintptr_t ofs, bool ascii)
137 {
138   const uint8_t *buf = buf_;
139   const size_t per_line = 16; /* Maximum bytes per line. */
140
141   while (size > 0)
142     {
143       size_t start, end, n;
144       size_t i;
145
146       /* Number of bytes on this line. */
147       start = ofs % per_line;
148       end = per_line;
149       if (end - start > size)
150         end = start + size;
151       n = end - start;
152
153       /* Print line. */
154       ds_put_format(ds, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
155       for (i = 0; i < start; i++)
156         ds_put_format(ds, "   ");
157       for (; i < end; i++)
158         ds_put_format(ds, "%02hhx%c",
159                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
160       if (ascii)
161         {
162           for (; i < per_line; i++)
163             ds_put_format(ds, "   ");
164           ds_put_format(ds, "|");
165           for (i = 0; i < start; i++)
166             ds_put_format(ds, " ");
167           for (; i < end; i++) {
168               int c = buf[i - start];
169               ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
170           }
171           for (; i < per_line; i++)
172             ds_put_format(ds, " ");
173           ds_put_format(ds, "|");
174         }
175       ds_put_format(ds, "\n");
176
177       ofs += n;
178       buf += n;
179       size -= n;
180     }
181 }