ovsdb: Allow recovery from transient write errors in log implementation.
[sliver-openvswitch.git] / ovsdb / log.c
1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17
18 #include "log.h"
19
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <sys/stat.h>
25 #include <unistd.h>
26
27 #include "json.h"
28 #include "lockfile.h"
29 #include "ovsdb.h"
30 #include "ovsdb-error.h"
31 #include "sha1.h"
32 #include "socket-util.h"
33 #include "transaction.h"
34 #include "util.h"
35 #include "vlog.h"
36
37 VLOG_DEFINE_THIS_MODULE(ovsdb_log);
38
39 enum ovsdb_log_mode {
40     OVSDB_LOG_READ,
41     OVSDB_LOG_WRITE
42 };
43
44 struct ovsdb_log {
45     off_t prev_offset;
46     off_t offset;
47     char *name;
48     struct lockfile *lockfile;
49     FILE *stream;
50     struct ovsdb_error *read_error;
51     bool write_error;
52     enum ovsdb_log_mode mode;
53 };
54
55 /* Attempts to open 'name' with the specified 'open_mode'.  On success, stores
56  * the new log into '*filep' and returns NULL; otherwise returns NULL and
57  * stores NULL into '*filep'.
58  *
59  * Whether the file will be locked using lockfile_lock() depends on 'locking':
60  * use true to lock it, false not to lock it, or -1 to lock it only if
61  * 'open_mode' is a mode that allows writing.
62  */
63 struct ovsdb_error *
64 ovsdb_log_open(const char *name, enum ovsdb_log_open_mode open_mode,
65                int locking, struct ovsdb_log **filep)
66 {
67     struct lockfile *lockfile;
68     struct ovsdb_error *error;
69     struct ovsdb_log *file;
70     struct stat s;
71     FILE *stream;
72     int flags;
73     int fd;
74
75     *filep = NULL;
76
77     ovs_assert(locking == -1 || locking == false || locking == true);
78     if (locking < 0) {
79         locking = open_mode != OVSDB_LOG_READ_ONLY;
80     }
81     if (locking) {
82         int retval = lockfile_lock(name, &lockfile);
83         if (retval) {
84             error = ovsdb_io_error(retval, "%s: failed to lock lockfile",
85                                    name);
86             goto error;
87         }
88     } else {
89         lockfile = NULL;
90     }
91
92     if (open_mode == OVSDB_LOG_READ_ONLY) {
93         flags = O_RDONLY;
94     } else if (open_mode == OVSDB_LOG_READ_WRITE) {
95         flags = O_RDWR;
96     } else if (open_mode == OVSDB_LOG_CREATE) {
97         if (stat(name, &s) == -1 && errno == ENOENT
98             && lstat(name, &s) == 0 && S_ISLNK(s.st_mode)) {
99             /* 'name' is a dangling symlink.  We want to create the file that
100              * the symlink points to, but POSIX says that open() with O_EXCL
101              * must fail with EEXIST if the named file is a symlink.  So, we
102              * have to leave off O_EXCL and accept the race. */
103             flags = O_RDWR | O_CREAT;
104         } else {
105             flags = O_RDWR | O_CREAT | O_EXCL;
106         }
107     } else {
108         NOT_REACHED();
109     }
110     fd = open(name, flags, 0666);
111     if (fd < 0) {
112         const char *op = open_mode == OVSDB_LOG_CREATE ? "create" : "open";
113         error = ovsdb_io_error(errno, "%s: %s failed", op, name);
114         goto error_unlock;
115     }
116
117     if (!fstat(fd, &s) && s.st_size == 0) {
118         /* It's (probably) a new file so fsync() its parent directory to ensure
119          * that its directory entry is committed to disk. */
120         fsync_parent_dir(name);
121     }
122
123     stream = fdopen(fd, open_mode == OVSDB_LOG_READ_ONLY ? "rb" : "w+b");
124     if (!stream) {
125         error = ovsdb_io_error(errno, "%s: fdopen failed", name);
126         goto error_close;
127     }
128
129     file = xmalloc(sizeof *file);
130     file->name = xstrdup(name);
131     file->lockfile = lockfile;
132     file->stream = stream;
133     file->prev_offset = 0;
134     file->offset = 0;
135     file->read_error = NULL;
136     file->write_error = false;
137     file->mode = OVSDB_LOG_READ;
138     *filep = file;
139     return NULL;
140
141 error_close:
142     close(fd);
143 error_unlock:
144     lockfile_unlock(lockfile);
145 error:
146     return error;
147 }
148
149 void
150 ovsdb_log_close(struct ovsdb_log *file)
151 {
152     if (file) {
153         free(file->name);
154         fclose(file->stream);
155         lockfile_unlock(file->lockfile);
156         ovsdb_error_destroy(file->read_error);
157         free(file);
158     }
159 }
160
161 static const char magic[] = "OVSDB JSON ";
162
163 static bool
164 parse_header(char *header, unsigned long int *length,
165              uint8_t sha1[SHA1_DIGEST_SIZE])
166 {
167     char *p;
168
169     /* 'header' must consist of a magic string... */
170     if (strncmp(header, magic, strlen(magic))) {
171         return false;
172     }
173
174     /* ...followed by a length in bytes... */
175     *length = strtoul(header + strlen(magic), &p, 10);
176     if (!*length || *length == ULONG_MAX || *p != ' ') {
177         return false;
178     }
179     p++;
180
181     /* ...followed by a SHA-1 hash... */
182     if (!sha1_from_hex(sha1, p)) {
183         return false;
184     }
185     p += SHA1_HEX_DIGEST_LEN;
186
187     /* ...and ended by a new-line. */
188     if (*p != '\n') {
189         return false;
190     }
191
192     return true;
193 }
194
195 struct ovsdb_log_read_cbdata {
196     char input[4096];
197     struct ovsdb_log *file;
198     int error;
199     unsigned long length;
200 };
201
202 static struct ovsdb_error *
203 parse_body(struct ovsdb_log *file, off_t offset, unsigned long int length,
204            uint8_t sha1[SHA1_DIGEST_SIZE], struct json **jsonp)
205 {
206     struct json_parser *parser;
207     struct sha1_ctx ctx;
208
209     sha1_init(&ctx);
210     parser = json_parser_create(JSPF_TRAILER);
211
212     while (length > 0) {
213         char input[BUFSIZ];
214         int chunk;
215
216         chunk = MIN(length, sizeof input);
217         if (fread(input, 1, chunk, file->stream) != chunk) {
218             json_parser_abort(parser);
219             return ovsdb_io_error(ferror(file->stream) ? errno : EOF,
220                                   "%s: error reading %lu bytes "
221                                   "starting at offset %lld", file->name,
222                                   length, (long long int) offset);
223         }
224         sha1_update(&ctx, input, chunk);
225         json_parser_feed(parser, input, chunk);
226         length -= chunk;
227     }
228
229     sha1_final(&ctx, sha1);
230     *jsonp = json_parser_finish(parser);
231     return NULL;
232 }
233
234 struct ovsdb_error *
235 ovsdb_log_read(struct ovsdb_log *file, struct json **jsonp)
236 {
237     uint8_t expected_sha1[SHA1_DIGEST_SIZE];
238     uint8_t actual_sha1[SHA1_DIGEST_SIZE];
239     struct ovsdb_error *error;
240     off_t data_offset;
241     unsigned long data_length;
242     struct json *json;
243     char header[128];
244
245     *jsonp = json = NULL;
246
247     if (file->read_error) {
248         return ovsdb_error_clone(file->read_error);
249     } else if (file->mode == OVSDB_LOG_WRITE) {
250         return OVSDB_BUG("reading file in write mode");
251     }
252
253     if (!fgets(header, sizeof header, file->stream)) {
254         if (feof(file->stream)) {
255             error = NULL;
256         } else {
257             error = ovsdb_io_error(errno, "%s: read failed", file->name);
258         }
259         goto error;
260     }
261
262     if (!parse_header(header, &data_length, expected_sha1)) {
263         error = ovsdb_syntax_error(NULL, NULL, "%s: parse error at offset "
264                                    "%lld in header line \"%.*s\"",
265                                    file->name, (long long int) file->offset,
266                                    (int) strcspn(header, "\n"), header);
267         goto error;
268     }
269
270     data_offset = file->offset + strlen(header);
271     error = parse_body(file, data_offset, data_length, actual_sha1, &json);
272     if (error) {
273         goto error;
274     }
275
276     if (memcmp(expected_sha1, actual_sha1, SHA1_DIGEST_SIZE)) {
277         error = ovsdb_syntax_error(NULL, NULL, "%s: %lu bytes starting at "
278                                    "offset %lld have SHA-1 hash "SHA1_FMT" "
279                                    "but should have hash "SHA1_FMT,
280                                    file->name, data_length,
281                                    (long long int) data_offset,
282                                    SHA1_ARGS(actual_sha1),
283                                    SHA1_ARGS(expected_sha1));
284         goto error;
285     }
286
287     if (json->type == JSON_STRING) {
288         error = ovsdb_syntax_error(NULL, NULL, "%s: %lu bytes starting at "
289                                    "offset %lld are not valid JSON (%s)",
290                                    file->name, data_length,
291                                    (long long int) data_offset,
292                                    json->u.string);
293         goto error;
294     }
295
296     file->prev_offset = file->offset;
297     file->offset = data_offset + data_length;
298     *jsonp = json;
299     return NULL;
300
301 error:
302     file->read_error = ovsdb_error_clone(error);
303     json_destroy(json);
304     return error;
305 }
306
307 /* Causes the log record read by the previous call to ovsdb_log_read() to be
308  * effectively discarded.  The next call to ovsdb_log_write() will overwrite
309  * that previously read record.
310  *
311  * Calling this function more than once has no additional effect.
312  *
313  * This function is useful when ovsdb_log_read() successfully reads a record
314  * but that record does not make sense at a higher level (e.g. it specifies an
315  * invalid transaction). */
316 void
317 ovsdb_log_unread(struct ovsdb_log *file)
318 {
319     ovs_assert(file->mode == OVSDB_LOG_READ);
320     file->offset = file->prev_offset;
321 }
322
323 struct ovsdb_error *
324 ovsdb_log_write(struct ovsdb_log *file, struct json *json)
325 {
326     uint8_t sha1[SHA1_DIGEST_SIZE];
327     struct ovsdb_error *error;
328     char *json_string;
329     char header[128];
330     size_t length;
331
332     json_string = NULL;
333
334     if (file->mode == OVSDB_LOG_READ || file->write_error) {
335         file->mode = OVSDB_LOG_WRITE;
336         file->write_error = false;
337         if (fseeko(file->stream, file->offset, SEEK_SET)) {
338             error = ovsdb_io_error(errno, "%s: cannot seek to offset %lld",
339                                    file->name, (long long int) file->offset);
340             goto error;
341         }
342         if (ftruncate(fileno(file->stream), file->offset)) {
343             error = ovsdb_io_error(errno, "%s: cannot truncate to length %lld",
344                                    file->name, (long long int) file->offset);
345             goto error;
346         }
347     }
348
349     if (json->type != JSON_OBJECT && json->type != JSON_ARRAY) {
350         error = OVSDB_BUG("bad JSON type");
351         goto error;
352     }
353
354     /* Compose content.  Add a new-line (replacing the null terminator) to make
355      * the file easier to read, even though it has no semantic value.  */
356     json_string = json_to_string(json, 0);
357     length = strlen(json_string) + 1;
358     json_string[length - 1] = '\n';
359
360     /* Compose header. */
361     sha1_bytes(json_string, length, sha1);
362     snprintf(header, sizeof header, "%s%zu "SHA1_FMT"\n",
363              magic, length, SHA1_ARGS(sha1));
364
365     /* Write. */
366     if (fwrite(header, strlen(header), 1, file->stream) != 1
367         || fwrite(json_string, length, 1, file->stream) != 1
368         || fflush(file->stream))
369     {
370         error = ovsdb_io_error(errno, "%s: write failed", file->name);
371
372         /* Remove any partially written data, ignoring errors since there is
373          * nothing further we can do. */
374         ignore(ftruncate(fileno(file->stream), file->offset));
375
376         goto error;
377     }
378
379     file->offset += strlen(header) + length;
380     free(json_string);
381     return NULL;
382
383 error:
384     file->write_error = true;
385     free(json_string);
386     return error;
387 }
388
389 struct ovsdb_error *
390 ovsdb_log_commit(struct ovsdb_log *file)
391 {
392     if (fsync(fileno(file->stream))) {
393         return ovsdb_io_error(errno, "%s: fsync failed", file->name);
394     }
395     return NULL;
396 }
397
398 /* Returns the current offset into the file backing 'log', in bytes.  This
399  * reflects the number of bytes that have been read or written in the file.  If
400  * the whole file has been read, this is the file size. */
401 off_t
402 ovsdb_log_get_offset(const struct ovsdb_log *log)
403 {
404     return log->offset;
405 }