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 3492
int onearg(VRT_CTX, const char *f, int nargs)
60
{
61 3492
        if (nargs == 1)
62 3474
                return (1);
63 36
        VRT_fail(ctx, "std.%s: %s arguments", f,
64 18
            nargs > 1 ? "too many" : "not enough");
65 18
        return (0);
66 3492
}
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 486
vmod_duration(VRT_CTX, struct VARGS(duration) *a)
75
{
76
        double r;
77
        int nargs;
78
79 486
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
80
81 486
        nargs = a->valid_s + a->valid_real + a->valid_integer;
82
83 486
        if (!onearg(ctx, "duration", nargs))
84 0
                return (0);
85
86 486
        if (a->valid_real)
87 54
                return ((VCL_DURATION)a->real);
88
89 432
        if (a->valid_integer)
90 36
                return ((VCL_DURATION)a->integer);
91
92 396
        if (a->valid_s) {
93 396
                r = VNUM_duration(a->s);
94 396
                if (!isnan(r))
95 216
                        return (r);
96 180
        }
97
98 180
        if (a->valid_fallback)
99 126
                return (a->fallback);
100
101 54
        VRT_fail(ctx, "std.duration: conversion failed");
102 54
        return (0);
103 486
}
104
105
VCL_BYTES v_matchproto_(td_std_bytes)
106 270
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 270
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
114
115 270
        nargs = a->valid_s + a->valid_real + a->valid_integer;
116
117 270
        if (!onearg(ctx, "bytes", nargs))
118 0
                return (0);
119
120 270
        if (a->valid_s) {
121 198
                errtxt = VNUM_2bytes(a->s, &r, 0);
122 198
                if (errtxt == NULL && r <= VCL_BYTES_MAX)
123 81
                        return ((VCL_BYTES)r);
124 117
        }
125
126 189
        if (a->valid_real && !isnan(a->real) && a->real >= 0) {
127 45
                rr = trunc(a->real);
128 45
                if (rr <= (VCL_REAL)VCL_BYTES_MAX)
129 45
                        return ((VCL_BYTES)rr);
130 0
        }
131
132 144
        if (a->valid_integer && a->integer >= 0)
133 27
                return ((VCL_BYTES)a->integer);
134
135 117
        if (a->valid_fallback)
136 108
                return (a->fallback);
137
138 9
        VRT_fail(ctx, "std.bytes: conversion failed");
139 9
        return (0);
