ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CBOR-XS/XS.xs
Revision: 1.67
Committed: Sun Nov 29 21:35:06 2020 UTC (3 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-1_8
Changes since 1.66: +8 -6 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #include "EXTERN.h"
2 #include "perl.h"
3 #include "XSUB.h"
4
5 #include <assert.h>
6 #include <string.h>
7 #include <stdlib.h>
8 #include <stdio.h>
9 #include <limits.h>
10 #include <float.h>
11 #include <inttypes.h>
12
13 #define ECB_NO_THREADS 1
14 #include "ecb.h"
15
16 // compatibility with perl <5.18
17 #ifndef HvNAMELEN_get
18 # define HvNAMELEN_get(hv) strlen (HvNAME (hv))
19 #endif
20 #ifndef HvNAMELEN
21 # define HvNAMELEN(hv) HvNAMELEN_get (hv)
22 #endif
23 #ifndef HvNAMEUTF8
24 # define HvNAMEUTF8(hv) 0
25 #endif
26 #ifndef SvREFCNT_inc_NN
27 # define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
28 #endif
29 #ifndef SvREFCNT_dec_NN
30 # define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv)
31 #endif
32
33 // known major and minor types
34 enum cbor_type
35 {
36 MAJOR_SHIFT = 5,
37 MINOR_MASK = 0x1f,
38
39 MAJOR_POS_INT = 0 << MAJOR_SHIFT,
40 MAJOR_NEG_INT = 1 << MAJOR_SHIFT,
41 MAJOR_BYTES = 2 << MAJOR_SHIFT,
42 MAJOR_TEXT = 3 << MAJOR_SHIFT,
43 MAJOR_ARRAY = 4 << MAJOR_SHIFT,
44 MAJOR_MAP = 5 << MAJOR_SHIFT,
45 MAJOR_TAG = 6 << MAJOR_SHIFT,
46 MAJOR_MISC = 7 << MAJOR_SHIFT,
47
48 // INT/STRING/ARRAY/MAP subtypes
49 LENGTH_EXT1 = 24,
50 LENGTH_EXT2 = 25,
51 LENGTH_EXT4 = 26,
52 LENGTH_EXT8 = 27,
53
54 // SIMPLE types (effectively MISC subtypes)
55 SIMPLE_FALSE = 20,
56 SIMPLE_TRUE = 21,
57 SIMPLE_NULL = 22,
58 SIMPLE_UNDEF = 23,
59
60 // MISC subtype (unused)
61 MISC_EXT1 = 24,
62 MISC_FLOAT16 = 25,
63 MISC_FLOAT32 = 26,
64 MISC_FLOAT64 = 27,
65
66 // BYTES/TEXT/ARRAY/MAP
67 MINOR_INDEF = 31,
68 };
69
70 // known tags
71 enum cbor_tag
72 {
73 // extensions
74 CBOR_TAG_STRINGREF = 25, // http://cbor.schmorp.de/stringref
75 CBOR_TAG_PERL_OBJECT = 26, // http://cbor.schmorp.de/perl-object
76 CBOR_TAG_GENERIC_OBJECT = 27, // http://cbor.schmorp.de/generic-object
77 CBOR_TAG_VALUE_SHAREABLE = 28, // http://cbor.schmorp.de/value-sharing
78 CBOR_TAG_VALUE_SHAREDREF = 29, // http://cbor.schmorp.de/value-sharing
79 CBOR_TAG_STRINGREF_NAMESPACE = 256, // http://cbor.schmorp.de/stringref
80 CBOR_TAG_INDIRECTION = 22098, // http://cbor.schmorp.de/indirection
81
82 // rfc7049
83 CBOR_TAG_DATETIME = 0, // rfc4287, utf-8
84 CBOR_TAG_TIMESTAMP = 1, // unix timestamp, any
85 CBOR_TAG_POS_BIGNUM = 2, // byte string
86 CBOR_TAG_NEG_BIGNUM = 3, // byte string
87 CBOR_TAG_DECIMAL = 4, // decimal fraction, array
88 CBOR_TAG_BIGFLOAT = 5, // array
89
90 CBOR_TAG_CONV_B64U = 21, // base64url, any
91 CBOR_TAG_CONV_B64 = 22, // base64, any
92 CBOR_TAG_CONV_HEX = 23, // base16, any
93 CBOR_TAG_CBOR = 24, // embedded cbor, byte string
94
95 CBOR_TAG_URI = 32, // URI rfc3986, utf-8
96 CBOR_TAG_B64U = 33, // base64url rfc4648, utf-8
97 CBOR_TAG_B64 = 34, // base6 rfc46484, utf-8
98 CBOR_TAG_REGEX = 35, // regex pcre/ecma262, utf-8
99 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8
100
101 CBOR_TAG_MAGIC = 55799, // self-describe cbor
102 };
103
104 // known forced types, also hardcoded in CBOR.pm
105 enum
106 {
107 AS_CBOR = 0,
108 AS_BYTES = 1,
109 AS_TEXT = 2,
110 AS_INT = 3,
111 AS_FLOAT16 = 4,
112 AS_FLOAT32 = 5,
113 AS_FLOAT64 = 6,
114 // possibly future enhancements: (generic) float, (generic) string
115 };
116
117 #define F_SHRINK 0x00000001UL
118 #define F_ALLOW_UNKNOWN 0x00000002UL
119 #define F_ALLOW_SHARING 0x00000004UL
120 #define F_ALLOW_CYCLES 0x00000008UL
121 #define F_FORBID_OBJECTS 0x00000010UL
122 #define F_PACK_STRINGS 0x00000020UL
123 #define F_TEXT_KEYS 0x00000040UL
124 #define F_TEXT_STRINGS 0x00000080UL
125 #define F_VALIDATE_UTF8 0x00000100UL
126
127 #define INIT_SIZE 32 // initial scalar size to be allocated
128
129 #define SB do {
130 #define SE } while (0)
131
132 #define IN_RANGE_INC(type,val,beg,end) \
133 ((unsigned type)((unsigned type)(val) - (unsigned type)(beg)) \
134 <= (unsigned type)((unsigned type)(end) - (unsigned type)(beg)))
135
136 #define ERR_NESTING_EXCEEDED "cbor text or perl structure exceeds maximum nesting level (max_depth set too low?)"
137
138 #ifdef USE_ITHREADS
139 # define CBOR_SLOW 1
140 # define CBOR_STASH (cbor_stash ? cbor_stash : gv_stashpv ("CBOR::XS", 1))
141 #else
142 # define CBOR_SLOW 0
143 # define CBOR_STASH cbor_stash
144 #endif
145
146 static HV *cbor_stash, *types_boolean_stash, *types_error_stash, *cbor_tagged_stash; // CBOR::XS::
147 static SV *types_true, *types_false, *types_error, *sv_cbor, *default_filter;
148
149 typedef struct {
150 U32 flags;
151 U32 max_depth;
152 STRLEN max_size;
153 SV *filter;
154
155 // for the incremental parser
156 STRLEN incr_pos; // the current offset into the text
157 STRLEN incr_need; // minimum bytes needed to decode
158 AV *incr_count; // for every nesting level, the number of outstanding values, or -1 for indef.
159 } CBOR;
160
161 ecb_inline void
162 cbor_init (CBOR *cbor)
163 {
164 Zero (cbor, 1, CBOR);
165 cbor->max_depth = 512;
166 }
167
168 ecb_inline void
169 cbor_free (CBOR *cbor)
170 {
171 SvREFCNT_dec (cbor->filter);
172 SvREFCNT_dec (cbor->incr_count);
173 }
174
175 /////////////////////////////////////////////////////////////////////////////
176 // utility functions
177
178 ecb_inline SV *
179 get_bool (const char *name)
180 {
181 SV *sv = get_sv (name, 1);
182
183 SvREADONLY_on (sv);
184 SvREADONLY_on (SvRV (sv));
185
186 return sv;
187 }
188
189 ecb_inline void
190 shrink (SV *sv)
191 {
192 sv_utf8_downgrade (sv, 1);
193
194 if (SvLEN (sv) > SvCUR (sv) + 1)
195 {
196 #ifdef SvPV_shrink_to_cur
197 SvPV_shrink_to_cur (sv);
198 #elif defined (SvPV_renew)
199 SvPV_renew (sv, SvCUR (sv) + 1);
200 #endif
201 }
202 }
203
204 // minimum length of a string to be registered for stringref
205 ecb_inline int
206 minimum_string_length (UV idx)
207 {
208 return idx <= 23 ? 3
209 : idx <= 0xffU ? 4
210 : idx <= 0xffffU ? 5
211 : idx <= 0xffffffffU ? 7
212 : 11;
213 }
214
215 /////////////////////////////////////////////////////////////////////////////
216 // encoder
217
218 // structure used for encoding CBOR
219 typedef struct
220 {
221 char *cur; // SvPVX (sv) + current output position
222 char *end; // SvEND (sv)
223 SV *sv; // result scalar
224 CBOR cbor;
225 U32 depth; // recursion level
226 HV *stringref[2]; // string => index, or 0 ([0] = bytes, [1] = utf-8)
227 UV stringref_idx;
228 HV *shareable; // ptr => index, or 0
229 UV shareable_idx;
230 } enc_t;
231
232 ecb_inline void
233 need (enc_t *enc, STRLEN len)
234 {
235 if (ecb_expect_false ((uintptr_t)(enc->end - enc->cur) < len))
236 {
237 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv);
238 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1);
239 enc->cur = SvPVX (enc->sv) + cur;
240 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1;
241 }
242 }
243
244 ecb_inline void
245 encode_ch (enc_t *enc, char ch)
246 {
247 need (enc, 1);
248 *enc->cur++ = ch;
249 }
250
251 // used for tags, intregers, element counts and so on
252 static void
253 encode_uint (enc_t *enc, int major, UV len)
254 {
255 need (enc, 9);
256
257 if (ecb_expect_true (len < LENGTH_EXT1))
258 *enc->cur++ = major | len;
259 else if (ecb_expect_true (len <= 0xffU))
260 {
261 *enc->cur++ = major | LENGTH_EXT1;
262 *enc->cur++ = len;
263 }
264 else if (len <= 0xffffU)
265 {
266 *enc->cur++ = major | LENGTH_EXT2;
267 *enc->cur++ = len >> 8;
268 *enc->cur++ = len;
269 }
270 else if (len <= 0xffffffffU)
271 {
272 *enc->cur++ = major | LENGTH_EXT4;
273 *enc->cur++ = len >> 24;
274 *enc->cur++ = len >> 16;
275 *enc->cur++ = len >> 8;
276 *enc->cur++ = len;
277 }
278 else
279 {
280 *enc->cur++ = major | LENGTH_EXT8;
281 *enc->cur++ = len >> 56;
282 *enc->cur++ = len >> 48;
283 *enc->cur++ = len >> 40;
284 *enc->cur++ = len >> 32;
285 *enc->cur++ = len >> 24;
286 *enc->cur++ = len >> 16;
287 *enc->cur++ = len >> 8;
288 *enc->cur++ = len;
289 }
290 }
291
292 // encodes a perl value into a CBOR integer
293 ecb_inline void
294 encode_int (enc_t *enc, SV *sv)
295 {
296 if (SvIsUV (sv))
297 encode_uint (enc, MAJOR_POS_INT, SvUVX (sv));
298 else if (SvIVX (sv) >= 0)
299 encode_uint (enc, MAJOR_POS_INT, SvIVX (sv));
300 else
301 encode_uint (enc, MAJOR_NEG_INT, -(SvIVX (sv) + 1));
302 }
303
304 ecb_inline void
305 encode_tag (enc_t *enc, UV tag)
306 {
307 encode_uint (enc, MAJOR_TAG, tag);
308 }
309
310 // exceptional (hopefully) slow path for byte strings that need to be utf8-encoded
311 ecb_noinline static void
312 encode_str_utf8 (enc_t *enc, int utf8, char *str, STRLEN len)
313 {
314 STRLEN ulen = len;
315 U8 *p, *pend = (U8 *)str + len;
316
317 for (p = (U8 *)str; p < pend; ++p)
318 ulen += *p >> 7; // count set high bits
319
320 encode_uint (enc, MAJOR_TEXT, ulen);
321
322 need (enc, ulen);
323 for (p = (U8 *)str; p < pend; ++p)
324 if (*p < 0x80)
325 *enc->cur++ = *p;
326 else
327 {
328 *enc->cur++ = 0xc0 + (*p >> 6);
329 *enc->cur++ = 0x80 + (*p & 63);
330 }
331 }
332
333 ecb_inline void
334 encode_str (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
335 {
336 if (ecb_expect_false (upgrade_utf8))
337 if (!utf8)
338 {
339 encode_str_utf8 (enc, utf8, str, len);
340 return;
341 }
342
343 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len);
344 need (enc, len);
345 memcpy (enc->cur, str, len);
346 enc->cur += len;
347 }
348
349 ecb_inline void
350 encode_strref (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
351 {
352 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS))
353 {
354 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1);
355
356 if (SvOK (*svp))
357 {
358 // already registered, use stringref
359 encode_tag (enc, CBOR_TAG_STRINGREF);
360 encode_uint (enc, MAJOR_POS_INT, SvUV (*svp));
361 return;
362 }
363 else if (len >= minimum_string_length (enc->stringref_idx))
364 {
365 // register only
366 sv_setuv (*svp, enc->stringref_idx);
367 ++enc->stringref_idx;
368 }
369 }
370
371 encode_str (enc, upgrade_utf8, utf8, str, len);
372 }
373
374 ecb_inline void
375 encode_float16 (enc_t *enc, NV nv)
376 {
377 need (enc, 1+2);
378
379 *enc->cur++ = MAJOR_MISC | MISC_FLOAT16;
380
381 uint16_t fp = ecb_float_to_binary16 (nv);
382
383 if (!ecb_big_endian ())
384 fp = ecb_bswap16 (fp);
385
386 memcpy (enc->cur, &fp, 2);
387 enc->cur += 2;
388 }
389
390 ecb_inline void
391 encode_float32 (enc_t *enc, NV nv)
392 {
393 need (enc, 1+4);
394
395 *enc->cur++ = MAJOR_MISC | MISC_FLOAT32;
396
397 uint32_t fp = ecb_float_to_binary32 (nv);
398
399 if (!ecb_big_endian ())
400 fp = ecb_bswap32 (fp);
401
402 memcpy (enc->cur, &fp, 4);
403 enc->cur += 4;
404 }
405
406 ecb_inline void
407 encode_float64 (enc_t *enc, NV nv)
408 {
409 need (enc, 1+8);
410
411 *enc->cur++ = MAJOR_MISC | MISC_FLOAT64;
412
413 uint64_t fp = ecb_double_to_binary64 (nv);
414
415 if (!ecb_big_endian ())
416 fp = ecb_bswap64 (fp);
417
418 memcpy (enc->cur, &fp, 8);
419 enc->cur += 8;
420 }
421
422 ecb_inline void
423 encode_forced (enc_t *enc, UV type, SV *sv)
424 {
425 switch (type)
426 {
427 case AS_CBOR:
428 {
429 STRLEN len;
430 char *str = SvPVbyte (sv, len);
431
432 need (enc, len);
433 memcpy (enc->cur, str, len);
434 enc->cur += len;
435 }
436 break;
437
438 case AS_BYTES:
439 {
440 STRLEN len;
441 char *str = SvPVbyte (sv, len);
442 encode_strref (enc, 0, 0, str, len);
443 }
444 break;
445
446 case AS_TEXT:
447 {
448 STRLEN len;
449 char *str = SvPVutf8 (sv, len);
450 encode_strref (enc, 1, 1, str, len);
451 }
452 break;
453
454 case AS_INT: encode_int (enc, sv); break;
455 case AS_FLOAT16: encode_float16 (enc, SvNV (sv)); break;
456 case AS_FLOAT32: encode_float32 (enc, SvNV (sv)); break;
457 case AS_FLOAT64: encode_float64 (enc, SvNV (sv)); break;
458
459 default:
460 croak ("encountered malformed CBOR::XS::Tagged object");
461 }
462 }
463
464 static void encode_sv (enc_t *enc, SV *sv);
465
466 static void
467 encode_av (enc_t *enc, AV *av)
468 {
469 int i, len = av_len (av);
470
471 if (enc->depth >= enc->cbor.max_depth)
472 croak (ERR_NESTING_EXCEEDED);
473
474 ++enc->depth;
475
476 encode_uint (enc, MAJOR_ARRAY, len + 1);
477
478 if (ecb_expect_false (SvMAGICAL (av)))
479 for (i = 0; i <= len; ++i)
480 {
481 SV **svp = av_fetch (av, i, 0);
482 encode_sv (enc, svp ? *svp : &PL_sv_undef);
483 }
484 else
485 for (i = 0; i <= len; ++i)
486 {
487 SV *sv = AvARRAY (av)[i];
488 encode_sv (enc, sv ? sv : &PL_sv_undef);
489 }
490
491 --enc->depth;
492 }
493
494 static void
495 encode_hv (enc_t *enc, HV *hv)
496 {
497 HE *he;
498
499 if (enc->depth >= enc->cbor.max_depth)
500 croak (ERR_NESTING_EXCEEDED);
501
502 ++enc->depth;
503
504 int pairs = hv_iterinit (hv);
505 int mg = SvMAGICAL (hv);
506
507 if (ecb_expect_false (mg))
508 encode_ch (enc, MAJOR_MAP | MINOR_INDEF);
509 else
510 encode_uint (enc, MAJOR_MAP, pairs);
511
512 while ((he = hv_iternext (hv)))
513 {
514 if (HeKLEN (he) == HEf_SVKEY)
515 encode_sv (enc, HeSVKEY (he));
516 else
517 encode_strref (enc, enc->cbor.flags & (F_TEXT_KEYS | F_TEXT_STRINGS), HeKUTF8 (he), HeKEY (he), HeKLEN (he));
518
519 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he));
520 }
521
522 if (ecb_expect_false (mg))
523 encode_ch (enc, MAJOR_MISC | MINOR_INDEF);
524
525 --enc->depth;
526 }
527
528 // encode objects, arrays and special \0=false and \1=true values.
529 static void
530 encode_rv (enc_t *enc, SV *sv)
531 {
532 SvGETMAGIC (sv);
533
534 svtype svt = SvTYPE (sv);
535
536 if (ecb_expect_false (SvOBJECT (sv)))
537 {
538 HV *boolean_stash = !CBOR_SLOW || types_boolean_stash
539 ? types_boolean_stash
540 : gv_stashpv ("Types::Serialiser::Boolean", 1);
541 HV *error_stash = !CBOR_SLOW || types_error_stash
542 ? types_error_stash
543 : gv_stashpv ("Types::Serialiser::Error", 1);
544 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
545 ? cbor_tagged_stash
546 : gv_stashpv ("CBOR::XS::Tagged" , 1);
547
548 HV *stash = SvSTASH (sv);
549
550 if (stash == boolean_stash)
551 {
552 encode_ch (enc, SvIV (sv) ? MAJOR_MISC | SIMPLE_TRUE : MAJOR_MISC | SIMPLE_FALSE);
553 return;
554 }
555 else if (stash == error_stash)
556 {
557 encode_ch (enc, MAJOR_MISC | SIMPLE_UNDEF);
558 return;
559 }
560 else if (stash == tagged_stash)
561 {
562 if (svt != SVt_PVAV)
563 croak ("encountered CBOR::XS::Tagged object that isn't an array");
564
565 switch (av_len ((AV *)sv))
566 {
567 case 2-1:
568 // actually a tagged value
569 encode_uint (enc, MAJOR_TAG, SvUV (*av_fetch ((AV *)sv, 0, 1)));
570 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1));
571 break;
572
573 case 3-1:
574 // a forced type [value, type, undef]
575 encode_forced (enc, SvUV (*av_fetch ((AV *)sv, 1, 1)), *av_fetch ((AV *)sv, 0, 1));
576 break;
577
578 default:
579 croak ("encountered malformed CBOR::XS::Tagged object");
580 }
581
582 return;
583 }
584 }
585
586 if (ecb_expect_false (SvREFCNT (sv) > 1)
587 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING))
588 {
589 if (ecb_expect_false (!enc->shareable))
590 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ());
591
592 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1);
593
594 if (SvOK (*svp))
595 {
596 encode_tag (enc, CBOR_TAG_VALUE_SHAREDREF);
597 encode_uint (enc, MAJOR_POS_INT, SvUV (*svp));
598 return;
599 }
600 else
601 {
602 sv_setuv (*svp, enc->shareable_idx);
603 ++enc->shareable_idx;
604 encode_tag (enc, CBOR_TAG_VALUE_SHAREABLE);
605 }
606 }
607
608 if (ecb_expect_false (SvOBJECT (sv)))
609 {
610 HV *stash = SvSTASH (sv);
611 GV *method;
612
613 if (enc->cbor.flags & F_FORBID_OBJECTS)
614 croak ("encountered object '%s', but forbid_objects is enabled",
615 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
616 else if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
617 {
618 dSP;
619
620 ENTER; SAVETMPS;
621 PUSHMARK (SP);
622 // we re-bless the reference to get overload and other niceties right
623 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
624
625 PUTBACK;
626 // G_SCALAR ensures that return value is 1
627 call_sv ((SV *)GvCV (method), G_SCALAR);
628 SPAGAIN;
629
630 // catch this surprisingly common error
631 if (SvROK (TOPs) && SvRV (TOPs) == sv)
632 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (stash));
633
634 encode_sv (enc, POPs);
635
636 PUTBACK;
637
638 FREETMPS; LEAVE;
639 }
640 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
641 {
642 dSP;
643
644 ENTER; SAVETMPS;
645 PUSHMARK (SP);
646 EXTEND (SP, 2);
647 // we re-bless the reference to get overload and other niceties right
648 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
649 PUSHs (sv_cbor);
650
651 PUTBACK;
652 int count = call_sv ((SV *)GvCV (method), G_ARRAY);
653 SPAGAIN;
654
655 // catch this surprisingly common error
656 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
657 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash));
658
659 encode_tag (enc, CBOR_TAG_PERL_OBJECT);
660 encode_uint (enc, MAJOR_ARRAY, count + 1);
661 encode_strref (enc, 0, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
662
663 {
664 int i;
665
666 for (i = 0; i < count; ++i)
667 encode_sv (enc, SP[i + 1 - count]);
668
669 SP -= count;
670 }
671
672 PUTBACK;
673
674 FREETMPS; LEAVE;
675 }
676 else
677 croak ("encountered object '%s', but no TO_CBOR or FREEZE methods available on it",
678 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
679 }
680 else if (svt == SVt_PVHV)
681 encode_hv (enc, (HV *)sv);
682 else if (svt == SVt_PVAV)
683 encode_av (enc, (AV *)sv);
684 else
685 {
686 encode_tag (enc, CBOR_TAG_INDIRECTION);
687 encode_sv (enc, sv);
688 }
689 }
690
691 static void
692 encode_nv (enc_t *enc, SV *sv)
693 {
694 double nv = SvNVX (sv);
695
696 need (enc, 9);
697
698 if (ecb_expect_false (nv == (NV)(U32)nv))
699 encode_uint (enc, MAJOR_POS_INT, (U32)nv);
700 //TODO: maybe I32?
701 else if (ecb_expect_false (nv == (float)nv))
702 encode_float32 (enc, nv);
703 else
704 encode_float64 (enc, nv);
705 }
706
707 static void
708 encode_sv (enc_t *enc, SV *sv)
709 {
710 SvGETMAGIC (sv);
711
712 if (SvPOKp (sv))
713 {
714 STRLEN len;
715 char *str = SvPV (sv, len);
716 encode_strref (enc, enc->cbor.flags & F_TEXT_STRINGS, SvUTF8 (sv), str, len);
717 }
718 else if (SvNOKp (sv))
719 encode_nv (enc, sv);
720 else if (SvIOKp (sv))
721 encode_int (enc, sv);
722 else if (SvROK (sv))
723 encode_rv (enc, SvRV (sv));
724 else if (!SvOK (sv))
725 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL);
726 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
727 encode_ch (enc, MAJOR_MISC | SIMPLE_UNDEF);
728 else
729 croak ("encountered perl type (%s,0x%x) that CBOR cannot handle, check your input data",
730 SvPV_nolen (sv), (unsigned int)SvFLAGS (sv));
731 }
732
733 static SV *
734 encode_cbor (SV *scalar, CBOR *cbor)
735 {
736 enc_t enc = { 0 };
737
738 enc.cbor = *cbor;
739 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE));
740 enc.cur = SvPVX (enc.sv);
741 enc.end = SvEND (enc.sv);
742
743 SvPOK_only (enc.sv);
744
745 if (cbor->flags & F_PACK_STRINGS)
746 {
747 encode_tag (&enc, CBOR_TAG_STRINGREF_NAMESPACE);
748 enc.stringref[0]= (HV *)sv_2mortal ((SV *)newHV ());
749 enc.stringref[1]= (HV *)sv_2mortal ((SV *)newHV ());
750 }
751
752 encode_sv (&enc, scalar);
753
754 SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv));
755 *SvEND (enc.sv) = 0; // many xs functions expect a trailing 0 for text strings
756
757 if (enc.cbor.flags & F_SHRINK)
758 shrink (enc.sv);
759
760 return enc.sv;
761 }
762
763 /////////////////////////////////////////////////////////////////////////////
764 // decoder
765
766 // structure used for decoding CBOR
767 typedef struct
768 {
769 U8 *cur; // current parser pointer
770 U8 *end; // end of input string
771 const char *err; // parse error, if != 0
772 CBOR cbor;
773 U32 depth; // recursion depth
774 U32 maxdepth; // recursion depth limit
775 AV *shareable;
776 AV *stringref;
777 SV *decode_tagged;
778 SV *err_sv; // optional sv for error, needs to be freed
779 } dec_t;
780
781 // set dec->err to ERRSV
782 ecb_cold static void
783 err_errsv (dec_t *dec)
784 {
785 if (!dec->err)
786 {
787 dec->err_sv = newSVsv (ERRSV);
788
789 // chop off the trailing \n
790 SvCUR_set (dec->err_sv, SvCUR (dec->err_sv) - 1);
791 *SvEND (dec->err_sv) = 0;
792
793 dec->err = SvPVutf8_nolen (dec->err_sv);
794 }
795 }
796
797 // the following functions are used to reduce code size and help the compiler to optimise
798 ecb_cold static void
799 err_set (dec_t *dec, const char *reason)
800 {
801 if (!dec->err)
802 dec->err = reason;
803 }
804
805 ecb_cold static void
806 err_unexpected_end (dec_t *dec)
807 {
808 err_set (dec, "unexpected end of CBOR data");
809 }
810
811 #define ERR_DO(do) SB do; goto fail; SE
812 #define ERR(reason) ERR_DO (err_set (dec, reason))
813 #define ERR_ERRSV ERR_DO (err_errsv (dec))
814
815 #define WANT(len) if (ecb_expect_false ((uintptr_t)(dec->end - dec->cur) < (STRLEN)len)) ERR_DO (err_unexpected_end (dec))
816
817 #define DEC_INC_DEPTH if (ecb_expect_false (++dec->depth > dec->cbor.max_depth)) ERR (ERR_NESTING_EXCEEDED)
818 #define DEC_DEC_DEPTH --dec->depth
819
820 static UV
821 decode_uint (dec_t *dec)
822 {
823 U8 m = *dec->cur & MINOR_MASK;
824 ++dec->cur;
825
826 if (ecb_expect_true (m < LENGTH_EXT1))
827 return m;
828 else if (ecb_expect_true (m == LENGTH_EXT1))
829 {
830 WANT (1);
831 dec->cur += 1;
832 return dec->cur[-1];
833 }
834 else if (ecb_expect_true (m == LENGTH_EXT2))
835 {
836 WANT (2);
837 dec->cur += 2;
838 return (((UV)dec->cur[-2]) << 8)
839 | ((UV)dec->cur[-1]);
840 }
841 else if (ecb_expect_true (m == LENGTH_EXT4))
842 {
843 WANT (4);
844 dec->cur += 4;
845 return (((UV)dec->cur[-4]) << 24)
846 | (((UV)dec->cur[-3]) << 16)
847 | (((UV)dec->cur[-2]) << 8)
848 | ((UV)dec->cur[-1]);
849 }
850 else if (ecb_expect_true (m == LENGTH_EXT8))
851 {
852 WANT (8);
853 dec->cur += 8;
854
855 return
856 #if UVSIZE < 8
857 0
858 #else
859 (((UV)dec->cur[-8]) << 56)
860 | (((UV)dec->cur[-7]) << 48)
861 | (((UV)dec->cur[-6]) << 40)
862 | (((UV)dec->cur[-5]) << 32)
863 #endif
864 | (((UV)dec->cur[-4]) << 24)
865 | (((UV)dec->cur[-3]) << 16)
866 | (((UV)dec->cur[-2]) << 8)
867 | ((UV)dec->cur[-1]);
868 }
869 else
870 ERR ("corrupted CBOR data (unsupported integer minor encoding)");
871
872 fail:
873 return 0;
874 }
875
876 static SV *decode_sv (dec_t *dec);
877
878 static SV *
879 decode_av (dec_t *dec)
880 {
881 AV *av = newAV ();
882
883 DEC_INC_DEPTH;
884
885 if (*dec->cur == (MAJOR_ARRAY | MINOR_INDEF))
886 {
887 ++dec->cur;
888
889 for (;;)
890 {
891 WANT (1);
892
893 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
894 {
895 ++dec->cur;
896 break;
897 }
898
899 av_push (av, decode_sv (dec));
900 }
901 }
902 else
903 {
904 UV i, len = decode_uint (dec);
905
906 WANT (len); // complexity check for av_fill - need at least one byte per value, do not allow supersize arrays
907 av_fill (av, len - 1);
908
909 for (i = 0; i < len; ++i)
910 AvARRAY (av)[i] = decode_sv (dec);
911 }
912
913 DEC_DEC_DEPTH;
914 return newRV_noinc ((SV *)av);
915
916 fail:
917 SvREFCNT_dec_NN (av);
918 DEC_DEC_DEPTH;
919 return &PL_sv_undef;
920 }
921
922 static void
923 decode_he (dec_t *dec, HV *hv)
924 {
925 // for speed reasons, we specialcase single-string
926 // byte or utf-8 strings as keys, but only when !stringref
927
928 if (ecb_expect_true (!dec->stringref))
929 if (ecb_expect_true ((U8)(*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8))
930 {
931 STRLEN len = decode_uint (dec);
932 char *key = (char *)dec->cur;
933
934 WANT (len);
935 dec->cur += len;
936
937 hv_store (hv, key, len, decode_sv (dec), 0);
938
939 return;
940 }
941 else if (ecb_expect_true ((U8)(*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8))
942 {
943 STRLEN len = decode_uint (dec);
944 char *key = (char *)dec->cur;
945
946 WANT (len);
947 dec->cur += len;
948
949 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
950 if (!is_utf8_string (key, len))
951 ERR ("corrupted CBOR data (invalid UTF-8 in map key)");
952
953 hv_store (hv, key, -len, decode_sv (dec), 0);
954
955 return;
956 }
957
958 SV *k = decode_sv (dec);
959 SV *v = decode_sv (dec);
960
961 // we leak memory if uncaught exceptions are thrown by random magical
962 // methods, and this is hopefully the only place where it can happen,
963 // so if there is a chance of an exception, take the very slow path.
964 // since catching exceptions is "undocumented/internal/forbidden" by
965 // the new p5p powers, we need to call out to a perl function :/
966 if (ecb_expect_false (SvAMAGIC (k)))
967 {
968 dSP;
969
970 ENTER; SAVETMPS;
971 PUSHMARK (SP);
972 EXTEND (SP, 3);
973 PUSHs (sv_2mortal (newRV_inc ((SV *)hv)));
974 PUSHs (sv_2mortal (k));
975 PUSHs (sv_2mortal (v));
976
977 PUTBACK;
978 call_pv ("CBOR::XS::_hv_store", G_VOID | G_DISCARD | G_EVAL);
979 SPAGAIN;
980
981 FREETMPS; LEAVE;
982
983 if (SvTRUE (ERRSV))
984 ERR_ERRSV;
985
986 return;
987 }
988
989 hv_store_ent (hv, k, v, 0);
990 SvREFCNT_dec_NN (k);
991
992 fail:
993 ;
994 }
995
996 static SV *
997 decode_hv (dec_t *dec)
998 {
999 HV *hv = newHV ();
1000
1001 DEC_INC_DEPTH;
1002
1003 if (*dec->cur == (MAJOR_MAP | MINOR_INDEF))
1004 {
1005 ++dec->cur;
1006
1007 for (;;)
1008 {
1009 WANT (1);
1010
1011 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
1012 {
1013 ++dec->cur;
1014 break;
1015 }
1016
1017 decode_he (dec, hv);
1018 }
1019 }
1020 else
1021 {
1022 UV pairs = decode_uint (dec);
1023
1024 WANT (pairs); // complexity check - need at least one byte per value, do not allow supersize hashes
1025
1026 while (pairs--)
1027 decode_he (dec, hv);
1028 }
1029
1030 DEC_DEC_DEPTH;
1031 return newRV_noinc ((SV *)hv);
1032
1033 fail:
1034 SvREFCNT_dec_NN (hv);
1035 DEC_DEC_DEPTH;
1036 return &PL_sv_undef;
1037 }
1038
1039 static SV *
1040 decode_str (dec_t *dec, int utf8)
1041 {
1042 SV *sv = 0;
1043
1044 if (ecb_expect_false ((*dec->cur & MINOR_MASK) == MINOR_INDEF))
1045 {
1046 // indefinite length strings
1047 ++dec->cur;
1048
1049 U8 major = *dec->cur & MAJOR_MISC;
1050
1051 sv = newSVpvn ("", 0);
1052
1053 for (;;)
1054 {
1055 WANT (1);
1056
1057 if ((*dec->cur - major) > LENGTH_EXT8)
1058 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF))
1059 {
1060 ++dec->cur;
1061 break;
1062 }
1063 else
1064 ERR ("corrupted CBOR data (invalid chunks in indefinite length string)");
1065
1066 STRLEN len = decode_uint (dec);
1067
1068 WANT (len);
1069 sv_catpvn (sv, dec->cur, len);
1070 dec->cur += len;
1071 }
1072 }
1073 else
1074 {
1075 STRLEN len = decode_uint (dec);
1076
1077 WANT (len);
1078 sv = newSVpvn (dec->cur, len);
1079 dec->cur += len;
1080
1081 if (ecb_expect_false (dec->stringref)
1082 && SvCUR (sv) >= minimum_string_length (AvFILLp (dec->stringref) + 1))
1083 av_push (dec->stringref, SvREFCNT_inc_NN (sv));
1084 }
1085
1086 if (utf8)
1087 {
1088 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
1089 if (!is_utf8_string (SvPVX (sv), SvCUR (sv)))
1090 ERR ("corrupted CBOR data (invalid UTF-8 in text string)");
1091
1092 SvUTF8_on (sv);
1093 }
1094
1095 return sv;
1096
1097 fail:
1098 SvREFCNT_dec (sv);
1099 return &PL_sv_undef;
1100 }
1101
1102 static SV *
1103 decode_tagged (dec_t *dec)
1104 {
1105 SV *sv = 0;
1106 UV tag = decode_uint (dec);
1107
1108 WANT (1);
1109
1110 switch (tag)
1111 {
1112 case CBOR_TAG_MAGIC:
1113 sv = decode_sv (dec);
1114 break;
1115
1116 case CBOR_TAG_INDIRECTION:
1117 sv = newRV_noinc (decode_sv (dec));
1118 break;
1119
1120 case CBOR_TAG_STRINGREF_NAMESPACE:
1121 {
1122 // do not use SAVETMPS/FREETMPS, as these will
1123 // erase mortalised caches, e.g. "shareable"
1124 ENTER;
1125
1126 SAVESPTR (dec->stringref);
1127 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ());
1128
1129 sv = decode_sv (dec);
1130
1131 LEAVE;
1132 }
1133 break;
1134
1135 case CBOR_TAG_STRINGREF:
1136 {
1137 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
1138 ERR ("corrupted CBOR data (stringref index not an unsigned integer)");
1139
1140 UV idx = decode_uint (dec);
1141
1142 if (!dec->stringref || idx >= (UV)(1 + AvFILLp (dec->stringref)))
1143 ERR ("corrupted CBOR data (stringref index out of bounds or outside namespace)");
1144
1145 sv = newSVsv (AvARRAY (dec->stringref)[idx]);
1146 }
1147 break;
1148
1149 case CBOR_TAG_VALUE_SHAREABLE:
1150 {
1151 if (ecb_expect_false (!dec->shareable))
1152 dec->shareable = (AV *)sv_2mortal ((SV *)newAV ());
1153
1154 if (dec->cbor.flags & F_ALLOW_CYCLES)
1155 {
1156 sv = newSV (0);
1157 av_push (dec->shareable, SvREFCNT_inc_NN (sv));
1158
1159 SV *osv = decode_sv (dec);
1160 sv_setsv (sv, osv);
1161 SvREFCNT_dec_NN (osv);
1162 }
1163 else
1164 {
1165 av_push (dec->shareable, &PL_sv_undef);
1166 int idx = AvFILLp (dec->shareable);
1167 sv = decode_sv (dec);
1168 av_store (dec->shareable, idx, SvREFCNT_inc_NN (sv));
1169 }
1170 }
1171 break;
1172
1173 case CBOR_TAG_VALUE_SHAREDREF:
1174 {
1175 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
1176 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)");
1177
1178 UV idx = decode_uint (dec);
1179
1180 if (!dec->shareable || idx >= (UV)(1 + AvFILLp (dec->shareable)))
1181 ERR ("corrupted CBOR data (sharedref index out of bounds)");
1182
1183 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]);
1184
1185 if (sv == &PL_sv_undef)
1186 ERR ("cyclic CBOR data structure found, but allow_cycles is not enabled");
1187 }
1188 break;
1189
1190 case CBOR_TAG_PERL_OBJECT:
1191 {
1192 if (dec->cbor.flags & F_FORBID_OBJECTS)
1193 goto filter;
1194
1195 sv = decode_sv (dec);
1196
1197 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
1198 ERR ("corrupted CBOR data (non-array perl object)");
1199
1200 AV *av = (AV *)SvRV (sv);
1201 int len = av_len (av) + 1;
1202 HV *stash = gv_stashsv (*av_fetch (av, 0, 1), 0);
1203
1204 if (!stash)
1205 ERR ("cannot decode perl-object (package does not exist)");
1206
1207 GV *method = gv_fetchmethod_autoload (stash, "THAW", 0);
1208
1209 if (!method)
1210 ERR ("cannot decode perl-object (package does not have a THAW method)");
1211
1212 dSP;
1213
1214 ENTER; SAVETMPS;
1215 PUSHMARK (SP);
1216 EXTEND (SP, len + 1);
1217 // we re-bless the reference to get overload and other niceties right
1218 PUSHs (*av_fetch (av, 0, 1));
1219 PUSHs (sv_cbor);
1220
1221 int i;
1222
1223 for (i = 1; i < len; ++i)
1224 PUSHs (*av_fetch (av, i, 1));
1225
1226 PUTBACK;
1227 call_sv ((SV *)GvCV (method), G_SCALAR | G_EVAL);
1228 SPAGAIN;
1229
1230 if (SvTRUE (ERRSV))
1231 {
1232 FREETMPS; LEAVE;
1233 ERR_ERRSV;
1234 }
1235
1236 SvREFCNT_dec_NN (sv);
1237 sv = SvREFCNT_inc (POPs);
1238
1239 PUTBACK;
1240
1241 FREETMPS; LEAVE;
1242 }
1243 break;
1244
1245 default:
1246 filter:
1247 {
1248 SV *tag_sv = newSVuv (tag);
1249
1250 sv = decode_sv (dec);
1251
1252 dSP;
1253 ENTER; SAVETMPS;
1254 PUSHMARK (SP);
1255 EXTEND (SP, 2);
1256 PUSHs (tag_sv);
1257 PUSHs (sv);
1258
1259 PUTBACK;
1260 int count = call_sv (dec->cbor.filter ? dec->cbor.filter : default_filter, G_ARRAY | G_EVAL);
1261 SPAGAIN;
1262
1263 if (SvTRUE (ERRSV))
1264 {
1265 SvREFCNT_dec_NN (tag_sv);
1266 FREETMPS; LEAVE;
1267 ERR_ERRSV;
1268 }
1269
1270 if (count)
1271 {
1272 SvREFCNT_dec_NN (tag_sv);
1273 SvREFCNT_dec_NN (sv);
1274 sv = SvREFCNT_inc_NN (TOPs);
1275 SP -= count;
1276 }
1277 else
1278 {
1279 AV *av = newAV ();
1280 av_push (av, tag_sv);
1281 av_push (av, sv);
1282
1283 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
1284 ? cbor_tagged_stash
1285 : gv_stashpv ("CBOR::XS::Tagged" , 1);
1286 sv = sv_bless (newRV_noinc ((SV *)av), tagged_stash);
1287 }
1288
1289 PUTBACK;
1290
1291 FREETMPS; LEAVE;
1292 }
1293 break;
1294 }
1295
1296 return sv;
1297
1298 fail:
1299 SvREFCNT_dec (sv);
1300 return &PL_sv_undef;
1301 }
1302
1303 static SV *
1304 decode_sv (dec_t *dec)
1305 {
1306 WANT (1);
1307
1308 switch (*dec->cur >> MAJOR_SHIFT)
1309 {
1310 case MAJOR_POS_INT >> MAJOR_SHIFT: return newSVuv (decode_uint (dec));
1311 case MAJOR_NEG_INT >> MAJOR_SHIFT: return newSViv (-1 - (IV)decode_uint (dec));
1312 case MAJOR_BYTES >> MAJOR_SHIFT: return decode_str (dec, 0);
1313 case MAJOR_TEXT >> MAJOR_SHIFT: return decode_str (dec, 1);
1314 case MAJOR_ARRAY >> MAJOR_SHIFT: return decode_av (dec);
1315 case MAJOR_MAP >> MAJOR_SHIFT: return decode_hv (dec);
1316 case MAJOR_TAG >> MAJOR_SHIFT: return decode_tagged (dec);
1317
1318 case MAJOR_MISC >> MAJOR_SHIFT:
1319 switch (*dec->cur++ & MINOR_MASK)
1320 {
1321 case SIMPLE_FALSE:
1322 #if CBOR_SLOW
1323 types_false = get_bool ("Types::Serialiser::false");
1324 #endif
1325 return newSVsv (types_false);
1326 case SIMPLE_TRUE:
1327 #if CBOR_SLOW
1328 types_true = get_bool ("Types::Serialiser::true");
1329 #endif
1330 return newSVsv (types_true);
1331 case SIMPLE_NULL:
1332 return newSVsv (&PL_sv_undef);
1333 case SIMPLE_UNDEF:
1334 #if CBOR_SLOW
1335 types_error = get_bool ("Types::Serialiser::error");
1336 #endif
1337 return newSVsv (types_error);
1338
1339 case MISC_FLOAT16:
1340 {
1341 WANT (2);
1342
1343 uint16_t fp = (dec->cur[0] << 8) | dec->cur[1];
1344 dec->cur += 2;
1345
1346 return newSVnv (ecb_binary16_to_float (fp));
1347 }
1348
1349 case MISC_FLOAT32:
1350 {
1351 uint32_t fp;
1352 WANT (4);
1353 memcpy (&fp, dec->cur, 4);
1354 dec->cur += 4;
1355
1356 if (!ecb_big_endian ())
1357 fp = ecb_bswap32 (fp);
1358
1359 return newSVnv (ecb_binary32_to_float (fp));
1360 }
1361
1362 case MISC_FLOAT64:
1363 {
1364 uint64_t fp;
1365 WANT (8);
1366 memcpy (&fp, dec->cur, 8);
1367 dec->cur += 8;
1368
1369 if (!ecb_big_endian ())
1370 fp = ecb_bswap64 (fp);
1371
1372 return newSVnv (ecb_binary64_to_double (fp));
1373 }
1374
1375 // 0..19 unassigned simple
1376 // 24 reserved + unassigned simple (reserved values are not encodable)
1377 // 28-30 unassigned misc
1378 // 31 break code
1379 default:
1380 ERR ("corrupted CBOR data (reserved/unassigned/unexpected major 7 value)");
1381 }
1382
1383 break;
1384 }
1385
1386 fail:
1387 return &PL_sv_undef;
1388 }
1389
1390 static SV *
1391 decode_cbor (SV *string, CBOR *cbor, char **offset_return)
1392 {
1393 dec_t dec = { 0 };
1394 SV *sv;
1395 STRLEN len;
1396 char *data = SvPVbyte (string, len);
1397
1398 if (len > cbor->max_size && cbor->max_size)
1399 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
1400 (unsigned long)len, (unsigned long)cbor->max_size);
1401
1402 dec.cbor = *cbor;
1403 dec.cur = (U8 *)data;
1404 dec.end = (U8 *)data + len;
1405
1406 sv = decode_sv (&dec);
1407
1408 if (offset_return)
1409 *offset_return = dec.cur;
1410
1411 if (!(offset_return || !sv))
1412 if (dec.cur != dec.end && !dec.err)
1413 dec.err = "garbage after CBOR object";
1414
1415 if (dec.err)
1416 {
1417 if (dec.shareable)
1418 {
1419 // need to break cyclic links, which would all be in shareable
1420 int i;
1421 SV **svp;
1422
1423 for (i = av_len (dec.shareable) + 1; i--; )
1424 if ((svp = av_fetch (dec.shareable, i, 0)))
1425 sv_setsv (*svp, &PL_sv_undef);
1426 }
1427
1428 SvREFCNT_dec_NN (sv);
1429
1430 if (dec.err_sv)
1431 sv_2mortal (dec.err_sv);
1432
1433 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur);
1434 }
1435
1436 sv = sv_2mortal (sv);
1437
1438 return sv;
1439 }
1440
1441 /////////////////////////////////////////////////////////////////////////////
1442 // incremental parser
1443
1444 #define INCR_DONE(cbor) (AvFILLp (cbor->incr_count) < 0)
1445
1446 // returns 0 for notyet, 1 for success or error
1447 static int
1448 incr_parse (CBOR *self, SV *cborstr)
1449 {
1450 STRLEN cur;
1451 SvPV (cborstr, cur);
1452
1453 while (ecb_expect_true (self->incr_need <= cur))
1454 {
1455 // table of integer count bytes
1456 static I8 incr_len[MINOR_MASK + 1] = {
1457 0, 0, 0, 0, 0, 0, 0, 0,
1458 0, 0, 0, 0, 0, 0, 0, 0,
1459 0, 0, 0, 0, 0, 0, 0, 0,
1460 1, 2, 4, 8,-1,-1,-1,-2
1461 };
1462
1463 const U8 *p = SvPVX (cborstr) + self->incr_pos;
1464 U8 m = *p & MINOR_MASK;
1465 IV count = SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]);
1466 I8 ilen = incr_len[m];
1467
1468 self->incr_need = self->incr_pos + 1;
1469
1470 if (ecb_expect_false (ilen < 0))
1471 {
1472 if (m != MINOR_INDEF)
1473 return 1; // error
1474
1475 if (*p == (MAJOR_MISC | MINOR_INDEF))
1476 {
1477 if (count >= 0)
1478 return 1; // error
1479
1480 count = 1;
1481 }
1482 else
1483 {
1484 av_push (self->incr_count, newSViv (-1)); //TODO: nest
1485 count = -1;
1486 }
1487 }
1488 else
1489 {
1490 self->incr_need += ilen;
1491 if (ecb_expect_false (self->incr_need > cur))
1492 return 0;
1493
1494 int major = *p >> MAJOR_SHIFT;
1495
1496 switch (major)
1497 {
1498 case MAJOR_TAG >> MAJOR_SHIFT:
1499 ++count; // tags merely prefix another value
1500 break;
1501
1502 case MAJOR_BYTES >> MAJOR_SHIFT:
1503 case MAJOR_TEXT >> MAJOR_SHIFT:
1504 case MAJOR_ARRAY >> MAJOR_SHIFT:
1505 case MAJOR_MAP >> MAJOR_SHIFT:
1506 {
1507 UV len;
1508
1509 if (ecb_expect_false (ilen))
1510 {
1511 len = 0;
1512
1513 do {
1514 len = (len << 8) | *++p;
1515 } while (--ilen);
1516 }
1517 else
1518 len = m;
1519
1520 switch (major)
1521 {
1522 case MAJOR_BYTES >> MAJOR_SHIFT:
1523 case MAJOR_TEXT >> MAJOR_SHIFT:
1524 self->incr_need += len;
1525 if (ecb_expect_false (self->incr_need > cur))
1526 return 0;
1527
1528 break;
1529
1530 case MAJOR_MAP >> MAJOR_SHIFT:
1531 len <<= 1;
1532 case MAJOR_ARRAY >> MAJOR_SHIFT:
1533 if (len)
1534 {
1535 av_push (self->incr_count, newSViv (len + 1)); //TODO: nest
1536 count = len + 1;
1537 }
1538 break;
1539 }
1540 }
1541 }
1542 }
1543
1544 self->incr_pos = self->incr_need;
1545
1546 if (count > 0)
1547 {
1548 while (!--count)
1549 {
1550 if (!AvFILLp (self->incr_count))
1551 return 1; // done
1552
1553 SvREFCNT_dec_NN (av_pop (self->incr_count));
1554 count = SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]);
1555 }
1556
1557 SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]) = count;
1558 }
1559 }
1560
1561 return 0;
1562 }
1563
1564
1565 /////////////////////////////////////////////////////////////////////////////
1566 // XS interface functions
1567
1568 MODULE = CBOR::XS PACKAGE = CBOR::XS
1569
1570 BOOT:
1571 {
1572 cbor_stash = gv_stashpv ("CBOR::XS" , 1);
1573 cbor_tagged_stash = gv_stashpv ("CBOR::XS::Tagged" , 1);
1574
1575 types_boolean_stash = gv_stashpv ("Types::Serialiser::Boolean", 1);
1576 types_error_stash = gv_stashpv ("Types::Serialiser::Error" , 1);
1577
1578 types_true = get_bool ("Types::Serialiser::true" );
1579 types_false = get_bool ("Types::Serialiser::false");
1580 types_error = get_bool ("Types::Serialiser::error");
1581
1582 default_filter = newSVpv ("CBOR::XS::default_filter", 0);
1583
1584 sv_cbor = newSVpv ("CBOR", 0);
1585 SvREADONLY_on (sv_cbor);
1586
1587 assert (("STRLEN must be an unsigned type", 0 <= (STRLEN)-1));
1588 }
1589
1590 PROTOTYPES: DISABLE
1591
1592 void CLONE (...)
1593 CODE:
1594 cbor_stash = 0;
1595 cbor_tagged_stash = 0;
1596 types_error_stash = 0;
1597 types_boolean_stash = 0;
1598
1599 void new (char *klass)
1600 PPCODE:
1601 {
1602 SV *pv = NEWSV (0, sizeof (CBOR));
1603 SvPOK_only (pv);
1604 cbor_init ((CBOR *)SvPVX (pv));
1605 XPUSHs (sv_2mortal (sv_bless (
1606 newRV_noinc (pv),
1607 strEQ (klass, "CBOR::XS") ? CBOR_STASH : gv_stashpv (klass, 1)
1608 )));
1609 }
1610
1611 void shrink (CBOR *self, int enable = 1)
1612 ALIAS:
1613 shrink = F_SHRINK
1614 allow_unknown = F_ALLOW_UNKNOWN
1615 allow_sharing = F_ALLOW_SHARING
1616 allow_cycles = F_ALLOW_CYCLES
1617 forbid_objects = F_FORBID_OBJECTS
1618 pack_strings = F_PACK_STRINGS
1619 text_keys = F_TEXT_KEYS
1620 text_strings = F_TEXT_STRINGS
1621 validate_utf8 = F_VALIDATE_UTF8
1622 PPCODE:
1623 {
1624 if (enable)
1625 self->flags |= ix;
1626 else
1627 self->flags &= ~ix;
1628
1629 XPUSHs (ST (0));
1630 }
1631
1632 void get_shrink (CBOR *self)
1633 ALIAS:
1634 get_shrink = F_SHRINK
1635 get_allow_unknown = F_ALLOW_UNKNOWN
1636 get_allow_sharing = F_ALLOW_SHARING
1637 get_allow_cycles = F_ALLOW_CYCLES
1638 get_forbid_objects = F_FORBID_OBJECTS
1639 get_pack_strings = F_PACK_STRINGS
1640 get_text_keys = F_TEXT_KEYS
1641 get_text_strings = F_TEXT_STRINGS
1642 get_validate_utf8 = F_VALIDATE_UTF8
1643 PPCODE:
1644 XPUSHs (boolSV (self->flags & ix));
1645
1646 void max_depth (CBOR *self, U32 max_depth = 0x80000000UL)
1647 PPCODE:
1648 self->max_depth = max_depth;
1649 XPUSHs (ST (0));
1650
1651 U32 get_max_depth (CBOR *self)
1652 CODE:
1653 RETVAL = self->max_depth;
1654 OUTPUT:
1655 RETVAL
1656
1657 void max_size (CBOR *self, U32 max_size = 0)
1658 PPCODE:
1659 self->max_size = max_size;
1660 XPUSHs (ST (0));
1661
1662 int get_max_size (CBOR *self)
1663 CODE:
1664 RETVAL = self->max_size;
1665 OUTPUT:
1666 RETVAL
1667
1668 void filter (CBOR *self, SV *filter = 0)
1669 PPCODE:
1670 SvREFCNT_dec (self->filter);
1671 self->filter = filter ? newSVsv (filter) : filter;
1672 XPUSHs (ST (0));
1673
1674 SV *get_filter (CBOR *self)
1675 CODE:
1676 RETVAL = self->filter ? self->filter : NEWSV (0, 0);
1677 OUTPUT:
1678 RETVAL
1679
1680 void encode (CBOR *self, SV *scalar)
1681 PPCODE:
1682 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN;
1683 XPUSHs (scalar);
1684
1685 void decode (CBOR *self, SV *cborstr)
1686 PPCODE:
1687 PUTBACK; cborstr = decode_cbor (cborstr, self, 0); SPAGAIN;
1688 XPUSHs (cborstr);
1689
1690 void decode_prefix (CBOR *self, SV *cborstr)
1691 PPCODE:
1692 {
1693 SV *sv;
1694 char *offset;
1695 PUTBACK; sv = decode_cbor (cborstr, self, &offset); SPAGAIN;
1696 EXTEND (SP, 2);
1697 PUSHs (sv);
1698 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr))));
1699 }
1700
1701 void incr_parse (CBOR *self, SV *cborstr)
1702 ALIAS:
1703 incr_parse_multiple = 1
1704 PPCODE:
1705 {
1706 if (SvUTF8 (cborstr))
1707 sv_utf8_downgrade (cborstr, 0);
1708
1709 if (!self->incr_count)
1710 {
1711 self->incr_count = newAV ();
1712 self->incr_pos = 0;
1713 self->incr_need = 1;
1714
1715 av_push (self->incr_count, newSViv (1));
1716 }
1717
1718 do
1719 {
1720 if (!incr_parse (self, cborstr))
1721 {
1722 if (self->incr_need > self->max_size && self->max_size)
1723 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
1724 (unsigned long)self->incr_need, (unsigned long)self->max_size);
1725
1726 break;
1727 }
1728
1729 SV *sv;
1730 char *offset;
1731
1732 PUTBACK; sv = decode_cbor (cborstr, self, &offset); SPAGAIN;
1733 XPUSHs (sv);
1734
1735 sv_chop (cborstr, offset);
1736
1737 av_clear (self->incr_count);
1738 av_push (self->incr_count, newSViv (1));
1739
1740 self->incr_pos = 0;
1741 self->incr_need = self->incr_pos + 1;
1742 }
1743 while (ix);
1744 }
1745
1746 void incr_reset (CBOR *self)
1747 CODE:
1748 {
1749 SvREFCNT_dec (self->incr_count);
1750 self->incr_count = 0;
1751 }
1752
1753 void DESTROY (CBOR *self)
1754 PPCODE:
1755 cbor_free (self);
1756
1757 PROTOTYPES: ENABLE
1758
1759 void encode_cbor (SV *scalar)
1760 ALIAS:
1761 encode_cbor = 0
1762 encode_cbor_sharing = F_ALLOW_SHARING
1763 PPCODE:
1764 {
1765 CBOR cbor;
1766 cbor_init (&cbor);
1767 cbor.flags |= ix;
1768 PUTBACK; scalar = encode_cbor (scalar, &cbor); SPAGAIN;
1769 XPUSHs (scalar);
1770 }
1771
1772 void decode_cbor (SV *cborstr)
1773 PPCODE:
1774 {
1775 CBOR cbor;
1776 cbor_init (&cbor);
1777 PUTBACK; cborstr = decode_cbor (cborstr, &cbor, 0); SPAGAIN;
1778 XPUSHs (cborstr);
1779 }
1780
1781 #ifdef __AFL_COMPILER
1782
1783 void
1784 afl_init ()
1785 CODE:
1786 __AFL_INIT ();
1787
1788 int
1789 afl_loop (unsigned int count = 10000)
1790 CODE:
1791 RETVAL = __AFL_LOOP (count);
1792 OUTPUT:
1793 RETVAL
1794
1795 #endif
1796