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 45261
VFIL_null_fd(int target)
59
{
60
        int fd;
61
62 45261
        assert(target >= 0);
63 45261
        fd = open("/dev/null", O_RDWR);
64 45261
        assert(fd >= 0);
65 45261
        assert(dup2(fd, target) == target);
66 45261
        closefd(&fd);
67 45261
}
68
69
static char *
70 23052
vfil_readfd(int fd, ssize_t *sz)
71
{
72
        struct stat st;
73
        char *f;
74
        int i;
75
76 23052
        AZ(fstat(fd, &st));
77 23052
        if (!S_ISREG(st.st_mode))
78 0
                return (NULL);
79 23052
        f = malloc(st.st_size + 1);
80 23052
        assert(f != NULL);
81 23052
        i = read(fd, f, st.st_size + 1);
82 23052
        if (i != st.st_size) {
83 0
                free(f);
84 0
                return (NULL);
85
        }
86 23052
        f[i] = '\0';
87 23052
        if (sz != NULL)
88 39
                *sz = st.st_size;
89 23052
        return (f);
90 23052
}
91
92
static int
93 54
vfil_writefd(int fd, const char *buf, size_t sz)
94
{
95
        ssize_t len;
96
97 108
        while (sz > 0) {
98 54
                len = write(fd, buf, sz);
99 54
                if (len < 0)
100 0
                        return (len);
101 54
                if (len == 0)
102 0
                        break;
103 54
                buf += len;
104 54
                sz -= len;
105
        }
106
107 54
        return (sz == 0 ? 0 : -1);
108 54
}
109
110
static int
111 23130
vfil_openfile(const char *pfx, const char *fn, int flags, int mode)
112
{
113
        char fnb[PATH_MAX + 1];
114
115 23130
        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 23130
        if (flags & O_CREAT)
122 54
                return (open(fn, flags, mode));
123
        else
124 23076
                return (open(fn, flags));
125 23130
}
126
127
char *
128 23076
VFIL_readfile(const char *pfx, const char *fn, ssize_t *sz)
129
{
130
        int fd, err;
131
        char *r;
132
133 23076
        fd = vfil_openfile(pfx, fn, O_RDONLY, 0);
134 23076
        if (fd < 0)
135 24
                return (NULL);
136 23052
        r = vfil_readfd(fd, sz);
137 23052
        err = errno;
138 23052
        closefd(&fd);
139 23052
        errno = err;
140 23052
        return (r);
141 23076
}
142
143
int
144 54
VFIL_writefile(const char *pfx, const char *fn, const char *buf, size_t sz)
145
{
146
        int fd, err;
147
        int r;
148
149 54
        fd = vfil_openfile(pfx, fn, O_WRONLY|O_CREAT|O_TRUNC, 0660);
150 54
        if (fd < 0)
151 0
                return (fd);
152 54
        r = vfil_writefd(fd, buf, sz);
153 54
        err = errno;
154 54
        closefd(&fd);
155 54
        errno = err;
156 54
        return (r);
157 54
}
158
159
int
160 3009
VFIL_nonblocking(int fd)
161
{
162
        int i;
163
164 3009
        i = fcntl(fd, F_GETFL);
165 3009
        assert(i != -1);
166 3009
        i |= O_NONBLOCK;
167 3009
        i = fcntl(fd, F_SETFL, i);
168 3009
        assert(i != -1);
169 3009
        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 156102
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 156102
        if (fstatvfs(fd, &fsst))
185 0
                return (-1);
186 156102
        bs = fsst.f_frsize;
187 156102
        size = fsst.f_blocks * fsst.f_frsize;
188 156102
        space = fsst.f_bavail * fsst.f_frsize;
189
190 156102
        if (pbs)
191 132
                *pbs = bs;
192 156102
        if (psize)
193 132
                *psize = size;
194 156102
        if (pspace)
195 155970
                *pspace = space;
196 156102
        return (0);
197 156102
}
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 155970
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 155970
        int retval = 0;
217
218 155970
        if (ftruncate(fd, size))
219 0
                return (-1);
220 155970
        if (fstat(fd, &st))
221 0
                return (-1);
222 155970
        if (VFIL_fsinfo(fd, NULL, NULL, &fsspace))
223 0
                return (-1);
