RSM/asn1codec/e2ap_engine/constr_TYPE.h

   1
   2 /*
   3  * Copyright (c) 2003-2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
   4  * Redistribution and modifications are permitted subject to BSD license.
   5  */
   6 /*
   7  * This file contains the declaration structure called "ASN.1 Type Definition",
   8  * which holds all information necessary for encoding and decoding routines.
   9  * This structure even contains pointer to these encoding and decoding routines
  10  * for each defined ASN.1 type.
  11  */
  12 #ifndef _CONSTR_TYPE_H_
  13 #define _CONSTR_TYPE_H_
  14
  15 #include <ber_tlv_length.h>
  16 #include <ber_tlv_tag.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 struct asn_TYPE_descriptor_s;   /* Forward declaration */
  23 struct asn_TYPE_member_s;       /* Forward declaration */
  24
  25 /*
  26  * This type provides the context information for various ASN.1 routines,
  27  * primarily ones doing decoding. A member _asn_ctx of this type must be
  28  * included into certain target language's structures, such as compound types.
  29  */
  30 typedef struct asn_struct_ctx_s {
  31         short phase;            /* Decoding phase */
  32         short step;             /* Elementary step of a phase */
  33         int context;            /* Other context information */
  34         void *ptr;              /* Decoder-specific stuff (stack elements) */
  35         ber_tlv_len_t left;     /* Number of bytes left, -1 for indefinite */
  36 } asn_struct_ctx_t;
  37
  38 #include <ber_decoder.h>        /* Basic Encoding Rules decoder */
  39 #include <der_encoder.h>        /* Distinguished Encoding Rules encoder */
  40 #include <xer_decoder.h>        /* Decoder of XER (XML, text) */
  41 #include <xer_encoder.h>        /* Encoder into XER (XML, text) */
  42 #include <per_decoder.h>        /* Packet Encoding Rules decoder */
  43 #include <per_encoder.h>        /* Packet Encoding Rules encoder */
  44 #include <constraints.h>        /* Subtype constraints support */
  45 #include <asn_random_fill.h>    /* Random structures support */
  46
  47 #ifdef  ASN_DISABLE_OER_SUPPORT
  48 typedef void (oer_type_decoder_f)(void);
  49 typedef void (oer_type_encoder_f)(void);
  50 typedef void asn_oer_constraints_t;
  51 #else
  52 #include <oer_decoder.h>        /* Octet Encoding Rules encoder */
  53 #include <oer_encoder.h>        /* Octet Encoding Rules encoder */
  54 #endif
  55
  56 /*
  57  * Free the structure according to its specification.
  58  * Use one of ASN_STRUCT_{FREE,RESET,CONTENTS_ONLY} macros instead.
  59  * Do not use directly.
  60  */
  61 enum asn_struct_free_method {
  62     ASFM_FREE_EVERYTHING,   /* free(struct_ptr) and underlying members */
  63     ASFM_FREE_UNDERLYING,   /* free underlying members */
  64     ASFM_FREE_UNDERLYING_AND_RESET   /* FREE_UNDERLYING + memset(0) */
  65 };
  66 typedef void (asn_struct_free_f)(
  67                 const struct asn_TYPE_descriptor_s *type_descriptor,
  68                 void *struct_ptr, enum asn_struct_free_method);
  69
  70 /*
  71  * Free the structure including freeing the memory pointed to by ptr itself.
  72  */
  73 #define ASN_STRUCT_FREE(asn_DEF, ptr) \
  74     (asn_DEF).op->free_struct(&(asn_DEF), (ptr), ASFM_FREE_EVERYTHING)
  75
  76 /*
  77  * Free the memory used by the members of the structure without freeing the
  78  * the structure pointer itself.
  79  * ZERO-OUT the structure to the safe clean state.
  80  * (Retaining the pointer may be useful in case the structure is allocated
  81  *  statically or arranged on the stack, yet its elements are dynamic.)
  82  */
  83 #define ASN_STRUCT_RESET(asn_DEF, ptr) \
  84     (asn_DEF).op->free_struct(&(asn_DEF), (ptr), ASFM_FREE_UNDERLYING_AND_RESET)
  85
  86 /*
  87  * Free memory used by the members of the structure without freeing
  88  * the structure pointer itself.
  89  * (Retaining the pointer may be useful in case the structure is allocated
  90  *  statically or arranged on the stack, yet its elements are dynamic.)
  91  * AVOID using it in the application code;
  92  * Use a safer ASN_STRUCT_RESET() instead.
  93  */
  94 #define ASN_STRUCT_FREE_CONTENTS_ONLY(asn_DEF, ptr) \
  95     (asn_DEF).op->free_struct(&(asn_DEF), (ptr), ASFM_FREE_UNDERLYING)
  96
  97 /*
  98  * Print the structure according to its specification.
  99  */
 100 typedef int(asn_struct_print_f)(
 101     const struct asn_TYPE_descriptor_s *type_descriptor,
 102     const void *struct_ptr,
 103     int level, /* Indentation level */
 104     asn_app_consume_bytes_f *callback, void *app_key);
 105
 106 /*
 107  * Compare two structs between each other.
 108  * Returns <0 if struct_A is "smaller" than struct_B, >0 if "greater",
 109  * and =0 if "equal to", for some type-specific, stable definition of
 110  * "smaller", "greater" and "equal to".
 111  */
 112 typedef int (asn_struct_compare_f)(
 113                 const struct asn_TYPE_descriptor_s *type_descriptor,
 114                 const void *struct_A,
 115                 const void *struct_B);
 116
 117 /*
 118  * Return the outmost tag of the type.
 119  * If the type is untagged CHOICE, the dynamic operation is performed.
 120  * NOTE: This function pointer type is only useful internally.
 121  * Do not use it in your application.
 122  */
 123 typedef ber_tlv_tag_t (asn_outmost_tag_f)(
 124                 const struct asn_TYPE_descriptor_s *type_descriptor,
 125                 const void *struct_ptr, int tag_mode, ber_tlv_tag_t tag);
 126 /* The instance of the above function type; used internally. */
 127 asn_outmost_tag_f asn_TYPE_outmost_tag;
 128
 129 /*
 130  * Fetch the desired type of the Open Type based on the
 131  * Information Object Set driven constraints.
 132  */
 133 typedef struct asn_type_selector_result_s {
 134     const struct asn_TYPE_descriptor_s *type_descriptor; /* Type encoded. */
 135     unsigned presence_index; /* Associated choice variant. */
 136 } asn_type_selector_result_t;
 137 typedef asn_type_selector_result_t(asn_type_selector_f)(
 138     const struct asn_TYPE_descriptor_s *parent_type_descriptor,
 139     const void *parent_structure_ptr);
 140
 141 /*
 142  * Generalized functions for dealing with the speciic type.
 143  * May be directly invoked by applications.
 144  */
 145 typedef struct asn_TYPE_operation_s {
 146     asn_struct_free_f *free_struct;     /* Free the structure */
 147     asn_struct_print_f *print_struct;   /* Human readable output */
 148     asn_struct_compare_f *compare_struct; /* Compare two structures */
 149     ber_type_decoder_f *ber_decoder;      /* Generic BER decoder */
 150     der_type_encoder_f *der_encoder;      /* Canonical DER encoder */
 151     xer_type_decoder_f *xer_decoder;      /* Generic XER decoder */
 152     xer_type_encoder_f *xer_encoder;      /* [Canonical] XER encoder */
 153     oer_type_decoder_f *oer_decoder;      /* Generic OER decoder */
 154     oer_type_encoder_f *oer_encoder;      /* Canonical OER encoder */
 155     per_type_decoder_f *uper_decoder;     /* Unaligned PER decoder */
 156     per_type_encoder_f *uper_encoder;     /* Unaligned PER encoder */
 157     per_type_decoder_f *aper_decoder;     /* Aligned PER decoder */
 158     per_type_encoder_f *aper_encoder;     /* Aligned PER encoder */
 159     asn_random_fill_f *random_fill;       /* Initialize with a random value */
 160     asn_outmost_tag_f *outmost_tag;       /* <optional, internal> */
 161 } asn_TYPE_operation_t;
 162
 163 /*
 164  * A constraints tuple specifying both the OER and PER constraints.
 165  */
 166 typedef struct asn_encoding_constraints_s {
 167     const struct asn_oer_constraints_s *oer_constraints;
 168     const struct asn_per_constraints_s *per_constraints;
 169     asn_constr_check_f *general_constraints;
 170 } asn_encoding_constraints_t;
 171
 172 /*
 173  * The definitive description of the destination language's structure.
 174  */
 175 typedef struct asn_TYPE_descriptor_s {
 176     const char *name;       /* A name of the ASN.1 type. "" in some cases. */
 177     const char *xml_tag;    /* Name used in XML tag */
 178
 179     /*
 180      * Generalized functions for dealing with the specific type.
 181      * May be directly invoked by applications.
 182      */
 183     asn_TYPE_operation_t *op;
 184
 185     /***********************************************************************
 186      * Internally useful members. Not to be used by applications directly. *
 187      **********************************************************************/
 188
 189     /*
 190      * Tags that are expected to occur.
 191      */
 192     const ber_tlv_tag_t *tags;      /* Effective tags sequence for this type */
 193     unsigned tags_count;            /* Number of tags which are expected */
 194     const ber_tlv_tag_t *all_tags;  /* Every tag for BER/containment */
 195     unsigned all_tags_count;        /* Number of tags */
 196
 197     /* OER, PER, and general constraints */
 198     asn_encoding_constraints_t encoding_constraints;
 199
 200     /*
 201      * An ASN.1 production type members (members of SEQUENCE, SET, CHOICE).
 202      */
 203     struct asn_TYPE_member_s *elements;
 204     unsigned elements_count;
 205
 206     /*
 207      * Additional information describing the type, used by appropriate
 208      * functions above.
 209      */
 210     const void *specifics;
 211 } asn_TYPE_descriptor_t;
 212
 213 /*
 214  * This type describes an element of the constructed type,
 215  * i.e. SEQUENCE, SET, CHOICE, etc.
 216  */
 217   enum asn_TYPE_flags_e {
 218     ATF_NOFLAGS,
 219     ATF_POINTER = 0x01,   /* Represented by the pointer */
 220     ATF_OPEN_TYPE = 0x02, /* Open Type */
 221     ATF_ANY_TYPE = 0x04   /* ANY type (deprecated!) */
 222   };
 223 typedef struct asn_TYPE_member_s {
 224     enum asn_TYPE_flags_e flags; /* Element's presentation flags */
 225     unsigned optional;      /* Following optional members, including current */
 226     unsigned memb_offset;   /* Offset of the element */
 227     ber_tlv_tag_t tag;      /* Outmost (most immediate) tag */
 228     int tag_mode;           /* IMPLICIT/no/EXPLICIT tag at current level */
 229     asn_TYPE_descriptor_t *type;            /* Member type descriptor */
 230     asn_type_selector_f *type_selector;     /* IoS runtime type selector */
 231     asn_encoding_constraints_t encoding_constraints;
 232     int (*default_value_cmp)(const void *sptr); /* Compare DEFAULT <value> */
 233     int (*default_value_set)(void **sptr);      /* Set DEFAULT <value> */
 234     const char *name; /* ASN.1 identifier of the element */
 235 } asn_TYPE_member_t;
 236
 237 /*
 238  * BER tag to element number mapping.
 239  */
 240 typedef struct asn_TYPE_tag2member_s {
 241     ber_tlv_tag_t el_tag;   /* Outmost tag of the member */
 242     unsigned el_no;         /* Index of the associated member, base 0 */
 243     int toff_first;         /* First occurence of the el_tag, relative */
 244     int toff_last;          /* Last occurence of the el_tag, relative */
 245 } asn_TYPE_tag2member_t;
 246
 247 /*
 248  * This function prints out the contents of the target language's structure
 249  * (struct_ptr) into the file pointer (stream) in human readable form.
 250  * RETURN VALUES:
 251  *       0: The structure is printed.
 252  *      -1: Problem dumping the structure.
 253  * (See also xer_fprint() in xer_encoder.h)
 254  */
 255 int asn_fprint(FILE *stream, /* Destination stream descriptor */
 256                const asn_TYPE_descriptor_t *td, /* ASN.1 type descriptor */
 257                const void *struct_ptr);         /* Structure to be printed */
 258
 259 #ifdef __cplusplus
 260 }
 261 #endif
 262
 263 #endif  /* _CONSTR_TYPE_H_ */