varnish-cache/vmod/vmod_std_conversions.c
0
/*-
1
 * Copyright (c) 2010-2015 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@FreeBSD.org>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 *
29
 */
30
31
#include "config.h"
32
33
#include <ctype.h>
34
#include <string.h>
35
#include <stdlib.h>
36
#include <sys/socket.h>
37
38
#include <netdb.h>
39
40
#include "cache/cache.h"
41
42
#include "vnum.h"
43
#include "vsa.h"
44
#include "vss.h"
45
#include "vtim.h"
46
#include "vcc_std_if.h"
47
48
/*
49
 * technically, as our VCL_INT is int64_t, its limits are INT64_MIN
50
 * .. INT64_MAX.
51
 *
52
 * We redistrict to VRT_INTEGER_MIN .. VRT_INTEGER_MAX
53
 */
54
55
/* limited by using double for conversions */
56
#define VCL_BYTES_MAX ((INT64_C(1)<<53)-1)
57
58
static
59 10425
int onearg(VRT_CTX, const char *f, int nargs)
60
{
61 10425
        if (nargs == 1)
62 10375
                return (1);
63 100
        VRT_fail(ctx, "std.%s: %s arguments", f,
64 50
            nargs > 1 ? "too many" : "not enough");
65 50
        return (0);
66 10425
}
67
68
/*
69
 * not handling real arg isfinite() / nan() : caller error
70
 * always trunc, never round
71
 */
72
73
VCL_DURATION v_matchproto_(td_std_duration)
74 1050
vmod_duration(VRT_CTX, struct VARGS(duration) *a)
75
{
76
        double r;
77
        int nargs;
78
79 1050
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
80
81 1050
        nargs = a->valid_s + a->valid_real + a->valid_integer;
82
83 1050
        if (!onearg(ctx, "duration", nargs))
84 0
                return (0);
85
86 1050
        if (a->valid_real)
87 150
                return ((VCL_DURATION)a->real);
88
89 900
        if (a->valid_integer)
90 100
                return ((VCL_DURATION)a->integer);
91
92 800
        if (a->valid_s) {
93 800
                r = VNUM_duration(a->s);
94 800
                if (!isnan(r))
95 425
                        return (r);
96 375
        }
97
98 375
        if (a->valid_fallback)
99 225
                return (a->fallback);
100
101 150
        VRT_fail(ctx, "std.duration: conversion failed");
102 150
        return (0);
103 1050
}
104
105
VCL_BYTES v_matchproto_(td_std_bytes)
106 750
vmod_bytes(VRT_CTX, struct VARGS(bytes) *a)
107
{
108
        uintmax_t r;
109
        VCL_REAL rr;
110
        int nargs;
111
        const char *errtxt;
112
113 750
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
114
115 750
        nargs = a->valid_s + a->valid_real + a->valid_integer;
116
117 750
        if (!onearg(ctx, "bytes", nargs))
118 0
                return (0);
119
120 750
        if (a->valid_s) {
121 550
                errtxt = VNUM_2bytes(a->s, &r, 0);
122 550
                if (errtxt == NULL && r <= VCL_BYTES_MAX)
123 225
                        return ((VCL_BYTES)r);
124 325
        }
125
126 525
        if (a->valid_real && !isnan(a->real) && a->real >= 0) {
127 125
                rr = trunc(a->real);
128 125
                if (rr <= (VCL_REAL)VCL_BYTES_MAX)
129 125
                        return ((VCL_BYTES)rr);
130 0
        }
131
132 400
        if (a->valid_integer && a->integer >= 0)
133 75
                return ((VCL_BYTES)a->integer);
134
135 325
        if (a->valid_fallback)
136 300
                return (a->fallback);
137
138 25
        VRT_fail(ctx, "std.bytes: conversion failed");
139 25
        return (0);
140 750
}
141
142
VCL_INT v_matchproto_(td_std_integer)
143 4625
vmod_integer(VRT_CTX, struct VARGS(integer) *a)
144
{
145 4625
        const char *p, *errtxt = NULL;
146
        double r, tmp;
147
        int nargs;
148
149 4625
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
150
151 13875
        nargs = a->valid_s + a->valid_bool + a->valid_bytes +
152 9250
            a->valid_duration + a->valid_real + a->valid_time;
153
154 4625
        if (!onearg(ctx, "integer", nargs))
155 50
                return (0);
156
157 4575
        r = NAN;
158 4575
        if (a->valid_bool)
159 25
                return (a->bool ? 1 : 0);
160
161 4550
        if (a->valid_bytes)
162 50
                return (a->bytes);
163
164 4500
        if (a->valid_s && a->s != NULL) {
165 3625
                p = a->s;
166 3625
                r = SF_Parse_Number(&p, 0, &errtxt);
167 3625
                if (!errno && *p == '\0' && modf(r, &tmp) == 0.0)
168 3225
                        return ((VCL_INT)r);
169 400
                r = NAN;
170 400
        }
171
172 1275
        if (a->valid_duration)
173 75
                r = a->duration;
174
175 1275
        if (a->valid_real)
176 125
                r = a->real;
177
178 1275
        if (a->valid_time)
179 100
                r = a->time;
180
181 1275
        if (!isnan(r)) {
182 300
                r = trunc(r);
183 300
                if (r >= VRT_INTEGER_MIN && r <= VRT_INTEGER_MAX)
184 300
                        return ((VCL_INT)r);
185 0
        }
186
187 975
        if (a->valid_fallback)
188 850
                return (a->fallback);
189
190 125
        if (errtxt != NULL)
191 50
                VRT_fail(ctx, "std.integer: conversion failed: %s", errtxt);
192
        else
193 75
                VRT_fail(ctx, "std.integer: conversion failed");
194 125
        return (0);
195 4625
}
196
197
VCL_IP
198 2225
vmod_ip(VRT_CTX, struct VARGS(ip) *a)
199
{
200
        uintptr_t sn;
201
        void *p;
202 2225
        VCL_IP retval = NULL, fb = bogo_ip;
203
204 2225
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
205
206 2225
        if (a->valid_fallback) {
207 600
                if (a->fallback == NULL || !VSA_Sane(a->fallback)) {
208 0
                        VRT_fail(ctx, "std.ip: invalid fallback");
209 0
                        return (fb);
210
                }
211 600
                fb = a->fallback;
212 600
        }
213
214 2225
        sn = WS_Snapshot(ctx->ws);
215 2225
        p = WS_Alloc(ctx->ws, vsa_suckaddr_len);
216 2225
        if (p == NULL) {
217 0
                VRT_fail(ctx, "std.ip: insufficient workspace");
218 0
                return (fb);
219
        }
220
221 2225
        if (a->s != NULL)
222 2200
                retval = VSS_ResolveFirst(
223 2200
                    p, a->s, a->valid_p ? a->p : "80",
224
                    AF_UNSPEC, SOCK_STREAM,
225 2200
                    a->resolve ? 0 : AI_NUMERICHOST|AI_NUMERICSERV);
226
227 2225
        if (retval != NULL)
228 1875
                return (retval);
229
230 350
        WS_Reset(ctx->ws, sn);
231
232 350
        if (!a->valid_fallback)
233 0
                VRT_fail(ctx, "std.ip: conversion failed");
234
235 350
        return (fb);
236 2225
}
237
238
VCL_REAL v_matchproto_(td_std_real)
239 1500
vmod_real(VRT_CTX, struct VARGS(real) *a)
240
{
241
        VCL_REAL r;
242 1500
        const char *p, *errtxt = NULL;
243
        int nargs;
244
245 1500
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
246
247 4500
        nargs = a->valid_s + a->valid_integer + a->valid_bool + a->valid_bytes +
248 3000
            a->valid_duration + a->valid_time;
249
250 1500
        if (!onearg(ctx, "real", nargs))
251 0
                return (0);
252
253 1500
        if (a->valid_integer)
254 75
                return ((VCL_REAL)a->integer);
255
256 1425
        if (a->valid_bool)
257 25
                return ((VCL_REAL)(a->bool ? 1 : 0));
258
259 1400
        if (a->valid_bytes)
260 50
                return ((VCL_REAL)a->bytes);
261
262 1350
        if (a->valid_duration)
263 75
                return ((VCL_REAL)a->duration);
264
265 1275
        if (a->valid_time)
266 50
                return ((VCL_REAL)a->time);
267
268 1225
        if (a->valid_s && a->s != NULL) {
269 1050
                p = a->s;
270 1050
                r = SF_Parse_Decimal(&p, 0, &errtxt);
271 1050
                if (!errno && *p == '\0')
272 875
                        return (r);
273 175
        }
274
275 350
        if (a->valid_fallback)
276 225
                return (a->fallback);
277
278 125
        if (errtxt != NULL)
279 50
                VRT_fail(ctx, "std.real: conversion failed: %s", errtxt);
280
        else
281 75
                VRT_fail(ctx, "std.real: conversion failed");
282 125
        return (0);
283 1500
}
284
285
VCL_REAL v_matchproto_(td_std_round)
286 50
vmod_round(VRT_CTX, VCL_REAL r)
287
{
288 50
        (void) ctx;
289 50
        return (round(r));
290
}
291
292
VCL_TIME v_matchproto_(td_std_time)
293 2500
vmod_time(VRT_CTX, struct VARGS(time)* a)
294
{
295
        double r;
296
        int nargs;
297
298 2500
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
299
300 2500
        nargs = a->valid_s + a->valid_real + a->valid_integer;
301
302 2500
        if (!onearg(ctx, "time", nargs))
303 0
                return (0);
304
305 2500
        if (a->valid_integer)
306 50
                return ((VCL_REAL)a->integer);
307
308 2450
        if (a->valid_real)
309 75
                return ((VCL_REAL)a->real);
310
311 2375
        if (a->valid_s && a->s != NULL) {
312 2300
                r = VTIM_parse(a->s);
313 2300
                if (r)
314 750
                        return (r);
315
316 1550
                r = VNUM(a->s);
317
318 1550
                if (!isnan(r) && r > 0)
319 350
                        return (r);
320 1200
        }
321
322 1275
        if (a->valid_fallback)
323 1275
                return (a->fallback);
324
325 0
        VRT_fail(ctx, "std.time: conversion failed");
326 0
        return (0);
327 2500
}
328
329
VCL_STRING v_matchproto_(td_std_strftime)
330 550
vmod_strftime(VRT_CTX, VCL_TIME t, VCL_STRING fmt)
331
{
332
        struct tm tm;
333
        time_t tt;
334
        size_t r;
335
        unsigned spc;
336
        char *s;
337
338 550
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
339
340 550
        tt = (time_t)(intmax_t)t;
341 550
        if (gmtime_r(&tt, &tm) == NULL)
342 0
                return ("");
343
344 550
        spc = WS_ReserveAll(ctx->ws);
345 550
        s = WS_Reservation(ctx->ws);
346 550
        r = strftime(s, spc, fmt, &tm);
347 550
        if (r == 0) {
348 25
                WS_Release(ctx->ws, 0);
349 25
                return ("");
350
        }
351 525
        r++;
352 525
        WS_Release(ctx->ws, r);
353 525
        return (s);
354 550
}
355
356
/* These functions are deprecated as of 2019-03-15 release */
357
358
VCL_INT v_matchproto_(td_std_real2integer)
359 100
vmod_real2integer(VRT_CTX, VCL_REAL r, VCL_INT i)
360
{
361
        VCL_INT retval;
362
363 100
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
364
365 100
        if (!VRT_REAL_is_valid(r))
366 50
                return (i);
367 50
        retval = (VCL_INT)round(r);
368 50
        if (!VRT_INT_is_valid(retval))
369 0
                return (i);
370 50
        return (retval);
371 100
}
372
373
VCL_TIME v_matchproto_(td_std_real2time)
374 150
vmod_real2time(VRT_CTX, VCL_REAL r, VCL_TIME t)
375
{
376 150
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
377
378 150
        if (!isfinite(r))
379 0
                return (t);
380
381 150
        return (r);
382 150
}
383
384
VCL_INT v_matchproto_(td_std_time2integer)
385 50
vmod_time2integer(VRT_CTX, VCL_TIME t, VCL_INT i)
386
{
387 50
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
388
389 50
        if (!isfinite(t))
390 0
                return (i);
391 50
        t = round(t);
392 50
        if (t > VRT_INTEGER_MAX || t < VRT_INTEGER_MIN)
393 0
                return (i);
394 50
        return ((VCL_INT)t);
395 50
}
396
397
VCL_REAL v_matchproto_(td_std_time2real)
398 50
vmod_time2real(VRT_CTX, VCL_TIME t, VCL_REAL r)
399
{
400 50
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
401
402 50
        if (!isfinite(t))
403 0
                return (r);
404
405 50
        return (t);
406 50
}