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.27 by root, Fri Nov 22 15:28:38 2013 UTC vs.
Revision 1.60 by root, Sat Nov 26 00:47:02 2016 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines