blob: 4e90bbd6fb31997d7fa135aa62c78287180554be [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.
Lev Walkinc34dc462005-02-18 16:23:48 +0000593 * Phase 3: Only waiting for closing tag.
594 * Phase 4: Skipping unknown extensions.
595 * Phase 5: PHASED OUT
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000596 */
Lev Walkinc34dc462005-02-18 16:23:48 +0000597 for(edx = ctx->step; ctx->phase <= 4;) {
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000598 pxer_chunk_type_e ch_type; /* XER chunk type */
599 ssize_t ch_size; /* Chunk size */
600 xer_check_tag_e tcv; /* Tag check value */
601 asn_TYPE_member_t *elm;
602
603 /*
604 * Go inside the member.
605 */
606 if(ctx->phase == 2) {
607 asn_dec_rval_t tmprval;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000608 void *memb_ptr; /* Pointer to the member */
609 void **memb_ptr2; /* Pointer to that pointer */
610
Lev Walkinabf68892004-10-26 10:12:14 +0000611 elm = &td->elements[edx];
612
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000613 if(elm->flags & ATF_POINTER) {
614 /* Member is a pointer to another structure */
615 memb_ptr2 = (void **)((char *)st
616 + elm->memb_offset);
617 } else {
618 memb_ptr = (char *)st + elm->memb_offset;
619 memb_ptr2 = &memb_ptr;
620 }
621
Lev Walkinc61f3862005-02-14 17:21:22 +0000622 /* Start/Continue decoding the inner member */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000623 tmprval = elm->type->xer_decoder(opt_codec_ctx,
624 elm->type, memb_ptr2, elm->name,
625 buf_ptr, size);
626 XER_ADVANCE(tmprval.consumed);
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000627 ASN_DEBUG("XER/CHOICE: itdf: code=%d", tmprval.code);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000628 if(tmprval.code != RC_OK)
629 RETURN(tmprval.code);
Lev Walkinc61f3862005-02-14 17:21:22 +0000630 assert(_fetch_present_idx(st,
631 specs->pres_offset, specs->pres_size) == 0);
632 /* Record what we've got */
633 _set_present_idx(st,
634 specs->pres_offset, specs->pres_size, edx + 1);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000635 ctx->phase = 3;
636 /* Fall through */
637 }
638
639 /*
640 * Get the next part of the XML stream.
641 */
Lev Walkin1e443962005-02-18 18:06:36 +0000642 ch_size = xer_next_token(&ctx->context, buf_ptr, size, &ch_type);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000643 switch(ch_size) {
644 case -1: RETURN(RC_FAIL);
Lev Walkin2eeeedc2005-02-18 16:10:40 +0000645 case 0: RETURN(RC_WMORE);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000646 default:
647 switch(ch_type) {
648 case PXER_COMMENT: /* Got XML comment */
649 case PXER_TEXT: /* Ignore free-standing text */
650 XER_ADVANCE(ch_size); /* Skip silently */
651 continue;
652 case PXER_TAG:
653 break; /* Check the rest down there */
654 }
655 }
656
Lev Walkinc61f3862005-02-14 17:21:22 +0000657 tcv = xer_check_tag(buf_ptr, ch_size, xml_tag);
Lev Walkinc34dc462005-02-18 16:23:48 +0000658
659 /* Skip the extensions section */
660 if(ctx->phase == 4) {
661 ASN_DEBUG("skip_unknown(%d, %ld)",
662 tcv, (long)ctx->left);
663 switch(xer_skip_unknown(tcv, &ctx->left)) {
664 case -1:
665 ctx->phase = 5;
666 RETURN(RC_FAIL);
667 continue;
668 case 1:
669 ctx->phase = 3;
Lev Walkin1e443962005-02-18 18:06:36 +0000670 /* Fall through */
Lev Walkinc34dc462005-02-18 16:23:48 +0000671 case 0:
672 XER_ADVANCE(ch_size);
673 continue;
674 case 2:
675 ctx->phase = 3;
676 break;
677 }
678 }
679
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000680 switch(tcv) {
681 case XCT_BOTH:
Lev Walkinc61f3862005-02-14 17:21:22 +0000682 break; /* No CHOICE? */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000683 case XCT_CLOSING:
Lev Walkinc61f3862005-02-14 17:21:22 +0000684 if(ctx->phase != 3)
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000685 break;
686 XER_ADVANCE(ch_size);
Lev Walkinc34dc462005-02-18 16:23:48 +0000687 ctx->phase = 5; /* Phase out */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000688 RETURN(RC_OK);
689 case XCT_OPENING:
690 if(ctx->phase == 0) {
691 XER_ADVANCE(ch_size);
692 ctx->phase = 1; /* Processing body phase */
693 continue;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000694 }
695 /* Fall through */
Lev Walkin904e65b2005-02-18 14:23:48 +0000696 case XCT_UNKNOWN_OP:
697 case XCT_UNKNOWN_BO:
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000698
699 if(ctx->phase != 1)
700 break; /* Really unexpected */
701
702 /*
Lev Walkinc61f3862005-02-14 17:21:22 +0000703 * Search which inner member corresponds to this tag.
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000704 */
705 for(edx = 0; edx < td->elements_count; edx++) {
706 elm = &td->elements[edx];
Lev Walkinc61f3862005-02-14 17:21:22 +0000707 tcv = xer_check_tag(buf_ptr,ch_size,elm->name);
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000708 switch(tcv) {
709 case XCT_BOTH:
710 case XCT_OPENING:
711 /*
712 * Process this member.
713 */
714 ctx->step = edx;
715 ctx->phase = 2;
716 break;
Lev Walkin904e65b2005-02-18 14:23:48 +0000717 case XCT_UNKNOWN_OP:
718 case XCT_UNKNOWN_BO:
Lev Walkin6c0df202005-02-14 19:03:17 +0000719 continue;
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000720 default:
721 edx = td->elements_count;
722 break; /* Phase out */
723 }
724 break;
725 }
Lev Walkin6c0df202005-02-14 19:03:17 +0000726 if(edx != td->elements_count)
727 continue;
Lev Walkin904e65b2005-02-18 14:23:48 +0000728
729 /* It is expected extension */
730 if(specs->extensible) {
Lev Walkinc34dc462005-02-18 16:23:48 +0000731 ASN_DEBUG("Got anticipated extension");
Lev Walkin904e65b2005-02-18 14:23:48 +0000732 /*
Lev Walkinc34dc462005-02-18 16:23:48 +0000733 * Check for (XCT_BOTH or XCT_UNKNOWN_BO)
734 * By using a mask. Only record a pure
735 * <opening> tags.
Lev Walkin904e65b2005-02-18 14:23:48 +0000736 */
Lev Walkinc34dc462005-02-18 16:23:48 +0000737 if(tcv & XCT_CLOSING) {
738 /* Found </extension> without body */
739 ctx->phase = 3; /* Terminating */
740 } else {
741 ctx->left = 1;
742 ctx->phase = 4; /* Skip ...'s */
743 }
744 XER_ADVANCE(ch_size);
745 continue;
Lev Walkin904e65b2005-02-18 14:23:48 +0000746 }
747
Lev Walkin6c0df202005-02-14 19:03:17 +0000748 /* Fall through */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000749 default:
750 break;
751 }
752
Lev Walkinc61f3862005-02-14 17:21:22 +0000753 ASN_DEBUG("Unexpected XML tag in CHOICE");
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000754 break;
755 }
756
Lev Walkinc34dc462005-02-18 16:23:48 +0000757 ctx->phase = 5; /* Phase out, just in case */
Lev Walkin8d01b4c2004-10-23 14:57:50 +0000758 RETURN(RC_FAIL);
759}
760
761
Lev Walkina9cc46e2004-09-22 16:06:28 +0000762asn_enc_rval_t
Lev Walkin5e033762004-09-29 13:26:15 +0000763CHOICE_encode_xer(asn_TYPE_descriptor_t *td, void *sptr,
Lev Walkina9cc46e2004-09-22 16:06:28 +0000764 int ilevel, enum xer_encoder_flags_e flags,
765 asn_app_consume_bytes_f *cb, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000766 asn_CHOICE_specifics_t *specs=(asn_CHOICE_specifics_t *)td->specifics;
Lev Walkina9cc46e2004-09-22 16:06:28 +0000767 asn_enc_rval_t er;
768 int present;
769
770 if(!sptr)
771 _ASN_ENCODE_FAILED;
772
773 /*
774 * Figure out which CHOICE element is encoded.
775 */
776 present = _fetch_present_idx(sptr, specs->pres_offset,specs->pres_size);
777
778 if(present <= 0 || present > td->elements_count) {
779 _ASN_ENCODE_FAILED;
780 } else {
781 asn_enc_rval_t tmper;
Lev Walkin5e033762004-09-29 13:26:15 +0000782 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkina9cc46e2004-09-22 16:06:28 +0000783 void *memb_ptr;
784 const char *mname = elm->name;
785 unsigned int mlen = strlen(mname);
786
787 if(elm->flags & ATF_POINTER) {
788 memb_ptr = *(void **)((char *)sptr + elm->memb_offset);
789 if(!memb_ptr) _ASN_ENCODE_FAILED;
790 } else {
791 memb_ptr = (void *)((char *)sptr + elm->memb_offset);
792 }
793
794 er.encoded = 0;
795
796 if(!(flags & XER_F_CANONICAL)) _i_ASN_TEXT_INDENT(1, ilevel);
797 _ASN_CALLBACK3("<", 1, mname, mlen, ">", 1);
798
799 tmper = elm->type->xer_encoder(elm->type, memb_ptr,
800 ilevel + 1, flags, cb, app_key);
801 if(tmper.encoded == -1) return tmper;
802
803 _ASN_CALLBACK3("</", 2, mname, mlen, ">", 1);
804
805 er.encoded += 5 + (2 * mlen) + tmper.encoded;
806 }
807
808 if(!(flags & XER_F_CANONICAL)) _i_ASN_TEXT_INDENT(1, ilevel - 1);
809
810 return er;
Lev Walkin942fd082004-10-03 09:13:02 +0000811cb_failed:
812 _ASN_ENCODE_FAILED;
Lev Walkina9cc46e2004-09-22 16:06:28 +0000813}
814
Lev Walkinf15320b2004-06-03 03:38:44 +0000815int
Lev Walkin5e033762004-09-29 13:26:15 +0000816CHOICE_print(asn_TYPE_descriptor_t *td, const void *sptr, int ilevel,
Lev Walkinf15320b2004-06-03 03:38:44 +0000817 asn_app_consume_bytes_f *cb, void *app_key) {
Lev Walkin5e033762004-09-29 13:26:15 +0000818 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000819 int present;
820
Lev Walkin8e8078a2004-09-26 13:10:40 +0000821 if(!sptr) return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000822
823 /*
824 * Figure out which CHOICE element is encoded.
825 */
826 present = _fetch_present_idx(sptr, specs->pres_offset,specs->pres_size);
827
828 /*
Lev Walkina9cc46e2004-09-22 16:06:28 +0000829 * Print that element.
Lev Walkinf15320b2004-06-03 03:38:44 +0000830 */
Lev Walkin449f8322004-08-20 13:23:42 +0000831 if(present > 0 && present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000832 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkinf15320b2004-06-03 03:38:44 +0000833 const void *memb_ptr;
834
Lev Walkincc93b0f2004-09-10 09:18:20 +0000835 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000836 memb_ptr = *(const void * const *)((const char *)sptr + elm->memb_offset);
Lev Walkin8e8078a2004-09-26 13:10:40 +0000837 if(!memb_ptr) return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000838 } else {
839 memb_ptr = (const void *)((const char *)sptr + elm->memb_offset);
840 }
841
842 /* Print member's name and stuff */
Lev Walkincc6a9102004-09-23 22:06:26 +0000843 if(0) {
Lev Walkin8e8078a2004-09-26 13:10:40 +0000844 if(cb(elm->name, strlen(elm->name), app_key) < 0
845 || cb(": ", 2, app_key) < 0)
Lev Walkincc6a9102004-09-23 22:06:26 +0000846 return -1;
847 }
Lev Walkinf15320b2004-06-03 03:38:44 +0000848
849 return elm->type->print_struct(elm->type, memb_ptr, ilevel,
850 cb, app_key);
851 } else {
Lev Walkin8e8078a2004-09-26 13:10:40 +0000852 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
Lev Walkinf15320b2004-06-03 03:38:44 +0000853 }
854}
855
856void
Lev Walkin5e033762004-09-29 13:26:15 +0000857CHOICE_free(asn_TYPE_descriptor_t *td, void *ptr, int contents_only) {
858 asn_CHOICE_specifics_t *specs = (asn_CHOICE_specifics_t *)td->specifics;
Lev Walkinf15320b2004-06-03 03:38:44 +0000859 int present;
860
861 if(!td || !ptr)
862 return;
863
864 ASN_DEBUG("Freeing %s as CHOICE", td->name);
865
866 /*
867 * Figure out which CHOICE element is encoded.
868 */
869 present = _fetch_present_idx(ptr, specs->pres_offset, specs->pres_size);
870
871 /*
872 * Free that element.
873 */
Lev Walkin449f8322004-08-20 13:23:42 +0000874 if(present > 0 && present <= td->elements_count) {
Lev Walkin5e033762004-09-29 13:26:15 +0000875 asn_TYPE_member_t *elm = &td->elements[present-1];
Lev Walkinf15320b2004-06-03 03:38:44 +0000876 void *memb_ptr;
877
Lev Walkincc93b0f2004-09-10 09:18:20 +0000878 if(elm->flags & ATF_POINTER) {
Lev Walkinf15320b2004-06-03 03:38:44 +0000879 memb_ptr = *(void **)((char *)ptr + elm->memb_offset);
880 if(memb_ptr)
881 elm->type->free_struct(elm->type, memb_ptr, 0);
882 } else {
883 memb_ptr = (void *)((char *)ptr + elm->memb_offset);
884 elm->type->free_struct(elm->type, memb_ptr, 1);
885 }
886 }
887
888 if(!contents_only) {
889 FREEMEM(ptr);
890 }
891}
892
893
894/*
895 * The following functions functions offer protection against -fshort-enums,
896 * compatible with little- and big-endian machines.
897 * If assertion is triggered, either disable -fshort-enums, or add an entry
898 * here with the ->pres_size of your target stracture.
899 * Unless the target structure is packed, the ".present" member
900 * is guaranteed to be aligned properly. ASN.1 compiler itself does not
901 * produce packed code.
902 */
Lev Walkin91f5cd02004-08-11 09:10:59 +0000903static int
Lev Walkinf15320b2004-06-03 03:38:44 +0000904_fetch_present_idx(const void *struct_ptr, int pres_offset, int pres_size) {
905 const void *present_ptr;
906 int present;
907
908 present_ptr = ((const char *)struct_ptr) + pres_offset;
909
910 switch(pres_size) {
911 case sizeof(int): present = *(const int *)present_ptr; break;
912 case sizeof(short): present = *(const short *)present_ptr; break;
913 case sizeof(char): present = *(const char *)present_ptr; break;
914 default:
915 /* ANSI C mandates enum to be equivalent to integer */
916 assert(pres_size != sizeof(int));
917 return 0; /* If not aborted, pass back safe value */
918 }
919
920 return present;
921}
922
Lev Walkin91f5cd02004-08-11 09:10:59 +0000923static void
Lev Walkinf15320b2004-06-03 03:38:44 +0000924_set_present_idx(void *struct_ptr, int pres_offset, int pres_size, int present) {
925 void *present_ptr;
926 present_ptr = ((char *)struct_ptr) + pres_offset;
927
928 switch(pres_size) {
929 case sizeof(int): *(int *)present_ptr = present; break;
930 case sizeof(short): *(short *)present_ptr = present; break;
931 case sizeof(char): *(char *)present_ptr = present; break;
932 default:
933 /* ANSI C mandates enum to be equivalent to integer */
934 assert(pres_size != sizeof(int));
935 }
936}