blob: 175ef2469e0772b8afaba34470c1d15385cdb142 [file] [log] [blame]
Lev Walkinf15320b2004-06-03 03:38:44 +00001/*-
Lev Walkinc61f3862005-02-14 17:21:22 +00002 * Copyright (c) 2003, 2004, 2005 Lev Walkin <vlm@lionet.info>.
3 * All rights reserved.
Lev Walkinf15320b2004-06-03 03:38:44 +00004 * Redistribution and modifications are permitted subject to BSD license.
5 */
Lev Walkina9cc46e2004-09-22 16:06:28 +00006#include <asn_internal.h>
Lev Walkinf15320b2004-06-03 03:38:44 +00007#include <constr_CHOICE.h>
Lev Walkinf15320b2004-06-03 03:38:44 +00008#include <assert.h>
9
10/*
11 * Number of bytes left for this structure.
12 * (ctx->left) indicates the number of bytes _transferred_ for the structure.
13 * (size) contains the number of bytes in the buffer passed.
14 */
Lev Walkinec1ffd42004-08-18 04:53:32 +000015#define LEFT ((size<(size_t)ctx->left)?size:(size_t)ctx->left)
Lev Walkinf15320b2004-06-03 03:38:44 +000016
17/*
18 * If the subprocessor function returns with an indication that it wants
19 * more data, it may well be a fatal decoding problem, because the
20 * size is constrained by the <TLV>'s L, even if the buffer size allows
21 * reading more data.
22 * For example, consider the buffer containing the following TLVs:
23 * <T:5><L:1><V> <T:6>...
24 * The TLV length clearly indicates that one byte is expected in V, but
25 * if the V processor returns with "want more data" even if the buffer
26 * contains way more data than the V processor have seen.
27 */
Lev Walkind9bd7752004-06-05 08:17:50 +000028#define SIZE_VIOLATION (ctx->left >= 0 && (size_t)ctx->left <= size)
Lev Walkinf15320b2004-06-03 03:38:44 +000029
30/*
31 * This macro "eats" the part of the buffer which is definitely "consumed",
32 * i.e. was correctly converted into local representation or rightfully skipped.
33 */
Lev Walkincc6a9102004-09-23 22:06:26 +000034#undef ADVANCE
Lev Walkinf15320b2004-06-03 03:38:44 +000035#define ADVANCE(num_bytes) do { \
36 size_t num = num_bytes; \
Lev Walkin4ce78ca2004-08-25 01:34:11 +000037 ptr = ((char *)ptr) + num; \
Lev Walkinf15320b2004-06-03 03:38:44 +000038 size -= num; \
39 if(ctx->left >= 0) \
40 ctx->left -= num; \
41 consumed_myself += num; \
42 } while(0)
43
44/*
45 * Switch to the next phase of parsing.
46 */
Lev Walkincc6a9102004-09-23 22:06:26 +000047#undef NEXT_PHASE
Lev Walkinf15320b2004-06-03 03:38:44 +000048#define NEXT_PHASE(ctx) do { \
49 ctx->phase++; \
50 ctx->step = 0; \
51 } while(0)
52
53/*
54 * Return a standardized complex structure.
55 */
Lev Walkincc6a9102004-09-23 22:06:26 +000056#undef RETURN
Lev Walkinf15320b2004-06-03 03:38:44 +000057#define RETURN(_code) do { \
58 rval.code = _code; \
59 rval.consumed = consumed_myself;\
60 return rval; \
61 } while(0)
62
63/*
64 * See the definitions.
65 */
Lev Walkin91f5cd02004-08-11 09:10:59 +000066static int _fetch_present_idx(const void *struct_ptr, int off, int size);
67static void _set_present_idx(void *sptr, int offset, int size, int pres);
Lev Walkinf15320b2004-06-03 03:38:44 +000068
69/*
70 * Tags are canonically sorted in the tag to member table.
71 */
72static int
73_search4tag(const void *ap, const void *bp) {
Lev Walkin5e033762004-09-29 13:26:15 +000074 const asn_TYPE_tag2member_t *a = (const asn_TYPE_tag2member_t *)ap;
75 const asn_TYPE_tag2member_t *b = (const asn_TYPE_tag2member_t *)bp;
Lev Walkinc2346572004-08-11 09:07:36 +000076
Lev Walkinf15320b2004-06-03 03:38:44 +000077 int a_class = BER_TAG_CLASS(a->el_tag);
78 int b_class = BER_TAG_CLASS(b->el_tag);
79
80 if(a_class == b_class) {
81 ber_tlv_tag_t a_value = BER_TAG_VALUE(a->el_tag);
82 ber_tlv_tag_t b_value = BER_TAG_VALUE(b->el_tag);
83
84 if(a_value == b_value)
85 return 0;
86 else if(a_value < b_value)
87 return -1;
88 else
89 return 1;
90 } else if(a_class < b_class) {
91 return -1;
92 } else {
93 return 1;
94 }
95}
96
97/*
98 * The decoder of the CHOICE type.
99 */
Lev Walkindc06f6b2004-10-20 15:50:55 +0000100asn_dec_rval_t
Lev Walkin5e033762004-09-29 13:26:15 +0000101CHOICE_decode_ber(asn_codec_ctx_t *opt_codec_ctx, asn_TYPE_descriptor_t *td,
Lev Walkinf15320b2004-06-03 03:38:44 +0000102 void **struct_ptr, void *ptr, size_t size, int tag_mode) {
103 /*
104 * Bring closer parts of structure description.
105 */
Lev Walkin5e033762004-09-29 13:26:15 +0000106 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
107 asn_TYPE_member_t *elements = td->elements;
Lev Walkinf15320b2004-06-03 03:38:44 +0000108
109 /*
110 * Parts of the structure being constructed.
111 */
112 void *st = *struct_ptr; /* Target structure. */
Lev Walkin5e033762004-09-29 13:26:15 +0000113 asn_struct_ctx_t *ctx; /* Decoder context */
Lev Walkinf15320b2004-06-03 03:38:44 +0000114
115 ber_tlv_tag_t tlv_tag; /* T from TLV */
116 ssize_t tag_len; /* Length of TLV's T */
Lev Walkindc06f6b2004-10-20 15:50:55 +0000117 asn_dec_rval_t rval; /* Return code from subparsers */
Lev Walkinf15320b2004-06-03 03:38:44 +0000118
119 ssize_t consumed_myself = 0; /* Consumed bytes from ptr */
120
Lev Walkin449f8322004-08-20 13:23:42 +0000121 ASN_DEBUG("Decoding %s as CHOICE", td->name);
Lev Walkinf15320b2004-06-03 03:38:44 +0000122
123 /*
124 * Create the target structure if it is not present already.
125 */
126 if(st == 0) {
127 st = *struct_ptr = CALLOC(1, specs->struct_size);
128 if(st == 0) {
129 RETURN(RC_FAIL);
130 }
131 }
132
133 /*
134 * Restore parsing context.
135 */
Lev Walkin5e033762004-09-29 13:26:15 +0000136 ctx = (asn_struct_ctx_t *)((char *)st + specs->ctx_offset);
Lev Walkinf15320b2004-06-03 03:38:44 +0000137
138 /*
139 * Start to parse where left previously
140 */
141 switch(ctx->phase) {
142 case 0:
143 /*
144 * PHASE 0.
145 * Check that the set of tags associated with given structure
146 * perfectly fits our expectations.
147 */
148
Lev Walkin449f8322004-08-20 13:23:42 +0000149 if(tag_mode || td->tags_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000150 rval = ber_check_tags(opt_codec_ctx, td, ctx, ptr, size,
Lev Walkin8e8078a2004-09-26 13:10:40 +0000151 tag_mode, -1, &ctx->left, 0);
Lev Walkinf15320b2004-06-03 03:38:44 +0000152 if(rval.code != RC_OK) {
153 ASN_DEBUG("%s tagging check failed: %d",
Lev Walkin449f8322004-08-20 13:23:42 +0000154 td->name, rval.code);
Lev Walkinf0f04d12004-10-05 06:36:02 +0000155 return rval;
Lev Walkinf15320b2004-06-03 03:38:44 +0000156 }
157
158 if(ctx->left >= 0) {
159 /* ?Substracted below! */
160 ctx->left += rval.consumed;
161 }
162 ADVANCE(rval.consumed);
163 } else {
164 ctx->left = -1;
165 }
166
167 NEXT_PHASE(ctx);
168
169 ASN_DEBUG("Structure consumes %ld bytes, buffer %ld",
170 (long)ctx->left, (long)size);
171
172 /* Fall through */
173 case 1:
174 /*
175 * Fetch the T from TLV.
176 */
177 tag_len = ber_fetch_tag(ptr, LEFT, &tlv_tag);
Lev Walkin449f8322004-08-20 13:23:42 +0000178 ASN_DEBUG("In %s CHOICE tag length %d", td->name, (int)tag_len);
Lev Walkinf15320b2004-06-03 03:38:44 +0000179 switch(tag_len) {
180 case 0: if(!SIZE_VIOLATION) RETURN(RC_WMORE);
181 /* Fall through */
182 case -1: RETURN(RC_FAIL);
183 }
184
185 do {
Lev Walkin5e033762004-09-29 13:26:15 +0000186 asn_TYPE_tag2member_t *t2m;
187 asn_TYPE_tag2member_t key;
Lev Walkinf15320b2004-06-03 03:38:44 +0000188
189 key.el_tag = tlv_tag;
Lev Walkinc17d90f2005-01-17 14:32:45 +0000190 t2m = (asn_TYPE_tag2member_t *)bsearch(&key,
Lev Walkinc2346572004-08-11 09:07:36 +0000191 specs->tag2el, specs->tag2el_count,
Lev Walkinf15320b2004-06-03 03:38:44 +0000192 sizeof(specs->tag2el[0]), _search4tag);
193 if(t2m) {
194 /*
195 * Found the element corresponding to the tag.
196 */
197 NEXT_PHASE(ctx);
198 ctx->step = t2m->el_no;
199 break;
200 } else if(specs->extensible == 0) {
201 ASN_DEBUG("Unexpected tag %s "
202 "in non-extensible CHOICE %s",
Lev Walkin449f8322004-08-20 13:23:42 +0000203 ber_tlv_tag_string(tlv_tag), td->name);
Lev Walkinf15320b2004-06-03 03:38:44 +0000204 RETURN(RC_FAIL);
205 } else {
206 /* Skip this tag */
207 ssize_t skip;
208
209 ASN_DEBUG("Skipping unknown tag %s",
210 ber_tlv_tag_string(tlv_tag));
211
Lev Walkinbaaa24f2004-09-29 14:19:14 +0000212 skip = ber_skip_length(opt_codec_ctx,
Lev Walkinf15320b2004-06-03 03:38:44 +0000213 BER_TLV_CONSTRUCTED(ptr),
Lev Walkin4d9528c2004-08-11 08:10:13 +0000214 (char *)ptr + tag_len, LEFT - tag_len);
Lev Walkinf15320b2004-06-03 03:38:44 +0000215
216 switch(skip) {
217 case 0: if(!SIZE_VIOLATION) RETURN(RC_WMORE);
218 /* Fall through */
219 case -1: RETURN(RC_FAIL);
220 }
221
222 ADVANCE(skip + tag_len);
223 RETURN(RC_OK);
224 }
225 } while(0);
226
227 case 2:
228 /*
229 * PHASE 2.
230 * Read in the element.
231 */
232 do {
Lev Walkin5e033762004-09-29 13:26:15 +0000233 asn_TYPE_member_t *elm;/* CHOICE's element */
Lev Walkinf15320b2004-06-03 03:38:44 +0000234 void *memb_ptr; /* Pointer to the member */
Lev Walkinc2346572004-08-11 09:07:36 +0000235 void **memb_ptr2; /* Pointer to that pointer */
Lev Walkinf15320b2004-06-03 03:38:44 +0000236
237 elm = &elements[ctx->step];
238
239 /*
240 * Compute the position of the member inside a structure,
241 * and also a type of containment (it may be contained
242 * as pointer or using inline inclusion).
243 */
Lev Walkincc93b0f2004-09-10 09:18:20 +0000244 if(elm->flags & ATF_POINTER) {
245 /* Member is a pointer to another structure */
Lev Walkinc2346572004-08-11 09:07:36 +0000246 memb_ptr2 = (void **)((char *)st + elm->memb_offset);
Lev Walkinf15320b2004-06-03 03:38:44 +0000247 } else {
248 /*
249 * A pointer to a pointer
250 * holding the start of the structure
251 */
252 memb_ptr = (char *)st + elm->memb_offset;
253 memb_ptr2 = &memb_ptr;
254 }
255 /*
256 * Invoke the member fetch routine according to member's type
257 */
Lev Walkin5e033762004-09-29 13:26:15 +0000258 rval = elm->type->ber_decoder(opt_codec_ctx, elm->type,
Lev Walkinf15320b2004-06-03 03:38:44 +0000259 memb_ptr2, ptr, LEFT,
260 elm->tag_mode);
261 switch(rval.code) {
262 case RC_OK:
263 _set_present_idx(st, specs->pres_offset,
264 specs->pres_size, ctx->step + 1);
265 break;
266 case RC_WMORE: /* More data expected */
267 if(!SIZE_VIOLATION) {
268 ADVANCE(rval.consumed);
269 RETURN(RC_WMORE);
270 }
271 RETURN(RC_FAIL);
272 case RC_FAIL: /* Fatal error */
273 RETURN(rval.code);
274 } /* switch(rval) */
275
276 ADVANCE(rval.consumed);
277 } while(0);
278
279 NEXT_PHASE(ctx);
280
281 /* Fall through */
282 case 3:
283 ASN_DEBUG("CHOICE %s Leftover: %ld, size = %ld, tm=%d, tc=%d",
Lev Walkin449f8322004-08-20 13:23:42 +0000284 td->name, (long)ctx->left, (long)size,
285 tag_mode, td->tags_count);
Lev Walkinf15320b2004-06-03 03:38:44 +0000286
287 if(ctx->left > 0) {
288 /*
289 * The type must be fully decoded
290 * by the CHOICE member-specific decoder.
291 */
292 RETURN(RC_FAIL);
293 }
294
295 if(ctx->left == -1
Lev Walkin449f8322004-08-20 13:23:42 +0000296 && !(tag_mode || td->tags_count)) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000297 /*
298 * This is an untagged CHOICE.
299 * It doesn't contain nothing
300 * except for the member itself, including all its tags.
301 * The decoding is completed.
302 */
303 NEXT_PHASE(ctx);
304 break;
305 }
306
307 /*
308 * Read in the "end of data chunks"'s.
309 */
310 while(ctx->left < 0) {
311 ssize_t tl;
312
313 tl = ber_fetch_tag(ptr, LEFT, &tlv_tag);
314 switch(tl) {
315 case 0: if(!SIZE_VIOLATION) RETURN(RC_WMORE);
316 /* Fall through */
317 case -1: RETURN(RC_FAIL);
318 }
319
320 /*
321 * Expected <0><0>...
322 */
323 if(((uint8_t *)ptr)[0] == 0) {
324 if(LEFT < 2) {
325 if(SIZE_VIOLATION)
326 RETURN(RC_FAIL);
327 else
328 RETURN(RC_WMORE);
329 } else if(((uint8_t *)ptr)[1] == 0) {
330 /*
331 * Correctly finished with <0><0>.
332 */
Lev Walkinf0f04d12004-10-05 06:36:02 +0000333 ADVANCE(2);
334 ctx->left++;
Lev Walkinf15320b2004-06-03 03:38:44 +0000335 continue;
336 }
337 } else {
338 ASN_DEBUG("Unexpected continuation in %s",
Lev Walkin449f8322004-08-20 13:23:42 +0000339 td->name);
Lev Walkinf15320b2004-06-03 03:38:44 +0000340 RETURN(RC_FAIL);
341 }
342
Lev Walkinf0f04d12004-10-05 06:36:02 +0000343 /* UNREACHABLE */
Lev Walkinf15320b2004-06-03 03:38:44 +0000344 }
345
346 NEXT_PHASE(ctx);
347 case 4:
348 /* No meaningful work here */
349 break;
350 }
351
352 RETURN(RC_OK);
353}
354
Lev Walkina9cc46e2004-09-22 16:06:28 +0000355asn_enc_rval_t
Lev Walkin5e033762004-09-29 13:26:15 +0000356CHOICE_encode_der(asn_TYPE_descriptor_t *td,
Lev Walkinf15320b2004-06-03 03:38:44 +0000357 void *struct_ptr,
358 int tag_mode, ber_tlv_tag_t tag,
359 asn_app_consume_bytes_f *cb, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000360 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
361 asn_TYPE_member_t *elm; /* CHOICE element */
Lev Walkina9cc46e2004-09-22 16:06:28 +0000362 asn_enc_rval_t erval;
Lev Walkinf15320b2004-06-03 03:38:44 +0000363 void *memb_ptr;
364 size_t computed_size = 0;
365 int present;
366
367 ASN_DEBUG("%s %s as CHOICE",
Lev Walkin449f8322004-08-20 13:23:42 +0000368 cb?"Encoding":"Estimating", td->name);
Lev Walkinf15320b2004-06-03 03:38:44 +0000369
370 present = _fetch_present_idx(struct_ptr,
371 specs->pres_offset, specs->pres_size);
372
373 /*
374 * If the structure was not initialized, it cannot be encoded:
375 * can't deduce what to encode in the choice type.
376 */
Lev Walkin449f8322004-08-20 13:23:42 +0000377 if(present <= 0 || present > td->elements_count) {
378 if(present == 0 && td->elements_count == 0) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000379 /* The CHOICE is empty?! */
380 erval.encoded = 0;
381 return erval;
382 }
383 erval.encoded = -1;
Lev Walkin449f8322004-08-20 13:23:42 +0000384 erval.failed_type = td;
Lev Walkinf15320b2004-06-03 03:38:44 +0000385 erval.structure_ptr = struct_ptr;
386 return erval;
387 }
388
389 /*
390 * Seek over the present member of the structure.
391 */
Lev Walkin449f8322004-08-20 13:23:42 +0000392 elm = &td->elements[present-1];
Lev Walkincc93b0f2004-09-10 09:18:20 +0000393 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000394 memb_ptr = *(void **)((char *)struct_ptr + elm->memb_offset);
395 if(memb_ptr == 0) {
Lev Walkincc93b0f2004-09-10 09:18:20 +0000396 if(elm->optional) {
397 erval.encoded = 0;
398 } else {
399 /* Mandatory element absent */
400 erval.encoded = -1;
401 erval.failed_type = td;
402 erval.structure_ptr = struct_ptr;
403 }
Lev Walkinf15320b2004-06-03 03:38:44 +0000404 return erval;
405 }
406 } else {
407 memb_ptr = (void *)((char *)struct_ptr + elm->memb_offset);
408 }
409
410 /*
411 * If the CHOICE itself is tagged EXPLICIT:
412 * T ::= [2] EXPLICIT CHOICE { ... }
413 * Then emit the appropriate tags.
414 */
Lev Walkin449f8322004-08-20 13:23:42 +0000415 if(tag_mode == 1 || td->tags_count) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000416 /*
417 * For this, we need to pre-compute the member.
418 */
419 ssize_t ret;
420
421 /* Encode member with its tag */
422 erval = elm->type->der_encoder(elm->type, memb_ptr,
423 elm->tag_mode, elm->tag, 0, 0);
424 if(erval.encoded == -1)
425 return erval;
426
427 /* Encode CHOICE with parent or my own tag */
Lev Walkin8e8078a2004-09-26 13:10:40 +0000428 ret = der_write_tags(td, erval.encoded, tag_mode, 1, tag,
Lev Walkinf15320b2004-06-03 03:38:44 +0000429 cb, app_key);
430 if(ret == -1) {
431 erval.encoded = -1;
Lev Walkin449f8322004-08-20 13:23:42 +0000432 erval.failed_type = td;
Lev Walkinf15320b2004-06-03 03:38:44 +0000433 erval.structure_ptr = struct_ptr;
434 return erval;
435 }
436 computed_size += ret;
437 }
438
439 /*
440 * Encode the single underlying member.
441 */
442 erval = elm->type->der_encoder(elm->type, memb_ptr,
443 elm->tag_mode, elm->tag, cb, app_key);
444 if(erval.encoded == -1)
445 return erval;
446
447 ASN_DEBUG("Encoded CHOICE member in %ld bytes (+%ld)",
448 (long)erval.encoded, (long)computed_size);
449
450 erval.encoded += computed_size;
451
452 return erval;
453}
454
455ber_tlv_tag_t
Lev Walkin5e033762004-09-29 13:26:15 +0000456CHOICE_outmost_tag(asn_TYPE_descriptor_t *td, const void *ptr, int tag_mode, ber_tlv_tag_t tag) {
457 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000458 int present;
459
460 assert(tag_mode == 0);
461 assert(tag == 0);
462
463 /*
464 * Figure out which CHOICE element is encoded.
465 */
466 present = _fetch_present_idx(ptr, specs->pres_offset, specs->pres_size);
467
Lev Walkin449f8322004-08-20 13:23:42 +0000468 if(present > 0 || present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000469 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkin70e70282004-06-05 01:45:48 +0000470 const void *memb_ptr;
Lev Walkinf15320b2004-06-03 03:38:44 +0000471
Lev Walkincc93b0f2004-09-10 09:18:20 +0000472 if(elm->flags & ATF_POINTER) {
Lev Walkin70e70282004-06-05 01:45:48 +0000473 memb_ptr = *(const void * const *)
474 ((const char *)ptr + elm->memb_offset);
Lev Walkinf15320b2004-06-03 03:38:44 +0000475 } else {
Lev Walkin70e70282004-06-05 01:45:48 +0000476 memb_ptr = (const void *)
477 ((const char *)ptr + elm->memb_offset);
Lev Walkinf15320b2004-06-03 03:38:44 +0000478 }
479
Lev Walkin5e033762004-09-29 13:26:15 +0000480 return asn_TYPE_outmost_tag(elm->type, memb_ptr,
Lev Walkinf15320b2004-06-03 03:38:44 +0000481 elm->tag_mode, elm->tag);
482 } else {
Lev Walkin4d9528c2004-08-11 08:10:13 +0000483 return (ber_tlv_tag_t)-1;
Lev Walkinf15320b2004-06-03 03:38:44 +0000484 }
485}
486
487int
Lev Walkin5e033762004-09-29 13:26:15 +0000488CHOICE_constraint(asn_TYPE_descriptor_t *td, const void *sptr,
Lev Walkinf15320b2004-06-03 03:38:44 +0000489 asn_app_consume_bytes_f *app_errlog, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000490 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000491 int present;
492
493 if(!sptr) {
Lev Walkinba4e5182004-08-11 09:44:13 +0000494 _ASN_ERRLOG(app_errlog, app_key,
Lev Walkin16835b62004-08-22 13:47:59 +0000495 "%s: value not given (%s:%d)",
496 td->name, __FILE__, __LINE__);
Lev Walkinf15320b2004-06-03 03:38:44 +0000497 return -1;
498 }
499
500 /*
501 * Figure out which CHOICE element is encoded.
502 */
503 present = _fetch_present_idx(sptr, specs->pres_offset,specs->pres_size);
Lev Walkin449f8322004-08-20 13:23:42 +0000504 if(present > 0 && present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000505 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkinf15320b2004-06-03 03:38:44 +0000506 const void *memb_ptr;
507
Lev Walkincc93b0f2004-09-10 09:18:20 +0000508 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000509 memb_ptr = *(const void * const *)((const char *)sptr + elm->memb_offset);
Lev Walkincc93b0f2004-09-10 09:18:20 +0000510 if(!memb_ptr) {
511 if(elm->optional)
512 return 0;
513 _ASN_ERRLOG(app_errlog, app_key,
514 "%s: mandatory CHOICE element %s absent (%s:%d)",
515 td->name, elm->name, __FILE__, __LINE__);
516 return -1;
517 }
Lev Walkinf15320b2004-06-03 03:38:44 +0000518 } else {
519 memb_ptr = (const void *)((const char *)sptr + elm->memb_offset);
520 }
521
Lev Walkin449f8322004-08-20 13:23:42 +0000522 if(elm->memb_constraints) {
523 return elm->memb_constraints(elm->type, memb_ptr,
Lev Walkinf15320b2004-06-03 03:38:44 +0000524 app_errlog, app_key);
Lev Walkin449f8322004-08-20 13:23:42 +0000525 } else {
526 int ret = elm->type->check_constraints(elm->type,
527 memb_ptr, app_errlog, app_key);
528 /*
529 * Cannot inherit it eralier:
530 * need to make sure we get the updated version.
531 */
532 elm->memb_constraints = elm->type->check_constraints;
533 return ret;
534 }
Lev Walkinf15320b2004-06-03 03:38:44 +0000535 } else {
Lev Walkinba4e5182004-08-11 09:44:13 +0000536 _ASN_ERRLOG(app_errlog, app_key,
Lev Walkind34a8512004-08-22 13:55:49 +0000537 "%s: no CHOICE element given (%s:%d)",
Lev Walkin16835b62004-08-22 13:47:59 +0000538 td->name, __FILE__, __LINE__);
Lev Walkinf15320b2004-06-03 03:38:44 +0000539 return -1;
540 }
541}
542
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000543#undef XER_ADVANCE
544#define XER_ADVANCE(num_bytes) do { \
545 size_t num = num_bytes; \
546 buf_ptr = ((char *)buf_ptr) + num; \
547 size -= num; \
548 consumed_myself += num; \
549 } while(0)
550
Lev Walkinc61f3862005-02-14 17:21:22 +0000551/*
552 * Decode the XER (XML) data.
553 */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000554asn_dec_rval_t
555CHOICE_decode_xer(asn_codec_ctx_t *opt_codec_ctx, asn_TYPE_descriptor_t *td,
556 void **struct_ptr, const char *opt_mname,
557 void *buf_ptr, size_t size) {
558 /*
559 * Bring closer parts of structure description.
560 */
561 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
562 const char *xml_tag = opt_mname ? opt_mname : td->xml_tag;
563
564 /*
565 * Parts of the structure being constructed.
566 */
567 void *st = *struct_ptr; /* Target structure. */
568 asn_struct_ctx_t *ctx; /* Decoder context */
569
Lev Walkinc61f3862005-02-14 17:21:22 +0000570 asn_dec_rval_t rval; /* Return value of a decoder */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000571 ssize_t consumed_myself = 0; /* Consumed bytes from ptr */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000572 int edx; /* Element index */
573
574 /*
575 * Create the target structure if it is not present already.
576 */
577 if(st == 0) {
578 st = *struct_ptr = CALLOC(1, specs->struct_size);
579 if(st == 0) RETURN(RC_FAIL);
580 }
581
582 /*
583 * Restore parsing context.
584 */
585 ctx = (asn_struct_ctx_t *)((char *)st + specs->ctx_offset);
586
587
588 /*
589 * Phases of XER/XML processing:
590 * Phase 0: Check that the opening tag matches our expectations.
591 * Phase 1: Processing body and reacting on closing tag.
592 * Phase 2: Processing inner type.
593 * Phase 3: Only waiting for closing tag
594 */
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000595 for(edx = ctx->step; ctx->phase <= 3;) {
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000596 pxer_chunk_type_e ch_type; /* XER chunk type */
597 ssize_t ch_size; /* Chunk size */
598 xer_check_tag_e tcv; /* Tag check value */
599 asn_TYPE_member_t *elm;
600
601 /*
602 * Go inside the member.
603 */
604 if(ctx->phase == 2) {
605 asn_dec_rval_t tmprval;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000606 void *memb_ptr; /* Pointer to the member */
607 void **memb_ptr2; /* Pointer to that pointer */
608
Lev Walkinabf68892004-10-26 10:12:14 +0000609 elm = &td->elements[edx];
610
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000611 if(elm->flags & ATF_POINTER) {
612 /* Member is a pointer to another structure */
613 memb_ptr2 = (void **)((char *)st
614 + elm->memb_offset);
615 } else {
616 memb_ptr = (char *)st + elm->memb_offset;
617 memb_ptr2 = &memb_ptr;
618 }
619
Lev Walkinc61f3862005-02-14 17:21:22 +0000620 /* Start/Continue decoding the inner member */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000621 tmprval = elm->type->xer_decoder(opt_codec_ctx,
622 elm->type, memb_ptr2, elm->name,
623 buf_ptr, size);
624 XER_ADVANCE(tmprval.consumed);
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000625 ASN_DEBUG("XER/CHOICE: itdf: code=%d", tmprval.code);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000626 if(tmprval.code != RC_OK)
627 RETURN(tmprval.code);
Lev Walkinc61f3862005-02-14 17:21:22 +0000628 assert(_fetch_present_idx(st,
629 specs->pres_offset, specs->pres_size) == 0);
630 /* Record what we've got */
631 _set_present_idx(st,
632 specs->pres_offset, specs->pres_size, edx + 1);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000633 ctx->phase = 3;
634 /* Fall through */
635 }
636
637 /*
638 * Get the next part of the XML stream.
639 */
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000640 ch_size = xer_next_token(buf_ptr, size, &ch_type);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000641 switch(ch_size) {
642 case -1: RETURN(RC_FAIL);
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000643 case 0: RETURN(RC_WMORE);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000644 default:
645 switch(ch_type) {
646 case PXER_COMMENT: /* Got XML comment */
647 case PXER_TEXT: /* Ignore free-standing text */
648 XER_ADVANCE(ch_size); /* Skip silently */
649 continue;
650 case PXER_TAG:
651 break; /* Check the rest down there */
652 }
653 }
654
Lev Walkinc61f3862005-02-14 17:21:22 +0000655 tcv = xer_check_tag(buf_ptr, ch_size, xml_tag);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000656 switch(tcv) {
657 case XCT_BOTH:
Lev Walkinc61f3862005-02-14 17:21:22 +0000658 break; /* No CHOICE? */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000659 case XCT_CLOSING:
Lev Walkinc61f3862005-02-14 17:21:22 +0000660 if(ctx->phase != 3)
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000661 break;
662 XER_ADVANCE(ch_size);
Lev Walkinc61f3862005-02-14 17:21:22 +0000663 ctx->phase = 4; /* Phase out */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000664 RETURN(RC_OK);
665 case XCT_OPENING:
666 if(ctx->phase == 0) {
667 XER_ADVANCE(ch_size);
668 ctx->phase = 1; /* Processing body phase */
669 continue;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000670 }
671 /* Fall through */
Lev Walkin904e65b2005-02-18 14:23:48 +0000672 case XCT_UNKNOWN_OP:
673 case XCT_UNKNOWN_BO:
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000674
675 if(ctx->phase != 1)
676 break; /* Really unexpected */
677
678 /*
Lev Walkinc61f3862005-02-14 17:21:22 +0000679 * Search which inner member corresponds to this tag.
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000680 */
681 for(edx = 0; edx < td->elements_count; edx++) {
682 elm = &td->elements[edx];
Lev Walkinc61f3862005-02-14 17:21:22 +0000683 tcv = xer_check_tag(buf_ptr,ch_size,elm->name);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000684 switch(tcv) {
685 case XCT_BOTH:
686 case XCT_OPENING:
687 /*
688 * Process this member.
689 */
690 ctx->step = edx;
691 ctx->phase = 2;
692 break;
Lev Walkin904e65b2005-02-18 14:23:48 +0000693 case XCT_UNKNOWN_OP:
694 case XCT_UNKNOWN_BO:
Lev Walkin6c0df202005-02-14 19:03:17 +0000695 continue;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000696 default:
697 edx = td->elements_count;
698 break; /* Phase out */
699 }
700 break;
701 }
Lev Walkin6c0df202005-02-14 19:03:17 +0000702 if(edx != td->elements_count)
703 continue;
Lev Walkin904e65b2005-02-18 14:23:48 +0000704
705 /* It is expected extension */
706 if(specs->extensible) {
707 ASN_DEBUG("Got anticipated extension, "
708 "but NOT IMPLEMENTED YET");
709 /*
710 * TODO: implement skipping of extensions
711 */
712 }
713
Lev Walkin6c0df202005-02-14 19:03:17 +0000714 /* Fall through */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000715 default:
716 break;
717 }
718
Lev Walkinc61f3862005-02-14 17:21:22 +0000719 ASN_DEBUG("Unexpected XML tag in CHOICE");
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000720 break;
721 }
722
723 ctx->phase = 4; /* Phase out, just in case */
724 RETURN(RC_FAIL);
725}
726
727
Lev Walkina9cc46e2004-09-22 16:06:28 +0000728asn_enc_rval_t
Lev Walkin5e033762004-09-29 13:26:15 +0000729CHOICE_encode_xer(asn_TYPE_descriptor_t *td, void *sptr,
Lev Walkina9cc46e2004-09-22 16:06:28 +0000730 int ilevel, enum xer_encoder_flags_e flags,
731 asn_app_consume_bytes_f *cb, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000732 asn_CHOICE_specifics_t *specs=(asn_CHOICE_specifics_t *)td->specifics;
Lev Walkina9cc46e2004-09-22 16:06:28 +0000733 asn_enc_rval_t er;
734 int present;
735
736 if(!sptr)
737 _ASN_ENCODE_FAILED;
738
739 /*
740 * Figure out which CHOICE element is encoded.
741 */
742 present = _fetch_present_idx(sptr, specs->pres_offset,specs->pres_size);
743
744 if(present <= 0 || present > td->elements_count) {
745 _ASN_ENCODE_FAILED;
746 } else {
747 asn_enc_rval_t tmper;
Lev Walkin5e033762004-09-29 13:26:15 +0000748 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkina9cc46e2004-09-22 16:06:28 +0000749 void *memb_ptr;
750 const char *mname = elm->name;
751 unsigned int mlen = strlen(mname);
752
753 if(elm->flags & ATF_POINTER) {
754 memb_ptr = *(void **)((char *)sptr + elm->memb_offset);
755 if(!memb_ptr) _ASN_ENCODE_FAILED;
756 } else {
757 memb_ptr = (void *)((char *)sptr + elm->memb_offset);
758 }
759
760 er.encoded = 0;
761
762 if(!(flags & XER_F_CANONICAL)) _i_ASN_TEXT_INDENT(1, ilevel);
763 _ASN_CALLBACK3("<", 1, mname, mlen, ">", 1);
764
765 tmper = elm->type->xer_encoder(elm->type, memb_ptr,
766 ilevel + 1, flags, cb, app_key);
767 if(tmper.encoded == -1) return tmper;
768
769 _ASN_CALLBACK3("</", 2, mname, mlen, ">", 1);
770
771 er.encoded += 5 + (2 * mlen) + tmper.encoded;
772 }
773
774 if(!(flags & XER_F_CANONICAL)) _i_ASN_TEXT_INDENT(1, ilevel - 1);
775
776 return er;
Lev Walkin942fd082004-10-03 09:13:02 +0000777cb_failed:
778 _ASN_ENCODE_FAILED;
Lev Walkina9cc46e2004-09-22 16:06:28 +0000779}
780
Lev Walkinf15320b2004-06-03 03:38:44 +0000781int
Lev Walkin5e033762004-09-29 13:26:15 +0000782CHOICE_print(asn_TYPE_descriptor_t *td, const void *sptr, int ilevel,
Lev Walkinf15320b2004-06-03 03:38:44 +0000783 asn_app_consume_bytes_f *cb, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000784 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000785 int present;
786
Lev Walkin8e8078a2004-09-26 13:10:40 +0000787 if(!sptr) return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000788
789 /*
790 * Figure out which CHOICE element is encoded.
791 */
792 present = _fetch_present_idx(sptr, specs->pres_offset,specs->pres_size);
793
794 /*
Lev Walkina9cc46e2004-09-22 16:06:28 +0000795 * Print that element.
Lev Walkinf15320b2004-06-03 03:38:44 +0000796 */
Lev Walkin449f8322004-08-20 13:23:42 +0000797 if(present > 0 && present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000798 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkinf15320b2004-06-03 03:38:44 +0000799 const void *memb_ptr;
800
Lev Walkincc93b0f2004-09-10 09:18:20 +0000801 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000802 memb_ptr = *(const void * const *)((const char *)sptr + elm->memb_offset);
Lev Walkin8e8078a2004-09-26 13:10:40 +0000803 if(!memb_ptr) return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000804 } else {
805 memb_ptr = (const void *)((const char *)sptr + elm->memb_offset);
806 }
807
808 /* Print member's name and stuff */
Lev Walkincc6a9102004-09-23 22:06:26 +0000809 if(0) {
Lev Walkin8e8078a2004-09-26 13:10:40 +0000810 if(cb(elm->name, strlen(elm->name), app_key) < 0
811 || cb(": ", 2, app_key) < 0)
Lev Walkincc6a9102004-09-23 22:06:26 +0000812 return -1;
813 }
Lev Walkinf15320b2004-06-03 03:38:44 +0000814
815 return elm->type->print_struct(elm->type, memb_ptr, ilevel,
816 cb, app_key);
817 } else {
Lev Walkin8e8078a2004-09-26 13:10:40 +0000818 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000819 }
820}
821
822void
Lev Walkin5e033762004-09-29 13:26:15 +0000823CHOICE_free(asn_TYPE_descriptor_t *td, void *ptr, int contents_only) {
824 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000825 int present;
826
827 if(!td || !ptr)
828 return;
829
830 ASN_DEBUG("Freeing %s as CHOICE", td->name);
831
832 /*
833 * Figure out which CHOICE element is encoded.
834 */
835 present = _fetch_present_idx(ptr, specs->pres_offset, specs->pres_size);
836
837 /*
838 * Free that element.
839 */
Lev Walkin449f8322004-08-20 13:23:42 +0000840 if(present > 0 && present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000841 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkinf15320b2004-06-03 03:38:44 +0000842 void *memb_ptr;
843
Lev Walkincc93b0f2004-09-10 09:18:20 +0000844 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000845 memb_ptr = *(void **)((char *)ptr + elm->memb_offset);
846 if(memb_ptr)
847 elm->type->free_struct(elm->type, memb_ptr, 0);
848 } else {
849 memb_ptr = (void *)((char *)ptr + elm->memb_offset);
850 elm->type->free_struct(elm->type, memb_ptr, 1);
851 }
852 }
853
854 if(!contents_only) {
855 FREEMEM(ptr);
856 }
857}
858
859
860/*
861 * The following functions functions offer protection against -fshort-enums,
862 * compatible with little- and big-endian machines.
863 * If assertion is triggered, either disable -fshort-enums, or add an entry
864 * here with the ->pres_size of your target stracture.
865 * Unless the target structure is packed, the ".present" member
866 * is guaranteed to be aligned properly. ASN.1 compiler itself does not
867 * produce packed code.
868 */
Lev Walkin91f5cd02004-08-11 09:10:59 +0000869static int
Lev Walkinf15320b2004-06-03 03:38:44 +0000870_fetch_present_idx(const void *struct_ptr, int pres_offset, int pres_size) {
871 const void *present_ptr;
872 int present;
873
874 present_ptr = ((const char *)struct_ptr) + pres_offset;
875
876 switch(pres_size) {
877 case sizeof(int): present = *(const int *)present_ptr; break;
878 case sizeof(short): present = *(const short *)present_ptr; break;
879 case sizeof(char): present = *(const char *)present_ptr; break;
880 default:
881 /* ANSI C mandates enum to be equivalent to integer */
882 assert(pres_size != sizeof(int));
883 return 0; /* If not aborted, pass back safe value */
884 }
885
886 return present;
887}
888
Lev Walkin91f5cd02004-08-11 09:10:59 +0000889static void
Lev Walkinf15320b2004-06-03 03:38:44 +0000890_set_present_idx(void *struct_ptr, int pres_offset, int pres_size, int present) {
891 void *present_ptr;
892 present_ptr = ((char *)struct_ptr) + pres_offset;
893
894 switch(pres_size) {
895 case sizeof(int): *(int *)present_ptr = present; break;
896 case sizeof(short): *(short *)present_ptr = present; break;
897 case sizeof(char): *(char *)present_ptr = present; break;
898 default:
899 /* ANSI C mandates enum to be equivalent to integer */
900 assert(pres_size != sizeof(int));
901 }
902}