224 155970
        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 155970
        if (!insist)
250 15
                return (0);
251
252
        /* Write size zero bytes to make sure the entire file is allocated
253
           in the file system */
254 155955
        if (size > 65536)
255 2919
                bufsiz = 64 * 1024;
256
        else
257 153036
                bufsiz = size;
258 155955
        buf = calloc(1, bufsiz);
259 155955
        AN(buf);
260 155955
        assert(lseek(fd, 0, SEEK_SET) == 0);
261 406143
        for (l = 0; l < size; l += l2) {
262 250188
                l2 = bufsiz;
263 250188
                if (l + l2 > size)
264 0
                        l2 = size - l;
265 250188
                l3 = write(fd, buf, l2);
266 250188
                if (l3 != l2) {
267 0
                        retval = -1;
268 0
                        break;
269
                }
270 250188
        }
271 155955
        assert(lseek(fd, 0, SEEK_SET) == 0);
272 155955
        free(buf);
273 155955
        return (retval);
274 155970
}
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 9612
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 9612
        AN(pp);
302 9612
        AN(path);
303
304 9612
        vp = *pp;
305 9612
        if (vp == NULL) {
306 9600
                ALLOC_OBJ(vp, VFIL_PATH_MAGIC);
307 9600
                AN(vp);
308 9600
                VTAILQ_INIT(&vp->paths);
309 9600
                *pp = vp;
310 9600
        }
311 9612
        REPLACE(vp->str, path);
312 9636
        while (!VTAILQ_EMPTY(&vp->paths)) {
313 24
                vd = VTAILQ_FIRST(&vp->paths);
314 24
                CHECK_OBJ_NOTNULL(vd, VFIL_DIR_MAGIC);
315 24
                VTAILQ_REMOVE(&vp->paths, vd, list);
316 24
                FREE_OBJ(vd);
317
        }
318 28653
        for (p = vp->str; p != NULL; p = q) {
319 19041
                q = strchr(p, ':');
320 19041
                if (q != NULL)
321 9429
                        *q++ = '\0';
322 19041
                ALLOC_OBJ(vd, VFIL_DIR_MAGIC);
323 19041
                AN(vd);
324 19041
                vd->dir = p;
325 19041
                VTAILQ_INSERT_TAIL(&vp->paths, vd, list);
326 19041
        }
327 9612
}
328
329
static int
330 189
vfil_path_openfile(void *priv, const char *fn)
331
{
332
        char *p, **pp;
333
334 189
        AN(priv);
335 189
        AN(fn);
336 189
        p = VFIL_readfile(NULL, fn, NULL);
337 189
        if (p == NULL)
338 6
                return (1);
339
340 183
        pp = priv;
341 183
        *pp = p;
342 183
        return (0);
343 189
}
344
345
int
346 2031
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 2031
        CHECK_OBJ_NOTNULL(vp, VFIL_PATH_MAGIC);
354 2031
        AN(fno);
355 2031
        *fno = NULL;
356
357 2031
        if (func == NULL) {
358 195
                func = vfil_path_openfile;
359 195
                AN(priv);
360 195
        }
361
362 2031
        if (*fni == '/') {
363 159
                i = func(priv, fni);
364 159
                if (i <= 0)
365 153
                        REPLACE(*fno, fni);
366 159
                return (i);
367
        }
368 1872
        vsb = VSB_new_auto();
369 1872
        AN(vsb);
370 1893
        VTAILQ_FOREACH(vd, &vp->paths, list) {
371 1881
                VSB_clear(vsb);
372 1881
                VSB_printf(vsb, "%s/%s", vd->dir, fni);
373 1881
                AZ(VSB_finish(vsb));
374 1881
                if (access(VSB_data(vsb), F_OK))
375 21
                        continue;
376 1860
                i = func(priv, VSB_data(vsb));
377 1860
                if (i <= 0) {
378 1860
                        e = errno;
379 1860
                        *fno = strdup(VSB_data(vsb));
380 1860
                        AN(*fno);
381 1860
                        VSB_destroy(&vsb);
382 1860
                        errno = e;
383 1860
                        return (i);
384
                }
385 0
        }
386 12
        VSB_destroy(&vsb);
387 12
        return (-1);
388 2031
}