140 270
}
141
142
VCL_INT v_matchproto_(td_std_integer)
143 1296
vmod_integer(VRT_CTX, struct VARGS(integer) *a)
144
{
145 1296
        const char *p, *errtxt = NULL;
146
        double r, tmp;
147
        int nargs;
148
149 1296
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
150
151 3888
        nargs = a->valid_s + a->valid_boolean + a->valid_bytes +
152 2592
            a->valid_duration + a->valid_real + a->valid_time;
153
154 1296
        if (!onearg(ctx, "integer", nargs))
155 18
                return (0);
156
157 1278
        r = NAN;
158 1278
        if (a->valid_boolean)
159 9
                return (a->boolean ? 1 : 0);
160
161 1269
        if (a->valid_bytes)
162 18
                return (a->bytes);
163
164 1251
        if (a->valid_s && a->s != NULL) {
165 936
                p = a->s;
166 936
                r = SF_Parse_Number(&p, 0, &errtxt);
167 936
                if (!errno && *p == '\0' && modf(r, &tmp) == 0.0)
168 792
                        return ((VCL_INT)r);
169 144
                r = NAN;
170 144
        }
171
172 459
        if (a->valid_duration)
173 27
                r = a->duration;
174
175 459
        if (a->valid_real)
176 45
                r = a->real;
177
178 459
        if (a->valid_time)
179 36
                r = a->time;
180
181 459
        if (!isnan(r)) {
182 108
                r = trunc(r);
183 108
                if (r >= VRT_INTEGER_MIN && r <= VRT_INTEGER_MAX)
184 108
                        return ((VCL_INT)r);
185 0
        }
186
187 351
        if (a->valid_fallback)
188 306
                return (a->fallback);
189
190 45
        if (errtxt != NULL)
191 18
                VRT_fail(ctx, "std.integer: conversion failed: %s", errtxt);
192
        else
193 27
                VRT_fail(ctx, "std.integer: conversion failed");
194 45
        return (0);
195 1296
}
196
197
VCL_IP
198 801
vmod_ip(VRT_CTX, struct VARGS(ip) *a)
199
{
200
        uintptr_t sn;
201
        void *p;
202 801
        VCL_IP retval = NULL, fb = bogo_ip;
203
204 801
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
205
206 801
        if (a->valid_fallback) {
207 216
                if (a->fallback == NULL || !VSA_Sane(a->fallback)) {
208 0
                        VRT_fail(ctx, "std.ip: invalid fallback");
209 0
                        return (fb);
210
                }
211 216
                fb = a->fallback;
212 216
        }
213
214 801
        sn = WS_Snapshot(ctx->ws);
215 801
        p = WS_Alloc(ctx->ws, vsa_suckaddr_len);
216 801
        if (p == NULL) {
217 0
                VRT_fail(ctx, "std.ip: insufficient workspace");
218 0
                return (fb);
219
        }
220
221 801
        if (a->s != NULL)
222 792
                retval = VSS_ResolveFirst(
223 792
                    p, a->s, a->valid_p ? a->p : "80",
224
                    AF_UNSPEC, SOCK_STREAM,
225 792
                    a->resolve ? 0 : AI_NUMERICHOST|AI_NUMERICSERV);
226
227 801
        if (retval != NULL)
228 675
                return (retval);
229
230 126
        WS_Reset(ctx->ws, sn);
231
232 126
        if (!a->valid_fallback)
233 0
                VRT_fail(ctx, "std.ip: conversion failed");
234
235 126
        return (fb);
236 801
}
237
238
VCL_REAL v_matchproto_(td_std_real)
239 540
vmod_real(VRT_CTX, struct VARGS(real) *a)
240
{
241
        VCL_REAL r;
242 540
        const char *p, *errtxt = NULL;
243
        int nargs;
244
245 540
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
246
247 1620
        nargs = a->valid_s + a->valid_integer + a->valid_boolean + a->valid_bytes +
248 1080
            a->valid_duration + a->valid_time;
249
250 540
        if (!onearg(ctx, "real", nargs))
251 0
                return (0);
252
253 540
        if (a->valid_integer)
254 27
                return ((VCL_REAL)a->integer);
255
256 513
        if (a->valid_boolean)
257 9
                return ((VCL_REAL)(a->boolean ? 1 : 0));
258
259 504
        if (a->valid_bytes)
260 18
                return ((VCL_REAL)a->bytes);
261
262 486
        if (a->valid_duration)
263 27
                return ((VCL_REAL)a->duration);
264
265 459
        if (a->valid_time)
266 18
                return ((VCL_REAL)a->time);
267
268 441
        if (a->valid_s && a->s != NULL) {
269 378
                p = a->s;
270 378
                r = SF_Parse_Decimal(&p, 0, &errtxt);
271 378
                if (!errno && *p == '\0')
272 315
                        return (r);
273 63
        }
274
275 126
        if (a->valid_fallback)
276 81
                return (a->fallback);
277
278 45
        if (errtxt != NULL)
279 18
                VRT_fail(ctx, "std.real: conversion failed: %s", errtxt);
280
        else
281 27
                VRT_fail(ctx, "std.real: conversion failed");
282 45
        return (0);
283 540
}
284
285
VCL_REAL v_matchproto_(td_std_round)
286 18
vmod_round(VRT_CTX, VCL_REAL r)
287
{
288 18
        (void) ctx;
289 18
        return (round(r));
290
}
291
292
VCL_TIME v_matchproto_(td_std_time)
293 900
vmod_time(VRT_CTX, struct VARGS(time)* a)
294
{
295
        double r;
296
        int nargs;
297
298 900
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
299
300 900
        nargs = a->valid_s + a->valid_real + a->valid_integer;
301
302 900
        if (!onearg(ctx, "time", nargs))
303 0
                return (0);
304
305 900
        if (a->valid_integer)
306 18
                return ((VCL_REAL)a->integer);
307
308 882
        if (a->valid_real)
309 27
                return ((VCL_REAL)a->real);
310
311 855
        if (a->valid_s && a->s != NULL) {
312 828
                r = VTIM_parse(a->s);
313 828
                if (r)
314 270
                        return (r);
315
316 558
                r = VNUM(a->s);
317
318 558
                if (!isnan(r) && r > 0)
319 126
                        return (r);
320 432
        }
321
322 459
        if (a->valid_fallback)
323 459
                return (a->fallback);
324
325 0
        VRT_fail(ctx, "std.time: conversion failed");
326 0
        return (0);
327 900
}
328
329
VCL_STRING v_matchproto_(td_std_strftime)
330 198
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 198
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
339
340 198
        tt = (time_t)(intmax_t)t;
341 198
        if (gmtime_r(&tt, &tm) == NULL)
342 0
                return ("");
343
344 198
        spc = WS_ReserveAll(ctx->ws);
345 198
        s = WS_Reservation(ctx->ws);
346 198
        r = strftime(s, spc, fmt, &tm);
347 198
        if (r == 0) {
348 9
                WS_Release(ctx->ws, 0);
349 9
                return ("");
350
        }
351 189
        r++;
352 189
        WS_Release(ctx->ws, r);
353 189
        return (s);
354 198
}
355
356
/* These functions are deprecated as of 2019-03-15 release */
357
358
VCL_INT v_matchproto_(td_std_real2integer)
359 36
vmod_real2integer(VRT_CTX, VCL_REAL r, VCL_INT i)
360
{
361
        VCL_INT retval;
362
363 36
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
364
365 36
        if (!VRT_REAL_is_valid(r))
366 18
                return (i);
367 18
        retval = (VCL_INT)round(r);
368 18
        if (!VRT_INT_is_valid(retval))
369 0
                return (i);
370 18
        return (retval);
371 36
}
372
373
VCL_TIME v_matchproto_(td_std_real2time)
374 54
vmod_real2time(VRT_CTX, VCL_REAL r, VCL_TIME t)
375
{
376 54
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
377
378 54
        if (!isfinite(r))
379 0
                return (t);
380
381 54
        return (r);
382 54
}
383
384
VCL_INT v_matchproto_(td_std_time2integer)
385 18
vmod_time2integer(VRT_CTX, VCL_TIME t, VCL_INT i)
386
{
387 18
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
388
389 18
        if (!isfinite(t))
390 0
                return (i);
391 18
        t = round(t);
392 18
        if (t > VRT_INTEGER_MAX || t < VRT_INTEGER_MIN)
393 0
                return (i);
394 18
        return ((VCL_INT)t);
395 18
}
396
397
VCL_REAL v_matchproto_(td_std_time2real)
398 18
vmod_time2real(VRT_CTX, VCL_TIME t, VCL_REAL r)
399
{
400 18
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
401
402 18
        if (!isfinite(t))
403 0
                return (r);
404
405 18
        return (t);
406 18
}