asn1c (Lev Walkin) extended with features required by MAP/TCAP
Go to file
Harald Welte 1b38a280d9 aper fix for decoding constrained integer with lower boundary
When decoding a constrained integer with a lower boundary, we need
to make sure the lower bound is added after decoding the raw offset
inside the range.

Before this change, RANAP_CauseMisc_unspecified_failure (115) would be
encoded as 2 (115 - 113 = 2), but would be decoded as 2, rather than
113+2 = 115.

Code for this was taken from
openairinterface5g/openair3/S1AP/MESSAGES/ASN1/asn1cpatch.p0 which
unfortunately doesn't carry much of a revision history :/
2016-05-01 01:09:11 +02:00
asn1c port/merge Eurecom APER support from OPENAIRMME 2015-08-30 16:33:07 +02:00
doc formatting and English 2014-10-26 20:23:08 -07:00
examples no need in ENUMERATED file 2014-10-12 19:47:17 -07:00
libasn1compiler prefixing of generated types using a ASN1C_PREFIX environment variable 2016-04-30 17:38:04 +02:00
libasn1fix prefixing of generated types using a ASN1C_PREFIX environment variable 2016-04-30 17:38:04 +02:00
libasn1parser useless -all-static 2014-10-13 02:43:57 +00:00
libasn1print removed autotools intermediate files from source code; use autoreconf -iv. 2014-10-12 17:31:26 -07:00
m4 prefixing of generated types using a ASN1C_PREFIX environment variable 2016-04-30 17:38:04 +02:00
skeletons aper fix for decoding constrained integer with lower boundary 2016-05-01 01:09:11 +02:00
tests regenerated tests based on Wim L patch 2014-10-12 18:37:35 -07:00
.gitignore removed intermediate files 2014-10-12 18:21:11 -07:00
.travis.yml removed autotools intermediate files from source code; use autoreconf -iv. 2014-10-12 17:31:26 -07:00
AUTHORS Initial revision 2004-06-03 03:38:44 +00:00
BUGS BIT STRING identifiers is not a problem 2005-02-28 15:35:27 +00:00
COPYING copyright years 2014-10-12 17:47:15 -07:00
ChangeLog issue/32 acknowledged 2014-10-12 19:45:25 -07:00
FAQ update: more documentation 2005-12-22 21:36:47 +00:00
INSTALL 80 column 2014-10-12 17:55:50 -07:00
MANIFEST Initial revision 2004-06-03 03:38:44 +00:00
Makefile.am README.md is not automatically distributed 2014-10-12 18:09:31 -07:00
README.md wording 2014-10-12 18:02:12 -07:00
TODO PER encoding is mostly present 2006-09-19 06:12:11 +00:00
asn1c.spec.in docs updated; use markdown 2014-10-12 17:51:12 -07:00
config.sub update automake and move doc -> docsrc 2010-11-09 03:26:07 -08:00
configure.ac automake: automake 1.11.1 does not have this macro, ignore it then 2016-04-30 17:38:04 +02:00
depcomp update automake and move doc -> docsrc 2010-11-09 03:26:07 -08:00
stamp-h.in Initial revision 2004-06-03 03:38:44 +00:00

README.md

Installation

If you haven't installed the asn1c yet, read the INSTALL file for a short installation guide.

Documentation

For the list of asn1c command line options, see asn1c -h or man asn1c.

The comprehensive documentation on this compiler is in asn1c-usage.pdf.

If you are building the compiler from the sources, the PDFs reside in the ./doc directory. Normally the file is installed together with the README.md file you're reading right now.

Please also read the FAQ file.

An excellent book on ASN.1 is written by Olivier Dubuisson: "ASN.1 Communication between heterogeneous systems", ISBN:0-12-6333361-0.

Quick start

(also check out asn1c-quick.pdf)

After building [and installing] the compiler (see INSTALL), you may use the asn1c command to compile the ASN.1 specification:

asn1c <module.asn1>                         # Compile module

If several specifications contain interdependencies, all of them must be specified:

asn1c <module1.asn1> <module2.asn1> ...     # Compile interdependent modules

If you are building the asn1c from the sources, the ./examples directory contains several ASN.1 modules and a script to extract the ASN.1 modules from RFC documents. Refer to the README file in that directory. To compile the X.509 PKI module:

./asn1c/asn1c -P ./examples/rfc3280-*.asn1  # Compile-n-print

In this example, -P option is used to instruct the compiler to print the compiled text on the standard output instead of creating multiple .c and .h files for every ASN.1 type found inside the specified ASN.1 modules. This is useful for debugging and test automation.

The compiler -E and -EF options are used for testing the parser and the semantic fixer, respectively. These options will instruct the compiler to dump out the parsed (and fixed) ASN.1 specification as it was "understood" by the compiler. It might be useful for checking whether a particular syntactic construction is properly supported by the compiler.

asn1c -EF <module-to-test.asn1>     # Check semantic validity

Model of operation

The asn1c compiler works by processing the ASN.1 module specifications in several stages:

  1. In the first stage, the ASN.1 file is parsed. (Parsing produces an ASN.1 syntax tree for the subsequent levels)
  2. In the second stage, the syntax tree is "fixed". (Fixing is a process of checking the tree for semantic errors, accompanied by the tree transformation into the canonical form)
  3. In the third stage, the syntax tree is compiled into the target language.

There are several command-line options reserved for printing the results after each stage of operation:

<parser> => print                                       (-E)
<parser> => <fixer> => print                            (-E -F)
<parser> => <fixer> => <compiler> => print              (-P)
<parser> => <fixer> => <compiler> => save-compiled      [default]

-- Lev Walkin vlm@lionet.info