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.9 by root, Sun Oct 27 10:17:12 2013 UTC vs.
Revision 1.16 by root, Tue Oct 29 20:59:16 2013 UTC

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 11
12#include "ecb.h" 12#include "ecb.h"
13
14// compatibility with perl <5.18
15#ifndef HvNAMELEN_get
16# define HvNAMELEN_get(hv) strlen (HvNAME (hv))
17#endif
18#ifndef HvNAMELEN
19# define HvNAMELEN(hv) HvNAMELEN_get (hv)
20#endif
21#ifndef HvNAMEUTF8
22# define HvNAMEUTF8(hv) 0
23#endif
13 24
14// known tags 25// known tags
15enum cbor_tag 26enum cbor_tag
16{ 27{
17 // inofficial extensions (pending iana registration) 28 // inofficial extensions (pending iana registration)
60#else 71#else
61# define CBOR_SLOW 0 72# define CBOR_SLOW 0
62# define CBOR_STASH cbor_stash 73# define CBOR_STASH cbor_stash
63#endif 74#endif
64 75
65static HV *cbor_stash, *cbor_boolean_stash, *cbor_tagged_stash; // CBOR::XS:: 76static HV *cbor_stash, *types_boolean_stash, *types_error_stash, *cbor_tagged_stash; // CBOR::XS::
66static SV *cbor_true, *cbor_false; 77static SV *types_true, *types_false, *types_error, *sv_cbor;
67 78
68typedef struct { 79typedef struct {
69 U32 flags; 80 U32 flags;
70 U32 max_depth; 81 U32 max_depth;
71 STRLEN max_size; 82 STRLEN max_size;
259 SvGETMAGIC (sv); 270 SvGETMAGIC (sv);
260 svt = SvTYPE (sv); 271 svt = SvTYPE (sv);
261 272
262 if (ecb_expect_false (SvOBJECT (sv))) 273 if (ecb_expect_false (SvOBJECT (sv)))
263 { 274 {
264 HV *boolean_stash = !CBOR_SLOW || cbor_boolean_stash 275 HV *boolean_stash = !CBOR_SLOW || types_boolean_stash
265 ? cbor_boolean_stash 276 ? types_boolean_stash
266 : gv_stashpv ("CBOR::XS::Boolean", 1); 277 : gv_stashpv ("Types::Serialiser::Boolean", 1);
278 HV *error_stash = !CBOR_SLOW || types_error_stash
279 ? types_error_stash
280 : gv_stashpv ("Types::Serialiser::Error", 1);
267 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 281 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
268 ? cbor_tagged_stash 282 ? cbor_tagged_stash
269 : gv_stashpv ("CBOR::XS::Tagged" , 1); 283 : gv_stashpv ("CBOR::XS::Tagged" , 1);
270 284
285 HV *stash = SvSTASH (sv);
286 GV *method;
287
271 if (SvSTASH (sv) == boolean_stash) 288 if (stash == boolean_stash)
272 encode_ch (enc, SvIV (sv) ? 0xe0 | 21 : 0xe0 | 20); 289 encode_ch (enc, SvIV (sv) ? 0xe0 | 21 : 0xe0 | 20);
290 else if (stash == error_stash)
291 encode_ch (enc, 0xe0 | 23);
273 else if (SvSTASH (sv) == tagged_stash) 292 else if (stash == tagged_stash)
274 { 293 {
275 if (svt != SVt_PVAV) 294 if (svt != SVt_PVAV)
276 croak ("encountered CBOR::XS::Tagged object that isn't an array"); 295 croak ("encountered CBOR::XS::Tagged object that isn't an array");
277 296
278 encode_uint (enc, 0xc0, SvUV (*av_fetch ((AV *)sv, 0, 1))); 297 encode_uint (enc, 0xc0, SvUV (*av_fetch ((AV *)sv, 0, 1)));
279 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1)); 298 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1));
280 } 299 }
300 else if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
301 {
302 dSP;
303
304 ENTER; SAVETMPS; PUSHMARK (SP);
305 // we re-bless the reference to get overload and other niceties right
306 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
307
308 PUTBACK;
309 // G_SCALAR ensures that return value is 1
310 call_sv ((SV *)GvCV (method), G_SCALAR);
311 SPAGAIN;
312
313 // catch this surprisingly common error
314 if (SvROK (TOPs) && SvRV (TOPs) == sv)
315 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (stash));
316
317 encode_sv (enc, POPs);
318
319 PUTBACK;
320
321 FREETMPS; LEAVE;
322 }
323 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
324 {
325 dSP;
326
327 ENTER; SAVETMPS; PUSHMARK (SP);
328 EXTEND (SP, 2);
329 // we re-bless the reference to get overload and other niceties right
330 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
331 PUSHs (sv_cbor);
332
333 PUTBACK;
334 int count = call_sv ((SV *)GvCV (method), G_ARRAY);
335 SPAGAIN;
336
337 // catch this surprisingly common error
338 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
339 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash));
340
341 encode_uint (enc, 0xc0, CBOR_TAG_PERL_OBJECT);
342 encode_uint (enc, 0x80, count + 1);
343 encode_str (enc, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
344
345 while (count)
346 encode_sv (enc, SP[1 - count--]);
347
348 PUTBACK;
349
350 FREETMPS; LEAVE;
351 }
281 else 352 else
282 {
283 // we re-bless the reference to get overload and other niceties right
284 GV *to_cbor = gv_fetchmethod_autoload (SvSTASH (sv), "TO_CBOR", 0);
285
286 if (to_cbor)
287 {
288 dSP;
289
290 ENTER; SAVETMPS; PUSHMARK (SP);
291 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), SvSTASH (sv)));
292
293 // calling with G_SCALAR ensures that we always get a 1 return value
294 PUTBACK;
295 call_sv ((SV *)GvCV (to_cbor), G_SCALAR);
296 SPAGAIN;
297
298 // catch this surprisingly common error
299 if (SvROK (TOPs) && SvRV (TOPs) == sv)
300 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (SvSTASH (sv)));
301
302 sv = POPs;
303 PUTBACK;
304
305 encode_sv (enc, sv);
306
307 FREETMPS; LEAVE;
308 }
309 else
310 croak ("encountered object '%s', but no TO_CBOR method available on it", 353 croak ("encountered object '%s', but no TO_CBOR or FREEZE methods available on it",
311 SvPV_nolen (sv_2mortal (newRV_inc (sv)))); 354 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
312 }
313 } 355 }
314 else if (svt == SVt_PVHV) 356 else if (svt == SVt_PVHV)
315 encode_hv (enc, (HV *)sv); 357 encode_hv (enc, (HV *)sv);
316 else if (svt == SVt_PVAV) 358 else if (svt == SVt_PVAV)
317 encode_av (enc, (AV *)sv); 359 encode_av (enc, (AV *)sv);
542 SvREFCNT_dec (av); 584 SvREFCNT_dec (av);
543 DEC_DEC_DEPTH; 585 DEC_DEC_DEPTH;
544 return &PL_sv_undef; 586 return &PL_sv_undef;
545} 587}
546 588
589static void
590decode_he (dec_t *dec, HV *hv)
591{
592 // for speed reasons, we specialcase single-string
593 // byte or utf-8 strings as keys.
594
595 if (*dec->cur >= 0x40 && *dec->cur <= 0x40 + 27)
596 {
597 I32 len = decode_uint (dec);
598 char *key = (char *)dec->cur;
599
600 dec->cur += len;
601
602 hv_store (hv, key, len, decode_sv (dec), 0);
603 }
604 else if (*dec->cur >= 0x60 && *dec->cur <= 0x60 + 27)
605 {
606 I32 len = decode_uint (dec);
607 char *key = (char *)dec->cur;
608
609 dec->cur += len;
610
611 hv_store (hv, key, -len, decode_sv (dec), 0);
612 }
613 else
614 {
615 SV *k = decode_sv (dec);
616 SV *v = decode_sv (dec);
617
618 hv_store_ent (hv, k, v, 0);
619 SvREFCNT_dec (k);
620 }
621}
622
547static SV * 623static SV *
548decode_hv (dec_t *dec) 624decode_hv (dec_t *dec)
549{ 625{
550 HV *hv = newHV (); 626 HV *hv = newHV ();
551 627
563 { 639 {
564 ++dec->cur; 640 ++dec->cur;
565 break; 641 break;
566 } 642 }
567 643
568 SV *k = decode_sv (dec); 644 decode_he (dec, hv);
569 SV *v = decode_sv (dec);
570
571 hv_store_ent (hv, k, v, 0);
572 } 645 }
573 } 646 }
574 else 647 else
575 { 648 {
576 int len = decode_uint (dec); 649 int pairs = decode_uint (dec);
577 650
578 while (len--) 651 while (pairs--)
579 { 652 decode_he (dec, hv);
580 SV *k = decode_sv (dec);
581 SV *v = decode_sv (dec);
582
583 hv_store_ent (hv, k, v, 0);
584 }
585 } 653 }
586 654
587 DEC_DEC_DEPTH; 655 DEC_DEC_DEPTH;
588 return newRV_noinc ((SV *)hv); 656 return newRV_noinc ((SV *)hv);
589 657
643 UV tag = decode_uint (dec); 711 UV tag = decode_uint (dec);
644 SV *sv = decode_sv (dec); 712 SV *sv = decode_sv (dec);
645 713
646 if (tag == CBOR_TAG_MAGIC) 714 if (tag == CBOR_TAG_MAGIC)
647 return sv; 715 return sv;
648
649 if (tag == CBOR_TAG_PERL_OBJECT) 716 else if (tag == CBOR_TAG_PERL_OBJECT)
650 { 717 {
651 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV) 718 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
652 ERR ("corrupted CBOR data (non-array perl object)"); 719 ERR ("corrupted CBOR data (non-array perl object)");
720
721 AV *av = (AV *)SvRV (sv);
722 int len = av_len (av) + 1;
723 HV *stash = gv_stashsv (*av_fetch (av, 0, 1), 0);
724
725 if (!stash)
726 ERR ("cannot decode perl-object (package does not exist)");
727
728 GV *method = gv_fetchmethod_autoload (stash, "THAW", 0);
653 729
654 // TODO 730 if (!method)
731 ERR ("cannot decode perl-object (package does not have a THAW method)");
732
733 dSP;
734
735 ENTER; SAVETMPS; PUSHMARK (SP);
736 EXTEND (SP, len + 1);
737 // we re-bless the reference to get overload and other niceties right
738 PUSHs (*av_fetch (av, 0, 1));
739 PUSHs (sv_cbor);
740
741 int i;
742
743 for (i = 1; i < len; ++i)
744 PUSHs (*av_fetch (av, i, 1));
745
746 PUTBACK;
747 call_sv ((SV *)GvCV (method), G_SCALAR);
748 SPAGAIN;
749
750 SvREFCNT_dec (sv);
751 sv = SvREFCNT_inc (POPs);
752
753 PUTBACK;
754
755 FREETMPS; LEAVE;
756
757 return sv;
758 }
759 else
655 } 760 {
656
657 AV *av = newAV (); 761 AV *av = newAV ();
658 av_push (av, newSVuv (tag)); 762 av_push (av, newSVuv (tag));
659 av_push (av, sv); 763 av_push (av, sv);
660 764
661 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 765 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
662 ? cbor_tagged_stash 766 ? cbor_tagged_stash
663 : gv_stashpv ("CBOR::XS::Tagged" , 1); 767 : gv_stashpv ("CBOR::XS::Tagged" , 1);
664 768
665 return sv_bless (newRV_noinc ((SV *)av), tagged_stash); 769 return sv_bless (newRV_noinc ((SV *)av), tagged_stash);
770 }
666 771
667fail: 772fail:
668 SvREFCNT_dec (sv); 773 SvREFCNT_dec (sv);
669 return &PL_sv_undef; 774 return &PL_sv_undef;
670} 775}
693 case 7: // misc 798 case 7: // misc
694 switch (*dec->cur++ & 31) 799 switch (*dec->cur++ & 31)
695 { 800 {
696 case 20: 801 case 20:
697#if CBOR_SLOW 802#if CBOR_SLOW
698 cbor_false = get_bool ("CBOR::XS::false"); 803 types_false = get_bool ("Types::Serialiser::false");
699#endif 804#endif
700 return newSVsv (cbor_false); 805 return newSVsv (types_false);
701 case 21: 806 case 21:
702#if CBOR_SLOW 807#if CBOR_SLOW
703 cbor_true = get_bool ("CBOR::XS::true"); 808 types_true = get_bool ("Types::Serialiser::true");
704#endif 809#endif
705 return newSVsv (cbor_true); 810 return newSVsv (types_true);
706 case 22: 811 case 22:
707 return newSVsv (&PL_sv_undef); 812 return newSVsv (&PL_sv_undef);
813 case 23:
814#if CBOR_SLOW
815 types_error = get_bool ("Types::Serialiser::error");
816#endif
817 return newSVsv (types_error);
708 818
709 case 25: 819 case 25:
710 { 820 {
711 WANT (2); 821 WANT (2);
712 822
758static SV * 868static SV *
759decode_cbor (SV *string, CBOR *cbor, char **offset_return) 869decode_cbor (SV *string, CBOR *cbor, char **offset_return)
760{ 870{
761 dec_t dec; 871 dec_t dec;
762 SV *sv; 872 SV *sv;
873 STRLEN len;
874 char *data = SvPVbyte (string, len);
763 875
764 /* work around bugs in 5.10 where manipulating magic values
765 * makes perl ignore the magic in subsequent accesses.
766 * also make a copy of non-PV values, to get them into a clean
767 * state (SvPV should do that, but it's buggy, see below).
768 */
769 /*SvGETMAGIC (string);*/
770 if (SvMAGICAL (string) || !SvPOK (string))
771 string = sv_2mortal (newSVsv (string));
772
773 SvUPGRADE (string, SVt_PV);
774
775 /* work around a bug in perl 5.10, which causes SvCUR to fail an
776 * assertion with -DDEBUGGING, although SvCUR is documented to
777 * return the xpv_cur field which certainly exists after upgrading.
778 * according to nicholas clark, calling SvPOK fixes this.
779 * But it doesn't fix it, so try another workaround, call SvPV_nolen
780 * and hope for the best.
781 * Damnit, SvPV_nolen still trips over yet another assertion. This
782 * assertion business is seriously broken, try yet another workaround
783 * for the broken -DDEBUGGING.
784 */
785 {
786#ifdef DEBUGGING
787 STRLEN offset = SvOK (string) ? sv_len (string) : 0;
788#else
789 STRLEN offset = SvCUR (string);
790#endif
791
792 if (offset > cbor->max_size && cbor->max_size) 876 if (len > cbor->max_size && cbor->max_size)
793 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu", 877 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
794 (unsigned long)SvCUR (string), (unsigned long)cbor->max_size); 878 (unsigned long)len, (unsigned long)cbor->max_size);
795 }
796
797 sv_utf8_downgrade (string, 0);
798 879
799 dec.cbor = *cbor; 880 dec.cbor = *cbor;
800 dec.cur = (U8 *)SvPVX (string); 881 dec.cur = (U8 *)data;
801 dec.end = (U8 *)SvEND (string); 882 dec.end = (U8 *)data + len;
802 dec.err = 0; 883 dec.err = 0;
803 dec.depth = 0; 884 dec.depth = 0;
804 885
805 sv = decode_sv (&dec); 886 sv = decode_sv (&dec);
806 887
812 dec.err = "garbage after CBOR object"; 893 dec.err = "garbage after CBOR object";
813 894
814 if (dec.err) 895 if (dec.err)
815 { 896 {
816 SvREFCNT_dec (sv); 897 SvREFCNT_dec (sv);
817 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)SvPVX (string), (int)(uint8_t)*dec.cur); 898 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur);
818 } 899 }
819 900
820 sv = sv_2mortal (sv); 901 sv = sv_2mortal (sv);
821 902
822 return sv; 903 return sv;
828MODULE = CBOR::XS PACKAGE = CBOR::XS 909MODULE = CBOR::XS PACKAGE = CBOR::XS
829 910
830BOOT: 911BOOT:
831{ 912{
832 cbor_stash = gv_stashpv ("CBOR::XS" , 1); 913 cbor_stash = gv_stashpv ("CBOR::XS" , 1);
833 cbor_boolean_stash = gv_stashpv ("CBOR::XS::Boolean", 1);
834 cbor_tagged_stash = gv_stashpv ("CBOR::XS::Tagged" , 1); 914 cbor_tagged_stash = gv_stashpv ("CBOR::XS::Tagged" , 1);
835 915
836 cbor_true = get_bool ("CBOR::XS::true"); 916 types_boolean_stash = gv_stashpv ("Types::Serialiser::Boolean", 1);
837 cbor_false = get_bool ("CBOR::XS::false"); 917 types_error_stash = gv_stashpv ("Types::Serialiser::Error" , 1);
918
919 types_true = get_bool ("Types::Serialiser::true" );
920 types_false = get_bool ("Types::Serialiser::false");
921 types_error = get_bool ("Types::Serialiser::error");
922
923 sv_cbor = newSVpv ("CBOR", 0);
924 SvREADONLY_on (sv_cbor);
838} 925}
839 926
840PROTOTYPES: DISABLE 927PROTOTYPES: DISABLE
841 928
842void CLONE (...) 929void CLONE (...)
843 CODE: 930 CODE:
844 cbor_stash = 0; 931 cbor_stash = 0;
845 cbor_boolean_stash = 0;
846 cbor_tagged_stash = 0; 932 cbor_tagged_stash = 0;
933 types_error_stash = 0;
934 types_boolean_stash = 0;
847 935
848void new (char *klass) 936void new (char *klass)
849 PPCODE: 937 PPCODE:
850{ 938{
851 SV *pv = NEWSV (0, sizeof (CBOR)); 939 SV *pv = NEWSV (0, sizeof (CBOR));
898 CODE: 986 CODE:
899 RETVAL = self->max_size; 987 RETVAL = self->max_size;
900 OUTPUT: 988 OUTPUT:
901 RETVAL 989 RETVAL
902 990
903#if 0 //TODO
904
905void filter_cbor_object (CBOR *self, SV *cb = &PL_sv_undef)
906 PPCODE:
907{
908 SvREFCNT_dec (self->cb_object);
909 self->cb_object = SvOK (cb) ? newSVsv (cb) : 0;
910
911 XPUSHs (ST (0));
912}
913
914void filter_cbor_single_key_object (CBOR *self, SV *key, SV *cb = &PL_sv_undef)
915 PPCODE:
916{
917 if (!self->cb_sk_object)
918 self->cb_sk_object = newHV ();
919
920 if (SvOK (cb))
921 hv_store_ent (self->cb_sk_object, key, newSVsv (cb), 0);
922 else
923 {
924 hv_delete_ent (self->cb_sk_object, key, G_DISCARD, 0);
925
926 if (!HvKEYS (self->cb_sk_object))
927 {
928 SvREFCNT_dec (self->cb_sk_object);
929 self->cb_sk_object = 0;
930 }
931 }
932
933 XPUSHs (ST (0));
934}
935
936#endif
937
938void encode (CBOR *self, SV *scalar) 991void encode (CBOR *self, SV *scalar)
939 PPCODE: 992 PPCODE:
940 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN; 993 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN;
941 XPUSHs (scalar); 994 XPUSHs (scalar);
942 995
954 EXTEND (SP, 2); 1007 EXTEND (SP, 2);
955 PUSHs (sv); 1008 PUSHs (sv);
956 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr)))); 1009 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr))));
957} 1010}
958 1011
959#if 0
960
961void DESTROY (CBOR *self)
962 CODE:
963 SvREFCNT_dec (self->cb_sk_object);
964 SvREFCNT_dec (self->cb_object);
965
966#endif
967
968PROTOTYPES: ENABLE 1012PROTOTYPES: ENABLE
969 1013
970void encode_cbor (SV *scalar) 1014void encode_cbor (SV *scalar)
971 PPCODE: 1015 PPCODE:
972{ 1016{

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines