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

Comparing cvsroot/CBOR-XS/XS.xs (file contents):
Revision 1.44 by root, Tue Feb 18 22:12:12 2014 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
12#define ECB_NO_THREADS 1 13#define ECB_NO_THREADS 1
13#include "ecb.h" 14#include "ecb.h"
14 15
15// compatibility with perl <5.18 16// compatibility with perl <5.18
… …
20# define HvNAMELEN(hv) HvNAMELEN_get (hv) 21# define HvNAMELEN(hv) HvNAMELEN_get (hv)
21#endif 22#endif
22#ifndef HvNAMEUTF8 23#ifndef HvNAMEUTF8
23# define HvNAMEUTF8(hv) 0 24# define HvNAMEUTF8(hv) 0
24#endif 25#endif
26#ifndef SvREFCNT_inc_NN
27# define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
28#endif
25#ifndef SvREFCNT_dec_NN 29#ifndef SvREFCNT_dec_NN
26# define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv) 30# define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv)
27#endif 31#endif
28 32
29// known major and minor types 33// known major and minor types
… …
95 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8 99 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8
96 100
97 CBOR_TAG_MAGIC = 55799, // self-describe cbor 101 CBOR_TAG_MAGIC = 55799, // self-describe cbor
98}; 102};
99 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
100#define F_SHRINK 0x00000001UL 116#define F_SHRINK 0x00000001UL
101#define F_ALLOW_UNKNOWN 0x00000002UL 117#define F_ALLOW_UNKNOWN 0x00000002UL
102#define F_ALLOW_SHARING 0x00000004UL 118#define F_ALLOW_SHARING 0x00000004UL
103#define F_ALLOW_CYCLES 0x00000008UL 119#define F_ALLOW_CYCLES 0x00000008UL
120#define F_FORBID_OBJECTS 0x00000010UL
104#define F_PACK_STRINGS 0x00000010UL 121#define F_PACK_STRINGS 0x00000020UL
122#define F_TEXT_KEYS 0x00000040UL
123#define F_TEXT_STRINGS 0x00000080UL
105#define F_VALIDATE_UTF8 0x00000020UL 124#define F_VALIDATE_UTF8 0x00000100UL
106 125
107#define INIT_SIZE 32 // initial scalar size to be allocated 126#define INIT_SIZE 32 // initial scalar size to be allocated
108 127
109#define SB do { 128#define SB do {
110#define SE } while (0) 129#define SE } while (0)
… …
183 202
184// minimum length of a string to be registered for stringref 203// minimum length of a string to be registered for stringref
185ecb_inline int 204ecb_inline int
186minimum_string_length (UV idx) 205minimum_string_length (UV idx)
187{ 206{
188 return idx > 23 207 return idx <= 23 ? 3
189 ? idx > 0xffU 208 : idx <= 0xffU ? 4
190 ? idx > 0xffffU 209 : idx <= 0xffffU ? 5
191 ? idx > 0xffffffffU 210 : idx <= 0xffffffffU ? 7
192 ? 11 211 : 11;
193 : 7
194 : 5
195 : 4
196 : 3;
197} 212}
198 213
199///////////////////////////////////////////////////////////////////////////// 214/////////////////////////////////////////////////////////////////////////////
200// encoder 215// encoder
201 216
… …
214} enc_t; 229} enc_t;
215 230
216ecb_inline void 231ecb_inline void
217need (enc_t *enc, STRLEN len) 232need (enc_t *enc, STRLEN len)
218{ 233{
219 if (ecb_expect_false (enc->cur + len >= enc->end)) 234 if (ecb_expect_false ((uintptr_t)(enc->end - enc->cur) < len))
220 { 235 {
221 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv); 236 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv);
222 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1); 237 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1);
223 enc->cur = SvPVX (enc->sv) + cur; 238 enc->cur = SvPVX (enc->sv) + cur;
224 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1; 239 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1;
… …
230{ 245{
231 need (enc, 1); 246 need (enc, 1);
232 *enc->cur++ = ch; 247 *enc->cur++ = ch;
233} 248}
234 249
250// used for tags, intregers, element counts and so on
235static void 251static void
236encode_uint (enc_t *enc, int major, UV len) 252encode_uint (enc_t *enc, int major, UV len)
237{ 253{
238 need (enc, 9); 254 need (enc, 9);
239 255
… …
270 *enc->cur++ = len >> 8; 286 *enc->cur++ = len >> 8;
271 *enc->cur++ = len; 287 *enc->cur++ = len;
272 } 288 }
273} 289}
274 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
275ecb_inline void 303ecb_inline void
276encode_tag (enc_t *enc, UV tag) 304encode_tag (enc_t *enc, UV tag)
277{ 305{
278 encode_uint (enc, MAJOR_TAG, tag); 306 encode_uint (enc, MAJOR_TAG, tag);
279} 307}
280 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
281ecb_inline void 332ecb_inline void
282encode_str (enc_t *enc, int utf8, char *str, STRLEN len) 333encode_str (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
283{ 334{
335 if (ecb_expect_false (upgrade_utf8))
336 if (!utf8)
337 {
338 encode_str_utf8 (enc, utf8, str, len);
339 return;
340 }
341
284 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len); 342 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len);
285 need (enc, len); 343 need (enc, len);
286 memcpy (enc->cur, str, len); 344 memcpy (enc->cur, str, len);
287 enc->cur += len; 345 enc->cur += len;
288} 346}
289 347
290static void 348ecb_inline void
291encode_strref (enc_t *enc, int utf8, char *str, STRLEN len) 349encode_strref (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
292{ 350{
293 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS)) 351 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS))
294 { 352 {
295 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1); 353 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1);
296 354
… …
307 sv_setuv (*svp, enc->stringref_idx); 365 sv_setuv (*svp, enc->stringref_idx);
308 ++enc->stringref_idx; 366 ++enc->stringref_idx;
309 } 367 }
310 } 368 }
311 369
312 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 }
313} 460}
314 461
315static void encode_sv (enc_t *enc, SV *sv); 462static void encode_sv (enc_t *enc, SV *sv);
316 463
317static void 464static void
… …
324 471
325 ++enc->depth; 472 ++enc->depth;
326 473
327 encode_uint (enc, MAJOR_ARRAY, len + 1); 474 encode_uint (enc, MAJOR_ARRAY, len + 1);
328 475
476 if (ecb_expect_false (SvMAGICAL (av)))
329 for (i = 0; i <= len; ++i) 477 for (i = 0; i <= len; ++i)
330 { 478 {
331 SV **svp = av_fetch (av, i, 0); 479 SV **svp = av_fetch (av, i, 0);
332 encode_sv (enc, svp ? *svp : &PL_sv_undef); 480 encode_sv (enc, svp ? *svp : &PL_sv_undef);
333 } 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 }
334 488
335 --enc->depth; 489 --enc->depth;
336} 490}
337 491
338static void 492static void
… …
346 ++enc->depth; 500 ++enc->depth;
347 501
348 int pairs = hv_iterinit (hv); 502 int pairs = hv_iterinit (hv);
349 int mg = SvMAGICAL (hv); 503 int mg = SvMAGICAL (hv);
350 504
351 if (mg) 505 if (ecb_expect_false (mg))
352 encode_ch (enc, MAJOR_MAP | MINOR_INDEF); 506 encode_ch (enc, MAJOR_MAP | MINOR_INDEF);
353 else 507 else
354 encode_uint (enc, MAJOR_MAP, pairs); 508 encode_uint (enc, MAJOR_MAP, pairs);
355 509
356 while ((he = hv_iternext (hv))) 510 while ((he = hv_iternext (hv)))
357 { 511 {
358 if (HeKLEN (he) == HEf_SVKEY) 512 if (HeKLEN (he) == HEf_SVKEY)
359 encode_sv (enc, HeSVKEY (he)); 513 encode_sv (enc, HeSVKEY (he));
360 else 514 else
361 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));
362 516
363 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));
364 } 518 }
365 519
366 if (mg) 520 if (ecb_expect_false (mg))
367 encode_ch (enc, MAJOR_MISC | MINOR_INDEF); 521 encode_ch (enc, MAJOR_MISC | MINOR_INDEF);
368 522
369 --enc->depth; 523 --enc->depth;
370} 524}
371 525
… …
404 else if (stash == tagged_stash) 558 else if (stash == tagged_stash)
405 { 559 {
406 if (svt != SVt_PVAV) 560 if (svt != SVt_PVAV)
407 croak ("encountered CBOR::XS::Tagged object that isn't an array"); 561 croak ("encountered CBOR::XS::Tagged object that isn't an array");
408 562
563 switch (av_len ((AV *)sv))
564 {
565 case 2-1:
566 // actually a tagged value
409 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)));
410 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 }
411 579
412 return; 580 return;
413 } 581 }
414 } 582 }
415 583
416 if (ecb_expect_false (SvREFCNT (sv) > 1) 584 if (ecb_expect_false (SvREFCNT (sv) > 1)
417 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING)) 585 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING))
418 { 586 {
419 if (!enc->shareable) 587 if (ecb_expect_false (!enc->shareable))
420 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ()); 588 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ());
421 589
422 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1); 590 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1);
423 591
424 if (SvOK (*svp)) 592 if (SvOK (*svp))
… …
438 if (ecb_expect_false (SvOBJECT (sv))) 606 if (ecb_expect_false (SvOBJECT (sv)))
439 { 607 {
440 HV *stash = SvSTASH (sv); 608 HV *stash = SvSTASH (sv);
441 GV *method; 609 GV *method;
442 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))));
443 if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0))) 614 else if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
444 { 615 {
445 dSP; 616 dSP;
446 617
447 ENTER; SAVETMPS; PUSHMARK (SP); 618 ENTER; SAVETMPS;
619 PUSHMARK (SP);
448 // 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
449 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash)); 621 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
450 622
451 PUTBACK; 623 PUTBACK;
452 // G_SCALAR ensures that return value is 1 624 // G_SCALAR ensures that return value is 1
… …
465 } 637 }
466 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0) 638 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
467 { 639 {
468 dSP; 640 dSP;
469 641
470 ENTER; SAVETMPS; PUSHMARK (SP); 642 ENTER; SAVETMPS;
643 PUSHMARK (SP);
471 EXTEND (SP, 2); 644 EXTEND (SP, 2);
472 // 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
473 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash)); 646 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
474 PUSHs (sv_cbor); 647 PUSHs (sv_cbor);
475 648
… …
481 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv) 654 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
482 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));
483 656
484 encode_tag (enc, CBOR_TAG_PERL_OBJECT); 657 encode_tag (enc, CBOR_TAG_PERL_OBJECT);
485 encode_uint (enc, MAJOR_ARRAY, count + 1); 658 encode_uint (enc, MAJOR_ARRAY, count + 1);
486 encode_strref (enc, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash)); 659 encode_strref (enc, 0, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
487 660
488 while (count) 661 {
662 int i;
663
664 for (i = 0; i < count; ++i)
489 encode_sv (enc, SP[1 - count--]); 665 encode_sv (enc, SP[i + 1 - count]);
666
667 SP -= count;
668 }
490 669
491 PUTBACK; 670 PUTBACK;
492 671
493 FREETMPS; LEAVE; 672 FREETMPS; LEAVE;
494 } 673 }
… …
516 695
517 if (ecb_expect_false (nv == (NV)(U32)nv)) 696 if (ecb_expect_false (nv == (NV)(U32)nv))
518 encode_uint (enc, MAJOR_POS_INT, (U32)nv); 697 encode_uint (enc, MAJOR_POS_INT, (U32)nv);
519 //TODO: maybe I32? 698 //TODO: maybe I32?
520 else if (ecb_expect_false (nv == (float)nv)) 699 else if (ecb_expect_false (nv == (float)nv))
521 { 700 encode_float32 (enc, nv);
522 uint32_t fp = ecb_float_to_binary32 (nv);
523
524 *enc->cur++ = MAJOR_MISC | MISC_FLOAT32;
525
526 if (!ecb_big_endian ())
527 fp = ecb_bswap32 (fp);
528
529 memcpy (enc->cur, &fp, 4);
530 enc->cur += 4;
531 }
532 else 701 else
533 { 702 encode_float64 (enc, nv);
534 uint64_t fp = ecb_double_to_binary64 (nv);
535
536 *enc->cur++ = MAJOR_MISC | MISC_FLOAT64;
537
538 if (!ecb_big_endian ())
539 fp = ecb_bswap64 (fp);
540
541 memcpy (enc->cur, &fp, 8);
542 enc->cur += 8;
543 }
544} 703}
545 704
546static void 705static void
547encode_sv (enc_t *enc, SV *sv) 706encode_sv (enc_t *enc, SV *sv)
548{ 707{
… …
550 709
551 if (SvPOKp (sv)) 710 if (SvPOKp (sv))
552 { 711 {
553 STRLEN len; 712 STRLEN len;
554 char *str = SvPV (sv, len); 713 char *str = SvPV (sv, len);
555 encode_strref (enc, SvUTF8 (sv), str, len); 714 encode_strref (enc, enc->cbor.flags & F_TEXT_STRINGS, SvUTF8 (sv), str, len);
556 } 715 }
557 else if (SvNOKp (sv)) 716 else if (SvNOKp (sv))
558 encode_nv (enc, sv); 717 encode_nv (enc, sv);
559 else if (SvIOKp (sv)) 718 else if (SvIOKp (sv))
560 { 719 encode_int (e,v sv);
561 if (SvIsUV (sv))
562 encode_uint (enc, MAJOR_POS_INT, SvUVX (sv));
563 else if (SvIVX (sv) >= 0)
564 encode_uint (enc, MAJOR_POS_INT, SvIVX (sv));
565 else
566 encode_uint (enc, MAJOR_NEG_INT, -(SvIVX (sv) + 1));
567 }
568 else if (SvROK (sv)) 720 else if (SvROK (sv))
569 encode_rv (enc, SvRV (sv)); 721 encode_rv (enc, SvRV (sv));
570 else if (!SvOK (sv)) 722 else if (!SvOK (sv))
571 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL); 723 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL);
572 else if (enc->cbor.flags & F_ALLOW_UNKNOWN) 724 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
… …
577} 729}
578 730
579static SV * 731static SV *
580encode_cbor (SV *scalar, CBOR *cbor) 732encode_cbor (SV *scalar, CBOR *cbor)
581{ 733{
582 enc_t enc = { }; 734 enc_t enc = { 0 };
583 735
584 enc.cbor = *cbor; 736 enc.cbor = *cbor;
585 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE)); 737 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE));
586 enc.cur = SvPVX (enc.sv); 738 enc.cur = SvPVX (enc.sv);
587 enc.end = SvEND (enc.sv); 739 enc.end = SvEND (enc.sv);
588 740
589 SvPOK_only (enc.sv); 741 SvPOK_only (enc.sv);
590 742
591 if (cbor->flags & F_PACK_STRINGS) 743 if (cbor->flags & F_PACK_STRINGS)
592 { 744 {
… …
619 U32 depth; // recursion depth 771 U32 depth; // recursion depth
620 U32 maxdepth; // recursion depth limit 772 U32 maxdepth; // recursion depth limit
621 AV *shareable; 773 AV *shareable;
622 AV *stringref; 774 AV *stringref;
623 SV *decode_tagged; 775 SV *decode_tagged;
776 SV *err_sv; // optional sv for error, needs to be freed
624} dec_t; 777} dec_t;
625 778
626#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);
627 786
628#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;
629 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
630#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)
631#define DEC_DEC_DEPTH --dec->depth 816#define DEC_DEC_DEPTH --dec->depth
632 817
633static UV 818static UV
634decode_uint (dec_t *dec) 819decode_uint (dec_t *dec)
635{ 820{
… …
701 886
702 for (;;) 887 for (;;)
703 { 888 {
704 WANT (1); 889 WANT (1);
705 890
706 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF)) 891 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
707 { 892 {
708 ++dec->cur; 893 ++dec->cur;
709 break; 894 break;
710 } 895 }
711 896
712 av_push (av, decode_sv (dec)); 897 av_push (av, decode_sv (dec));
713 } 898 }
714 } 899 }
715 else 900 else
716 { 901 {
717 int i, len = decode_uint (dec); 902 UV i, len = decode_uint (dec);
718 903
719 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
720 av_fill (av, len - 1); 905 av_fill (av, len - 1);
721 906
722 for (i = 0; i < len; ++i) 907 for (i = 0; i < len; ++i)
… …
725 910
726 DEC_DEC_DEPTH; 911 DEC_DEC_DEPTH;
727 return newRV_noinc ((SV *)av); 912 return newRV_noinc ((SV *)av);
728 913
729fail: 914fail:
730 SvREFCNT_dec (av); 915 SvREFCNT_dec_NN (av);
731 DEC_DEC_DEPTH; 916 DEC_DEC_DEPTH;
732 return &PL_sv_undef; 917 return &PL_sv_undef;
733} 918}
734 919
735static void 920static void
… …
739 // byte or utf-8 strings as keys, but only when !stringref 924 // byte or utf-8 strings as keys, but only when !stringref
740 925
741 if (ecb_expect_true (!dec->stringref)) 926 if (ecb_expect_true (!dec->stringref))
742 if (ecb_expect_true ((U8)(*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8)) 927 if (ecb_expect_true ((U8)(*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8))
743 { 928 {
744 I32 len = decode_uint (dec); 929 STRLEN len = decode_uint (dec);
745 char *key = (char *)dec->cur; 930 char *key = (char *)dec->cur;
746 931
932 WANT (len);
747 dec->cur += len; 933 dec->cur += len;
748 934
749 hv_store (hv, key, len, decode_sv (dec), 0); 935 hv_store (hv, key, len, decode_sv (dec), 0);
750 936
751 return; 937 return;
752 } 938 }
753 else if (ecb_expect_true ((U8)(*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8)) 939 else if (ecb_expect_true ((U8)(*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8))
754 { 940 {
755 I32 len = decode_uint (dec); 941 STRLEN len = decode_uint (dec);
756 char *key = (char *)dec->cur; 942 char *key = (char *)dec->cur;
757 943
944 WANT (len);
758 dec->cur += len; 945 dec->cur += len;
759 946
760 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8)) 947 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
761 if (!is_utf8_string (key, len)) 948 if (!is_utf8_string (key, len))
762 ERR ("corrupted CBOR data (invalid UTF-8 in map key)"); 949 ERR ("corrupted CBOR data (invalid UTF-8 in map key)");
… …
767 } 954 }
768 955
769 SV *k = decode_sv (dec); 956 SV *k = decode_sv (dec);
770 SV *v = decode_sv (dec); 957 SV *v = decode_sv (dec);
771 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
772 hv_store_ent (hv, k, v, 0); 987 hv_store_ent (hv, k, v, 0);
773 SvREFCNT_dec (k); 988 SvREFCNT_dec_NN (k);
774 989
775fail: 990fail:
776 ; 991 ;
777} 992}
778 993
… …
789 1004
790 for (;;) 1005 for (;;)
791 { 1006 {
792 WANT (1); 1007 WANT (1);
793 1008
794 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF)) 1009 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF) || dec->err)
795 { 1010 {
796 ++dec->cur; 1011 ++dec->cur;
797 break; 1012 break;
798 } 1013 }
799 1014
800 decode_he (dec, hv); 1015 decode_he (dec, hv);
801 } 1016 }
802 } 1017 }
803 else 1018 else
804 { 1019 {
805 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
806 1023
807 while (pairs--) 1024 while (pairs--)
808 decode_he (dec, hv); 1025 decode_he (dec, hv);
809 } 1026 }
810 1027
811 DEC_DEC_DEPTH; 1028 DEC_DEC_DEPTH;
812 return newRV_noinc ((SV *)hv); 1029 return newRV_noinc ((SV *)hv);
813 1030
814fail: 1031fail:
815 SvREFCNT_dec (hv); 1032 SvREFCNT_dec_NN (hv);
816 DEC_DEC_DEPTH; 1033 DEC_DEC_DEPTH;
817 return &PL_sv_undef; 1034 return &PL_sv_undef;
818} 1035}
819 1036
820static SV * 1037static SV *
821decode_str (dec_t *dec, int utf8) 1038decode_str (dec_t *dec, int utf8)
822{ 1039{
823 SV *sv = 0; 1040 SV *sv = 0;
824 1041
825 if ((*dec->cur & MINOR_MASK) == MINOR_INDEF) 1042 if (ecb_expect_false ((*dec->cur & MINOR_MASK) == MINOR_INDEF))
826 { 1043 {
827 // indefinite length strings 1044 // indefinite length strings
828 ++dec->cur; 1045 ++dec->cur;
829 1046
830 U8 major = *dec->cur & MAJOR_MISC; 1047 U8 major = *dec->cur & MAJOR_MISC;
… …
898 sv = newRV_noinc (decode_sv (dec)); 1115 sv = newRV_noinc (decode_sv (dec));
899 break; 1116 break;
900 1117
901 case CBOR_TAG_STRINGREF_NAMESPACE: 1118 case CBOR_TAG_STRINGREF_NAMESPACE:
902 { 1119 {
1120 // do not use SAVETMPS/FREETMPS, as these will
1121 // erase mortalised caches, e.g. "shareable"
903 ENTER; SAVETMPS; 1122 ENTER;
904 1123
905 SAVESPTR (dec->stringref); 1124 SAVESPTR (dec->stringref);
906 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ()); 1125 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ());
907 1126
908 sv = decode_sv (dec); 1127 sv = decode_sv (dec);
909 1128
910 FREETMPS; LEAVE; 1129 LEAVE;
911 } 1130 }
912 break; 1131 break;
913 1132
914 case CBOR_TAG_STRINGREF: 1133 case CBOR_TAG_STRINGREF:
915 { 1134 {
916 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT)) 1135 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
917 ERR ("corrupted CBOR data (stringref index not an unsigned integer)"); 1136 ERR ("corrupted CBOR data (stringref index not an unsigned integer)");
918 1137
919 UV idx = decode_uint (dec); 1138 UV idx = decode_uint (dec);
920 1139
921 if (!dec->stringref || (int)idx > AvFILLp (dec->stringref)) 1140 if (!dec->stringref || idx >= (UV)(1 + AvFILLp (dec->stringref)))
922 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)");
923 1142
924 sv = newSVsv (AvARRAY (dec->stringref)[idx]); 1143 sv = newSVsv (AvARRAY (dec->stringref)[idx]);
925 } 1144 }
926 break; 1145 break;
… …
954 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT)) 1173 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
955 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)"); 1174 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)");
956 1175
957 UV idx = decode_uint (dec); 1176 UV idx = decode_uint (dec);
958 1177
959 if (!dec->shareable || (int)idx > AvFILLp (dec->shareable)) 1178 if (!dec->shareable || idx >= (UV)(1 + AvFILLp (dec->shareable)))
960 ERR ("corrupted CBOR data (sharedref index out of bounds)"); 1179 ERR ("corrupted CBOR data (sharedref index out of bounds)");
961 1180
962 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]); 1181 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]);
963 1182
964 if (sv == &PL_sv_undef) 1183 if (sv == &PL_sv_undef)
… …
966 } 1185 }
967 break; 1186 break;
968 1187
969 case CBOR_TAG_PERL_OBJECT: 1188 case CBOR_TAG_PERL_OBJECT:
970 { 1189 {
1190 if (dec->cbor.flags & F_FORBID_OBJECTS)
1191 goto filter;
1192
971 sv = decode_sv (dec); 1193 sv = decode_sv (dec);
972 1194
973 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV) 1195 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
974 ERR ("corrupted CBOR data (non-array perl object)"); 1196 ERR ("corrupted CBOR data (non-array perl object)");
975 1197
… …
985 if (!method) 1207 if (!method)
986 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)");
987 1209
988 dSP; 1210 dSP;
989 1211
990 ENTER; SAVETMPS; PUSHMARK (SP); 1212 ENTER; SAVETMPS;
1213 PUSHMARK (SP);
991 EXTEND (SP, len + 1); 1214 EXTEND (SP, len + 1);
992 // 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
993 PUSHs (*av_fetch (av, 0, 1)); 1216 PUSHs (*av_fetch (av, 0, 1));
994 PUSHs (sv_cbor); 1217 PUSHs (sv_cbor);
995 1218
… …
1003 SPAGAIN; 1226 SPAGAIN;
1004 1227
1005 if (SvTRUE (ERRSV)) 1228 if (SvTRUE (ERRSV))
1006 { 1229 {
1007 FREETMPS; LEAVE; 1230 FREETMPS; LEAVE;
1008 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV)))); 1231 ERR_ERRSV;
1009 } 1232 }
1010 1233
1011 SvREFCNT_dec (sv); 1234 SvREFCNT_dec_NN (sv);
1012 sv = SvREFCNT_inc (POPs); 1235 sv = SvREFCNT_inc (POPs);
1013 1236
1014 PUTBACK; 1237 PUTBACK;
1015 1238
1016 FREETMPS; LEAVE; 1239 FREETMPS; LEAVE;
1017 } 1240 }
1018 break; 1241 break;
1019 1242
1020 default: 1243 default:
1244 filter:
1021 { 1245 {
1246 SV *tag_sv = newSVuv (tag);
1247
1022 sv = decode_sv (dec); 1248 sv = decode_sv (dec);
1023 1249
1024 dSP; 1250 dSP;
1025 ENTER; SAVETMPS; PUSHMARK (SP); 1251 ENTER; SAVETMPS;
1252 PUSHMARK (SP);
1026 EXTEND (SP, 2); 1253 EXTEND (SP, 2);
1027 PUSHs (newSVuv (tag)); 1254 PUSHs (tag_sv);
1028 PUSHs (sv); 1255 PUSHs (sv);
1029 1256
1030 PUTBACK; 1257 PUTBACK;
1031 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);
1032 SPAGAIN; 1259 SPAGAIN;
1033 1260
1034 if (SvTRUE (ERRSV)) 1261 if (SvTRUE (ERRSV))
1035 { 1262 {
1263 SvREFCNT_dec_NN (tag_sv);
1036 FREETMPS; LEAVE; 1264 FREETMPS; LEAVE;
1037 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV)))); 1265 ERR_ERRSV;
1038 } 1266 }
1039 1267
1040 if (count) 1268 if (count)
1041 { 1269 {
1270 SvREFCNT_dec_NN (tag_sv);
1042 SvREFCNT_dec (sv); 1271 SvREFCNT_dec_NN (sv);
1043 sv = SvREFCNT_inc (POPs); 1272 sv = SvREFCNT_inc_NN (TOPs);
1273 SP -= count;
1044 } 1274 }
1045 else 1275 else
1046 { 1276 {
1047 AV *av = newAV (); 1277 AV *av = newAV ();
1048 av_push (av, newSVuv (tag)); 1278 av_push (av, tag_sv);
1049 av_push (av, sv); 1279 av_push (av, sv);
1050 1280
1051 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 1281 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
1052 ? cbor_tagged_stash 1282 ? cbor_tagged_stash
1053 : gv_stashpv ("CBOR::XS::Tagged" , 1); 1283 : gv_stashpv ("CBOR::XS::Tagged" , 1);
… …
1156} 1386}
1157 1387
1158static SV * 1388static SV *
1159decode_cbor (SV *string, CBOR *cbor, char **offset_return) 1389decode_cbor (SV *string, CBOR *cbor, char **offset_return)
1160{ 1390{
1161 dec_t dec = { }; 1391 dec_t dec = { 0 };
1162 SV *sv; 1392 SV *sv;
1163 STRLEN len; 1393 STRLEN len;
1164 char *data = SvPVbyte (string, len); 1394 char *data = SvPVbyte (string, len);
1165 1395
1166 if (len > cbor->max_size && cbor->max_size) 1396 if (len > cbor->max_size && cbor->max_size)
… …
1182 1412
1183 if (dec.err) 1413 if (dec.err)
1184 { 1414 {
1185 if (dec.shareable) 1415 if (dec.shareable)
1186 { 1416 {
1187 // need to break cyclic links, which whould all be in shareable 1417 // need to break cyclic links, which would all be in shareable
1188 int i; 1418 int i;
1189 SV **svp; 1419 SV **svp;
1190 1420
1191 for (i = av_len (dec.shareable) + 1; i--; ) 1421 for (i = av_len (dec.shareable) + 1; i--; )
1192 if ((svp = av_fetch (dec.shareable, i, 0))) 1422 if ((svp = av_fetch (dec.shareable, i, 0)))
1193 sv_setsv (*svp, &PL_sv_undef); 1423 sv_setsv (*svp, &PL_sv_undef);
1194 } 1424 }
1195 1425
1196 SvREFCNT_dec (sv); 1426 SvREFCNT_dec_NN (sv);
1427
1428 if (dec.err_sv)
1429 sv_2mortal (dec.err_sv);
1430
1197 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);
1198 } 1432 }
1199 1433
1200 sv = sv_2mortal (sv); 1434 sv = sv_2mortal (sv);
1201 1435
… …
1257 1491
1258 int major = *p >> MAJOR_SHIFT; 1492 int major = *p >> MAJOR_SHIFT;
1259 1493
1260 switch (major) 1494 switch (major)
1261 { 1495 {
1496 case MAJOR_TAG >> MAJOR_SHIFT:
1497 ++count; // tags merely prefix another value
1498 break;
1499
1262 case MAJOR_BYTES >> MAJOR_SHIFT: 1500 case MAJOR_BYTES >> MAJOR_SHIFT:
1263 case MAJOR_TEXT >> MAJOR_SHIFT: 1501 case MAJOR_TEXT >> MAJOR_SHIFT:
1264 case MAJOR_ARRAY >> MAJOR_SHIFT: 1502 case MAJOR_ARRAY >> MAJOR_SHIFT:
1265 case MAJOR_MAP >> MAJOR_SHIFT: 1503 case MAJOR_MAP >> MAJOR_SHIFT:
1266 { 1504 {
… …
1341 1579
1342 default_filter = newSVpv ("CBOR::XS::default_filter", 0); 1580 default_filter = newSVpv ("CBOR::XS::default_filter", 0);
1343 1581
1344 sv_cbor = newSVpv ("CBOR", 0); 1582 sv_cbor = newSVpv ("CBOR", 0);
1345 SvREADONLY_on (sv_cbor); 1583 SvREADONLY_on (sv_cbor);
1584
1585 assert (("STRLEN must be an unsigned type", 0 <= (STRLEN)-1));
1346} 1586}
1347 1587
1348PROTOTYPES: DISABLE 1588PROTOTYPES: DISABLE
1349 1589
1350void CLONE (...) 1590void CLONE (...)
… …
1370 ALIAS: 1610 ALIAS:
1371 shrink = F_SHRINK 1611 shrink = F_SHRINK
1372 allow_unknown = F_ALLOW_UNKNOWN 1612 allow_unknown = F_ALLOW_UNKNOWN
1373 allow_sharing = F_ALLOW_SHARING 1613 allow_sharing = F_ALLOW_SHARING
1374 allow_cycles = F_ALLOW_CYCLES 1614 allow_cycles = F_ALLOW_CYCLES
1615 forbid_objects = F_FORBID_OBJECTS
1375 pack_strings = F_PACK_STRINGS 1616 pack_strings = F_PACK_STRINGS
1617 text_keys = F_TEXT_KEYS
1618 text_strings = F_TEXT_STRINGS
1376 validate_utf8 = F_VALIDATE_UTF8 1619 validate_utf8 = F_VALIDATE_UTF8
1377 PPCODE: 1620 PPCODE:
1378{ 1621{
1379 if (enable) 1622 if (enable)
1380 self->flags |= ix; 1623 self->flags |= ix;
… …
1388 ALIAS: 1631 ALIAS:
1389 get_shrink = F_SHRINK 1632 get_shrink = F_SHRINK
1390 get_allow_unknown = F_ALLOW_UNKNOWN 1633 get_allow_unknown = F_ALLOW_UNKNOWN
1391 get_allow_sharing = F_ALLOW_SHARING 1634 get_allow_sharing = F_ALLOW_SHARING
1392 get_allow_cycles = F_ALLOW_CYCLES 1635 get_allow_cycles = F_ALLOW_CYCLES
1636 get_forbid_objects = F_FORBID_OBJECTS
1393 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
1394 get_validate_utf8 = F_VALIDATE_UTF8 1640 get_validate_utf8 = F_VALIDATE_UTF8
1395 PPCODE: 1641 PPCODE:
1396 XPUSHs (boolSV (self->flags & ix)); 1642 XPUSHs (boolSV (self->flags & ix));
1397 1643
1398void max_depth (CBOR *self, U32 max_depth = 0x80000000UL) 1644void max_depth (CBOR *self, U32 max_depth = 0x80000000UL)
… …
1528 cbor_init (&cbor); 1774 cbor_init (&cbor);
1529 PUTBACK; cborstr = decode_cbor (cborstr, &cbor, 0); SPAGAIN; 1775 PUTBACK; cborstr = decode_cbor (cborstr, &cbor, 0); SPAGAIN;
1530 XPUSHs (cborstr); 1776 XPUSHs (cborstr);
1531} 1777}
1532 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