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.10 by root, Sun Oct 27 20:40:25 2013 UTC vs.
Revision 1.56 by root, Fri Nov 25 11:33:03 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"
14
15// compatibility with perl <5.18
16#ifndef HvNAMELEN_get
17# define HvNAMELEN_get(hv) strlen (HvNAME (hv))
18#endif
19#ifndef HvNAMELEN
20# define HvNAMELEN(hv) HvNAMELEN_get (hv)
21#endif
22#ifndef HvNAMEUTF8
23# define HvNAMEUTF8(hv) 0
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};
13 65
14// known tags 66// known tags
15enum cbor_tag 67enum cbor_tag
16{ 68{
17 // inofficial extensions (pending iana registration) 69 // extensions
18 CBOR_TAG_PERL_OBJECT = 256, 70 CBOR_TAG_STRINGREF = 25, // http://cbor.schmorp.de/stringref
19 CBOR_TAG_GENERIC_OBJECT = 257, 71 CBOR_TAG_PERL_OBJECT = 26, // http://cbor.schmorp.de/perl-object
72 CBOR_TAG_GENERIC_OBJECT = 27, // http://cbor.schmorp.de/generic-object
73 CBOR_TAG_VALUE_SHAREABLE = 28, // http://cbor.schmorp.de/value-sharing
74 CBOR_TAG_VALUE_SHAREDREF = 29, // http://cbor.schmorp.de/value-sharing
75 CBOR_TAG_STRINGREF_NAMESPACE = 256, // http://cbor.schmorp.de/stringref
76 CBOR_TAG_INDIRECTION = 22098, // http://cbor.schmorp.de/indirection
20 77
21 // rfc7049 78 // rfc7049
22 CBOR_TAG_DATETIME = 0, // rfc4287, utf-8 79 CBOR_TAG_DATETIME = 0, // rfc4287, utf-8
23 CBOR_TAG_TIMESTAMP = 1, // unix timestamp, any 80 CBOR_TAG_TIMESTAMP = 1, // unix timestamp, any
24 CBOR_TAG_POS_BIGNUM = 2, // byte string 81 CBOR_TAG_POS_BIGNUM = 2, // byte string
25 CBOR_TAG_NEG_BIGNUM = 3, // byte string 82 CBOR_TAG_NEG_BIGNUM = 3, // byte string
26 CBOR_TAG_DECIMAL = 4, // decimal fraction, array 83 CBOR_TAG_DECIMAL = 4, // decimal fraction, array
27 CBOR_TAG_BIGFLOAT = 5, // array 84 CBOR_TAG_BIGFLOAT = 5, // array
28 85
29 CBOR_TAG_CONV_B64U = 21, // base64url, any 86 CBOR_TAG_CONV_B64U = 21, // base64url, any
30 CBOR_TAG_CONV_B64 = 22, // base64, any 87 CBOR_TAG_CONV_B64 = 22, // base64, any
31 CBOR_TAG_CONV_HEX = 23, // base16, any 88 CBOR_TAG_CONV_HEX = 23, // base16, any
32 CBOR_TAG_CBOR = 24, // embedded cbor, byte string 89 CBOR_TAG_CBOR = 24, // embedded cbor, byte string
33 90
34 CBOR_TAG_URI = 32, // URI rfc3986, utf-8 91 CBOR_TAG_URI = 32, // URI rfc3986, utf-8
35 CBOR_TAG_B64U = 33, // base64url rfc4648, utf-8 92 CBOR_TAG_B64U = 33, // base64url rfc4648, utf-8
36 CBOR_TAG_B64 = 34, // base6 rfc46484, utf-8 93 CBOR_TAG_B64 = 34, // base6 rfc46484, utf-8
37 CBOR_TAG_REGEX = 35, // regex pcre/ecma262, utf-8 94 CBOR_TAG_REGEX = 35, // regex pcre/ecma262, utf-8
38 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8 95 CBOR_TAG_MIME = 36, // mime message rfc2045, utf-8
39 96
40 CBOR_TAG_MAGIC = 55799 // self-describe cbor 97 CBOR_TAG_MAGIC = 55799, // self-describe cbor
41}; 98};
42 99
43#define F_SHRINK 0x00000200UL 100#define F_SHRINK 0x00000001UL
44#define F_ALLOW_UNKNOWN 0x00002000UL 101#define F_ALLOW_UNKNOWN 0x00000002UL
102#define F_ALLOW_SHARING 0x00000004UL
103#define F_ALLOW_CYCLES 0x00000008UL
104#define F_PACK_STRINGS 0x00000010UL
105#define F_TEXT_KEYS 0x00000020UL
106#define F_TEXT_STRINGS 0x00000040UL
107#define F_VALIDATE_UTF8 0x00000080UL
45 108
46#define INIT_SIZE 32 // initial scalar size to be allocated 109#define INIT_SIZE 32 // initial scalar size to be allocated
47 110
48#define SB do { 111#define SB do {
49#define SE } while (0) 112#define SE } while (0)
61# define CBOR_SLOW 0 124# define CBOR_SLOW 0
62# define CBOR_STASH cbor_stash 125# define CBOR_STASH cbor_stash
63#endif 126#endif
64 127
65static HV *cbor_stash, *types_boolean_stash, *types_error_stash, *cbor_tagged_stash; // CBOR::XS:: 128static HV *cbor_stash, *types_boolean_stash, *types_error_stash, *cbor_tagged_stash; // CBOR::XS::
66static SV *types_true, *types_false, *types_error; 129static SV *types_true, *types_false, *types_error, *sv_cbor, *default_filter;
67 130
68typedef struct { 131typedef struct {
69 U32 flags; 132 U32 flags;
70 U32 max_depth; 133 U32 max_depth;
71 STRLEN max_size; 134 STRLEN max_size;
135 SV *filter;
136
137 // for the incremental parser
138 STRLEN incr_pos; // the current offset into the text
139 STRLEN incr_need; // minimum bytes needed to decode
140 AV *incr_count; // for every nesting level, the number of outstanding values, or -1 for indef.
72} CBOR; 141} CBOR;
73 142
74ecb_inline void 143ecb_inline void
75cbor_init (CBOR *cbor) 144cbor_init (CBOR *cbor)
76{ 145{
77 Zero (cbor, 1, CBOR); 146 Zero (cbor, 1, CBOR);
78 cbor->max_depth = 512; 147 cbor->max_depth = 512;
148}
149
150ecb_inline void
151cbor_free (CBOR *cbor)
152{
153 SvREFCNT_dec (cbor->filter);
154 SvREFCNT_dec (cbor->incr_count);
79} 155}
80 156
81///////////////////////////////////////////////////////////////////////////// 157/////////////////////////////////////////////////////////////////////////////
82// utility functions 158// utility functions
83 159
105 SvPV_renew (sv, SvCUR (sv) + 1); 181 SvPV_renew (sv, SvCUR (sv) + 1);
106#endif 182#endif
107 } 183 }
108} 184}
109 185
110///////////////////////////////////////////////////////////////////////////// 186// minimum length of a string to be registered for stringref
111// fp hell 187ecb_inline int
112 188minimum_string_length (UV idx)
113//TODO 189{
190 return idx > 23
191 ? idx > 0xffU
192 ? idx > 0xffffU
193 ? idx > 0xffffffffU
194 ? 11
195 : 7
196 : 5
197 : 4
198 : 3;
199}
114 200
115///////////////////////////////////////////////////////////////////////////// 201/////////////////////////////////////////////////////////////////////////////
116// encoder 202// encoder
117 203
118// structure used for encoding CBOR 204// structure used for encoding CBOR
121 char *cur; // SvPVX (sv) + current output position 207 char *cur; // SvPVX (sv) + current output position
122 char *end; // SvEND (sv) 208 char *end; // SvEND (sv)
123 SV *sv; // result scalar 209 SV *sv; // result scalar
124 CBOR cbor; 210 CBOR cbor;
125 U32 depth; // recursion level 211 U32 depth; // recursion level
212 HV *stringref[2]; // string => index, or 0 ([0] = bytes, [1] = utf-8)
213 UV stringref_idx;
214 HV *shareable; // ptr => index, or 0
215 UV shareable_idx;
126} enc_t; 216} enc_t;
127 217
128ecb_inline void 218ecb_inline void
129need (enc_t *enc, STRLEN len) 219need (enc_t *enc, STRLEN len)
130{ 220{
147static void 237static void
148encode_uint (enc_t *enc, int major, UV len) 238encode_uint (enc_t *enc, int major, UV len)
149{ 239{
150 need (enc, 9); 240 need (enc, 9);
151 241
152 if (len < 24) 242 if (ecb_expect_true (len < LENGTH_EXT1))
153 *enc->cur++ = major | len; 243 *enc->cur++ = major | len;
154 else if (len <= 0xff) 244 else if (ecb_expect_true (len <= 0xffU))
155 { 245 {
156 *enc->cur++ = major | 24; 246 *enc->cur++ = major | LENGTH_EXT1;
157 *enc->cur++ = len; 247 *enc->cur++ = len;
158 } 248 }
159 else if (len <= 0xffff) 249 else if (len <= 0xffffU)
160 { 250 {
161 *enc->cur++ = major | 25; 251 *enc->cur++ = major | LENGTH_EXT2;
162 *enc->cur++ = len >> 8; 252 *enc->cur++ = len >> 8;
163 *enc->cur++ = len; 253 *enc->cur++ = len;
164 } 254 }
165 else if (len <= 0xffffffff) 255 else if (len <= 0xffffffffU)
166 { 256 {
167 *enc->cur++ = major | 26; 257 *enc->cur++ = major | LENGTH_EXT4;
168 *enc->cur++ = len >> 24; 258 *enc->cur++ = len >> 24;
169 *enc->cur++ = len >> 16; 259 *enc->cur++ = len >> 16;
170 *enc->cur++ = len >> 8; 260 *enc->cur++ = len >> 8;
171 *enc->cur++ = len; 261 *enc->cur++ = len;
172 } 262 }
173 else 263 else
174 { 264 {
175 *enc->cur++ = major | 27; 265 *enc->cur++ = major | LENGTH_EXT8;
176 *enc->cur++ = len >> 56; 266 *enc->cur++ = len >> 56;
177 *enc->cur++ = len >> 48; 267 *enc->cur++ = len >> 48;
178 *enc->cur++ = len >> 40; 268 *enc->cur++ = len >> 40;
179 *enc->cur++ = len >> 32; 269 *enc->cur++ = len >> 32;
180 *enc->cur++ = len >> 24; 270 *enc->cur++ = len >> 24;
182 *enc->cur++ = len >> 8; 272 *enc->cur++ = len >> 8;
183 *enc->cur++ = len; 273 *enc->cur++ = len;
184 } 274 }
185} 275}
186 276
187static void 277ecb_inline void
278encode_tag (enc_t *enc, UV tag)
279{
280 encode_uint (enc, MAJOR_TAG, tag);
281}
282
283// exceptional (hopefully) slow path for byte strings that need to be utf8-encoded
284ecb_noinline static void
188encode_str (enc_t *enc, int utf8, char *str, STRLEN len) 285encode_str_utf8 (enc_t *enc, int utf8, char *str, STRLEN len)
189{ 286{
190 encode_uint (enc, utf8 ? 0x60 : 0x40, len); 287 STRLEN ulen = len;
288 U8 *p, *pend = (U8 *)str + len;
289
290 for (p = (U8 *)str; p < pend; ++p)
291 ulen += *p >> 7; // count set high bits
292
293 encode_uint (enc, MAJOR_TEXT, ulen);
294
295 need (enc, ulen);
296 for (p = (U8 *)str; p < pend; ++p)
297 if (*p < 0x80)
298 *enc->cur++ = *p;
299 else
300 {
301 *enc->cur++ = 0xc0 + (*p >> 6);
302 *enc->cur++ = 0x80 + (*p & 63);
303 }
304}
305
306ecb_inline void
307encode_str (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
308{
309 if (ecb_expect_false (upgrade_utf8))
310 if (!utf8)
311 {
312 encode_str_utf8 (enc, utf8, str, len);
313 return;
314 }
315
316 encode_uint (enc, utf8 ? MAJOR_TEXT : MAJOR_BYTES, len);
191 need (enc, len); 317 need (enc, len);
192 memcpy (enc->cur, str, len); 318 memcpy (enc->cur, str, len);
193 enc->cur += len; 319 enc->cur += len;
194} 320}
195 321
322ecb_inline void
323encode_strref (enc_t *enc, int upgrade_utf8, int utf8, char *str, STRLEN len)
324{
325 if (ecb_expect_false (enc->cbor.flags & F_PACK_STRINGS))
326 {
327 SV **svp = hv_fetch (enc->stringref[!!utf8], str, len, 1);
328
329 if (SvOK (*svp))
330 {
331 // already registered, use stringref
332 encode_tag (enc, CBOR_TAG_STRINGREF);
333 encode_uint (enc, MAJOR_POS_INT, SvUV (*svp));
334 return;
335 }
336 else if (len >= minimum_string_length (enc->stringref_idx))
337 {
338 // register only
339 sv_setuv (*svp, enc->stringref_idx);
340 ++enc->stringref_idx;
341 }
342 }
343
344 encode_str (enc, upgrade_utf8, utf8, str, len);
345}
346
196static void encode_sv (enc_t *enc, SV *sv); 347static void encode_sv (enc_t *enc, SV *sv);
197 348
198static void 349static void
199encode_av (enc_t *enc, AV *av) 350encode_av (enc_t *enc, AV *av)
200{ 351{
203 if (enc->depth >= enc->cbor.max_depth) 354 if (enc->depth >= enc->cbor.max_depth)
204 croak (ERR_NESTING_EXCEEDED); 355 croak (ERR_NESTING_EXCEEDED);
205 356
206 ++enc->depth; 357 ++enc->depth;
207 358
208 encode_uint (enc, 0x80, len + 1); 359 encode_uint (enc, MAJOR_ARRAY, len + 1);
209 360
361 if (SvMAGICAL (av))
210 for (i = 0; i <= len; ++i) 362 for (i = 0; i <= len; ++i)
211 { 363 {
212 SV **svp = av_fetch (av, i, 0); 364 SV **svp = av_fetch (av, i, 0);
213 encode_sv (enc, svp ? *svp : &PL_sv_undef); 365 encode_sv (enc, svp ? *svp : &PL_sv_undef);
214 } 366 }
367 else
368 for (i = 0; i <= len; ++i)
369 {
370 SV *sv = AvARRAY (av)[i];
371 encode_sv (enc, sv ? sv : &PL_sv_undef);
372 }
215 373
216 --enc->depth; 374 --enc->depth;
217} 375}
218 376
219static void 377static void
228 386
229 int pairs = hv_iterinit (hv); 387 int pairs = hv_iterinit (hv);
230 int mg = SvMAGICAL (hv); 388 int mg = SvMAGICAL (hv);
231 389
232 if (mg) 390 if (mg)
233 encode_ch (enc, 0xa0 | 31); 391 encode_ch (enc, MAJOR_MAP | MINOR_INDEF);
234 else 392 else
235 encode_uint (enc, 0xa0, pairs); 393 encode_uint (enc, MAJOR_MAP, pairs);
236 394
237 while ((he = hv_iternext (hv))) 395 while ((he = hv_iternext (hv)))
238 { 396 {
239 if (HeKLEN (he) == HEf_SVKEY) 397 if (HeKLEN (he) == HEf_SVKEY)
240 encode_sv (enc, HeSVKEY (he)); 398 encode_sv (enc, HeSVKEY (he));
241 else 399 else
242 encode_str (enc, HeKUTF8 (he), HeKEY (he), HeKLEN (he)); 400 encode_strref (enc, enc->cbor.flags & (F_TEXT_KEYS | F_TEXT_STRINGS), HeKUTF8 (he), HeKEY (he), HeKLEN (he));
243 401
244 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he)); 402 encode_sv (enc, ecb_expect_false (mg) ? hv_iterval (hv, he) : HeVAL (he));
245 } 403 }
246 404
247 if (mg) 405 if (mg)
248 encode_ch (enc, 0xe0 | 31); 406 encode_ch (enc, MAJOR_MISC | MINOR_INDEF);
249 407
250 --enc->depth; 408 --enc->depth;
251} 409}
252 410
253// encode objects, arrays and special \0=false and \1=true values. 411// encode objects, arrays and special \0=false and \1=true values.
254static void 412static void
255encode_rv (enc_t *enc, SV *sv) 413encode_rv (enc_t *enc, SV *sv)
256{ 414{
257 svtype svt;
258
259 SvGETMAGIC (sv); 415 SvGETMAGIC (sv);
416
260 svt = SvTYPE (sv); 417 svtype svt = SvTYPE (sv);
261 418
262 if (ecb_expect_false (SvOBJECT (sv))) 419 if (ecb_expect_false (SvOBJECT (sv)))
263 { 420 {
264 HV *boolean_stash = !CBOR_SLOW || types_boolean_stash 421 HV *boolean_stash = !CBOR_SLOW || types_boolean_stash
265 ? types_boolean_stash 422 ? types_boolean_stash
269 : gv_stashpv ("Types::Serialiser::Error", 1); 426 : gv_stashpv ("Types::Serialiser::Error", 1);
270 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 427 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
271 ? cbor_tagged_stash 428 ? cbor_tagged_stash
272 : gv_stashpv ("CBOR::XS::Tagged" , 1); 429 : gv_stashpv ("CBOR::XS::Tagged" , 1);
273 430
431 HV *stash = SvSTASH (sv);
432
274 if (SvSTASH (sv) == boolean_stash) 433 if (stash == boolean_stash)
275 encode_ch (enc, SvIV (sv) ? 0xe0 | 21 : 0xe0 | 20); 434 {
435 encode_ch (enc, SvIV (sv) ? MAJOR_MISC | SIMPLE_TRUE : MAJOR_MISC | SIMPLE_FALSE);
436 return;
437 }
276 else if (SvSTASH (sv) == error_stash) 438 else if (stash == error_stash)
277 encode_ch (enc, 0xe0 | 23); 439 {
440 encode_ch (enc, MAJOR_MISC | SIMPLE_UNDEF);
441 return;
442 }
278 else if (SvSTASH (sv) == tagged_stash) 443 else if (stash == tagged_stash)
279 { 444 {
280 if (svt != SVt_PVAV) 445 if (svt != SVt_PVAV)
281 croak ("encountered CBOR::XS::Tagged object that isn't an array"); 446 croak ("encountered CBOR::XS::Tagged object that isn't an array");
282 447
283 encode_uint (enc, 0xc0, SvUV (*av_fetch ((AV *)sv, 0, 1))); 448 encode_uint (enc, MAJOR_TAG, SvUV (*av_fetch ((AV *)sv, 0, 1)));
284 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1)); 449 encode_sv (enc, *av_fetch ((AV *)sv, 1, 1));
450
451 return;
452 }
453 }
454
455 if (ecb_expect_false (SvREFCNT (sv) > 1)
456 && ecb_expect_false (enc->cbor.flags & F_ALLOW_SHARING))
457 {
458 if (!enc->shareable)
459 enc->shareable = (HV *)sv_2mortal ((SV *)newHV ());
460
461 SV **svp = hv_fetch (enc->shareable, (char *)&sv, sizeof (sv), 1);
462
463 if (SvOK (*svp))
464 {
465 encode_tag (enc, CBOR_TAG_VALUE_SHAREDREF);
466 encode_uint (enc, MAJOR_POS_INT, SvUV (*svp));
467 return;
285 } 468 }
286 else 469 else
287 { 470 {
471 sv_setuv (*svp, enc->shareable_idx);
472 ++enc->shareable_idx;
473 encode_tag (enc, CBOR_TAG_VALUE_SHAREABLE);
474 }
475 }
476
477 if (ecb_expect_false (SvOBJECT (sv)))
478 {
479 HV *stash = SvSTASH (sv);
480 GV *method;
481
482 if ((method = gv_fetchmethod_autoload (stash, "TO_CBOR", 0)))
483 {
484 dSP;
485
486 ENTER; SAVETMPS;
487 PUSHMARK (SP);
288 // we re-bless the reference to get overload and other niceties right 488 // we re-bless the reference to get overload and other niceties right
289 GV *to_cbor = gv_fetchmethod_autoload (SvSTASH (sv), "TO_CBOR", 0);
290
291 if (to_cbor)
292 {
293 dSP;
294
295 ENTER; SAVETMPS; PUSHMARK (SP);
296 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), SvSTASH (sv))); 489 XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
297 490
298 // calling with G_SCALAR ensures that we always get a 1 return value
299 PUTBACK; 491 PUTBACK;
492 // G_SCALAR ensures that return value is 1
300 call_sv ((SV *)GvCV (to_cbor), G_SCALAR); 493 call_sv ((SV *)GvCV (method), G_SCALAR);
301 SPAGAIN; 494 SPAGAIN;
302 495
303 // catch this surprisingly common error 496 // catch this surprisingly common error
304 if (SvROK (TOPs) && SvRV (TOPs) == sv) 497 if (SvROK (TOPs) && SvRV (TOPs) == sv)
305 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (SvSTASH (sv))); 498 croak ("%s::TO_CBOR method returned same object as was passed instead of a new one", HvNAME (stash));
306 499
307 sv = POPs; 500 encode_sv (enc, POPs);
501
308 PUTBACK; 502 PUTBACK;
309 503
310 encode_sv (enc, sv);
311
312 FREETMPS; LEAVE; 504 FREETMPS; LEAVE;
313 } 505 }
506 else if ((method = gv_fetchmethod_autoload (stash, "FREEZE", 0)) != 0)
507 {
508 dSP;
509
510 ENTER; SAVETMPS;
511 SAVESTACK_POS ();
512 PUSHMARK (SP);
513 EXTEND (SP, 2);
514 // we re-bless the reference to get overload and other niceties right
515 PUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), stash));
516 PUSHs (sv_cbor);
517
518 PUTBACK;
519 int count = call_sv ((SV *)GvCV (method), G_ARRAY);
520 SPAGAIN;
521
522 // catch this surprisingly common error
523 if (count == 1 && SvROK (TOPs) && SvRV (TOPs) == sv)
524 croak ("%s::FREEZE(CBOR) method returned same object as was passed instead of a new one", HvNAME (stash));
525
526 encode_tag (enc, CBOR_TAG_PERL_OBJECT);
527 encode_uint (enc, MAJOR_ARRAY, count + 1);
528 encode_strref (enc, 0, HvNAMEUTF8 (stash), HvNAME (stash), HvNAMELEN (stash));
529
530 while (count)
531 encode_sv (enc, SP[1 - count--]);
532
533 PUTBACK;
534
535 FREETMPS; LEAVE;
536 }
314 else 537 else
315 croak ("encountered object '%s', but no TO_CBOR method available on it", 538 croak ("encountered object '%s', but no TO_CBOR or FREEZE methods available on it",
316 SvPV_nolen (sv_2mortal (newRV_inc (sv)))); 539 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
317 }
318 } 540 }
319 else if (svt == SVt_PVHV) 541 else if (svt == SVt_PVHV)
320 encode_hv (enc, (HV *)sv); 542 encode_hv (enc, (HV *)sv);
321 else if (svt == SVt_PVAV) 543 else if (svt == SVt_PVAV)
322 encode_av (enc, (AV *)sv); 544 encode_av (enc, (AV *)sv);
323 else if (svt < SVt_PVAV)
324 {
325 STRLEN len = 0;
326 char *pv = svt ? SvPV (sv, len) : 0;
327
328 if (len == 1 && *pv == '1')
329 encode_ch (enc, 0xe0 | 21);
330 else if (len == 1 && *pv == '0')
331 encode_ch (enc, 0xe0 | 20);
332 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
333 encode_ch (enc, 0xe0 | 23);
334 else
335 croak ("cannot encode reference to scalar '%s' unless the scalar is 0 or 1",
336 SvPV_nolen (sv_2mortal (newRV_inc (sv))));
337 }
338 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
339 encode_ch (enc, 0xe0 | 23);
340 else 545 else
341 croak ("encountered %s, but CBOR can only represent references to arrays or hashes", 546 {
342 SvPV_nolen (sv_2mortal (newRV_inc (sv)))); 547 encode_tag (enc, CBOR_TAG_INDIRECTION);
548 encode_sv (enc, sv);
549 }
343} 550}
344 551
345static void 552static void
346encode_nv (enc_t *enc, SV *sv) 553encode_nv (enc_t *enc, SV *sv)
347{ 554{
348 double nv = SvNVX (sv); 555 double nv = SvNVX (sv);
349 556
350 need (enc, 9); 557 need (enc, 9);
351 558
352 if (ecb_expect_false (nv == (U32)nv)) 559 if (ecb_expect_false (nv == (NV)(U32)nv))
353 encode_uint (enc, 0x00, (U32)nv); 560 encode_uint (enc, MAJOR_POS_INT, (U32)nv);
354 //TODO: maybe I32? 561 //TODO: maybe I32?
355 else if (ecb_expect_false (nv == (float)nv)) 562 else if (ecb_expect_false (nv == (float)nv))
356 { 563 {
357 uint32_t fp = ecb_float_to_binary32 (nv); 564 uint32_t fp = ecb_float_to_binary32 (nv);
358 565
359 *enc->cur++ = 0xe0 | 26; 566 *enc->cur++ = MAJOR_MISC | MISC_FLOAT32;
360 567
361 if (!ecb_big_endian ()) 568 if (!ecb_big_endian ())
362 fp = ecb_bswap32 (fp); 569 fp = ecb_bswap32 (fp);
363 570
364 memcpy (enc->cur, &fp, 4); 571 memcpy (enc->cur, &fp, 4);
366 } 573 }
367 else 574 else
368 { 575 {
369 uint64_t fp = ecb_double_to_binary64 (nv); 576 uint64_t fp = ecb_double_to_binary64 (nv);
370 577
371 *enc->cur++ = 0xe0 | 27; 578 *enc->cur++ = MAJOR_MISC | MISC_FLOAT64;
372 579
373 if (!ecb_big_endian ()) 580 if (!ecb_big_endian ())
374 fp = ecb_bswap64 (fp); 581 fp = ecb_bswap64 (fp);
375 582
376 memcpy (enc->cur, &fp, 8); 583 memcpy (enc->cur, &fp, 8);
385 592
386 if (SvPOKp (sv)) 593 if (SvPOKp (sv))
387 { 594 {
388 STRLEN len; 595 STRLEN len;
389 char *str = SvPV (sv, len); 596 char *str = SvPV (sv, len);
390 encode_str (enc, SvUTF8 (sv), str, len); 597 encode_strref (enc, enc->cbor.flags & F_TEXT_STRINGS, SvUTF8 (sv), str, len);
391 } 598 }
392 else if (SvNOKp (sv)) 599 else if (SvNOKp (sv))
393 encode_nv (enc, sv); 600 encode_nv (enc, sv);
394 else if (SvIOKp (sv)) 601 else if (SvIOKp (sv))
395 { 602 {
396 if (SvIsUV (sv)) 603 if (SvIsUV (sv))
397 encode_uint (enc, 0x00, SvUVX (sv)); 604 encode_uint (enc, MAJOR_POS_INT, SvUVX (sv));
398 else if (SvIVX (sv) >= 0) 605 else if (SvIVX (sv) >= 0)
399 encode_uint (enc, 0x00, SvIVX (sv)); 606 encode_uint (enc, MAJOR_POS_INT, SvIVX (sv));
400 else 607 else
401 encode_uint (enc, 0x20, -(SvIVX (sv) + 1)); 608 encode_uint (enc, MAJOR_NEG_INT, -(SvIVX (sv) + 1));
402 } 609 }
403 else if (SvROK (sv)) 610 else if (SvROK (sv))
404 encode_rv (enc, SvRV (sv)); 611 encode_rv (enc, SvRV (sv));
405 else if (!SvOK (sv)) 612 else if (!SvOK (sv))
406 encode_ch (enc, 0xe0 | 22); 613 encode_ch (enc, MAJOR_MISC | SIMPLE_NULL);
407 else if (enc->cbor.flags & F_ALLOW_UNKNOWN) 614 else if (enc->cbor.flags & F_ALLOW_UNKNOWN)
408 encode_ch (enc, 0xe0 | 23); 615 encode_ch (enc, MAJOR_MISC | SIMPLE_UNDEF);
409 else 616 else
410 croak ("encountered perl type (%s,0x%x) that CBOR cannot handle, check your input data", 617 croak ("encountered perl type (%s,0x%x) that CBOR cannot handle, check your input data",
411 SvPV_nolen (sv), (unsigned int)SvFLAGS (sv)); 618 SvPV_nolen (sv), (unsigned int)SvFLAGS (sv));
412} 619}
413 620
414static SV * 621static SV *
415encode_cbor (SV *scalar, CBOR *cbor) 622encode_cbor (SV *scalar, CBOR *cbor)
416{ 623{
417 enc_t enc; 624 enc_t enc = { 0 };
418 625
419 enc.cbor = *cbor; 626 enc.cbor = *cbor;
420 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE)); 627 enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE));
421 enc.cur = SvPVX (enc.sv); 628 enc.cur = SvPVX (enc.sv);
422 enc.end = SvEND (enc.sv); 629 enc.end = SvEND (enc.sv);
423 enc.depth = 0;
424 630
425 SvPOK_only (enc.sv); 631 SvPOK_only (enc.sv);
632
633 if (cbor->flags & F_PACK_STRINGS)
634 {
635 encode_tag (&enc, CBOR_TAG_STRINGREF_NAMESPACE);
636 enc.stringref[0]= (HV *)sv_2mortal ((SV *)newHV ());
637 enc.stringref[1]= (HV *)sv_2mortal ((SV *)newHV ());
638 }
639
426 encode_sv (&enc, scalar); 640 encode_sv (&enc, scalar);
427 641
428 SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv)); 642 SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv));
429 *SvEND (enc.sv) = 0; // many xs functions expect a trailing 0 for text strings 643 *SvEND (enc.sv) = 0; // many xs functions expect a trailing 0 for text strings
430 644
444 U8 *end; // end of input string 658 U8 *end; // end of input string
445 const char *err; // parse error, if != 0 659 const char *err; // parse error, if != 0
446 CBOR cbor; 660 CBOR cbor;
447 U32 depth; // recursion depth 661 U32 depth; // recursion depth
448 U32 maxdepth; // recursion depth limit 662 U32 maxdepth; // recursion depth limit
663 AV *shareable;
664 AV *stringref;
665 SV *decode_tagged;
449} dec_t; 666} dec_t;
450 667
451#define ERR(reason) SB if (!dec->err) dec->err = reason; goto fail; SE 668#define ERR(reason) SB if (!dec->err) dec->err = reason; goto fail; SE
452 669
453#define WANT(len) if (ecb_expect_false (dec->cur + len > dec->end)) ERR ("unexpected end of CBOR data") 670#define WANT(len) if (ecb_expect_false (dec->cur + len > dec->end)) ERR ("unexpected end of CBOR data")
454 671
455#define DEC_INC_DEPTH if (++dec->depth > dec->cbor.max_depth) ERR (ERR_NESTING_EXCEEDED) 672#define DEC_INC_DEPTH if (ecb_expect_false (++dec->depth > dec->cbor.max_depth)) ERR (ERR_NESTING_EXCEEDED)
456#define DEC_DEC_DEPTH --dec->depth 673#define DEC_DEC_DEPTH --dec->depth
457 674
458static UV 675static UV
459decode_uint (dec_t *dec) 676decode_uint (dec_t *dec)
460{ 677{
461 switch (*dec->cur & 31) 678 U8 m = *dec->cur & MINOR_MASK;
462 { 679 ++dec->cur;
463 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
464 case 8: case 9: case 10: case 11: case 12: case 13: case 14: case 15:
465 case 16: case 17: case 18: case 19: case 20: case 21: case 22: case 23:
466 return *dec->cur++ & 31;
467 680
468 case 24: 681 if (ecb_expect_true (m < LENGTH_EXT1))
682 return m;
683 else if (ecb_expect_true (m == LENGTH_EXT1))
684 {
469 WANT (2); 685 WANT (1);
470 dec->cur += 2; 686 dec->cur += 1;
471 return dec->cur[-1]; 687 return dec->cur[-1];
472 688 }
473 case 25: 689 else if (ecb_expect_true (m == LENGTH_EXT2))
690 {
474 WANT (3); 691 WANT (2);
475 dec->cur += 3; 692 dec->cur += 2;
476 return (((UV)dec->cur[-2]) << 8) 693 return (((UV)dec->cur[-2]) << 8)
477 | ((UV)dec->cur[-1]); 694 | ((UV)dec->cur[-1]);
478 695 }
479 case 26: 696 else if (ecb_expect_true (m == LENGTH_EXT4))
697 {
480 WANT (5); 698 WANT (4);
481 dec->cur += 5; 699 dec->cur += 4;
482 return (((UV)dec->cur[-4]) << 24) 700 return (((UV)dec->cur[-4]) << 24)
483 | (((UV)dec->cur[-3]) << 16) 701 | (((UV)dec->cur[-3]) << 16)
484 | (((UV)dec->cur[-2]) << 8) 702 | (((UV)dec->cur[-2]) << 8)
485 | ((UV)dec->cur[-1]); 703 | ((UV)dec->cur[-1]);
486 704 }
487 case 27: 705 else if (ecb_expect_true (m == LENGTH_EXT8))
706 {
488 WANT (9); 707 WANT (8);
489 dec->cur += 9; 708 dec->cur += 8;
709
710 return
711#if UVSIZE < 8
712 0
713#else
490 return (((UV)dec->cur[-8]) << 56) 714 (((UV)dec->cur[-8]) << 56)
491 | (((UV)dec->cur[-7]) << 48) 715 | (((UV)dec->cur[-7]) << 48)
492 | (((UV)dec->cur[-6]) << 40) 716 | (((UV)dec->cur[-6]) << 40)
493 | (((UV)dec->cur[-5]) << 32) 717 | (((UV)dec->cur[-5]) << 32)
718#endif
494 | (((UV)dec->cur[-4]) << 24) 719 | (((UV)dec->cur[-4]) << 24)
495 | (((UV)dec->cur[-3]) << 16) 720 | (((UV)dec->cur[-3]) << 16)
496 | (((UV)dec->cur[-2]) << 8) 721 | (((UV)dec->cur[-2]) << 8)
497 | ((UV)dec->cur[-1]); 722 | ((UV)dec->cur[-1]);
498 723 }
499 default: 724 else
500 ERR ("corrupted CBOR data (unsupported integer minor encoding)"); 725 ERR ("corrupted CBOR data (unsupported integer minor encoding)");
501 }
502 726
503fail: 727fail:
504 return 0; 728 return 0;
505} 729}
506 730
511{ 735{
512 AV *av = newAV (); 736 AV *av = newAV ();
513 737
514 DEC_INC_DEPTH; 738 DEC_INC_DEPTH;
515 739
516 if ((*dec->cur & 31) == 31) 740 if (*dec->cur == (MAJOR_ARRAY | MINOR_INDEF))
517 { 741 {
518 ++dec->cur; 742 ++dec->cur;
519 743
520 for (;;) 744 for (;;)
521 { 745 {
522 WANT (1); 746 WANT (1);
523 747
524 if (*dec->cur == (0xe0 | 31)) 748 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF))
525 { 749 {
526 ++dec->cur; 750 ++dec->cur;
527 break; 751 break;
528 } 752 }
529 753
532 } 756 }
533 else 757 else
534 { 758 {
535 int i, len = decode_uint (dec); 759 int i, len = decode_uint (dec);
536 760
761 WANT (len); // complexity check for av_fill - need at least one byte per value, do not allow supersize arrays
537 av_fill (av, len - 1); 762 av_fill (av, len - 1);
538 763
539 for (i = 0; i < len; ++i) 764 for (i = 0; i < len; ++i)
540 AvARRAY (av)[i] = decode_sv (dec); 765 AvARRAY (av)[i] = decode_sv (dec);
541 } 766 }
547 SvREFCNT_dec (av); 772 SvREFCNT_dec (av);
548 DEC_DEC_DEPTH; 773 DEC_DEC_DEPTH;
549 return &PL_sv_undef; 774 return &PL_sv_undef;
550} 775}
551 776
777static void
778decode_he (dec_t *dec, HV *hv)
779{
780 // for speed reasons, we specialcase single-string
781 // byte or utf-8 strings as keys, but only when !stringref
782
783 if (ecb_expect_true (!dec->stringref))
784 if (ecb_expect_true ((U8)(*dec->cur - MAJOR_BYTES) <= LENGTH_EXT8))
785 {
786 STRLEN len = decode_uint (dec);
787 char *key = (char *)dec->cur;
788
789 WANT (len);
790 dec->cur += len;
791
792 hv_store (hv, key, len, decode_sv (dec), 0);
793
794 return;
795 }
796 else if (ecb_expect_true ((U8)(*dec->cur - MAJOR_TEXT) <= LENGTH_EXT8))
797 {
798 STRLEN len = decode_uint (dec);
799 char *key = (char *)dec->cur;
800
801 WANT (len);
802 dec->cur += len;
803
804 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
805 if (!is_utf8_string (key, len))
806 ERR ("corrupted CBOR data (invalid UTF-8 in map key)");
807
808 hv_store (hv, key, -len, decode_sv (dec), 0);
809
810 return;
811 }
812
813 SV *k = decode_sv (dec);
814 SV *v = decode_sv (dec);
815
816 hv_store_ent (hv, k, v, 0);
817 SvREFCNT_dec (k);
818
819fail:
820 ;
821}
822
552static SV * 823static SV *
553decode_hv (dec_t *dec) 824decode_hv (dec_t *dec)
554{ 825{
555 HV *hv = newHV (); 826 HV *hv = newHV ();
556 827
557 DEC_INC_DEPTH; 828 DEC_INC_DEPTH;
558 829
559 if ((*dec->cur & 31) == 31) 830 if (*dec->cur == (MAJOR_MAP | MINOR_INDEF))
560 { 831 {
561 ++dec->cur; 832 ++dec->cur;
562 833
563 for (;;) 834 for (;;)
564 { 835 {
565 WANT (1); 836 WANT (1);
566 837
567 if (*dec->cur == (0xe0 | 31)) 838 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF))
568 { 839 {
569 ++dec->cur; 840 ++dec->cur;
570 break; 841 break;
571 } 842 }
572 843
573 SV *k = decode_sv (dec); 844 decode_he (dec, hv);
574 SV *v = decode_sv (dec);
575
576 hv_store_ent (hv, k, v, 0);
577 } 845 }
578 } 846 }
579 else 847 else
580 { 848 {
581 int len = decode_uint (dec); 849 int pairs = decode_uint (dec);
582 850
583 while (len--) 851 while (pairs--)
584 { 852 decode_he (dec, hv);
585 SV *k = decode_sv (dec);
586 SV *v = decode_sv (dec);
587
588 hv_store_ent (hv, k, v, 0);
589 }
590 } 853 }
591 854
592 DEC_DEC_DEPTH; 855 DEC_DEC_DEPTH;
593 return newRV_noinc ((SV *)hv); 856 return newRV_noinc ((SV *)hv);
594 857
601static SV * 864static SV *
602decode_str (dec_t *dec, int utf8) 865decode_str (dec_t *dec, int utf8)
603{ 866{
604 SV *sv = 0; 867 SV *sv = 0;
605 868
606 if ((*dec->cur & 31) == 31) 869 if ((*dec->cur & MINOR_MASK) == MINOR_INDEF)
607 { 870 {
871 // indefinite length strings
608 ++dec->cur; 872 ++dec->cur;
609 873
874 U8 major = *dec->cur & MAJOR_MISC;
875
610 sv = newSVpvn ("", 0); 876 sv = newSVpvn ("", 0);
611 877
612 // not very fast, and certainly not robust against illegal input
613 for (;;) 878 for (;;)
614 { 879 {
615 WANT (1); 880 WANT (1);
616 881
617 if (*dec->cur == (0xe0 | 31)) 882 if ((*dec->cur - major) > LENGTH_EXT8)
883 if (*dec->cur == (MAJOR_MISC | MINOR_INDEF))
618 { 884 {
619 ++dec->cur; 885 ++dec->cur;
620 break; 886 break;
621 } 887 }
888 else
889 ERR ("corrupted CBOR data (invalid chunks in indefinite length string)");
622 890
623 sv_catsv (sv, decode_sv (dec)); 891 STRLEN len = decode_uint (dec);
892
893 WANT (len);
894 sv_catpvn (sv, dec->cur, len);
895 dec->cur += len;
624 } 896 }
625 } 897 }
626 else 898 else
627 { 899 {
628 STRLEN len = decode_uint (dec); 900 STRLEN len = decode_uint (dec);
629 901
630 WANT (len); 902 WANT (len);
631 sv = newSVpvn (dec->cur, len); 903 sv = newSVpvn (dec->cur, len);
632 dec->cur += len; 904 dec->cur += len;
905
906 if (ecb_expect_false (dec->stringref)
907 && SvCUR (sv) >= minimum_string_length (AvFILLp (dec->stringref) + 1))
908 av_push (dec->stringref, SvREFCNT_inc_NN (sv));
633 } 909 }
634 910
635 if (utf8) 911 if (utf8)
912 {
913 if (ecb_expect_false (dec->cbor.flags & F_VALIDATE_UTF8))
914 if (!is_utf8_string (SvPVX (sv), SvCUR (sv)))
915 ERR ("corrupted CBOR data (invalid UTF-8 in text string)");
916
636 SvUTF8_on (sv); 917 SvUTF8_on (sv);
918 }
637 919
638 return sv; 920 return sv;
639 921
640fail: 922fail:
641 SvREFCNT_dec (sv); 923 SvREFCNT_dec (sv);
643} 925}
644 926
645static SV * 927static SV *
646decode_tagged (dec_t *dec) 928decode_tagged (dec_t *dec)
647{ 929{
930 SV *sv = 0;
648 UV tag = decode_uint (dec); 931 UV tag = decode_uint (dec);
932
933 WANT (1);
934
935 switch (tag)
936 {
937 case CBOR_TAG_MAGIC:
649 SV *sv = decode_sv (dec); 938 sv = decode_sv (dec);
939 break;
650 940
651 if (tag == CBOR_TAG_MAGIC) 941 case CBOR_TAG_INDIRECTION:
652 return sv; 942 sv = newRV_noinc (decode_sv (dec));
943 break;
653 944
654 if (tag == CBOR_TAG_PERL_OBJECT) 945 case CBOR_TAG_STRINGREF_NAMESPACE:
655 { 946 {
947 // do nmot use SAVETMPS/FREETMPS, as these will
948 // erase mortalised caches, e.g. "shareable"
949 ENTER;
950
951 SAVESPTR (dec->stringref);
952 dec->stringref = (AV *)sv_2mortal ((SV *)newAV ());
953
954 sv = decode_sv (dec);
955
956 LEAVE;
957 }
958 break;
959
960 case CBOR_TAG_STRINGREF:
961 {
962 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
963 ERR ("corrupted CBOR data (stringref index not an unsigned integer)");
964
965 UV idx = decode_uint (dec);
966
967 if (!dec->stringref || (int)idx > AvFILLp (dec->stringref))
968 ERR ("corrupted CBOR data (stringref index out of bounds or outside namespace)");
969
970 sv = newSVsv (AvARRAY (dec->stringref)[idx]);
971 }
972 break;
973
974 case CBOR_TAG_VALUE_SHAREABLE:
975 {
976 if (ecb_expect_false (!dec->shareable))
977 dec->shareable = (AV *)sv_2mortal ((SV *)newAV ());
978
979 if (dec->cbor.flags & F_ALLOW_CYCLES)
980 {
981 sv = newSV (0);
982 av_push (dec->shareable, SvREFCNT_inc_NN (sv));
983
984 SV *osv = decode_sv (dec);
985 sv_setsv (sv, osv);
986 SvREFCNT_dec_NN (osv);
987 }
988 else
989 {
990 av_push (dec->shareable, &PL_sv_undef);
991 int idx = AvFILLp (dec->shareable);
992 sv = decode_sv (dec);
993 av_store (dec->shareable, idx, SvREFCNT_inc_NN (sv));
994 }
995 }
996 break;
997
998 case CBOR_TAG_VALUE_SHAREDREF:
999 {
1000 if ((*dec->cur >> MAJOR_SHIFT) != (MAJOR_POS_INT >> MAJOR_SHIFT))
1001 ERR ("corrupted CBOR data (sharedref index not an unsigned integer)");
1002
1003 UV idx = decode_uint (dec);
1004
1005 if (!dec->shareable || (int)idx > AvFILLp (dec->shareable))
1006 ERR ("corrupted CBOR data (sharedref index out of bounds)");
1007
1008 sv = SvREFCNT_inc_NN (AvARRAY (dec->shareable)[idx]);
1009
1010 if (sv == &PL_sv_undef)
1011 ERR ("cyclic CBOR data structure found, but allow_cycles is not enabled");
1012 }
1013 break;
1014
1015 case CBOR_TAG_PERL_OBJECT:
1016 {
1017 sv = decode_sv (dec);
1018
656 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV) 1019 if (!SvROK (sv) || SvTYPE (SvRV (sv)) != SVt_PVAV)
657 ERR ("corrupted CBOR data (non-array perl object)"); 1020 ERR ("corrupted CBOR data (non-array perl object)");
1021
1022 AV *av = (AV *)SvRV (sv);
1023 int len = av_len (av) + 1;
1024 HV *stash = gv_stashsv (*av_fetch (av, 0, 1), 0);
1025
1026 if (!stash)
1027 ERR ("cannot decode perl-object (package does not exist)");
1028
1029 GV *method = gv_fetchmethod_autoload (stash, "THAW", 0);
1030
1031 if (!method)
1032 ERR ("cannot decode perl-object (package does not have a THAW method)");
1033
1034 dSP;
1035
1036 ENTER; SAVETMPS;
1037 PUSHMARK (SP);
1038 EXTEND (SP, len + 1);
1039 // we re-bless the reference to get overload and other niceties right
1040 PUSHs (*av_fetch (av, 0, 1));
1041 PUSHs (sv_cbor);
1042
1043 int i;
1044
1045 for (i = 1; i < len; ++i)
1046 PUSHs (*av_fetch (av, i, 1));
1047
1048 PUTBACK;
1049 call_sv ((SV *)GvCV (method), G_SCALAR | G_EVAL);
1050 SPAGAIN;
1051
1052 if (SvTRUE (ERRSV))
1053 {
1054 FREETMPS; LEAVE;
1055 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV))));
1056 }
1057
1058 SvREFCNT_dec (sv);
1059 sv = SvREFCNT_inc (POPs);
1060
1061 PUTBACK;
1062
1063 FREETMPS; LEAVE;
658 1064 }
659 // TODO 1065 break;
660 }
661 1066
1067 default:
1068 {
1069 sv = decode_sv (dec);
1070
1071 dSP;
1072 ENTER; SAVETMPS;
1073 SAVESTACK_POS ();
1074 PUSHMARK (SP);
1075 EXTEND (SP, 2);
1076 PUSHs (newSVuv (tag));
1077 PUSHs (sv);
1078
1079 PUTBACK;
1080 int count = call_sv (dec->cbor.filter ? dec->cbor.filter : default_filter, G_ARRAY | G_EVAL);
1081 SPAGAIN;
1082
1083 if (SvTRUE (ERRSV))
1084 {
1085 FREETMPS; LEAVE;
1086 ERR (SvPVutf8_nolen (sv_2mortal (SvREFCNT_inc (ERRSV))));
1087 }
1088
1089 if (count)
1090 {
1091 SvREFCNT_dec (sv);
1092 sv = SvREFCNT_inc (POPs);
1093 }
1094 else
1095 {
662 AV *av = newAV (); 1096 AV *av = newAV ();
663 av_push (av, newSVuv (tag)); 1097 av_push (av, newSVuv (tag));
664 av_push (av, sv); 1098 av_push (av, sv);
665 1099
666 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash 1100 HV *tagged_stash = !CBOR_SLOW || cbor_tagged_stash
667 ? cbor_tagged_stash 1101 ? cbor_tagged_stash
668 : gv_stashpv ("CBOR::XS::Tagged" , 1); 1102 : gv_stashpv ("CBOR::XS::Tagged" , 1);
669
670 return sv_bless (newRV_noinc ((SV *)av), tagged_stash); 1103 sv = sv_bless (newRV_noinc ((SV *)av), tagged_stash);
1104 }
1105
1106 PUTBACK;
1107
1108 FREETMPS; LEAVE;
1109 }
1110 break;
1111 }
1112
1113 return sv;
671 1114
672fail: 1115fail:
673 SvREFCNT_dec (sv); 1116 SvREFCNT_dec (sv);
674 return &PL_sv_undef; 1117 return &PL_sv_undef;
675} 1118}
677static SV * 1120static SV *
678decode_sv (dec_t *dec) 1121decode_sv (dec_t *dec)
679{ 1122{
680 WANT (1); 1123 WANT (1);
681 1124
682 switch (*dec->cur >> 5) 1125 switch (*dec->cur >> MAJOR_SHIFT)
683 { 1126 {
684 case 0: // unsigned int 1127 case MAJOR_POS_INT >> MAJOR_SHIFT: return newSVuv (decode_uint (dec));
685 return newSVuv (decode_uint (dec)); 1128 case MAJOR_NEG_INT >> MAJOR_SHIFT: return newSViv (-1 - (IV)decode_uint (dec));
686 case 1: // negative int 1129 case MAJOR_BYTES >> MAJOR_SHIFT: return decode_str (dec, 0);
687 return newSViv (-1 - (IV)decode_uint (dec)); 1130 case MAJOR_TEXT >> MAJOR_SHIFT: return decode_str (dec, 1);
688 case 2: // octet string 1131 case MAJOR_ARRAY >> MAJOR_SHIFT: return decode_av (dec);
689 return decode_str (dec, 0); 1132 case MAJOR_MAP >> MAJOR_SHIFT: return decode_hv (dec);
690 case 3: // utf-8 string 1133 case MAJOR_TAG >> MAJOR_SHIFT: return decode_tagged (dec);
691 return decode_str (dec, 1); 1134
692 case 4: // array 1135 case MAJOR_MISC >> MAJOR_SHIFT:
693 return decode_av (dec);
694 case 5: // map
695 return decode_hv (dec);
696 case 6: // tag
697 return decode_tagged (dec);
698 case 7: // misc
699 switch (*dec->cur++ & 31) 1136 switch (*dec->cur++ & MINOR_MASK)
700 { 1137 {
701 case 20: 1138 case SIMPLE_FALSE:
702#if CBOR_SLOW 1139#if CBOR_SLOW
703 types_false = get_bool ("Types::Serialiser::false"); 1140 types_false = get_bool ("Types::Serialiser::false");
704#endif 1141#endif
705 return newSVsv (types_false); 1142 return newSVsv (types_false);
706 case 21: 1143 case SIMPLE_TRUE:
707#if CBOR_SLOW 1144#if CBOR_SLOW
708 types_true = get_bool ("Types::Serialiser::true"); 1145 types_true = get_bool ("Types::Serialiser::true");
709#endif 1146#endif
710 return newSVsv (types_true); 1147 return newSVsv (types_true);
711 case 22: 1148 case SIMPLE_NULL:
712 return newSVsv (&PL_sv_undef); 1149 return newSVsv (&PL_sv_undef);
713 case 23: 1150 case SIMPLE_UNDEF:
714#if CBOR_SLOW 1151#if CBOR_SLOW
715 types_error = get_bool ("Types::Serialiser::error"); 1152 types_error = get_bool ("Types::Serialiser::error");
716#endif 1153#endif
717 return newSVsv (types_error); 1154 return newSVsv (types_error);
718 1155
719 case 25: 1156 case MISC_FLOAT16:
720 { 1157 {
721 WANT (2); 1158 WANT (2);
722 1159
723 uint16_t fp = (dec->cur[0] << 8) | dec->cur[1]; 1160 uint16_t fp = (dec->cur[0] << 8) | dec->cur[1];
724 dec->cur += 2; 1161 dec->cur += 2;
725 1162
726 return newSVnv (ecb_binary16_to_float (fp)); 1163 return newSVnv (ecb_binary16_to_float (fp));
727 } 1164 }
728 1165
729 case 26: 1166 case MISC_FLOAT32:
730 { 1167 {
731 uint32_t fp; 1168 uint32_t fp;
732 WANT (4); 1169 WANT (4);
733 memcpy (&fp, dec->cur, 4); 1170 memcpy (&fp, dec->cur, 4);
734 dec->cur += 4; 1171 dec->cur += 4;
737 fp = ecb_bswap32 (fp); 1174 fp = ecb_bswap32 (fp);
738 1175
739 return newSVnv (ecb_binary32_to_float (fp)); 1176 return newSVnv (ecb_binary32_to_float (fp));
740 } 1177 }
741 1178
742 case 27: 1179 case MISC_FLOAT64:
743 { 1180 {
744 uint64_t fp; 1181 uint64_t fp;
745 WANT (8); 1182 WANT (8);
746 memcpy (&fp, dec->cur, 8); 1183 memcpy (&fp, dec->cur, 8);
747 dec->cur += 8; 1184 dec->cur += 8;
750 fp = ecb_bswap64 (fp); 1187 fp = ecb_bswap64 (fp);
751 1188
752 return newSVnv (ecb_binary64_to_double (fp)); 1189 return newSVnv (ecb_binary64_to_double (fp));
753 } 1190 }
754 1191
755 // 0..19 unassigned 1192 // 0..19 unassigned simple
756 // 24 reserved + unassigned (reserved values are not encodable) 1193 // 24 reserved + unassigned simple (reserved values are not encodable)
1194 // 28-30 unassigned misc
1195 // 31 break code
757 default: 1196 default:
758 ERR ("corrupted CBOR data (reserved/unassigned major 7 value)"); 1197 ERR ("corrupted CBOR data (reserved/unassigned/unexpected major 7 value)");
759 } 1198 }
760 1199
761 break; 1200 break;
762 } 1201 }
763 1202
766} 1205}
767 1206
768static SV * 1207static SV *
769decode_cbor (SV *string, CBOR *cbor, char **offset_return) 1208decode_cbor (SV *string, CBOR *cbor, char **offset_return)
770{ 1209{
771 dec_t dec; 1210 dec_t dec = { 0 };
772 SV *sv; 1211 SV *sv;
1212 STRLEN len;
1213 char *data = SvPVbyte (string, len);
773 1214
774 /* work around bugs in 5.10 where manipulating magic values
775 * makes perl ignore the magic in subsequent accesses.
776 * also make a copy of non-PV values, to get them into a clean
777 * state (SvPV should do that, but it's buggy, see below).
778 */
779 /*SvGETMAGIC (string);*/
780 if (SvMAGICAL (string) || !SvPOK (string))
781 string = sv_2mortal (newSVsv (string));
782
783 SvUPGRADE (string, SVt_PV);
784
785 /* work around a bug in perl 5.10, which causes SvCUR to fail an
786 * assertion with -DDEBUGGING, although SvCUR is documented to
787 * return the xpv_cur field which certainly exists after upgrading.
788 * according to nicholas clark, calling SvPOK fixes this.
789 * But it doesn't fix it, so try another workaround, call SvPV_nolen
790 * and hope for the best.
791 * Damnit, SvPV_nolen still trips over yet another assertion. This
792 * assertion business is seriously broken, try yet another workaround
793 * for the broken -DDEBUGGING.
794 */
795 {
796#ifdef DEBUGGING
797 STRLEN offset = SvOK (string) ? sv_len (string) : 0;
798#else
799 STRLEN offset = SvCUR (string);
800#endif
801
802 if (offset > cbor->max_size && cbor->max_size) 1215 if (len > cbor->max_size && cbor->max_size)
803 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu", 1216 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
804 (unsigned long)SvCUR (string), (unsigned long)cbor->max_size); 1217 (unsigned long)len, (unsigned long)cbor->max_size);
805 }
806
807 sv_utf8_downgrade (string, 0);
808 1218
809 dec.cbor = *cbor; 1219 dec.cbor = *cbor;
810 dec.cur = (U8 *)SvPVX (string); 1220 dec.cur = (U8 *)data;
811 dec.end = (U8 *)SvEND (string); 1221 dec.end = (U8 *)data + len;
812 dec.err = 0;
813 dec.depth = 0;
814 1222
815 sv = decode_sv (&dec); 1223 sv = decode_sv (&dec);
816 1224
817 if (offset_return) 1225 if (offset_return)
818 *offset_return = dec.cur; 1226 *offset_return = dec.cur;
821 if (dec.cur != dec.end && !dec.err) 1229 if (dec.cur != dec.end && !dec.err)
822 dec.err = "garbage after CBOR object"; 1230 dec.err = "garbage after CBOR object";
823 1231
824 if (dec.err) 1232 if (dec.err)
825 { 1233 {
1234 if (dec.shareable)
1235 {
1236 // need to break cyclic links, which whould all be in shareable
1237 int i;
1238 SV **svp;
1239
1240 for (i = av_len (dec.shareable) + 1; i--; )
1241 if ((svp = av_fetch (dec.shareable, i, 0)))
1242 sv_setsv (*svp, &PL_sv_undef);
1243 }
1244
826 SvREFCNT_dec (sv); 1245 SvREFCNT_dec (sv);
827 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)SvPVX (string), (int)(uint8_t)*dec.cur); 1246 croak ("%s, at offset %d (octet 0x%02x)", dec.err, dec.cur - (U8 *)data, (int)(uint8_t)*dec.cur);
828 } 1247 }
829 1248
830 sv = sv_2mortal (sv); 1249 sv = sv_2mortal (sv);
831 1250
832 return sv; 1251 return sv;
833} 1252}
834 1253
1254/////////////////////////////////////////////////////////////////////////////
1255// incremental parser
1256
1257#define INCR_DONE(cbor) (AvFILLp (cbor->incr_count) < 0)
1258
1259// returns 0 for notyet, 1 for success or error
1260static int
1261incr_parse (CBOR *self, SV *cborstr)
1262{
1263 STRLEN cur;
1264 SvPV (cborstr, cur);
1265
1266 while (ecb_expect_true (self->incr_need <= cur))
1267 {
1268 // table of integer count bytes
1269 static I8 incr_len[MINOR_MASK + 1] = {
1270 0, 0, 0, 0, 0, 0, 0, 0,
1271 0, 0, 0, 0, 0, 0, 0, 0,
1272 0, 0, 0, 0, 0, 0, 0, 0,
1273 1, 2, 4, 8,-1,-1,-1,-2
1274 };
1275
1276 const U8 *p = SvPVX (cborstr) + self->incr_pos;
1277 U8 m = *p & MINOR_MASK;
1278 IV count = SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]);
1279 I8 ilen = incr_len[m];
1280
1281 self->incr_need = self->incr_pos + 1;
1282
1283 if (ecb_expect_false (ilen < 0))
1284 {
1285 if (m != MINOR_INDEF)
1286 return 1; // error
1287
1288 if (*p == (MAJOR_MISC | MINOR_INDEF))
1289 {
1290 if (count >= 0)
1291 return 1; // error
1292
1293 count = 1;
1294 }
1295 else
1296 {
1297 av_push (self->incr_count, newSViv (-1)); //TODO: nest
1298 count = -1;
1299 }
1300 }
1301 else
1302 {
1303 self->incr_need += ilen;
1304 if (ecb_expect_false (self->incr_need > cur))
1305 return 0;
1306
1307 int major = *p >> MAJOR_SHIFT;
1308
1309 switch (major)
1310 {
1311 case MAJOR_TAG >> MAJOR_SHIFT:
1312 ++count; // tags merely prefix another value
1313 break;
1314
1315 case MAJOR_BYTES >> MAJOR_SHIFT:
1316 case MAJOR_TEXT >> MAJOR_SHIFT:
1317 case MAJOR_ARRAY >> MAJOR_SHIFT:
1318 case MAJOR_MAP >> MAJOR_SHIFT:
1319 {
1320 UV len;
1321
1322 if (ecb_expect_false (ilen))
1323 {
1324 len = 0;
1325
1326 do {
1327 len = (len << 8) | *++p;
1328 } while (--ilen);
1329 }
1330 else
1331 len = m;
1332
1333 switch (major)
1334 {
1335 case MAJOR_BYTES >> MAJOR_SHIFT:
1336 case MAJOR_TEXT >> MAJOR_SHIFT:
1337 self->incr_need += len;
1338 if (ecb_expect_false (self->incr_need > cur))
1339 return 0;
1340
1341 break;
1342
1343 case MAJOR_MAP >> MAJOR_SHIFT:
1344 len <<= 1;
1345 case MAJOR_ARRAY >> MAJOR_SHIFT:
1346 if (len)
1347 {
1348 av_push (self->incr_count, newSViv (len + 1)); //TODO: nest
1349 count = len + 1;
1350 }
1351 break;
1352 }
1353 }
1354 }
1355 }
1356
1357 self->incr_pos = self->incr_need;
1358
1359 if (count > 0)
1360 {
1361 while (!--count)
1362 {
1363 if (!AvFILLp (self->incr_count))
1364 return 1; // done
1365
1366 SvREFCNT_dec_NN (av_pop (self->incr_count));
1367 count = SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]);
1368 }
1369
1370 SvIVX (AvARRAY (self->incr_count)[AvFILLp (self->incr_count)]) = count;
1371 }
1372 }
1373
1374 return 0;
1375}
1376
1377
835///////////////////////////////////////////////////////////////////////////// 1378/////////////////////////////////////////////////////////////////////////////
836// XS interface functions 1379// XS interface functions
837 1380
838MODULE = CBOR::XS PACKAGE = CBOR::XS 1381MODULE = CBOR::XS PACKAGE = CBOR::XS
839 1382
846 types_error_stash = gv_stashpv ("Types::Serialiser::Error" , 1); 1389 types_error_stash = gv_stashpv ("Types::Serialiser::Error" , 1);
847 1390
848 types_true = get_bool ("Types::Serialiser::true" ); 1391 types_true = get_bool ("Types::Serialiser::true" );
849 types_false = get_bool ("Types::Serialiser::false"); 1392 types_false = get_bool ("Types::Serialiser::false");
850 types_error = get_bool ("Types::Serialiser::error"); 1393 types_error = get_bool ("Types::Serialiser::error");
1394
1395 default_filter = newSVpv ("CBOR::XS::default_filter", 0);
1396
1397 sv_cbor = newSVpv ("CBOR", 0);
1398 SvREADONLY_on (sv_cbor);
1399
1400 assert (("STRLEN must be an unsigned type", 0 <= (STRLEN)-1));
851} 1401}
852 1402
853PROTOTYPES: DISABLE 1403PROTOTYPES: DISABLE
854 1404
855void CLONE (...) 1405void CLONE (...)
873 1423
874void shrink (CBOR *self, int enable = 1) 1424void shrink (CBOR *self, int enable = 1)
875 ALIAS: 1425 ALIAS:
876 shrink = F_SHRINK 1426 shrink = F_SHRINK
877 allow_unknown = F_ALLOW_UNKNOWN 1427 allow_unknown = F_ALLOW_UNKNOWN
1428 allow_sharing = F_ALLOW_SHARING
1429 allow_cycles = F_ALLOW_CYCLES
1430 pack_strings = F_PACK_STRINGS
1431 text_keys = F_TEXT_KEYS
1432 text_strings = F_TEXT_STRINGS
1433 validate_utf8 = F_VALIDATE_UTF8
878 PPCODE: 1434 PPCODE:
879{ 1435{
880 if (enable) 1436 if (enable)
881 self->flags |= ix; 1437 self->flags |= ix;
882 else 1438 else
887 1443
888void get_shrink (CBOR *self) 1444void get_shrink (CBOR *self)
889 ALIAS: 1445 ALIAS:
890 get_shrink = F_SHRINK 1446 get_shrink = F_SHRINK
891 get_allow_unknown = F_ALLOW_UNKNOWN 1447 get_allow_unknown = F_ALLOW_UNKNOWN
1448 get_allow_sharing = F_ALLOW_SHARING
1449 get_allow_cycles = F_ALLOW_CYCLES
1450 get_pack_strings = F_PACK_STRINGS
1451 get_text_keys = F_TEXT_KEYS
1452 get_text_strings = F_TEXT_STRINGS
1453 get_validate_utf8 = F_VALIDATE_UTF8
892 PPCODE: 1454 PPCODE:
893 XPUSHs (boolSV (self->flags & ix)); 1455 XPUSHs (boolSV (self->flags & ix));
894 1456
895void max_depth (CBOR *self, U32 max_depth = 0x80000000UL) 1457void max_depth (CBOR *self, U32 max_depth = 0x80000000UL)
896 PPCODE: 1458 PPCODE:
912 CODE: 1474 CODE:
913 RETVAL = self->max_size; 1475 RETVAL = self->max_size;
914 OUTPUT: 1476 OUTPUT:
915 RETVAL 1477 RETVAL
916 1478
917#if 0 //TODO 1479void filter (CBOR *self, SV *filter = 0)
918
919void filter_cbor_object (CBOR *self, SV *cb = &PL_sv_undef)
920 PPCODE: 1480 PPCODE:
921{
922 SvREFCNT_dec (self->cb_object); 1481 SvREFCNT_dec (self->filter);
923 self->cb_object = SvOK (cb) ? newSVsv (cb) : 0; 1482 self->filter = filter ? newSVsv (filter) : filter;
924
925 XPUSHs (ST (0)); 1483 XPUSHs (ST (0));
926}
927 1484
928void filter_cbor_single_key_object (CBOR *self, SV *key, SV *cb = &PL_sv_undef) 1485SV *get_filter (CBOR *self)
929 PPCODE: 1486 CODE:
930{ 1487 RETVAL = self->filter ? self->filter : NEWSV (0, 0);
931 if (!self->cb_sk_object) 1488 OUTPUT:
932 self->cb_sk_object = newHV (); 1489 RETVAL
933
934 if (SvOK (cb))
935 hv_store_ent (self->cb_sk_object, key, newSVsv (cb), 0);
936 else
937 {
938 hv_delete_ent (self->cb_sk_object, key, G_DISCARD, 0);
939
940 if (!HvKEYS (self->cb_sk_object))
941 {
942 SvREFCNT_dec (self->cb_sk_object);
943 self->cb_sk_object = 0;
944 }
945 }
946
947 XPUSHs (ST (0));
948}
949
950#endif
951 1490
952void encode (CBOR *self, SV *scalar) 1491void encode (CBOR *self, SV *scalar)
953 PPCODE: 1492 PPCODE:
954 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN; 1493 PUTBACK; scalar = encode_cbor (scalar, self); SPAGAIN;
955 XPUSHs (scalar); 1494 XPUSHs (scalar);
968 EXTEND (SP, 2); 1507 EXTEND (SP, 2);
969 PUSHs (sv); 1508 PUSHs (sv);
970 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr)))); 1509 PUSHs (sv_2mortal (newSVuv (offset - SvPVX (cborstr))));
971} 1510}
972 1511
973#if 0 1512void incr_parse (CBOR *self, SV *cborstr)
1513 ALIAS:
1514 incr_parse_multiple = 1
1515 PPCODE:
1516{
1517 if (SvUTF8 (cborstr))
1518 sv_utf8_downgrade (cborstr, 0);
1519
1520 if (!self->incr_count)
1521 {
1522 self->incr_count = newAV ();
1523 self->incr_pos = 0;
1524 self->incr_need = 1;
1525
1526 av_push (self->incr_count, newSViv (1));
1527 }
1528
1529 do
1530 {
1531 if (!incr_parse (self, cborstr))
1532 {
1533 if (self->incr_need > self->max_size && self->max_size)
1534 croak ("attempted decode of CBOR text of %lu bytes size, but max_size is set to %lu",
1535 (unsigned long)self->incr_need, (unsigned long)self->max_size);
1536
1537 break;
1538 }
1539
1540 SV *sv;
1541 char *offset;
1542
1543 PUTBACK; sv = decode_cbor (cborstr, self, &offset); SPAGAIN;
1544 XPUSHs (sv);
1545
1546 sv_chop (cborstr, offset);
1547
1548 av_clear (self->incr_count);
1549 av_push (self->incr_count, newSViv (1));
1550
1551 self->incr_pos = 0;
1552 self->incr_need = self->incr_pos + 1;
1553 }
1554 while (ix);
1555}
1556
1557void incr_reset (CBOR *self)
1558 CODE:
1559{
1560 SvREFCNT_dec (self->incr_count);
1561 self->incr_count = 0;
1562}
974 1563
975void DESTROY (CBOR *self) 1564void DESTROY (CBOR *self)
976 CODE: 1565 PPCODE:
977 SvREFCNT_dec (self->cb_sk_object); 1566 cbor_free (self);
978 SvREFCNT_dec (self->cb_object);
979
980#endif
981 1567
982PROTOTYPES: ENABLE 1568PROTOTYPES: ENABLE
983 1569
984void encode_cbor (SV *scalar) 1570void encode_cbor (SV *scalar)
1571 ALIAS:
1572 encode_cbor = 0
1573 encode_cbor_sharing = F_ALLOW_SHARING
985 PPCODE: 1574 PPCODE:
986{ 1575{
987 CBOR cbor; 1576 CBOR cbor;
988 cbor_init (&cbor); 1577 cbor_init (&cbor);
1578 cbor.flags |= ix;
989 PUTBACK; scalar = encode_cbor (scalar, &cbor); SPAGAIN; 1579 PUTBACK; scalar = encode_cbor (scalar, &cbor); SPAGAIN;
990 XPUSHs (scalar); 1580 XPUSHs (scalar);
991} 1581}
992 1582
993void decode_cbor (SV *cborstr) 1583void decode_cbor (SV *cborstr)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines