ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CBOR-XS/XS.xs
(Generate patch)

Comparing CBOR-XS/XS.xs (file contents):
Revision 1.42 by root, Tue Dec 10 15:31:40 2013 UTC vs.
Revision 1.66 by root, Sun Nov 29 21:32:01 2020 UTC

6#include <string.h> 6#include <string.h>
7#include <stdlib.h> 7#include <stdlib.h>
8#include <stdio.h> 8#include <stdio.h>
9#include <limits.h> 9#include <limits.h>
10#include <float.h> 10#include <float.h>
11#include <inttypes.h>
11 12
13#define ECB_NO_THREADS 1
12#include "ecb.h" 14#include "ecb.h"
13 15
14// compatibility with perl <5.18 16// compatibility with perl <5.18
15#ifndef HvNAMELEN_get 17#ifndef HvNAMELEN_get
16# define HvNAMELEN_get(hv) strlen (HvNAME (hv)) 18# define HvNAMELEN_get(hv) strlen (HvNAME (hv))
19# define HvNAMELEN(hv) HvNAMELEN_get (hv) 21# define HvNAMELEN(hv) HvNAMELEN_get (hv)
20#endif 22#endif
21#ifndef HvNAMEUTF8 23#ifndef HvNAMEUTF8
22# define HvNAMEUTF8(hv) 0 24# define HvNAMEUTF8(hv) 0
23#endif 25#endif
26#ifndef SvREFCNT_inc_NN
27# define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
28#endif
24#ifndef SvREFCNT_dec_NN 29#ifndef SvREFCNT_dec_NN
25# define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv) 30# define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv)
26#endif 31#endif
27 32
28// known major and minor types 33// known major and minor types
94 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8 99 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8
95 100
96 CBOR_TAG_MAGIC = 55799, // self-describe cbor 101 CBOR_TAG_MAGIC = 55799, // self-describe cbor
97}; 102};
98 103
104// known forced types, also hardcoded in CBOR.pm
105enum
106{
107 AS_CBOR = 0,
108 AS_BYTES = 1,
109 AS_TEXT = 2,
110 AS_FLOAT16 = 3,
111 AS_FLOAT32 = 4,
112 AS_FLOAT64 = 5,
113 // possibly future enhancements: float, integer
114};
115
99#define F_SHRINK 0x00000001UL 116#define F_SHRINK 0x00000001UL
100#define F_ALLOW_UNKNOWN 0x00000002UL 117#define F_ALLOW_UNKNOWN 0x00000002UL
101#define F_ALLOW_SHARING 0x00000004UL 118#define F_ALLOW_SHARING 0x00000004UL
102#define F_ALLOW_CYCLES 0x00000008UL 119#define F_ALLOW_CYCLES 0x00000008UL
120#define F_FORBID_OBJECTS 0x00000010UL
103#define F_PACK_STRINGS 0x00000010UL 121#define F_PACK_STRINGS 0x00000020UL
122#define F_TEXT_KEYS 0x00000040UL
123#define F_TEXT_STRINGS 0x00000080UL
104#define F_VALIDATE_UTF8 0x00000020UL 124#define F_VALIDATE_UTF8 0x00000100UL
105 125
106#define INIT_SIZE 32 // initial scalar size to be allocated 126#define INIT_SIZE 32 // initial scalar size to be allocated
107 127
108#define SB do { 128#define SB do {
109#define SE } while (0) 129#define SE } while (0)
182 202
183// minimum length of a string to be registered for stringref 203// minimum length of a string to be registered for stringref
184ecb_inline int 204ecb_inline int
185minimum_string_length (UV idx) 205minimum_string_length (UV idx)
186{ 206{
187 return idx > 23 207 return idx <= 23 ? 3
188 ? idx > 0xffU 208 : idx <= 0xffU ? 4
189 ? idx > 0xffffU 209 : idx <= 0xffffU ? 5
190 ? idx > 0xffffffffU 210 : idx <= 0xffffffffU ? 7
191 ? 11 211 : 11;
192 : 7
193 : 5
194 : 4
195 : 3;
196} 212}
197 213
198///////////////////////////////////////////////////////////////////////////// 214/////////////////////////////////////////////////////////////////////////////
199// encoder 215// encoder
200 216
213} enc_t; 229} enc_t;
214 230
215ecb_inline void 231ecb_inline void
216need (enc_t *enc, STRLEN len) 232need (enc_t *enc, STRLEN len)
217{ 233{
218 if (ecb_expect_false (enc->cur + len >= enc->end)) 234 if (ecb_expect_false ((uintptr_t)(enc->end - enc->cur) < len))
219 { 235 {
220 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv); 236 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv);
221 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1); 237 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1);
222 enc->cur = SvPVX (enc->sv) + cur; 238 enc->cur = SvPVX (enc->sv) + cur;
223 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1; 239 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1;
229{ 245{
230 need (enc, 1); 246 need (enc, 1);
231 *enc->cur++ = ch; 247 *enc->cur++ = ch;
232} 248}
233 249
250// used for tags, intregers, element counts and so on
234static void 251static void
235encode_uint (enc_t *enc, int major, UV len) 252encode_uint (enc_t *enc, int major, UV len)
236{ 253{
237 need (enc, 9); 254 need (enc, 9);
238 255
269 *enc->cur++ = len >> 8; 286 *enc->cur++ = len >> 8;
270 *enc->cur++ = len; 287 *enc->cur++ = len;
271 } 288 }
272} 289}
273 290
291// encodes a perl value into a CBOR integer
292ecb_inline
293encode_int (enc_t *enc, SV *sv)
294{
295 if (SvIsUV (sv))
296 encode_uint (enc, MAJOR_POS_INT, SvUVX (sv));
297 else if (SvIVX (sv) >= 0)
298 encode_uint (enc, MAJOR_POS_INT, SvIVX (sv));
299 else
300 encode_uint (enc, MAJOR_NEG_INT, -(SvIVX (sv) + 1));
301}
302
274ecb_inline void 303ecb_inline void
275encode_tag (enc_t *enc, UV tag) 304encode_tag (enc_t *enc, UV tag)
276{ 305{
277 encode_uint (enc, MAJOR_TAG, tag); 306 encode_uint (enc, MAJOR_TAG, tag);
278} 307}
279 308
309// exceptional (hopefully) slow path for byte strings that need to be utf8-encoded
310ecb_noinline static void
311encode_str_utf8 (enc_t *enc, int utf8, char *str, STRLEN len)
312{
313 STRLEN ulen = len;
314 U8 *p, *pend = (U8 *)str + len;
315
316 for (p = (U8 *)str; p < pend; ++p)
317 ulen += *p >> 7; // count set high bits
318
319 encode_uint (enc, MAJOR_TEXT, ulen);
320
321 need (enc, ulen);
322 for (p = (U8 *)str; p < pend; ++p)
323 if (*p < 0x80)
324 *enc->cur++ = *p;
325 else
326 {
327 *enc->cur++ = 0xc0 + (*p >> 6);
328 *enc->cur++ = 0x80 + (*p & 63);
329 }
330}
331
280ecb_inline void 332ecb_inline void
281encode_str (enc_t *enc, int utf8, char *str, STRLEN len) 333encode_str (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
282{ 334{
335 if (ecb_expect_false (upgrade_utf8))
336 if (!utf8)
337 {
338 encode_str_utf8 (enc, utf8, str, len);
339 return;
340 }
341
283 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len); 342 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len);
284 need (enc, len); 343 need (enc, len);
285 memcpy (enc->cur, str, len); 344 memcpy (enc->cur, str, len);
286 enc->cur += len; 345 enc->cur += len;
287} 346}
288 347
289static void 348ecb_inline void
290encode_strref (enc_t *enc, int utf8, char *str, STRLEN len) 349encode_strref (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
291{ 350{
292 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS)) 351 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS))
293 { 352 {
294 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1); 353 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1);
295 354
306 sv_setuv (*svp, enc->stringref_idx); 365 sv_setuv (*svp, enc->stringref_idx);
307 ++enc->stringref_idx; 366 ++enc->stringref_idx;
308 } 367 }
309 } 368 }
310 369
311 encode_str (enc, utf8, str, len); 370 encode_str (enc, upgrade_utf8, utf8, str, len);
371}
372
373ecb_inline void
374encode_float16 (enc_t *enc, NV nv)
375{
376 need (enc, 1+2);
377
378 *enc->cur++ = MAJOR_MISC | MISC_FLOAT16;
379
380 uint16_t fp = ecb_float_to_binary16 (nv);
381
382 if (!ecb_big_endian ())
383 fp = ecb_bswap16 (fp);
384
385 memcpy (enc->cur, &fp, 2);
386 enc->cur += 2;
387}
388
389ecb_inline void
390encode_float32 (enc_t *enc, NV nv)
391{
392 need (enc, 1+4);
393
394 *enc->cur++ = MAJOR_MISC | MISC_FLOAT32;
395
396 uint32_t fp = ecb_float_to_binary32 (nv);
397
398 if (!ecb_big_endian ())
399 fp = ecb_bswap32 (fp);
400
401 memcpy (enc->cur, &fp, 4);
402 enc->cur += 4;
403}
404
405ecb_inline void
406encode_float64 (enc_t *enc, NV nv)
407{
408 need (enc, 1+8);
409
410 *enc->cur++ = MAJOR_MISC | MISC_FLOAT64;
411
412 uint64_t fp = ecb_double_to_binary64 (nv);
413
414 if (!ecb_big_endian ())
415 fp = ecb_bswap64 (fp);
416
417 memcpy (enc->cur, &fp, 8);
418 enc->cur += 8;
419}
420
421ecb_inline void
422encode_forced (enc_t *enc, UV type, SV *sv)
423{
424 switch (type)
425 {
426 case AS_CBOR:
427 {
428 STRLEN len;
429 char *str = SvPVbyte (sv, len);
430
431 need (enc, len);
432 memcpy (enc->cur, str, len);
433 enc->cur += len;
434 }
435 break;
436
437 case AS_BYTES:
438 {
439 STRLEN len;
440 char *str = SvPVbyte (sv, len);
441 encode_strref (enc, 0, 0, str, len);
442 }
443 break;
444
445 case AS_TEXT:
446 {
447 STRLEN len;
448 char *str = SvPVutf8 (sv, len);
449 encode_strref (enc, 1, 1, str, len);
450 }
451 break;
452
453 case AS_FLOAT16: encode_float16 (enc, SvNV (sv)); break;
454 case AS_FLOAT32: encode_float32 (enc, SvNV (sv)); break;
455 case AS_FLOAT64: encode_float64 (enc, SvNV (sv)); break;
456
457 default:
458 croak ("encountered malformed CBOR::XS::Tagged object");
459 }
312} 460}
313 461
314static void encode_sv (enc_t *enc, SV *sv); 462static void encode_sv (enc_t *enc, SV *sv);
315 463
316static void 464static void
323 471
324 ++enc->depth; 472 ++enc->depth;
325 473
326 encode_uint (enc, MAJOR_ARRAY, len + 1); 474 encode_uint (enc, MAJOR_ARRAY, len + 1);
327 475
476 if (ecb_expect_false (SvMAGICAL (av)))
328 for (i = 0; i <= len; ++i) 477 for (i = 0; i <= len; ++i)
329 { 478 {
330 SV **svp = av_fetch (av, i, 0); 479 SV **svp = av_fetch (av, i, 0);
331 encode_sv (enc, svp ? *svp : &PL_sv_undef); 480 encode_sv (enc, svp ? *svp : &PL_sv_undef);
332 } 481 }
482 else
483 for (i = 0; i <= len; ++i)
484 {
485 SV *sv = AvARRAY (av)[i];
486 encode_sv (enc, sv ? sv : &PL_sv_undef);
487 }
333 488
334 --enc->depth; 489 --enc->depth;
335} 490}
336 491
337static void 492static void
345 ++enc->depth; 500 ++enc->depth;
346 501
347 int pairs = hv_iterinit (hv); 502 int pairs = hv_iterinit (hv);
348 int mg = SvMAGICAL (hv); 503 int mg = SvMAGICAL (hv);
349 504
350 if (mg) 505 if (ecb_expect_false (mg))
351 encode_ch (enc, MAJOR_MAP | MINOR_INDEF); 506 encode_ch (enc, MAJOR_MAP | MINOR_INDEF);
352 else 507 else
353 encode_uint (enc, MAJOR_MAP, pairs); 508 encode_uint (enc, MAJOR_MAP, pairs);
354 509
355 while ((he = hv_iternext (hv))) 510 while ((he = hv_iternext (hv)))
356 { 511 {
357 if (HeKLEN (he) == HEf_SVKEY) 512 if (HeKLEN (he) == HEf_SVKEY)
358 encode_sv (enc, HeSVKEY (he)); 513 encode_sv (enc, HeSVKEY (he));
359 else 514 else
360 encode_strref (enc, HeKUTF8 (he), HeKEY (he), HeKLEN (he)); 515 encode_strref (enc, enc->cbor.flags & (F_TEXT_KEYS | F_TEXT_STRINGS), HeKUTF8 (he), HeKEY (he), HeKLEN (he));
361 516
362 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he)); 517 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he));
363 } 518 }
364 519
365 if (mg) 520 if (ecb_expect_false (mg))
366 encode_ch (enc, MAJOR_MISC | MINOR_INDEF); 521 encode_ch (enc, MAJOR_MISC | MINOR_INDEF);
367 522
368 --enc->depth; 523 --enc->depth;
369} 524}
370 525
403 else if (stash == tagged_stash) 558 else if (stash == tagged_stash)
404 { 559 {
405 if (svt != SVt_PVAV) 560 if (svt != SVt_PVAV)
406 croak ("encountered CBOR::XS::Tagged object that isn't an array"); 561 croak ("encountered CBOR::XS::Tagged object that isn't an array");
407 562
563 switch (av_len ((AV *)sv))
564 {
565 case 2-1:
566 // actually a tagged value
408 encode_uint (enc, MAJOR_TAG, SvUV (*av_fetch ((AV *)sv, 0, 1))); 567 encode_uint (enc, MAJOR_TAG, SvUV (*av_fetch ((AV *)sv, 0, 1)));
409 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1)); 568 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1));
569 break;
570
571 case 3-1:
572 // a forced type [value, type, undef]
573 encode_forced (enc, SvUV (*av_fetch ((AV *)sv, 1, 1)), *av_fetch ((AV *)sv, 0, 1));
574 break;
575
576 default:
577 croak ("encountered malformed CBOR::XS::Tagged object");
578 }
410 579
411 return; 580 return;
412 } 581 }
413 } 582 }
414 583
415 if (ecb_expect_false (SvREFCNT (sv) > 1) 584 if (ecb_expect_false (SvREFCNT (sv) > 1)
416 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING)) 585 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING))
417 { 586 {
418 if (!enc->shareable) 587 if (ecb_expect_false (!enc->shareable))
419 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ()); 588 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ());
420 589
421 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1); 590 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1);
422 591
423 if (SvOK (*svp)) 592 if (SvOK (*svp))
437 if (ecb_expect_false (SvOBJECT (sv))) 606 if (ecb_expect_false (SvOBJECT (sv)))
438 { 607 {
439 HV *stash = SvSTASH (sv); 608 HV *stash = SvSTASH (sv);
440 GV *method; 609 GV *method;
441 610
611 if (enc->cbor.flags & F_FORBID_OBJECTS)
612 croak ("encountered object '%s', but forbid_objects is enabled",
613 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
442 if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0))) 614 else if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
443 { 615 {
444 dSP; 616 dSP;
445 617
446 ENTER; SAVETMPS; PUSHMARK (SP); 618 ENTER; SAVETMPS;
619 PUSHMARK (SP);
447 // we re-bless the reference to get overload and other niceties right 620 // we re-bless the reference to get overload and other niceties right
448 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash)); 621 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
449 622
450 PUTBACK; 623 PUTBACK;
451 // G_SCALAR ensures that return value is 1 624 // G_SCALAR ensures that return value is 1
464 } 637 }
465 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0) 638 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
466 { 639 {
467 dSP; 640 dSP;
468 641
469 ENTER; SAVETMPS; PUSHMARK (SP); 642 ENTER; SAVETMPS;
643 PUSHMARK (SP);
470 EXTEND (SP, 2); 644 EXTEND (SP, 2);
471 // we re-bless the reference to get overload and other niceties right 645 // we re-bless the reference to get overload and other niceties right
472 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash)); 646 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
473 PUSHs (sv_cbor); 647 PUSHs (sv_cbor);
474 648
480 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv) 654 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
481 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash)); 655 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash));
482 656
483 encode_tag (enc, CBOR_TAG_PERL_OBJECT); 657 encode_tag (enc, CBOR_TAG_PERL_OBJECT);
484 encode_uint (enc, MAJOR_ARRAY, count + 1); 658 encode_uint (enc, MAJOR_ARRAY, count + 1);
485 encode_strref (enc, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash)); 659 encode_strref (enc, 0, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
486 660
487 while (count) 661 {
662 int i;
663
664 for (i = 0; i < count; ++i)
488 encode_sv (enc, SP[1 - count--]); 665 encode_sv (enc, SP[i + 1 - count]);
666
667 SP -= count;
668 }
489 669
490 PUTBACK; 670 PUTBACK;
491 671
492 FREETMPS; LEAVE; 672 FREETMPS; LEAVE;
493 } 673 }
515 695
516 if (ecb_expect_false (nv == (NV)(U32)nv)) 696 if (ecb_expect_false (nv == (NV)(U32)nv))
517 encode_uint (enc, MAJOR_POS_INT, (U32)nv); 697 encode_uint (enc, MAJOR_POS_INT, (U32)nv);
518 //TODO: maybe I32? 698 //TODO: maybe I32?
519 else if (ecb_expect_false (nv == (float)nv)) 699 else if (ecb_expect_false (nv == (float)nv))
520 { 700 encode_float32 (enc, nv);
521 uint32_t fp = ecb_float_to_binary32 (nv);
522
523 *enc->cur++ = MAJOR_MISC | MISC_FLOAT32;
524
525 if (!ecb_big_endian ())
526 fp = ecb_bswap32 (fp);
527
528 memcpy (enc->cur, &fp, 4);
529 enc->cur += 4;
530 }
531 else 701 else
532 { 702 encode_float64 (enc, nv);
533 uint64_t fp = ecb_double_to_binary64 (nv);
534
535 *enc->cur++ = MAJOR_MISC | MISC_FLOAT64;
536
537 if (!ecb_big_endian ())
538 fp = ecb_bswap64 (fp);
539
540 memcpy (enc->cur, &fp, 8);
541 enc->cur += 8;
542 }
543} 703}
544 704
545static void 705static void
546encode_sv (enc_t *enc, SV *sv) 706encode_sv (enc_t *enc, SV *sv)
547{ 707{
549 709
550 if (SvPOKp (sv)) 710 if (SvPOKp (sv))
551 { 711 {
552 STRLEN len; 712 STRLEN len;
553 char *str = SvPV (sv, len); 713 char *str = SvPV (sv, len);
554 encode_strref (enc, SvUTF8 (sv), str, len); 714 encode_strref (enc, enc->cbor.flags & F_TEXT_STRINGS, SvUTF8 (sv), str, len);
555 } 715 }
556 else if (SvNOKp (sv)) 716 else if (SvNOKp (sv))
557 encode_nv (enc, sv); 717 encode_nv (enc, sv);
558 else if (SvIOKp (sv)) 718 else if (SvIOKp (sv))
559 { 719 encode_int (e,v sv);
560 if (SvIsUV (sv))
561 encode_uint (enc, MAJOR_POS_INT, SvUVX (sv));
562 else if (SvIVX (sv) >= 0)
563 encode_uint (enc, MAJOR_POS_INT, SvIVX (sv));
564 else
565 encode_uint (enc, MAJOR_NEG_INT, -(SvIVX (sv) + 1));
566 }
567 else if (SvROK (sv)) 720 else if (SvROK (sv))
568 encode_rv (enc, SvRV (sv)); 721 encode_rv (enc, SvRV (sv));
569 else if (!SvOK (sv)) 722 else if (!SvOK (sv))
570 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL); 723 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL);
571 else if (enc->cbor.flags & F_ALLOW_UNKNOWN) 724 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
576} 729}
577 730
578static SV * 731static SV *
579encode_cbor (SV *scalar, CBOR *cbor) 732encode_cbor (SV *scalar, CBOR *cbor)
580{ 733{
581 enc_t enc = { }; 734 enc_t enc = { 0 };
582 735
583 enc.cbor = *cbor; 736 enc.cbor = *cbor;
584 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE)); 737 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE));
585 enc.cur = SvPVX (enc.sv); 738 enc.cur = SvPVX (enc.sv);
586 enc.end = SvEND (enc.sv); 739 enc.end = SvEND (enc.sv);
587 740
588 SvPOK_only (enc.sv); 741 SvPOK_only (enc.sv);
589 742
590 if (cbor->flags & F_PACK_STRINGS) 743 if (cbor->flags & F_PACK_STRINGS)
591 { 744 {
618 U32 depth; // recursion depth 771 U32 depth; // recursion depth
619 U32 maxdepth; // recursion depth limit 772 U32 maxdepth; // recursion depth limit
620 AV *shareable; 773 AV *shareable;
621 AV *stringref; 774 AV *stringref;
622 SV *decode_tagged; 775 SV *decode_tagged;
776 SV *err_sv; // optional sv for error, needs to be freed
623} dec_t; 777} dec_t;
624 778
625#define ERR(reason) SB if (!dec->err) dec->err = reason; goto fail; SE 779// set dec->err to ERRSV
780ecb_cold static void
781err_errsv (dec_t *dec)
782{
783 if (!dec->err)
784 {
785 dec->err_sv = newSVsv (ERRSV);
626 786
627#define WANT(len) if (ecb_expect_false (dec->cur + len > dec->end)) ERR ("unexpected end of CBOR data") 787 // chop off the trailing \n
788 SvCUR_set (dec->err_sv, SvCUR (dec->err_sv) - 1);
789 *SvEND (dec->err_sv) = 0;
628 790
791 dec->err = SvPVutf8_nolen (dec->err_sv);
792 }
793}
794
795// the following functions are used to reduce code size and help the compiler to optimise
796ecb_cold static void
797err_set (dec_t *dec, const char *reason)
798{
799 if (!dec->err)
800 dec->err = reason;
801}
802
803ecb_cold static void
804err_unexpected_end (dec_t *dec)
805{
806 err_set (dec, "unexpected end of CBOR data");
807}
808
809#define ERR_DO(do) SB do; goto fail; SE
810#define ERR(reason) ERR_DO (err_set (dec, reason))
811#define ERR_ERRSV ERR_DO (err_errsv (dec))
812
813#define WANT(len) if (ecb_expect_false ((uintptr_t)(dec->end - dec->cur) < (STRLEN)len)) ERR_DO (err_unexpected_end (dec))
814
629#define DEC_INC_DEPTH if (++dec->depth > dec->cbor.max_depth) ERR (ERR_NESTING_EXCEEDED) 815#define DEC_INC_DEPTH if (ecb_expect_false (++dec->depth > dec->cbor.max_depth)) ERR (ERR_NESTING_EXCEEDED)
630#define DEC_DEC_DEPTH --dec->depth 816#define DEC_DEC_DEPTH --dec->depth
631 817
632static UV 818static UV
633decode_uint (dec_t *dec) 819decode_uint (dec_t *dec)
634{ 820{
700 886
701 for (;;) 887 for (;;)
702 { 888 {
703 WANT (1); 889 WANT (1);
704 890
705 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF)) 891 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
706 { 892 {
707 ++dec->cur; 893 ++dec->cur;
708 break; 894 break;
709 } 895 }
710 896
711 av_push (av, decode_sv (dec)); 897 av_push (av, decode_sv (dec));
712 } 898 }
713 } 899 }
714 else 900 else
715 { 901 {
716 int i, len = decode_uint (dec); 902 UV i, len = decode_uint (dec);
717 903
718 WANT (len); // complexity check for av_fill - need at least one byte per value, do not allow supersize arrays 904 WANT (len); // complexity check for av_fill - need at least one byte per value, do not allow supersize arrays
719 av_fill (av, len - 1); 905 av_fill (av, len - 1);
720 906
721 for (i = 0; i < len; ++i) 907 for (i = 0; i < len; ++i)
724 910
725 DEC_DEC_DEPTH; 911 DEC_DEC_DEPTH;
726 return newRV_noinc ((SV *)av); 912 return newRV_noinc ((SV *)av);
727 913
728fail: 914fail:
729 SvREFCNT_dec (av); 915 SvREFCNT_dec_NN (av);
730 DEC_DEC_DEPTH; 916 DEC_DEC_DEPTH;
731 return &PL_sv_undef; 917 return &PL_sv_undef;
732} 918}
733 919
734static void 920static void
736{ 922{
737 // for speed reasons, we specialcase single-string 923 // for speed reasons, we specialcase single-string
738 // byte or utf-8 strings as keys, but only when !stringref 924 // byte or utf-8 strings as keys, but only when !stringref
739 925
740 if (ecb_expect_true (!dec->stringref)) 926 if (ecb_expect_true (!dec->stringref))
741 if (ecb_expect_true ((*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8)) 927 if (ecb_expect_true ((U8)(*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8))
742 { 928 {
743 I32 len = decode_uint (dec); 929 STRLEN len = decode_uint (dec);
744 char *key = (char *)dec->cur; 930 char *key = (char *)dec->cur;
745 931
932 WANT (len);
746 dec->cur += len; 933 dec->cur += len;
747 934
748 hv_store (hv, key, len, decode_sv (dec), 0); 935 hv_store (hv, key, len, decode_sv (dec), 0);
749 936
750 return; 937 return;
751 } 938 }
752 else if (ecb_expect_true ((*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8)) 939 else if (ecb_expect_true ((U8)(*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8))
753 { 940 {
754 I32 len = decode_uint (dec); 941 STRLEN len = decode_uint (dec);
755 char *key = (char *)dec->cur; 942 char *key = (char *)dec->cur;
756 943
944 WANT (len);
757 dec->cur += len; 945 dec->cur += len;
758 946
759 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8)) 947 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
760 if (!is_utf8_string (key, len)) 948 if (!is_utf8_string (key, len))
761 ERR ("corrupted CBOR data (invalid UTF-8 in map key)"); 949 ERR ("corrupted CBOR data (invalid UTF-8 in map key)");
766 } 954 }
767 955
768 SV *k = decode_sv (dec); 956 SV *k = decode_sv (dec);
769 SV *v = decode_sv (dec); 957 SV *v = decode_sv (dec);
770 958
959 // we leak memory if uncaught exceptions are thrown by random magical
960 // methods, and this is hopefully the only place where it can happen,
961 // so if there is a chance of an exception, take the very slow path.
962 // since catching exceptions is "undocumented/internal/forbidden" by
963 // the new p5p powers, we need to call out to a perl function :/
964 if (ecb_expect_false (SvAMAGIC (k)))
965 {
966 dSP;
967
968 ENTER; SAVETMPS;
969 PUSHMARK (SP);
970 EXTEND (SP, 3);
971 PUSHs (sv_2mortal (newRV_inc ((SV *)hv)));
972 PUSHs (sv_2mortal (k));
973 PUSHs (sv_2mortal (v));
974
975 PUTBACK;
976 call_pv ("CBOR::XS::_hv_store", G_VOID | G_DISCARD | G_EVAL);
977 SPAGAIN;
978
979 FREETMPS; LEAVE;
980
981 if (SvTRUE (ERRSV))
982 ERR_ERRSV;
983
984 return;
985 }
986
771 hv_store_ent (hv, k, v, 0); 987 hv_store_ent (hv, k, v, 0);
772 SvREFCNT_dec (k); 988 SvREFCNT_dec_NN (k);
773 989
774fail: 990fail:
775 ; 991 ;
776} 992}
777 993
788 1004
789 for (;;) 1005 for (;;)
790 { 1006 {
791 WANT (1); 1007 WANT (1);
792 1008
793 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF)) 1009 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
794 { 1010 {
795 ++dec->cur; 1011 ++dec->cur;
796 break; 1012 break;
797 } 1013 }
798 1014
799 decode_he (dec, hv); 1015 decode_he (dec, hv);
800 } 1016 }
801 } 1017 }
802 else 1018 else
803 { 1019 {
804 int pairs = decode_uint (dec); 1020 UV pairs = decode_uint (dec);
1021
1022 WANT (pairs); // complexity check - need at least one byte per value, do not allow supersize hashes
805 1023
806 while (pairs--) 1024 while (pairs--)
807 decode_he (dec, hv); 1025 decode_he (dec, hv);
808 } 1026 }
809 1027
810 DEC_DEC_DEPTH; 1028 DEC_DEC_DEPTH;
811 return newRV_noinc ((SV *)hv); 1029 return newRV_noinc ((SV *)hv);
812 1030
813fail: 1031fail:
814 SvREFCNT_dec (hv); 1032 SvREFCNT_dec_NN (hv);
815 DEC_DEC_DEPTH; 1033 DEC_DEC_DEPTH;
816 return &PL_sv_undef; 1034 return &PL_sv_undef;
817} 1035}
818 1036
819static SV * 1037static SV *
820decode_str (dec_t *dec, int utf8) 1038decode_str (dec_t *dec, int utf8)
821{ 1039{
822 SV *sv = 0; 1040 SV *sv = 0;
823 1041
824 if ((*dec->cur & MINOR_MASK) == MINOR_INDEF) 1042 if (ecb_expect_false ((*dec->cur & MINOR_MASK) == MINOR_INDEF))
825 { 1043 {
826 // indefinite length strings 1044 // indefinite length strings
827 ++dec->cur; 1045 ++dec->cur;
828 1046
829 U8 major = *dec->cur & MAJOR_MISC; 1047 U8 major = *dec->cur & MAJOR_MISC;
897 sv = newRV_noinc (decode_sv (dec)); 1115 sv = newRV_noinc (decode_sv (dec));
898 break; 1116 break;
899 1117
900 case CBOR_TAG_STRINGREF_NAMESPACE: 1118 case CBOR_TAG_STRINGREF_NAMESPACE:
901 { 1119 {
1120 // do not use SAVETMPS/FREETMPS, as these will
1121 // erase mortalised caches, e.g. "shareable"
902 ENTER; SAVETMPS; 1122 ENTER;
903 1123
904 SAVESPTR (dec->stringref); 1124 SAVESPTR (dec->stringref);
905 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ()); 1125 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ());
906 1126
907 sv = decode_sv (dec); 1127 sv = decode_sv (dec);
908 1128
909 FREETMPS; LEAVE; 1129 LEAVE;
910 } 1130 }
911 break; 1131 break;
912 1132
913 case CBOR_TAG_STRINGREF: 1133 case CBOR_TAG_STRINGREF:
914 { 1134 {
915 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT)) 1135 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
916 ERR ("corrupted CBOR data (stringref index not an unsigned integer)"); 1136 ERR ("corrupted CBOR data (stringref index not an unsigned integer)");
917 1137
918 UV idx = decode_uint (dec); 1138 UV idx = decode_uint (dec);
919 1139
920 if (!dec->stringref || (int)idx > AvFILLp (dec->stringref)) 1140 if (!dec->stringref || idx >= (UV)(1 + AvFILLp (dec->stringref)))
921 ERR ("corrupted CBOR data (stringref index out of bounds or outside namespace)"); 1141 ERR ("corrupted CBOR data (stringref index out of bounds or outside namespace)");
922 1142
923 sv = newSVsv (AvARRAY (dec->stringref)[idx]); 1143 sv = newSVsv (AvARRAY (dec->stringref)[idx]);
924 } 1144 }
925 break; 1145 break;
953 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT)) 1173 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
954 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)"); 1174 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)");
955 1175
956 UV idx = decode_uint (dec); 1176 UV idx = decode_uint (dec);
957 1177
958 if (!dec->shareable || (int)idx > AvFILLp (dec->shareable)) 1178 if (!dec->shareable || idx >= (UV)(1 + AvFILLp (dec->shareable)))
959 ERR ("corrupted CBOR data (sharedref index out of bounds)"); 1179 ERR ("corrupted CBOR data (sharedref index out of bounds)");
960 1180
961 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]); 1181 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]);
962 1182
963 if (sv == &PL_sv_undef) 1183 if (sv == &PL_sv_undef)
965 } 1185 }
966 break; 1186 break;
967 1187
968 case CBOR_TAG_PERL_OBJECT: 1188 case CBOR_TAG_PERL_OBJECT:
969 { 1189 {
1190 if (dec->cbor.flags & F_FORBID_OBJECTS)
1191 goto filter;
1192
970 sv = decode_sv (dec); 1193 sv = decode_sv (dec);
971 1194
972 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV) 1195 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
973 ERR ("corrupted CBOR data (non-array perl object)"); 1196 ERR ("corrupted CBOR data (non-array perl object)");
974 1197
984 if (!method) 1207 if (!method)
985 ERR ("cannot decode perl-object (package does not have a THAW method)"); 1208 ERR ("cannot decode perl-object (package does not have a THAW method)");
986 1209
987 dSP; 1210 dSP;
988 1211
989 ENTER; SAVETMPS; PUSHMARK (SP); 1212 ENTER; SAVETMPS;
1213 PUSHMARK (SP);
990 EXTEND (SP, len + 1); 1214 EXTEND (SP, len + 1);
991 // we re-bless the reference to get overload and other niceties right 1215 // we re-bless the reference to get overload and other niceties right
992 PUSHs (*av_fetch (av, 0, 1)); 1216 PUSHs (*av_fetch (av, 0, 1));
993 PUSHs (sv_cbor); 1217 PUSHs (sv_cbor);
994 1218
1002 SPAGAIN; 1226 SPAGAIN;
1003 1227
1004 if (SvTRUE (ERRSV)) 1228 if (SvTRUE (ERRSV))
1005 { 1229 {
1006 FREETMPS; LEAVE; 1230 FREETMPS; LEAVE;
1007 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV)))); 1231 ERR_ERRSV;
1008 } 1232 }
1009 1233
1010 SvREFCNT_dec (sv); 1234 SvREFCNT_dec_NN (sv);
1011 sv = SvREFCNT_inc (POPs); 1235 sv = SvREFCNT_inc (POPs);
1012 1236
1013 PUTBACK; 1237 PUTBACK;
1014 1238
1015 FREETMPS; LEAVE; 1239 FREETMPS; LEAVE;
1016 } 1240 }
1017 break; 1241 break;
1018 1242
1019 default: 1243 default:
1244 filter:
1020 { 1245 {
1246 SV *tag_sv = newSVuv (tag);
1247
1021 sv = decode_sv (dec); 1248 sv = decode_sv (dec);
1022 1249
1023 dSP; 1250 dSP;
1024 ENTER; SAVETMPS; PUSHMARK (SP); 1251 ENTER; SAVETMPS;
1252 PUSHMARK (SP);
1025 EXTEND (SP, 2); 1253 EXTEND (SP, 2);
1026 PUSHs (newSVuv (tag)); 1254 PUSHs (tag_sv);
1027 PUSHs (sv); 1255 PUSHs (sv);
1028 1256
1029 PUTBACK; 1257 PUTBACK;
1030 int count = call_sv (dec->cbor.filter ? dec->cbor.filter : default_filter, G_ARRAY | G_EVAL); 1258 int count = call_sv (dec->cbor.filter ? dec->cbor.filter : default_filter, G_ARRAY | G_EVAL);
1031 SPAGAIN; 1259 SPAGAIN;
1032 1260
1033 if (SvTRUE (ERRSV)) 1261 if (SvTRUE (ERRSV))
1034 { 1262 {
1263 SvREFCNT_dec_NN (tag_sv);
1035 FREETMPS; LEAVE; 1264 FREETMPS; LEAVE;
1036 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV)))); 1265 ERR_ERRSV;
1037 } 1266 }
1038 1267
1039 if (count) 1268 if (count)
1040 { 1269 {
1270 SvREFCNT_dec_NN (tag_sv);
1041 SvREFCNT_dec (sv); 1271 SvREFCNT_dec_NN (sv);
1042 sv = SvREFCNT_inc (POPs); 1272 sv = SvREFCNT_inc_NN (TOPs);
1273 SP -= count;
1043 } 1274 }
1044 else 1275 else
1045 { 1276 {
1046 AV *av = newAV (); 1277 AV *av = newAV ();
1047 av_push (av, newSVuv (tag)); 1278 av_push (av, tag_sv);
1048 av_push (av, sv); 1279 av_push (av, sv);
1049 1280
1050 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 1281 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
1051 ? cbor_tagged_stash 1282 ? cbor_tagged_stash
1052 : gv_stashpv ("CBOR::XS::Tagged" , 1); 1283 : gv_stashpv ("CBOR::XS::Tagged" , 1);
1155} 1386}
1156 1387
1157static SV * 1388static SV *
1158decode_cbor (SV *string, CBOR *cbor, char **offset_return) 1389decode_cbor (SV *string, CBOR *cbor, char **offset_return)
1159{ 1390{
1160 dec_t dec = { }; 1391 dec_t dec = { 0 };
1161 SV *sv; 1392 SV *sv;
1162 STRLEN len; 1393 STRLEN len;
1163 char *data = SvPVbyte (string, len); 1394 char *data = SvPVbyte (string, len);
1164 1395
1165 if (len > cbor->max_size && cbor->max_size) 1396 if (len > cbor->max_size && cbor->max_size)
1181 1412
1182 if (dec.err) 1413 if (dec.err)
1183 { 1414 {
1184 if (dec.shareable) 1415 if (dec.shareable)
1185 { 1416 {
1186 // need to break cyclic links, which whould all be in shareable 1417 // need to break cyclic links, which would all be in shareable
1187 int i; 1418 int i;
1188 SV **svp; 1419 SV **svp;
1189 1420
1190 for (i = av_len (dec.shareable) + 1; i--; ) 1421 for (i = av_len (dec.shareable) + 1; i--; )
1191 if ((svp = av_fetch (dec.shareable, i, 0))) 1422 if ((svp = av_fetch (dec.shareable, i, 0)))
1192 sv_setsv (*svp, &PL_sv_undef); 1423 sv_setsv (*svp, &PL_sv_undef);
1193 } 1424 }
1194 1425
1195 SvREFCNT_dec (sv); 1426 SvREFCNT_dec_NN (sv);
1427
1428 if (dec.err_sv)
1429 sv_2mortal (dec.err_sv);
1430
1196 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur); 1431 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur);
1197 } 1432 }
1198 1433
1199 sv = sv_2mortal (sv); 1434 sv = sv_2mortal (sv);
1200 1435
1256 1491
1257 int major = *p >> MAJOR_SHIFT; 1492 int major = *p >> MAJOR_SHIFT;
1258 1493
1259 switch (major) 1494 switch (major)
1260 { 1495 {
1496 case MAJOR_TAG >> MAJOR_SHIFT:
1497 ++count; // tags merely prefix another value
1498 break;
1499
1261 case MAJOR_BYTES >> MAJOR_SHIFT: 1500 case MAJOR_BYTES >> MAJOR_SHIFT:
1262 case MAJOR_TEXT >> MAJOR_SHIFT: 1501 case MAJOR_TEXT >> MAJOR_SHIFT:
1263 case MAJOR_ARRAY >> MAJOR_SHIFT: 1502 case MAJOR_ARRAY >> MAJOR_SHIFT:
1264 case MAJOR_MAP >> MAJOR_SHIFT: 1503 case MAJOR_MAP >> MAJOR_SHIFT:
1265 { 1504 {
1340 1579
1341 default_filter = newSVpv ("CBOR::XS::default_filter", 0); 1580 default_filter = newSVpv ("CBOR::XS::default_filter", 0);
1342 1581
1343 sv_cbor = newSVpv ("CBOR", 0); 1582 sv_cbor = newSVpv ("CBOR", 0);
1344 SvREADONLY_on (sv_cbor); 1583 SvREADONLY_on (sv_cbor);
1584
1585 assert (("STRLEN must be an unsigned type", 0 <= (STRLEN)-1));
1345} 1586}
1346 1587
1347PROTOTYPES: DISABLE 1588PROTOTYPES: DISABLE
1348 1589
1349void CLONE (...) 1590void CLONE (...)
1369 ALIAS: 1610 ALIAS:
1370 shrink = F_SHRINK 1611 shrink = F_SHRINK
1371 allow_unknown = F_ALLOW_UNKNOWN 1612 allow_unknown = F_ALLOW_UNKNOWN
1372 allow_sharing = F_ALLOW_SHARING 1613 allow_sharing = F_ALLOW_SHARING
1373 allow_cycles = F_ALLOW_CYCLES 1614 allow_cycles = F_ALLOW_CYCLES
1615 forbid_objects = F_FORBID_OBJECTS
1374 pack_strings = F_PACK_STRINGS 1616 pack_strings = F_PACK_STRINGS
1617 text_keys = F_TEXT_KEYS
1618 text_strings = F_TEXT_STRINGS
1375 validate_utf8 = F_VALIDATE_UTF8 1619 validate_utf8 = F_VALIDATE_UTF8
1376 PPCODE: 1620 PPCODE:
1377{ 1621{
1378 if (enable) 1622 if (enable)
1379 self->flags |= ix; 1623 self->flags |= ix;
1387 ALIAS: 1631 ALIAS:
1388 get_shrink = F_SHRINK 1632 get_shrink = F_SHRINK
1389 get_allow_unknown = F_ALLOW_UNKNOWN 1633 get_allow_unknown = F_ALLOW_UNKNOWN
1390 get_allow_sharing = F_ALLOW_SHARING 1634 get_allow_sharing = F_ALLOW_SHARING
1391 get_allow_cycles = F_ALLOW_CYCLES 1635 get_allow_cycles = F_ALLOW_CYCLES
1636 get_forbid_objects = F_FORBID_OBJECTS
1392 get_pack_strings = F_PACK_STRINGS 1637 get_pack_strings = F_PACK_STRINGS
1638 get_text_keys = F_TEXT_KEYS
1639 get_text_strings = F_TEXT_STRINGS
1393 get_validate_utf8 = F_VALIDATE_UTF8 1640 get_validate_utf8 = F_VALIDATE_UTF8
1394 PPCODE: 1641 PPCODE:
1395 XPUSHs (boolSV (self->flags & ix)); 1642 XPUSHs (boolSV (self->flags & ix));
1396 1643
1397void max_depth (CBOR *self, U32 max_depth = 0x80000000UL) 1644void max_depth (CBOR *self, U32 max_depth = 0x80000000UL)
1527 cbor_init (&cbor); 1774 cbor_init (&cbor);
1528 PUTBACK; cborstr = decode_cbor (cborstr, &cbor, 0); SPAGAIN; 1775 PUTBACK; cborstr = decode_cbor (cborstr, &cbor, 0); SPAGAIN;
1529 XPUSHs (cborstr); 1776 XPUSHs (cborstr);
1530} 1777}
1531 1778
1779#ifdef __AFL_COMPILER
1780
1781void
1782afl_init ()
1783 CODE:
1784 __AFL_INIT ();
1785
1786int
1787afl_loop (unsigned int count = 10000)
1788 CODE:
1789 RETVAL = __AFL_LOOP (count);
1790 OUTPUT:
1791 RETVAL
1792
1793#endif
1794

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines