vinyl-cache/lib/libvinyl/vfil.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2011 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Dag-Erling Smørgrav <des@des.no>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 */
30
31
#include "config.h"
32
33
#include <time.h>
34
#include <sys/types.h>
35
#include <sys/stat.h>
36
#include <fcntl.h>
37
#include <limits.h>
38
#include <stdio.h>
39
#include <stdlib.h>
40
#include <unistd.h>
41
#include <stdint.h>
42
#include <string.h>
43
#include <sys/statvfs.h>
44
#if defined(__linux__) && defined(HAVE_FALLOCATE)
45
#  include <linux/magic.h>
46
#  include <sys/vfs.h>
47
#endif
48
49
#include "vdef.h"
50
51
#include "miniobj.h"
52
#include "vas.h"
53
#include "vsb.h"
54
#include "vfil.h"
55
#include "vqueue.h"
56
57
void
58 322662
VFIL_null_fd(int target)
59
{
60
        int fd;
61
62 322662
        assert(target >= 0);
63 322662
        fd = open("/dev/null", O_RDWR);
64 322662
        assert(fd >= 0);
65 322662
        assert(dup2(fd, target) == target);
66 322662
        closefd(&fd);
67 322662
}
68
69
static char *
70 165564
vfil_readfd(int fd, ssize_t *sz)
71
{
72
        struct stat st;
73
        char *f;
74
        int i;
75
76 165564
        AZ(fstat(fd, &st));
77 165564
        if (!S_ISREG(st.st_mode))
78 0
                return (NULL);
79 165564
        f = malloc(st.st_size + 1);
80 165564
        assert(f != NULL);
81 165564
        i = read(fd, f, st.st_size + 1);
82 165564
        if (i != st.st_size) {
83 0
                free(f);
84 0
                return (NULL);
85
        }
86 165564
        f[i] = '\0';
87 165564
        if (sz != NULL)
88 294
                *sz = st.st_size;
89 165564
        return (f);
90 165564
}
91
92
static int
93 378
vfil_writefd(int fd, const char *buf, size_t sz)
94
{
95
        ssize_t len;
96
97 756
        while (sz > 0) {
98 378
                len = write(fd, buf, sz);
99 378
                if (len < 0)
100 0
                        return (len);
101 378
                if (len == 0)
102 0
                        break;
103 378
                buf += len;
104 378
                sz -= len;
105
        }
106
107 378
        return (sz == 0 ? 0 : -1);
108 378
}
109
110
static int
111 166110
vfil_openfile(const char *pfx, const char *fn, int flags, int mode)
112
{
113
        char fnb[PATH_MAX + 1];
114
115 166110
        if (fn[0] != '/' && pfx != NULL) {
116
                /* XXX: graceful length check */
117 0
                bprintf(fnb, "/%s/%s", pfx, fn);
118 0
                fn = fnb;
119 0
        }
120
121 166110
        if (flags & O_CREAT)
122 378
                return (open(fn, flags, mode));
123
        else
124 165732
                return (open(fn, flags));
125 166110
}
126
127
char *
128 165732
VFIL_readfile(const char *pfx, const char *fn, ssize_t *sz)
129
{
130
        int fd, err;
131
        char *r;
132
133 165732
        fd = vfil_openfile(pfx, fn, O_RDONLY, 0);
134 165732
        if (fd < 0)
135 168
                return (NULL);
136 165564
        r = vfil_readfd(fd, sz);
137 165564
        err = errno;
138 165564
        closefd(&fd);
139 165564
        errno = err;
140 165564
        return (r);
141 165732
}
142
143
int
144 378
VFIL_writefile(const char *pfx, const char *fn, const char *buf, size_t sz)
145
{
146
        int fd, err;
147
        int r;
148
149 378
        fd = vfil_openfile(pfx, fn, O_WRONLY|O_CREAT|O_TRUNC, 0660);
150 378
        if (fd < 0)
151 0
                return (fd);
152 378
        r = vfil_writefd(fd, buf, sz);
153 378
        err = errno;
154 378
        closefd(&fd);
155 378
        errno = err;
156 378
        return (r);
157 378
}
158
159
int
160 21420
VFIL_nonblocking(int fd)
161
{
162
        int i;
163
164 21420
        i = fcntl(fd, F_GETFL);
165 21420
        assert(i != -1);
166 21420
        i |= O_NONBLOCK;
167 21420
        i = fcntl(fd, F_SETFL, i);
168 21420
        assert(i != -1);
169 21420
        return (i);
170
}
171
172
/*
173
 * Get file system information from an fd
174
 * Returns block size, total size and space available in the passed pointers
175
 * Returns 0 on success, or -1 on failure with errno set
176
 */
177
int
178 1116097
VFIL_fsinfo(int fd, unsigned *pbs, uintmax_t *psize, uintmax_t *pspace)
179
{
180
        unsigned bs;
181
        uintmax_t size, space;
182
        struct statvfs fsst;
183
184 1116097
        if (fstatvfs(fd, &fsst))
185 0
                return (-1);
186 1116097
        bs = fsst.f_frsize;
187 1116097
        size = fsst.f_blocks * fsst.f_frsize;
188 1116097
        space = fsst.f_bavail * fsst.f_frsize;
189
190 1116097
        if (pbs)
191 882
                *pbs = bs;
192 1116097
        if (psize)
193 882
                *psize = size;
194 1116097
        if (pspace)
195 1115215
                *pspace = space;
196 1116097
        return (0);
197 1116097
}
198
199
/*
200
 * Make sure that the file system can accommodate the file of the given
201
 * size. Will use fallocate if available. If fallocate is not available
202
 * and insist is true, it will write size zero bytes.
203
 *
204
 * Returns 0 on success, -1 on failure with errno set.
205
 */
206
207
int
208 1115215
VFIL_allocate(int fd, uintmax_t size, int insist)
209
{
210
        struct stat st;
211
        uintmax_t fsspace;
212
        size_t l;
213
        ssize_t l2, l3;
214
        char *buf;
215
        ssize_t bufsiz;
216 1115215
        int retval = 0;
217
218 1115215
        if (ftruncate(fd, size))
219 0
                return (-1);
220 1115215
        if (fstat(fd, &st))
221 0
                return (-1);
222 1115215
        if (VFIL_fsinfo(fd, NULL, NULL, &fsspace))
223 0
                return (-1);
224 1115215
        if ((st.st_blocks * 512) + fsspace < size) {
225
                /* Sum of currently allocated blocks and available space
226
                   is less than requested size */
227 0
                errno = ENOSPC;
228 0
                return (-1);
229
        }
230
#if defined(__linux__) && defined(HAVE_FALLOCATE)
231
        {
232
                /* fallocate will for some filesystems (e.g. xfs) not take
233
                   the already allocated blocks of the file into
234
                   account. This will cause fallocate to report ENOSPC
235
                   when called on an existing fully allocated file unless
236
                   the filesystem has enough free space to accommodate the
237
                   complete new file size. Because of this we enable
238
                   fallocate only on filesystems that are known to work as
239
                   we expect. */
240
                struct statfs stfs;
241
                if (!fstatfs(fd, &stfs) && stfs.f_type == EXT4_SUPER_MAGIC) {
242
                        if (!fallocate(fd, 0, 0, size))
243
                                return (0);
244
                        if (errno == ENOSPC)
245
                                return (-1);
246
                }
247
        }
248
#endif
249 1115215
        if (!insist)
250 105
                return (0);
251
252
        /* Write size zero bytes to make sure the entire file is allocated
253
           in the file system */
254 1115110
        if (size > 65536)
255 20888
                bufsiz = 64 * 1024;
256
        else
257 1094222
                bufsiz = size;
258 1115110
        buf = calloc(1, bufsiz);
259 1115110
        AN(buf);
260 1115110
        assert(lseek(fd, 0, SEEK_SET) == 0);
261 2923923
        for (l = 0; l < size; l += l2) {
262 1808813
                l2 = bufsiz;
263 1808813
                if (l + l2 > size)
264 0
                        l2 = size - l;
265 1808813
                l3 = write(fd, buf, l2);
266 1808813
                if (l3 != l2) {
267 0
                        retval = -1;
268 0
                        break;
269
                }
270 1808813
        }
271 1115110
        assert(lseek(fd, 0, SEEK_SET) == 0);
272 1115110
        free(buf);
273 1115110
        return (retval);
274 1115215
}
275
276
struct vfil_dir {
277
        unsigned                magic;
278
#define VFIL_DIR_MAGIC          0x3e214967
279
        char                    *dir;
280
        VTAILQ_ENTRY(vfil_dir)  list;
281
};
282
283
struct vfil_path {
284
        unsigned                magic;
285
#define VFIL_PATH_MAGIC         0x92dbcc31
286
        char                    *str;
287
        VTAILQ_HEAD(,vfil_dir)  paths;
288
};
289
290
/*
291
 * Path searching functions
292
 */
293
294
void
295 68794
VFIL_setpath(struct vfil_path **pp, const char *path)
296
{
297
        struct vfil_path *vp;
298
        struct vfil_dir *vd;
299
        char *p, *q;
300
301 68794
        AN(pp);
302 68794
        AN(path);
303
304 68794
        vp = *pp;
305 68794
        if (vp == NULL) {
306 68710
                ALLOC_OBJ(vp, VFIL_PATH_MAGIC);
307 68710
                AN(vp);
308 68710
                VTAILQ_INIT(&vp->paths);
309 68710
                *pp = vp;
310 68710
        }
311 68794
        REPLACE(vp->str, path);
312 68962
        while (!VTAILQ_EMPTY(&vp->paths)) {
313 168
                vd = VTAILQ_FIRST(&vp->paths);
314 168
                CHECK_OBJ_NOTNULL(vd, VFIL_DIR_MAGIC);
315 168
                VTAILQ_REMOVE(&vp->paths, vd, list);
316 168
                FREE_OBJ(vd);
317
        }
318 205122
        for (p = vp->str; p != NULL; p = q) {
319 136328
                q = strchr(p, ':');
320 136328
                if (q != NULL)
321 67534
                        *q++ = '\0';
322 136328
                ALLOC_OBJ(vd, VFIL_DIR_MAGIC);
323 136328
                AN(vd);
324 136328
                vd->dir = p;
325 136328
                VTAILQ_INSERT_TAIL(&vp->paths, vd, list);
326 136328
        }
327 68794
}
328
329
static int
330 1470
vfil_path_openfile(void *priv, const char *fn)
331
{
332
        char *p, **pp;
333
334 1470
        AN(priv);
335 1470
        AN(fn);
336 1470
        p = VFIL_readfile(NULL, fn, NULL);
337 1470
        if (p == NULL)
338 42
                return (1);
339
340 1428
        pp = priv;
341 1428
        *pp = p;
342 1428
        return (0);
343 1470
}
344
345
int
346 14763
VFIL_searchpath(const struct vfil_path *vp, vfil_path_func_f *func, void *priv,
347
    const char *fni, char **fno)
348
{
349
        struct vsb *vsb;
350
        struct vfil_dir *vd;
351
        int i, e;
352
353 14763
        CHECK_OBJ_NOTNULL(vp, VFIL_PATH_MAGIC);
354 14763
        AN(fno);
355 14763
        *fno = NULL;
356
357 14763
        if (func == NULL) {
358 1512
                func = vfil_path_openfile;
359 1512
                AN(priv);
360 1512
        }
361
362 14763
        if (*fni == '/') {
363 1260
                i = func(priv, fni);
364 1260
                if (i <= 0)
365 1218
                        REPLACE(*fno, fni);
366 1260
                return (i);
367
        }
368 13503
        vsb = VSB_new_auto();
369 13503
        AN(vsb);
370 13650
        VTAILQ_FOREACH(vd, &vp->paths, list) {
371 13566
                VSB_clear(vsb);
372 13566
                VSB_printf(vsb, "%s/%s", vd->dir, fni);
373 13566
                AZ(VSB_finish(vsb));
374 13566
                if (access(VSB_data(vsb), F_OK))
375 147
                        continue;
376 13419
                i = func(priv, VSB_data(vsb));
377 13419
                if (i <= 0) {
378 13419
                        e = errno;
379 13419
                        *fno = strdup(VSB_data(vsb));
380 13419
                        AN(*fno);
381 13419
                        VSB_destroy(&vsb);
382 13419
                        errno = e;
383 13419
                        return (i);
384
                }
385 0
        }
386 84
        VSB_destroy(&vsb);
387 84
        return (-1);
388 14763
}