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.4 by root, Sat Oct 26 21:06:37 2013 UTC vs.
Revision 1.19 by root, Wed Nov 20 02:03:09 2013 UTC

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 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
24
25// known tags
26enum cbor_tag
27{
28 // inofficial extensions (pending iana registration)
29 CBOR_TAG_PERL_OBJECT = 24, // http://cbor.schmorp.de/perl-object
30 CBOR_TAG_GENERIC_OBJECT = 25, // http://cbor.schmorp.de/generic-object
31 CBOR_TAG_VALUE_SHAREABLE = 26, // http://cbor.schmorp.de/value-sharing
32 CBOR_TAG_VALUE_SHAREDREF = 27, // http://cbor.schmorp.de/value-sharing
33 CBOR_TAG_STRINGREF_NAMESPACE = 65537, // http://cbor.schmorp.de/stringref
34 CBOR_TAG_STRINGREF = 28, // http://cbor.schmorp.de/stringref
35 CBOR_TAG_INDIRECTION = 22098, // http://cbor.schmorp.de/indirection
36
37 // rfc7049
38 CBOR_TAG_DATETIME = 0, // rfc4287, utf-8
39 CBOR_TAG_TIMESTAMP = 1, // unix timestamp, any
40 CBOR_TAG_POS_BIGNUM = 2, // byte string
41 CBOR_TAG_NEG_BIGNUM = 3, // byte string
42 CBOR_TAG_DECIMAL = 4, // decimal fraction, array
43 CBOR_TAG_BIGFLOAT = 5, // array
44
45 CBOR_TAG_CONV_B64U = 21, // base64url, any
46 CBOR_TAG_CONV_B64 = 22, // base64, any
47 CBOR_TAG_CONV_HEX = 23, // base16, any
48 CBOR_TAG_CBOR = 24, // embedded cbor, byte string
49
50 CBOR_TAG_URI = 32, // URI rfc3986, utf-8
51 CBOR_TAG_B64U = 33, // base64url rfc4648, utf-8
52 CBOR_TAG_B64 = 34, // base6 rfc46484, utf-8
53 CBOR_TAG_REGEX = 35, // regex pcre/ecma262, utf-8
54 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8
55
56 CBOR_TAG_MAGIC = 55799 // self-describe cbor
57};
58
14#define F_SHRINK 0x00000200UL 59#define F_SHRINK 0x00000001UL
15#define F_ALLOW_UNKNOWN 0x00002000UL 60#define F_ALLOW_UNKNOWN 0x00000002UL
61#define F_ALLOW_SHARING 0x00000004UL //TODO
62#define F_DEDUP_STRINGS 0x00000008UL //TODO
63#define F_DEDUP_KEYS 0x00000010UL //TODO
16 64
17#define INIT_SIZE 32 // initial scalar size to be allocated 65#define INIT_SIZE 32 // initial scalar size to be allocated
18 66
19#define SB do { 67#define SB do {
20#define SE } while (0) 68#define SE } while (0)
21
22#if __GNUC__ >= 3
23# define expect(expr,value) __builtin_expect ((expr), (value))
24# define INLINE static inline
25#else
26# define expect(expr,value) (expr)
27# define INLINE static
28#endif
29
30#define expect_false(expr) expect ((expr) != 0, 0)
31#define expect_true(expr) expect ((expr) != 0, 1)
32 69
33#define IN_RANGE_INC(type,val,beg,end) \ 70#define IN_RANGE_INC(type,val,beg,end) \
34 ((unsigned type)((unsigned type)(val) - (unsigned type)(beg)) \ 71 ((unsigned type)((unsigned type)(val) - (unsigned type)(beg)) \
35 <= (unsigned type)((unsigned type)(end) - (unsigned type)(beg))) 72 <= (unsigned type)((unsigned type)(end) - (unsigned type)(beg)))
36 73
42#else 79#else
43# define CBOR_SLOW 0 80# define CBOR_SLOW 0
44# define CBOR_STASH cbor_stash 81# define CBOR_STASH cbor_stash
45#endif 82#endif
46 83
47static HV *cbor_stash, *cbor_boolean_stash; // CBOR::XS:: 84static HV *cbor_stash, *types_boolean_stash, *types_error_stash, *cbor_tagged_stash; // CBOR::XS::
48static SV *cbor_true, *cbor_false; 85static SV *types_true, *types_false, *types_error, *sv_cbor;
49 86
50typedef struct { 87typedef struct {
51 U32 flags; 88 U32 flags;
52 U32 max_depth; 89 U32 max_depth;
53 STRLEN max_size; 90 STRLEN max_size;
54
55 SV *cb_object;
56 HV *cb_sk_object;
57} CBOR; 91} CBOR;
58 92
59INLINE void 93ecb_inline void
60cbor_init (CBOR *cbor) 94cbor_init (CBOR *cbor)
61{ 95{
62 Zero (cbor, 1, CBOR); 96 Zero (cbor, 1, CBOR);
63 cbor->max_depth = 512; 97 cbor->max_depth = 512;
64} 98}
65 99
66///////////////////////////////////////////////////////////////////////////// 100/////////////////////////////////////////////////////////////////////////////
67// utility functions 101// utility functions
68 102
69INLINE SV * 103ecb_inline SV *
70get_bool (const char *name) 104get_bool (const char *name)
71{ 105{
72 SV *sv = get_sv (name, 1); 106 SV *sv = get_sv (name, 1);
73 107
74 SvREADONLY_on (sv); 108 SvREADONLY_on (sv);
75 SvREADONLY_on (SvRV (sv)); 109 SvREADONLY_on (SvRV (sv));
76 110
77 return sv; 111 return sv;
78} 112}
79 113
80INLINE void 114ecb_inline void
81shrink (SV *sv) 115shrink (SV *sv)
82{ 116{
83 sv_utf8_downgrade (sv, 1); 117 sv_utf8_downgrade (sv, 1);
84 118
85 if (SvLEN (sv) > SvCUR (sv) + 1) 119 if (SvLEN (sv) > SvCUR (sv) + 1)
91#endif 125#endif
92 } 126 }
93} 127}
94 128
95///////////////////////////////////////////////////////////////////////////// 129/////////////////////////////////////////////////////////////////////////////
96// fp hell
97
98//TODO
99
100/////////////////////////////////////////////////////////////////////////////
101// encoder 130// encoder
102 131
103// structure used for encoding CBOR 132// structure used for encoding CBOR
104typedef struct 133typedef struct
105{ 134{
106 char *cur; // SvPVX (sv) + current output position 135 char *cur; // SvPVX (sv) + current output position
107 char *end; // SvEND (sv) 136 char *end; // SvEND (sv)
108 SV *sv; // result scalar 137 SV *sv; // result scalar
109 CBOR cbor; 138 CBOR cbor;
110 U32 depth; // recursion level 139 U32 depth; // recursion level
140 HV *stringref; // string => index, or 0
141 HV *shareable; // ptr => index, or 0
142 UV shareable_idx;
111} enc_t; 143} enc_t;
112 144
113INLINE void 145ecb_inline void
114need (enc_t *enc, STRLEN len) 146need (enc_t *enc, STRLEN len)
115{ 147{
116 if (expect_false (enc->cur + len >= enc->end)) 148 if (ecb_expect_false (enc->cur + len >= enc->end))
117 { 149 {
118 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv); 150 STRLEN cur = enc->cur - (char *)SvPVX (enc->sv);
119 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1); 151 SvGROW (enc->sv, cur + (len < (cur >> 2) ? cur >> 2 : len) + 1);
120 enc->cur = SvPVX (enc->sv) + cur; 152 enc->cur = SvPVX (enc->sv) + cur;
121 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1; 153 enc->end = SvPVX (enc->sv) + SvLEN (enc->sv) - 1;
122 } 154 }
123} 155}
124 156
125INLINE void 157ecb_inline void
126encode_ch (enc_t *enc, char ch) 158encode_ch (enc_t *enc, char ch)
127{ 159{
128 need (enc, 1); 160 need (enc, 1);
129 *enc->cur++ = ch; 161 *enc->cur++ = ch;
130} 162}
176 need (enc, len); 208 need (enc, len);
177 memcpy (enc->cur, str, len); 209 memcpy (enc->cur, str, len);
178 enc->cur += len; 210 enc->cur += len;
179} 211}
180 212
213ecb_inline void
214encode_tag (enc_t *enc, UV tag)
215{
216 encode_uint (enc, 0xc0, tag);
217}
218
181static void encode_sv (enc_t *enc, SV *sv); 219static void encode_sv (enc_t *enc, SV *sv);
182 220
183static void 221static void
184encode_av (enc_t *enc, AV *av) 222encode_av (enc_t *enc, AV *av)
185{ 223{
224 if (HeKLEN (he) == HEf_SVKEY) 262 if (HeKLEN (he) == HEf_SVKEY)
225 encode_sv (enc, HeSVKEY (he)); 263 encode_sv (enc, HeSVKEY (he));
226 else 264 else
227 encode_str (enc, HeKUTF8 (he), HeKEY (he), HeKLEN (he)); 265 encode_str (enc, HeKUTF8 (he), HeKEY (he), HeKLEN (he));
228 266
229 encode_sv (enc, expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he)); 267 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he));
230 } 268 }
231 269
232 if (mg) 270 if (mg)
233 encode_ch (enc, 0xe0 | 31); 271 encode_ch (enc, 0xe0 | 31);
234 272
237 275
238// encode objects, arrays and special \0=false and \1=true values. 276// encode objects, arrays and special \0=false and \1=true values.
239static void 277static void
240encode_rv (enc_t *enc, SV *sv) 278encode_rv (enc_t *enc, SV *sv)
241{ 279{
242 svtype svt;
243
244 SvGETMAGIC (sv); 280 SvGETMAGIC (sv);
245 svt = SvTYPE (sv);
246 281
247 if (expect_false (SvOBJECT (sv))) 282 if (ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING)
283 && ecb_expect_false (SvREFCNT (sv) > 1))
248 { 284 {
249 HV *stash = !CBOR_SLOW || cbor_boolean_stash 285 if (!enc->shareable)
250 ? cbor_boolean_stash 286 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ());
251 : gv_stashpv ("CBOR::XS::Boolean", 1);
252 287
253 if (SvSTASH (sv) == stash) 288 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1);
254 encode_ch (enc, SvIV (sv) ? 0xe0 | 21 : 0xe0 | 20); 289
290 if (SvOK (*svp))
291 {
292 encode_tag (enc, CBOR_TAG_VALUE_SHAREDREF);
293 encode_uint (enc, 0x00, SvUV (*svp));
294 return;
295 }
255 else 296 else
256 { 297 {
257#if 0 //TODO 298 sv_setuv (*svp, enc->shareable_idx);
258 if (enc->cbor.flags & F_CONV_BLESSED) 299 ++enc->shareable_idx;
259 { 300 encode_tag (enc, CBOR_TAG_VALUE_SHAREABLE);
260 // we re-bless the reference to get overload and other niceties right
261 GV *to_cbor = gv_fetchmethod_autoload (SvSTASH (sv), "TO_CBOR", 0);
262
263 if (to_cbor)
264 {
265 dSP;
266
267 ENTER; SAVETMPS; PUSHMARK (SP);
268 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), SvSTASH (sv)));
269
270 // calling with G_SCALAR ensures that we always get a 1 return value
271 PUTBACK;
272 call_sv ((SV *)GvCV (to_cbor), G_SCALAR);
273 SPAGAIN;
274
275 // catch this surprisingly common error
276 if (SvROK (TOPs) && SvRV (TOPs) == sv)
277 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (SvSTASH (sv)));
278
279 sv = POPs;
280 PUTBACK;
281
282 encode_sv (enc, sv);
283
284 FREETMPS; LEAVE;
285 }
286 else if (enc->cbor.flags & F_ALLOW_BLESSED)
287 encode_str (enc, "null", 4, 0);
288 else
289 croak ("encountered object '%s', but neither allow_blessed enabled nor TO_CBOR method available on it",
290 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
291 }
292 else if (enc->cbor.flags & F_ALLOW_BLESSED)
293 encode_str (enc, "null", 4, 0);
294 else
295 croak ("encountered object '%s', but neither allow_blessed nor convert_blessed settings are enabled",
296 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
297#endif
298 } 301 }
302 }
303
304 svtype svt = SvTYPE (sv);
305
306 if (ecb_expect_false (SvOBJECT (sv)))
307 {
308 HV *boolean_stash = !CBOR_SLOW || types_boolean_stash
309 ? types_boolean_stash
310 : gv_stashpv ("Types::Serialiser::Boolean", 1);
311 HV *error_stash = !CBOR_SLOW || types_error_stash
312 ? types_error_stash
313 : gv_stashpv ("Types::Serialiser::Error", 1);
314 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
315 ? cbor_tagged_stash
316 : gv_stashpv ("CBOR::XS::Tagged" , 1);
317
318 HV *stash = SvSTASH (sv);
319 GV *method;
320
321 if (stash == boolean_stash)
322 encode_ch (enc, SvIV (sv) ? 0xe0 | 21 : 0xe0 | 20);
323 else if (stash == error_stash)
324 encode_ch (enc, 0xe0 | 23);
325 else if (stash == tagged_stash)
326 {
327 if (svt != SVt_PVAV)
328 croak ("encountered CBOR::XS::Tagged object that isn't an array");
329
330 encode_uint (enc, 0xc0, SvUV (*av_fetch ((AV *)sv, 0, 1)));
331 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1));
332 }
333 else if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
334 {
335 dSP;
336
337 ENTER; SAVETMPS; PUSHMARK (SP);
338 // we re-bless the reference to get overload and other niceties right
339 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
340
341 PUTBACK;
342 // G_SCALAR ensures that return value is 1
343 call_sv ((SV *)GvCV (method), G_SCALAR);
344 SPAGAIN;
345
346 // catch this surprisingly common error
347 if (SvROK (TOPs) && SvRV (TOPs) == sv)
348 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (stash));
349
350 encode_sv (enc, POPs);
351
352 PUTBACK;
353
354 FREETMPS; LEAVE;
355 }
356 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
357 {
358 dSP;
359
360 ENTER; SAVETMPS; PUSHMARK (SP);
361 EXTEND (SP, 2);
362 // we re-bless the reference to get overload and other niceties right
363 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
364 PUSHs (sv_cbor);
365
366 PUTBACK;
367 int count = call_sv ((SV *)GvCV (method), G_ARRAY);
368 SPAGAIN;
369
370 // catch this surprisingly common error
371 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
372 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash));
373
374 encode_tag (enc, CBOR_TAG_PERL_OBJECT);
375 encode_uint (enc, 0x80, count + 1);
376 encode_str (enc, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
377
378 while (count)
379 encode_sv (enc, SP[1 - count--]);
380
381 PUTBACK;
382
383 FREETMPS; LEAVE;
384 }
385 else
386 croak ("encountered object '%s', but no TO_CBOR or FREEZE methods available on it",
387 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
299 } 388 }
300 else if (svt == SVt_PVHV) 389 else if (svt == SVt_PVHV)
301 encode_hv (enc, (HV *)sv); 390 encode_hv (enc, (HV *)sv);
302 else if (svt == SVt_PVAV) 391 else if (svt == SVt_PVAV)
303 encode_av (enc, (AV *)sv); 392 encode_av (enc, (AV *)sv);
304 else if (svt < SVt_PVAV)
305 {
306 STRLEN len = 0;
307 char *pv = svt ? SvPV (sv, len) : 0;
308
309 if (len == 1 && *pv == '1')
310 encode_ch (enc, 0xe0 | 21);
311 else if (len == 1 && *pv == '0')
312 encode_ch (enc, 0xe0 | 20);
313 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
314 encode_ch (enc, 0xe0 | 23);
315 else
316 croak ("cannot encode reference to scalar '%s' unless the scalar is 0 or 1",
317 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
318 }
319 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
320 encode_ch (enc, 0xe0 | 23);
321 else 393 else
322 croak ("encountered %s, but CBOR can only represent references to arrays or hashes", 394 {
323 SvPV_nolen (sv_2mortal (newRV_inc (sv)))); 395 encode_tag (enc, CBOR_TAG_INDIRECTION);
396 encode_sv (enc, sv);
397 }
324} 398}
325 399
326static void 400static void
327encode_nv (enc_t *enc, SV *sv) 401encode_nv (enc_t *enc, SV *sv)
328{ 402{
329 double nv = SvNVX (sv); 403 double nv = SvNVX (sv);
330 404
331 need (enc, 9); 405 need (enc, 9);
332 406
333 if (expect_false (nv == (U32)nv)) 407 if (ecb_expect_false (nv == (U32)nv))
334 encode_uint (enc, 0x00, (U32)nv); 408 encode_uint (enc, 0x00, (U32)nv);
335 //TODO: maybe I32? 409 //TODO: maybe I32?
336 else if (expect_false (nv == (float)nv)) 410 else if (ecb_expect_false (nv == (float)nv))
337 { 411 {
338 uint32_t fp = ecb_float_to_binary32 (nv); 412 uint32_t fp = ecb_float_to_binary32 (nv);
339 413
340 *enc->cur++ = 0xe0 | 26; 414 *enc->cur++ = 0xe0 | 26;
341 415
393} 467}
394 468
395static SV * 469static SV *
396encode_cbor (SV *scalar, CBOR *cbor) 470encode_cbor (SV *scalar, CBOR *cbor)
397{ 471{
398 enc_t enc; 472 enc_t enc = { };
399 473
400 enc.cbor = *cbor; 474 enc.cbor = *cbor;
401 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE)); 475 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE));
402 enc.cur = SvPVX (enc.sv); 476 enc.cur = SvPVX (enc.sv);
403 enc.end = SvEND (enc.sv); 477 enc.end = SvEND (enc.sv);
404 enc.depth = 0;
405 478
406 SvPOK_only (enc.sv); 479 SvPOK_only (enc.sv);
407 encode_sv (&enc, scalar); 480 encode_sv (&enc, scalar);
408 481
409 SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv)); 482 SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv));
425 U8 *end; // end of input string 498 U8 *end; // end of input string
426 const char *err; // parse error, if != 0 499 const char *err; // parse error, if != 0
427 CBOR cbor; 500 CBOR cbor;
428 U32 depth; // recursion depth 501 U32 depth; // recursion depth
429 U32 maxdepth; // recursion depth limit 502 U32 maxdepth; // recursion depth limit
503 AV *shareable;
430} dec_t; 504} dec_t;
431 505
432#define ERR(reason) SB if (!dec->err) dec->err = reason; goto fail; SE 506#define ERR(reason) SB if (!dec->err) dec->err = reason; goto fail; SE
433 507
434#define WANT(len) if (expect_false (dec->cur + len > dec->end)) ERR ("unexpected end of CBOR data"); 508#define WANT(len) if (ecb_expect_false (dec->cur + len > dec->end)) ERR ("unexpected end of CBOR data")
435 509
436#define DEC_INC_DEPTH if (++dec->depth > dec->cbor.max_depth) ERR (ERR_NESTING_EXCEEDED) 510#define DEC_INC_DEPTH if (++dec->depth > dec->cbor.max_depth) ERR (ERR_NESTING_EXCEEDED)
437#define DEC_DEC_DEPTH --dec->depth 511#define DEC_DEC_DEPTH --dec->depth
438 512
439static UV 513static UV
528 SvREFCNT_dec (av); 602 SvREFCNT_dec (av);
529 DEC_DEC_DEPTH; 603 DEC_DEC_DEPTH;
530 return &PL_sv_undef; 604 return &PL_sv_undef;
531} 605}
532 606
607static void
608decode_he (dec_t *dec, HV *hv)
609{
610 // for speed reasons, we specialcase single-string
611 // byte or utf-8 strings as keys.
612
613 if (*dec->cur >= 0x40 && *dec->cur <= 0x40 + 27)
614 {
615 I32 len = decode_uint (dec);
616 char *key = (char *)dec->cur;
617
618 dec->cur += len;
619
620 hv_store (hv, key, len, decode_sv (dec), 0);
621 }
622 else if (*dec->cur >= 0x60 && *dec->cur <= 0x60 + 27)
623 {
624 I32 len = decode_uint (dec);
625 char *key = (char *)dec->cur;
626
627 dec->cur += len;
628
629 hv_store (hv, key, -len, decode_sv (dec), 0);
630 }
631 else
632 {
633 SV *k = decode_sv (dec);
634 SV *v = decode_sv (dec);
635
636 hv_store_ent (hv, k, v, 0);
637 SvREFCNT_dec (k);
638 }
639}
640
533static SV * 641static SV *
534decode_hv (dec_t *dec) 642decode_hv (dec_t *dec)
535{ 643{
536 HV *hv = newHV (); 644 HV *hv = newHV ();
537 645
549 { 657 {
550 ++dec->cur; 658 ++dec->cur;
551 break; 659 break;
552 } 660 }
553 661
554 SV *k = decode_sv (dec); 662 decode_he (dec, hv);
555 SV *v = decode_sv (dec);
556
557 hv_store_ent (hv, k, v, 0);
558 } 663 }
559 } 664 }
560 else 665 else
561 { 666 {
562 int len = decode_uint (dec); 667 int pairs = decode_uint (dec);
563 668
564 while (len--) 669 while (pairs--)
565 { 670 decode_he (dec, hv);
566 SV *k = decode_sv (dec);
567 SV *v = decode_sv (dec);
568
569 hv_store_ent (hv, k, v, 0);
570 }
571 } 671 }
572 672
573 DEC_DEC_DEPTH; 673 DEC_DEC_DEPTH;
574 return newRV_noinc ((SV *)hv); 674 return newRV_noinc ((SV *)hv);
575
576#if 0
577 SV *sv;
578 HV *hv = newHV ();
579
580 DEC_INC_DEPTH;
581 decode_ws (dec);
582
583 for (;;)
584 {
585 // heuristic: assume that
586 // a) decode_str + hv_store_ent are abysmally slow.
587 // b) most hash keys are short, simple ascii text.
588 // => try to "fast-match" such strings to avoid
589 // the overhead of decode_str + hv_store_ent.
590 {
591 SV *value;
592 char *p = dec->cur;
593 char *e = p + 24; // only try up to 24 bytes
594
595 for (;;)
596 {
597 // the >= 0x80 is false on most architectures
598 if (p == e || *p < 0x20 || *p >= 0x80 || *p == '\\')
599 {
600 // slow path, back up and use decode_str
601 SV *key = decode_str (dec);
602 if (!key)
603 goto fail;
604
605 decode_ws (dec); EXPECT_CH (':');
606
607 decode_ws (dec);
608 value = decode_sv (dec);
609 if (!value)
610 {
611 SvREFCNT_dec (key);
612 goto fail;
613 }
614
615 hv_store_ent (hv, key, value, 0);
616 SvREFCNT_dec (key);
617
618 break;
619 }
620 else if (*p == '"')
621 {
622 // fast path, got a simple key
623 char *key = dec->cur;
624 int len = p - key;
625 dec->cur = p + 1;
626
627 decode_ws (dec); EXPECT_CH (':');
628
629 decode_ws (dec);
630 value = decode_sv (dec);
631 if (!value)
632 goto fail;
633
634 hv_store (hv, key, len, value, 0);
635
636 break;
637 }
638
639 ++p;
640 }
641 }
642
643 decode_ws (dec);
644
645 if (*dec->cur == '}')
646 {
647 ++dec->cur;
648 break;
649 }
650
651 if (*dec->cur != ',')
652 ERR (", or } expected while parsing object/hash");
653
654 ++dec->cur;
655
656 decode_ws (dec);
657
658 if (*dec->cur == '}' && dec->cbor.flags & F_RELAXED)
659 {
660 ++dec->cur;
661 break;
662 }
663 }
664
665 DEC_DEC_DEPTH;
666 sv = newRV_noinc ((SV *)hv);
667
668 // check filter callbacks
669 if (dec->cbor.flags & F_HOOK)
670 {
671 if (dec->cbor.cb_sk_object && HvKEYS (hv) == 1)
672 {
673 HE *cb, *he;
674
675 hv_iterinit (hv);
676 he = hv_iternext (hv);
677 hv_iterinit (hv);
678
679 // the next line creates a mortal sv each time its called.
680 // might want to optimise this for common cases.
681 cb = hv_fetch_ent (dec->cbor.cb_sk_object, hv_iterkeysv (he), 0, 0);
682
683 if (cb)
684 {
685 dSP;
686 int count;
687
688 ENTER; SAVETMPS; PUSHMARK (SP);
689 XPUSHs (HeVAL (he));
690 sv_2mortal (sv);
691
692 PUTBACK; count = call_sv (HeVAL (cb), G_ARRAY); SPAGAIN;
693
694 if (count == 1)
695 {
696 sv = newSVsv (POPs);
697 FREETMPS; LEAVE;
698 return sv;
699 }
700
701 SvREFCNT_inc (sv);
702 FREETMPS; LEAVE;
703 }
704 }
705
706 if (dec->cbor.cb_object)
707 {
708 dSP;
709 int count;
710
711 ENTER; SAVETMPS; PUSHMARK (SP);
712 XPUSHs (sv_2mortal (sv));
713
714 PUTBACK; count = call_sv (dec->cbor.cb_object, G_ARRAY); SPAGAIN;
715
716 if (count == 1)
717 {
718 sv = newSVsv (POPs);
719 FREETMPS; LEAVE;
720 return sv;
721 }
722
723 SvREFCNT_inc (sv);
724 FREETMPS; LEAVE;
725 }
726 }
727
728 return sv;
729#endif
730 675
731fail: 676fail:
732 SvREFCNT_dec (hv); 677 SvREFCNT_dec (hv);
733 DEC_DEC_DEPTH; 678 DEC_DEC_DEPTH;
734 return &PL_sv_undef; 679 return &PL_sv_undef;
735} 680}
736 681
737static SV * 682static SV *
738decode_str (dec_t *dec, int utf8) 683decode_str (dec_t *dec, int utf8)
739{ 684{
740 SV *sv; 685 SV *sv = 0;
741 686
742 if ((*dec->cur & 31) == 31) 687 if ((*dec->cur & 31) == 31)
743 { 688 {
744 ++dec->cur; 689 ++dec->cur;
745 690
754 { 699 {
755 ++dec->cur; 700 ++dec->cur;
756 break; 701 break;
757 } 702 }
758 703
759 SV *sv2 = decode_sv (dec);
760 sv_catsv (sv, sv2); 704 sv_catsv (sv, decode_sv (dec));
761 } 705 }
762 } 706 }
763 else 707 else
764 { 708 {
765 STRLEN len = decode_uint (dec); 709 STRLEN len = decode_uint (dec);
773 SvUTF8_on (sv); 717 SvUTF8_on (sv);
774 718
775 return sv; 719 return sv;
776 720
777fail: 721fail:
722 SvREFCNT_dec (sv);
778 return &PL_sv_undef; 723 return &PL_sv_undef;
779} 724}
780 725
781static SV * 726static SV *
782decode_tagged (dec_t *dec) 727decode_tagged (dec_t *dec)
783{ 728{
729 SV *sv = 0;
784 UV tag = decode_uint (dec); 730 UV tag = decode_uint (dec);
731
732 WANT (1);
733
734 switch (tag)
735 {
736 case CBOR_TAG_MAGIC:
737 return decode_sv (dec);
738
739 case CBOR_TAG_INDIRECTION:
740 return newRV_noinc (decode_sv (dec));
741
742 case CBOR_TAG_VALUE_SHAREABLE:
743 {
744 if (ecb_expect_false (!dec->shareable))
745 dec->shareable = (AV *)sv_2mortal ((SV *)newAV ());
746
747 sv = newSV (0);
748 av_push (dec->shareable, SvREFCNT_inc_NN (sv));
749
785 SV *sv = decode_sv (dec); 750 SV *osv = decode_sv (dec);
751 sv_setsv (sv, osv);
752 SvREFCNT_dec_NN (osv);
753 }
786 754
787 if (tag == 55799) // 2.4.5 Self-Describe CBOR
788 return sv; 755 return sv;
789 756
757 case CBOR_TAG_VALUE_SHAREDREF:
758 {
759 if ((*dec->cur >> 5) != 0)
760 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)");
761
762 UV idx = decode_uint (dec);
763
764 if (!dec->shareable || idx > AvFILLp (dec->shareable))
765 ERR ("corrupted CBOR data (sharedref index out of bounds)");
766
767 return SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]);
768 }
769
770 case CBOR_TAG_PERL_OBJECT:
771 {
772 sv = decode_sv (dec);
773
774 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
775 ERR ("corrupted CBOR data (non-array perl object)");
776
777 AV *av = (AV *)SvRV (sv);
778 int len = av_len (av) + 1;
779 HV *stash = gv_stashsv (*av_fetch (av, 0, 1), 0);
780
781 if (!stash)
782 ERR ("cannot decode perl-object (package does not exist)");
783
784 GV *method = gv_fetchmethod_autoload (stash, "THAW", 0);
785
786 if (!method)
787 ERR ("cannot decode perl-object (package does not have a THAW method)");
788
789 dSP;
790
791 ENTER; SAVETMPS; PUSHMARK (SP);
792 EXTEND (SP, len + 1);
793 // we re-bless the reference to get overload and other niceties right
794 PUSHs (*av_fetch (av, 0, 1));
795 PUSHs (sv_cbor);
796
797 int i;
798
799 for (i = 1; i < len; ++i)
800 PUSHs (*av_fetch (av, i, 1));
801
802 PUTBACK;
803 call_sv ((SV *)GvCV (method), G_SCALAR | G_EVAL);
804 SPAGAIN;
805
806 if (SvTRUE (ERRSV))
807 {
808 FREETMPS; LEAVE;
809 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV))));
810 }
811
812 SvREFCNT_dec (sv);
813 sv = SvREFCNT_inc (POPs);
814
815 PUTBACK;
816
817 FREETMPS; LEAVE;
818
819 return sv;
820 }
821
822 default:
823 {
824 sv = decode_sv (dec);
825
790 AV *av = newAV (); 826 AV *av = newAV ();
791 av_push (av, newSVuv (tag)); 827 av_push (av, newSVuv (tag));
792 av_push (av, sv); 828 av_push (av, sv);
793 return newRV_noinc ((SV *)av); 829
830 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
831 ? cbor_tagged_stash
832 : gv_stashpv ("CBOR::XS::Tagged" , 1);
833
834 return sv_bless (newRV_noinc ((SV *)av), tagged_stash);
835 }
836 }
837
838fail:
839 SvREFCNT_dec (sv);
840 return &PL_sv_undef;
794} 841}
795 842
796static SV * 843static SV *
797decode_sv (dec_t *dec) 844decode_sv (dec_t *dec)
798{ 845{
799 WANT (1); 846 WANT (1);
800 847
801 switch (*dec->cur >> 5) 848 switch (*dec->cur >> 5)
802 { 849 {
803 case 0: // unsigned int 850 case 0: // unsigned int
804 //TODO: 64 bit values on 3 2bit perls
805 return newSVuv (decode_uint (dec)); 851 return newSVuv (decode_uint (dec));
806 case 1: // negative int 852 case 1: // negative int
807 return newSViv (-1 - (IV)decode_uint (dec)); 853 return newSViv (-1 - (IV)decode_uint (dec));
808 case 2: // octet string 854 case 2: // octet string
809 return decode_str (dec, 0); 855 return decode_str (dec, 0);
818 case 7: // misc 864 case 7: // misc
819 switch (*dec->cur++ & 31) 865 switch (*dec->cur++ & 31)
820 { 866 {
821 case 20: 867 case 20:
822#if CBOR_SLOW 868#if CBOR_SLOW
823 cbor_false = get_bool ("CBOR::XS::false"); 869 types_false = get_bool ("Types::Serialiser::false");
824#endif 870#endif
825 return newSVsv (cbor_false); 871 return newSVsv (types_false);
826 case 21: 872 case 21:
827#if CBOR_SLOW 873#if CBOR_SLOW
828 cbor_true = get_bool ("CBOR::XS::true"); 874 types_true = get_bool ("Types::Serialiser::true");
829#endif 875#endif
830 return newSVsv (cbor_true); 876 return newSVsv (types_true);
831 case 22: 877 case 22:
832 return newSVsv (&PL_sv_undef); 878 return newSVsv (&PL_sv_undef);
879 case 23:
880#if CBOR_SLOW
881 types_error = get_bool ("Types::Serialiser::error");
882#endif
883 return newSVsv (types_error);
833 884
834 case 25: 885 case 25:
835 { 886 {
836 WANT (2); 887 WANT (2);
837 888
873 ERR ("corrupted CBOR data (reserved/unassigned major 7 value)"); 924 ERR ("corrupted CBOR data (reserved/unassigned major 7 value)");
874 } 925 }
875 926
876 break; 927 break;
877 } 928 }
878#if 0
879 switch (*dec->cur)
880 {
881 //case '"': ++dec->cur; return decode_str (dec);
882 case '[': ++dec->cur; return decode_av (dec);
883 case '{': ++dec->cur; return decode_hv (dec);
884
885 case '-':
886 case '0': case '1': case '2': case '3': case '4':
887 case '5': case '6': case '7': case '8': case '9':
888 //TODO return decode_num (dec);
889
890 case 't':
891 if (dec->end - dec->cur >= 4 && !memcmp (dec->cur, "true", 4))
892 {
893 dec->cur += 4;
894#if CBOR_SLOW
895 cbor_true = get_bool ("CBOR::XS::true");
896#endif
897 return newSVsv (cbor_true);
898 }
899 else
900 ERR ("'true' expected");
901
902 break;
903
904 case 'f':
905 if (dec->end - dec->cur >= 5 && !memcmp (dec->cur, "false", 5))
906 {
907 dec->cur += 5;
908#if CBOR_SLOW
909 cbor_false = get_bool ("CBOR::XS::false");
910#endif
911 return newSVsv (cbor_false);
912 }
913 else
914 ERR ("'false' expected");
915
916 break;
917
918 case 'n':
919 if (dec->end - dec->cur >= 4 && !memcmp (dec->cur, "null", 4))
920 {
921 dec->cur += 4;
922 return newSVsv (&PL_sv_undef);
923 }
924 else
925 ERR ("'null' expected");
926
927 break;
928
929 default:
930 ERR ("malformed CBOR string, neither array, object, number, string or atom");
931 break;
932 }
933#endif
934 929
935fail: 930fail:
936 return &PL_sv_undef; 931 return &PL_sv_undef;
937} 932}
938 933
939static SV * 934static SV *
940decode_cbor (SV *string, CBOR *cbor, char **offset_return) 935decode_cbor (SV *string, CBOR *cbor, char **offset_return)
941{ 936{
942 dec_t dec; 937 dec_t dec = { };
943 SV *sv; 938 SV *sv;
939 STRLEN len;
940 char *data = SvPVbyte (string, len);
944 941
945 /* work around bugs in 5.10 where manipulating magic values
946 * makes perl ignore the magic in subsequent accesses.
947 * also make a copy of non-PV values, to get them into a clean
948 * state (SvPV should do that, but it's buggy, see below).
949 */
950 /*SvGETMAGIC (string);*/
951 if (SvMAGICAL (string) || !SvPOK (string))
952 string = sv_2mortal (newSVsv (string));
953
954 SvUPGRADE (string, SVt_PV);
955
956 /* work around a bug in perl 5.10, which causes SvCUR to fail an
957 * assertion with -DDEBUGGING, although SvCUR is documented to
958 * return the xpv_cur field which certainly exists after upgrading.
959 * according to nicholas clark, calling SvPOK fixes this.
960 * But it doesn't fix it, so try another workaround, call SvPV_nolen
961 * and hope for the best.
962 * Damnit, SvPV_nolen still trips over yet another assertion. This
963 * assertion business is seriously broken, try yet another workaround
964 * for the broken -DDEBUGGING.
965 */
966 {
967#ifdef DEBUGGING
968 STRLEN offset = SvOK (string) ? sv_len (string) : 0;
969#else
970 STRLEN offset = SvCUR (string);
971#endif
972
973 if (offset > cbor->max_size && cbor->max_size) 942 if (len > cbor->max_size && cbor->max_size)
974 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu", 943 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
975 (unsigned long)SvCUR (string), (unsigned long)cbor->max_size); 944 (unsigned long)len, (unsigned long)cbor->max_size);
976 }
977
978 sv_utf8_downgrade (string, 0);
979 945
980 dec.cbor = *cbor; 946 dec.cbor = *cbor;
981 dec.cur = (U8 *)SvPVX (string); 947 dec.cur = (U8 *)data;
982 dec.end = (U8 *)SvEND (string); 948 dec.end = (U8 *)data + len;
983 dec.err = 0;
984 dec.depth = 0;
985
986 if (dec.cbor.cb_object || dec.cbor.cb_sk_object)
987 ;//TODO dec.cbor.flags |= F_HOOK;
988 949
989 sv = decode_sv (&dec); 950 sv = decode_sv (&dec);
990 951
991 if (offset_return) 952 if (offset_return)
992 *offset_return = dec.cur; 953 *offset_return = dec.cur;
996 dec.err = "garbage after CBOR object"; 957 dec.err = "garbage after CBOR object";
997 958
998 if (dec.err) 959 if (dec.err)
999 { 960 {
1000 SvREFCNT_dec (sv); 961 SvREFCNT_dec (sv);
1001 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)SvPVX (string), (int)(uint8_t)*dec.cur); 962 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur);
1002 } 963 }
1003 964
1004 sv = sv_2mortal (sv); 965 sv = sv_2mortal (sv);
1005 966
1006 return sv; 967 return sv;
1012MODULE = CBOR::XS PACKAGE = CBOR::XS 973MODULE = CBOR::XS PACKAGE = CBOR::XS
1013 974
1014BOOT: 975BOOT:
1015{ 976{
1016 cbor_stash = gv_stashpv ("CBOR::XS" , 1); 977 cbor_stash = gv_stashpv ("CBOR::XS" , 1);
1017 cbor_boolean_stash = gv_stashpv ("CBOR::XS::Boolean", 1); 978 cbor_tagged_stash = gv_stashpv ("CBOR::XS::Tagged" , 1);
1018 979
1019 cbor_true = get_bool ("CBOR::XS::true"); 980 types_boolean_stash = gv_stashpv ("Types::Serialiser::Boolean", 1);
1020 cbor_false = get_bool ("CBOR::XS::false"); 981 types_error_stash = gv_stashpv ("Types::Serialiser::Error" , 1);
982
983 types_true = get_bool ("Types::Serialiser::true" );
984 types_false = get_bool ("Types::Serialiser::false");
985 types_error = get_bool ("Types::Serialiser::error");
986
987 sv_cbor = newSVpv ("CBOR", 0);
988 SvREADONLY_on (sv_cbor);
1021} 989}
1022 990
1023PROTOTYPES: DISABLE 991PROTOTYPES: DISABLE
1024 992
1025void CLONE (...) 993void CLONE (...)
1026 CODE: 994 CODE:
1027 cbor_stash = 0; 995 cbor_stash = 0;
996 cbor_tagged_stash = 0;
997 types_error_stash = 0;
1028 cbor_boolean_stash = 0; 998 types_boolean_stash = 0;
1029 999
1030void new (char *klass) 1000void new (char *klass)
1031 PPCODE: 1001 PPCODE:
1032{ 1002{
1033 SV *pv = NEWSV (0, sizeof (CBOR)); 1003 SV *pv = NEWSV (0, sizeof (CBOR));
1041 1011
1042void shrink (CBOR *self, int enable = 1) 1012void shrink (CBOR *self, int enable = 1)
1043 ALIAS: 1013 ALIAS:
1044 shrink = F_SHRINK 1014 shrink = F_SHRINK
1045 allow_unknown = F_ALLOW_UNKNOWN 1015 allow_unknown = F_ALLOW_UNKNOWN
1016 allow_sharing = F_ALLOW_SHARING
1017 dedup_keys = F_DEDUP_KEYS
1018 dedup_strings = F_DEDUP_STRINGS
1046 PPCODE: 1019 PPCODE:
1047{ 1020{
1048 if (enable) 1021 if (enable)
1049 self->flags |= ix; 1022 self->flags |= ix;
1050 else 1023 else
1055 1028
1056void get_shrink (CBOR *self) 1029void get_shrink (CBOR *self)
1057 ALIAS: 1030 ALIAS:
1058 get_shrink = F_SHRINK 1031 get_shrink = F_SHRINK
1059 get_allow_unknown = F_ALLOW_UNKNOWN 1032 get_allow_unknown = F_ALLOW_UNKNOWN
1033 get_allow_sharing = F_ALLOW_SHARING
1034 get_dedup_keys = F_DEDUP_KEYS
1035 get_dedup_strings = F_DEDUP_STRINGS
1060 PPCODE: 1036 PPCODE:
1061 XPUSHs (boolSV (self->flags & ix)); 1037 XPUSHs (boolSV (self->flags & ix));
1062 1038
1063void max_depth (CBOR *self, U32 max_depth = 0x80000000UL) 1039void max_depth (CBOR *self, U32 max_depth = 0x80000000UL)
1064 PPCODE: 1040 PPCODE:
1079int get_max_size (CBOR *self) 1055int get_max_size (CBOR *self)
1080 CODE: 1056 CODE:
1081 RETVAL = self->max_size; 1057 RETVAL = self->max_size;
1082 OUTPUT: 1058 OUTPUT:
1083 RETVAL 1059 RETVAL
1084
1085#if 0 //TODO
1086
1087void filter_cbor_object (CBOR *self, SV *cb = &PL_sv_undef)
1088 PPCODE:
1089{
1090 SvREFCNT_dec (self->cb_object);
1091 self->cb_object = SvOK (cb) ? newSVsv (cb) : 0;
1092
1093 XPUSHs (ST (0));
1094}
1095
1096void filter_cbor_single_key_object (CBOR *self, SV *key, SV *cb = &PL_sv_undef)
1097 PPCODE:
1098{
1099 if (!self->cb_sk_object)
1100 self->cb_sk_object = newHV ();
1101
1102 if (SvOK (cb))
1103 hv_store_ent (self->cb_sk_object, key, newSVsv (cb), 0);
1104 else
1105 {
1106 hv_delete_ent (self->cb_sk_object, key, G_DISCARD, 0);
1107
1108 if (!HvKEYS (self->cb_sk_object))
1109 {
1110 SvREFCNT_dec (self->cb_sk_object);
1111 self->cb_sk_object = 0;
1112 }
1113 }
1114
1115 XPUSHs (ST (0));
1116}
1117
1118#endif
1119 1060
1120void encode (CBOR *self, SV *scalar) 1061void encode (CBOR *self, SV *scalar)
1121 PPCODE: 1062 PPCODE:
1122 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN; 1063 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN;
1123 XPUSHs (scalar); 1064 XPUSHs (scalar);
1136 EXTEND (SP, 2); 1077 EXTEND (SP, 2);
1137 PUSHs (sv); 1078 PUSHs (sv);
1138 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr)))); 1079 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr))));
1139} 1080}
1140 1081
1141void DESTROY (CBOR *self)
1142 CODE:
1143 SvREFCNT_dec (self->cb_sk_object);
1144 SvREFCNT_dec (self->cb_object);
1145
1146PROTOTYPES: ENABLE 1082PROTOTYPES: ENABLE
1147 1083
1148void encode_cbor (SV *scalar) 1084void encode_cbor (SV *scalar)
1149 PPCODE: 1085 PPCODE:
1150{ 1086{

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines