e2sim/ASN1c/xer_encoder.c

   1 /*****************************************************************************
   2 #                                                                            *
   3 # Copyright 2019 AT&T Intellectual Property                                  *
   4 #                                                                            *
   5 # Licensed under the Apache License, Version 2.0 (the "License");            *
   6 # you may not use this file except in compliance with the License.           *
   7 # You may obtain a copy of the License at                                    *
   8 #                                                                            *
   9 #      http://www.apache.org/licenses/LICENSE-2.0                            *
  10 #                                                                            *
  11 # Unless required by applicable law or agreed to in writing, software        *
  12 # distributed under the License is distributed on an "AS IS" BASIS,          *
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
  14 # See the License for the specific language governing permissions and        *
  15 # limitations under the License.                                             *
  16 #                                                                            *
  17 ******************************************************************************/
  18
  19 /*-
  20  * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
  21  * Redistribution and modifications are permitted subject to BSD license.
  22  */
  23 #include <asn_internal.h>
  24 #include <stdio.h>
  25 #include <errno.h>
  26
  27 /*
  28  * The XER encoder of any type. May be invoked by the application.
  29  */
  30 asn_enc_rval_t
  31 xer_encode(const asn_TYPE_descriptor_t *td, const void *sptr,
  32            enum xer_encoder_flags_e xer_flags, asn_app_consume_bytes_f *cb,
  33            void *app_key) {
  34     asn_enc_rval_t er = {0, 0, 0};
  35         asn_enc_rval_t tmper;
  36         const char *mname;
  37         size_t mlen;
  38         int xcan = (xer_flags & XER_F_CANONICAL) ? 1 : 2;
  39
  40         if(!td || !sptr) goto cb_failed;
  41
  42         mname = td->xml_tag;
  43         mlen = strlen(mname);
  44
  45         ASN__CALLBACK3("<", 1, mname, mlen, ">", 1);
  46
  47         tmper = td->op->xer_encoder(td, sptr, 1, xer_flags, cb, app_key);
  48         if(tmper.encoded == -1) return tmper;
  49         er.encoded += tmper.encoded;
  50
  51         ASN__CALLBACK3("</", 2, mname, mlen, ">\n", xcan);
  52
  53         ASN__ENCODED_OK(er);
  54 cb_failed:
  55         ASN__ENCODE_FAILED;
  56 }
  57
  58 /*
  59  * This is a helper function for xer_fprint, which directs all incoming data
  60  * into the provided file descriptor.
  61  */
  62 static int
  63 xer__print2fp(const void *buffer, size_t size, void *app_key) {
  64         FILE *stream = (FILE *)app_key;
  65
  66         if(fwrite(buffer, 1, size, stream) != size)
  67                 return -1;
  68
  69         return 0;
  70 }
  71
  72 int
  73 xer_fprint(FILE *stream, const asn_TYPE_descriptor_t *td, const void *sptr) {
  74         asn_enc_rval_t er = {0,0,0};
  75
  76         if(!stream) stream = stdout;
  77         if(!td || !sptr)
  78                 return -1;
  79
  80         er = xer_encode(td, sptr, XER_F_BASIC, xer__print2fp, stream);
  81         if(er.encoded == -1)
  82                 return -1;
  83
  84         return fflush(stream);
  85 }
  86
  87 struct xer_buffer {
  88     char *buffer;
  89     size_t buffer_size;
  90     size_t allocated_size;
  91 };
  92
  93 static int
  94 xer__buffer_append(const void *buffer, size_t size, void *app_key) {
  95     struct xer_buffer *xb = app_key;
  96
  97     while(xb->buffer_size + size + 1 > xb->allocated_size) {
  98         size_t new_size = 2 * (xb->allocated_size ? xb->allocated_size : 64);
  99         char *new_buf = MALLOC(new_size);
 100         if(!new_buf) return -1;
 101         if (xb->buffer) {
 102             memcpy(new_buf, xb->buffer, xb->buffer_size);
 103         }
 104         FREEMEM(xb->buffer);
 105         xb->buffer = new_buf;
 106         xb->allocated_size = new_size;
 107     }
 108
 109     memcpy(xb->buffer + xb->buffer_size, buffer, size);
 110     xb->buffer_size += size;
 111     xb->buffer[xb->buffer_size] = '\0';
 112     return 0;
 113 }
 114
 115 enum xer_equivalence_e
 116 xer_equivalent(const struct asn_TYPE_descriptor_s *td, const void *struct1,
 117                const void *struct2, FILE *opt_debug_stream) {
 118     struct xer_buffer xb1 = {0, 0, 0};
 119     struct xer_buffer xb2 = {0, 0, 0};
 120     asn_enc_rval_t e1, e2;
 121     asn_dec_rval_t rval;
 122     void *sptr = NULL;
 123
 124     if(!td || !struct1 || !struct2) {
 125         if(opt_debug_stream) {
 126             if(!td) fprintf(opt_debug_stream, "Type descriptor missing\n");
 127             if(!struct1) fprintf(opt_debug_stream, "Structure 1 missing\n");
 128             if(!struct2) fprintf(opt_debug_stream, "Structure 2 missing\n");
 129         }
 130         return XEQ_FAILURE;
 131     }
 132
 133     e1 = xer_encode(td, struct1, XER_F_BASIC, xer__buffer_append, &xb1);
 134     if(e1.encoded == -1) {
 135         if(opt_debug_stream) {
 136             fprintf(stderr, "XER Encoding of %s failed\n", td->name);
 137         }
 138         FREEMEM(xb1.buffer);
 139         return XEQ_ENCODE1_FAILED;
 140     }
 141
 142     e2 = xer_encode(td, struct2, XER_F_BASIC, xer__buffer_append, &xb2);
 143     if(e2.encoded == -1) {
 144         if(opt_debug_stream) {
 145             fprintf(stderr, "XER Encoding of %s failed\n", td->name);
 146         }
 147         FREEMEM(xb1.buffer);
 148         FREEMEM(xb2.buffer);
 149         return XEQ_ENCODE1_FAILED;
 150     }
 151
 152     if(xb1.buffer_size != xb2.buffer_size
 153        || memcmp(xb1.buffer, xb2.buffer, xb1.buffer_size) != 0) {
 154         if(opt_debug_stream) {
 155             fprintf(opt_debug_stream,
 156                     "Structures XER-encoded into different byte streams:\n=== "
 157                     "Structure 1 ===\n%s\n=== Structure 2 ===\n%s\n",
 158                     xb1.buffer, xb2.buffer);
 159         }
 160         FREEMEM(xb1.buffer);
 161         FREEMEM(xb2.buffer);
 162         return XEQ_DIFFERENT;
 163     } else {
 164         if(opt_debug_stream) {
 165             fprintf(opt_debug_stream,
 166                     "Both structures encoded into the same XER byte stream "
 167                     "of size %" ASN_PRI_SIZE ":\n%s",
 168                     xb1.buffer_size, xb1.buffer);
 169         }
 170     }
 171
 172     rval = xer_decode(NULL, td, (void **)&sptr, xb1.buffer,
 173                xb1.buffer_size);
 174     switch(rval.code) {
 175     case RC_OK:
 176         break;
 177     case RC_WMORE:
 178         if(opt_debug_stream) {
 179             fprintf(opt_debug_stream,
 180                     "Structure %s XER decode unexpectedly requires "
 181                     "more data:\n%s\n",
 182                     td->name, xb1.buffer);
 183         }
 184         /* Fall through */
 185     case RC_FAIL:
 186     default:
 187         if(opt_debug_stream) {
 188             fprintf(opt_debug_stream,
 189                     "Structure %s XER decoding resulted in failure.\n",
 190                     td->name);
 191         }
 192         ASN_STRUCT_FREE(*td, sptr);
 193         FREEMEM(xb1.buffer);
 194         FREEMEM(xb2.buffer);
 195         return XEQ_DECODE_FAILED;
 196     }
 197
 198     if(rval.consumed != xb1.buffer_size
 199        && ((rval.consumed > xb1.buffer_size)
 200            || xer_whitespace_span(xb1.buffer + rval.consumed,
 201                                   xb1.buffer_size - rval.consumed)
 202                   != (xb1.buffer_size - rval.consumed))) {
 203         if(opt_debug_stream) {
 204             fprintf(opt_debug_stream,
 205                     "Round-trip decode of %s required less bytes (%" ASN_PRI_SIZE ") than "
 206                     "encoded (%" ASN_PRI_SIZE ")\n",
 207                     td->name, rval.consumed, xb1.buffer_size);
 208         }
 209         ASN_STRUCT_FREE(*td, sptr);
 210         FREEMEM(xb1.buffer);
 211         FREEMEM(xb2.buffer);
 212         return XEQ_ROUND_TRIP_FAILED;
 213     }
 214
 215     /*
 216      * Reuse xb2 to encode newly decoded structure.
 217      */
 218     FREEMEM(xb2.buffer);
 219     memset(&xb2, 0, sizeof(xb2));
 220
 221     e2 = xer_encode(td, sptr, XER_F_BASIC, xer__buffer_append, &xb2);
 222     if(e2.encoded == -1) {
 223         if(opt_debug_stream) {
 224             fprintf(stderr, "XER Encoding of round-trip decode of %s failed\n",
 225                     td->name);
 226         }
 227         ASN_STRUCT_FREE(*td, sptr);
 228         FREEMEM(xb1.buffer);
 229         FREEMEM(xb2.buffer);
 230         return XEQ_ROUND_TRIP_FAILED;
 231     }
 232
 233     ASN_STRUCT_FREE(*td, sptr);
 234     sptr = 0;
 235
 236     if(xb1.buffer_size != xb2.buffer_size
 237        || memcmp(xb1.buffer, xb2.buffer, xb1.buffer_size) != 0) {
 238         if(opt_debug_stream) {
 239             fprintf(opt_debug_stream,
 240                     "XER Encoding of round-trip decode of %s resulted in "
 241                     "different byte stream:\n"
 242                     "=== Original ===\n%s\n"
 243                     "=== Round-tripped ===\n%s\n",
 244                     xb1.buffer, xb2.buffer, td->name);
 245         }
 246         FREEMEM(xb1.buffer);
 247         FREEMEM(xb2.buffer);
 248         return XEQ_ROUND_TRIP_FAILED;
 249     }
 250
 251         FREEMEM(xb1.buffer);
 252         FREEMEM(xb2.buffer);
 253         return XEQ_SUCCESS;
 254 }
 255