software/ors-amarisoft: add support for IMS

For this to work, SIM cards config needs to be modified,
impu and impi must be for instance:
impu: 001010000001312,
impi: 001010000001312@ims.mnc001.mcc001.3gppnetwork.org

TODO:

    - add tests / make tests works
    - don't launch IMS if amarisoft version is too old
    - merge branch ims of slapos.package
    - modify update amarisoft script of slapos.package
      to copy libs to /opt/amarisoft/ltemme (needed for
      newest amarisoft version)

software/ors-amarisoft/buildout.hash.cfg

@@ -16,7 +16,7 @@
 
 [template]
 filename = instance.cfg
-md5sum = 43f02b7b3552d0d657fa7dbf43ce20a5
+md5sum = bf471a7dd9c786a24c65209c978ebed5
 
 [template-ors]
 filename = instance-ors.cfg
@@ -96,7 +96,7 @@ md5sum = 601d6237059fa665d3f3ffb6a78ad9ca
 
 [template-core-network]
 _update_hash_filename_ = instance-core-network.jinja2.cfg
-md5sum = 326e194e9c98d58d926f89521bb95df5
+md5sum = d9406c9538994459452a9c7e302cba1a
 
 [template-ue]
 _update_hash_filename_ = instance-ue.jinja2.cfg
@@ -126,9 +126,13 @@ md5sum = 282b11d7b72b01b8325df4632d82b84d
 filename = config/sib23.jinja2.asn
 md5sum = 959523597e29b048e45ebf58f7ea4c5b
 
+[mt_call_qos.jinja2.sdp]
+_update_hash_filename_ = config/mt_call_qos.jinja2.sdp
+md5sum = 9dbd93036c15c87c6de74b88b34062b6
+
 [mme.jinja2.cfg]
 filename = config/mme.jinja2.cfg
-md5sum = 25ae6b1022548183293f0ef0c54532a7
+md5sum = cef33b6a8daa032738b6f1f1759c9164
 
 [dnsmasq-core-network.jinja2.cfg]
 filename = config/dnsmasq-core-network.jinja2.cfg
@@ -140,7 +144,7 @@ md5sum = 95f4f8fb85e0480eb3e9059b9db26540
 
 [ims.jinja2.cfg]
 filename = config/ims.jinja2.cfg
-md5sum = 36281b03597252cf75169417d02fc28c
+md5sum = 272c5bbf8514cc4e0b8e62cd3a9fefae
 
 [ue.jinja2.cfg]
 filename = config/ue.jinja2.cfg

software/ors-amarisoft/config/ims.jinja2.cfg

+{%- set tun_ipv6_start = int(netaddr.IPAddress(slap_configuration.get('tun-ipv6-addr', ''))) %}
+{%- set tun_ipv6_end   = netaddr.IPNetwork(slap_configuration.get('tun-ipv6-network')).last  %}
+{%- set tun_ipv4_start = int(netaddr.IPAddress(slap_configuration.get('tun-ipv4-addr', ''))) %}
+{%- set tun_ipv4_end   = netaddr.IPNetwork(slap_configuration.get('tun-ipv4-network')).last  %}
 {
     log_options: "all.level=debug,all.max_size=32",
     log_filename: "{{ directory['log'] }}/ims.log",
 
     sip_addr: [
-        {addr: "{{ slap_configuration['tun-ipv4-addr'] }}", bind_addr: "0.0.0.0", port_min: 10000, port_max: 20000},
-        {#" slap_configuration['tun-ipv6-addr'] ",#}
+        {addr: "{{ netaddr.IPAddress((tun_ipv4_start + tun_ipv4_end) // 2 + 1) }}", bind_addr: "{{ netaddr.IPAddress((tun_ipv4_start + tun_ipv4_end) // 2 + 1) }}", port_min: 10000, port_max: 20000},
+        "{{ netaddr.IPAddress((tun_ipv6_start + tun_ipv6_end) // 2) }}",
     ],
 
-    mms_server_bind_addr: "{{ netaddr.IPAddress(netaddr.IPNetwork(slap_configuration['tun-ipv4-network']).first) + 1 }}:1111",
+    mms_server_bind_addr: "{{ netaddr.IPAddress(tun_ipv4_start) }}:1111",
     sctp_addr: "{{ slap_configuration['configuration.ims_addr'] }}",
 
     
     cx_server_addr: "127.0.1.100",
     cx_bind_addr: "{{ slap_configuration['configuration.ims_addr'] }}",
 
-    
     rx_server_addr: "127.0.1.100",
-    rx_bind_addr: "{{ slap_configuration['configuration.ims_addr'] }}",
 
-    domain: "{{ slap_configuration['configuration.domain'] }}",
+    domain: "{{ slapparameter_dict.get('ims_domain', 'rapid.space') }}",
 
     include "{{ slap_configuration['ue_db_path'] }}",
 
@@ -44,7 +46,10 @@
     ipsec_aalg_list: ["hmac-md5-96", "hmac-sha-1-96"],
     ipsec_ealg_list: ["null", "aes-cbc", "des-cbc", "des-ede3-cbc"],
 
-    mt_call_sdp_file: "{{ directory['software'] }}/mme/config/mt_call.sdp",
+    ipsec_ifname: "{{ slap_configuration.get('tun-name') }}-ims",
+    ipsec_netns: "{{ slap_configuration.get('tun-name') }}-ims-netns",
+
+    mt_call_sdp_file: "{{ directory['etc'] }}/mt_call_qos.sdp",
 
     ue_db_filename: "{{ directory['var'] }}/lte_ue_ims.db",
 }

software/ors-amarisoft/config/mme.jinja2.cfg

+{%- set tun_ipv6_start = int(netaddr.IPAddress(slap_configuration.get('tun-ipv6-addr', ''))) %}
+{%- set tun_ipv6_end   = netaddr.IPNetwork(slap_configuration.get('tun-ipv6-network')).last  %}
+{%- set tun_ipv4_start = int(netaddr.IPAddress(slap_configuration.get('tun-ipv4-addr', ''))) %}
+{%- set tun_ipv4_end   = netaddr.IPNetwork(slap_configuration.get('tun-ipv4-network')).last  %}
 {
   log_options: "all.level=error,all.max_size=0,nas.level=debug,nas.max_size=1,s1ap.level=debug,s1ap.max_size=1,ngap.level=debug,ngap.max_size=1,file.rotate=1G,file.path=/dev/null",
   log_filename: "{{ directory['log'] }}/mme.log",
@@ -26,6 +30,7 @@
   ],
 
   rx: {
+    bind_addr: "127.0.1.100",
     qci: {audio: 1, video: 2},
   },
 
@@ -44,17 +49,16 @@
   ims_list: [
     {
       ims_addr: "{{ slap_configuration['configuration.ims_addr'] }}",
-      bind_addr: "{{  slap_configuration['configuration.ims_bind'] }}"
+      bind_addr: "{{  slap_configuration['configuration.ims_bind'] }}",
     }
   ],
 
   pdn_list: [
     {
-
 {% if slap_configuration.get('tun-ipv6-network', '') %}
       pdn_type: "ipv4v6",
-      first_ipv6_prefix: "{{ netaddr.IPAddress(slap_configuration.get('tun-ipv6-addr', '')) + 1 }}",
-      last_ipv6_prefix: "{{ netaddr.IPAddress(netaddr.IPNetwork(slap_configuration.get('tun-ipv6-network', '')).last) - 1 }}",
+      first_ipv6_prefix: "{{ netaddr.IPAddress(tun_ipv6_start + 1)                       }}",
+      last_ipv6_prefix:  "{{ netaddr.IPAddress((tun_ipv6_start + tun_ipv6_end) // 2 - 1) }}",
 {% if slapparameter_dict.get('local_domain', '') %}
       dns_addr:  ["{{ slap_configuration.get('tun-ipv4-addr', '') }}"],
 {% else %}
@@ -64,15 +68,43 @@
       pdn_type: "ipv4",
       dns_addr: "8.8.8.8",
 {% endif %}
-
       tun_ifname: "{{ slap_configuration.get('tun-name', '') }}",
-      access_point_name: ["default", "internet", "ims", "sos"],
+      access_point_name: ["default", "internet", "sos"],
 {% if slap_configuration.get('tun-name', '') %}
-      first_ip_addr: "{{ netaddr.IPAddress(netaddr.IPNetwork(slap_configuration.get('tun-ipv4-network', '')).first) + 2 }}",
-      last_ip_addr: "{{ netaddr.IPAddress(netaddr.IPNetwork(slap_configuration.get('tun-ipv4-network', '')).last) - 1 }}",
+      first_ip_addr: "{{ netaddr.IPAddress(tun_ipv4_start + 1)                       }}",
+      last_ip_addr:  "{{ netaddr.IPAddress((tun_ipv4_start + tun_ipv4_end) // 2 - 2) }}",
 {% endif %}
 
-      p_cscf_addr: ["{{ slap_configuration.get('tun-ipv4-addr', '') }}"],
+      erabs: [
+        {
+          qci: 9,
+          priority_level: 15,
+          pre_emption_capability: "shall_not_trigger_pre_emption",
+          pre_emption_vulnerability: "not_pre_emptable",
+        },
+      ],
+    },
+    {
+{% if slap_configuration.get('tun-ipv6-network', '') %}
+      pdn_type: "ipv4v6",
+      first_ipv6_prefix: "{{ netaddr.IPAddress((tun_ipv6_start + tun_ipv6_end) // 2) }}",
+      last_ipv6_prefix:  "{{ netaddr.IPAddress(tun_ipv6_end - 1)                     }}",
+{% if slapparameter_dict.get('local_domain', '') %}
+      dns_addr:  ["{{ slap_configuration.get('tun-ipv4-addr', '') }}"],
+{% else %}
+      dns_addr: ["8.8.8.8", "2001:4860:4860::8888"],
+{% endif %}
+{% else %}
+      pdn_type: "ipv4",
+      dns_addr: "8.8.8.8",
+{% endif %}
+      tun_ifname: "{{ slap_configuration.get('tun-name', '') }}-1",
+      access_point_name: "ims",
+{% if slap_configuration.get('tun-name', '') %}
+      first_ip_addr: "{{ netaddr.IPAddress((tun_ipv4_start + tun_ipv4_end) // 2 + 2) }}",
+      last_ip_addr:  "{{ netaddr.IPAddress(tun_ipv4_end - 1)                     }}",
+{% endif %}
+      p_cscf_addr: ["{{ netaddr.IPAddress((tun_ipv4_start + tun_ipv4_end) // 2) + 1 }}", "{{ netaddr.IPAddress((tun_ipv6_start + tun_ipv6_end) // 2) }}"],
 
       erabs: [
         {

software/ors-amarisoft/config/mt_call_qos.jinja2.sdp

+v=0
+o=Amarisoft-IMS 0 0 IN IP4 0.0.0.0
+s=Amarisoft-IMS
+c=IN IP4 0.0.0.0
+t=0 0
+m=audio 10000 RTP/AVP 116
+c=IN IP4 0.0.0.0
+b=AS:41
+b=RR:0
+b=RS:0
+a=rtpmap:116 AMR-WB/16000/1
+a=fmtp:116 mode-change-capability=2; max-red=0
+a=curr:qos local none
+a=curr:qos remote none
+a=des:qos mandatory local sendrecv
+a=des:qos mandatory remote sendrecv
+a=ptime:20
+a=maxptime:220
+a=sendrecv

software/ors-amarisoft/instance-core-network.jinja2.cfg

@@ -70,6 +70,9 @@ parts =
   directory
   mme-config
   mme-service
+  ims-config
+  mt-call-config
+  ims-service
   monitor-base
   check-interface-up.py
   publish-connection-information
@@ -135,25 +138,34 @@ service = ${:etc}/service
 promise = ${:etc}/promise
 log = ${:var}/log
 
-{% if slapparameter_dict.get("mme_config_link", None) %}
-[mme-config-dl]
-recipe = slapos.recipe.build:download
-url = {{ slapparameter_dict.get("mme_config_link") }}
-version = {{ slapparameter_dict.get("mme_config_version") }}
-offline = false
+[ims-sh-wrapper]
+recipe = slapos.recipe.template
+output = ${directory:bin}/${:_buildout_section_name_}
+ims-log = ${directory:log}/ims-output.log
+inline =
+  #!/bin/sh
+{% if not slapparameter_dict.get("testing", False) %}
+  (echo && echo && date "+[%Y/%m/%d %T.%N %Z] Starting IMS software..." && echo) >> ${:ims-log};
+  tail -c 1M ${:ims-log} > ${:ims-log}.tmp;
+  mv ${:ims-log}.tmp ${:ims-log};
+  {{ ims }}/lteims ${directory:etc}/ims.cfg >> ${:ims-log} 2>> ${:ims-log};
 {% endif %}
 
 ### IMS
 [ims-service]
 recipe = slapos.cookbook:wrapper
-command-line = {{ mme }}/lteims ${directory:etc}/ims.cfg
+command-line = ${ims-sh-wrapper:output}
 wrapper-path = ${directory:service}/ims
 mode = 0775
 pidfile = ${directory:run}/ims.pid
 hash-files =
   ${ims-config:output}
+  ${mt-call-config:output}
   ${ue-db-config:output}
-environment = AMARISOFT_PATH=/opt/amarisoft/.amarisoft
+  ${ims-sh-wrapper:output}
+environment =
+  LD_LIBRARY_PATH={{ openssl_location }}/lib:{{ nghttp2_location }}/lib
+  AMARISOFT_PATH=/opt/amarisoft/.amarisoft
 
 [mme-sh-wrapper]
 recipe = slapos.recipe.template
@@ -162,6 +174,7 @@ mme-log = ${directory:log}/mme-output.log
 inline =
   #!/bin/sh
 {% if not slapparameter_dict.get("testing", False) %}
+  sudo -n /opt/amarisoft/init-mme;
   rm -f ${directory:var}/lte_ue.db;
   (echo && echo && date "+[%Y/%m/%d %T.%N %Z] Starting MME software..." && echo) >> ${:mme-log};
   tail -c 1M ${:mme-log} > ${:mme-log}.tmp;
@@ -229,6 +242,11 @@ context =
 url = {{ ims_template }}
 output = ${directory:etc}/ims.cfg
 
+[mt-call-config]
+<= config-base
+url = {{ mt_call_template }}
+output = ${directory:etc}/mt_call_qos.sdp
+
 [ue-db-config]
 <= config-base
 url = {{ ue_db_template }}

software/ors-amarisoft/instance.cfg

@@ -91,7 +91,7 @@ init =
   options['sdr'] = path + "/trx_sdr"
   options['enb'] = path + "/enb"
   options['mme'] = path + "/mme"
-  options['ims'] = path + "/ims"
+  options['ims'] = path + "/mme"
   options['ue'] = path + "/ue"
   import os
   lte_expiration = "Unknown"
@@ -187,10 +187,13 @@ extra-context =
     key lte_version amarisoft:lte-version
     key lte_expiration amarisoft:lte-expiration
     key mme amarisoft:mme
+    key ims amarisoft:ims
     raw mme_template   ${mme.jinja2.cfg:target}
     raw dnsmasq_template   ${dnsmasq-core-network.jinja2.cfg:target}
     raw ims_template   ${ims.jinja2.cfg:target}
     raw ue_db_template ${ue_db.jinja2.cfg:target}
+    raw mt_call_template ${mt_call_qos.jinja2.sdp:target}
+    raw netcapdo ${netcapdo:exe}
     raw openssl_location ${openssl:location}
     raw nghttp2_location ${nghttp2:location}
     raw iperf3_location ${iperf3:location}

software/ors-amarisoft/software.cfg

@@ -35,6 +35,7 @@ parts +=
   drb_lte.jinja2.cfg
   drb_nr.jinja2.cfg
   sib23.jinja2.asn
+  mt_call_qos.jinja2.sdp
   monitor-httpd-extra-conf
 # copy all gadget file
   gadget
@@ -114,6 +115,8 @@ filename = enb.jinja2.cfg
 [sib23.jinja2.asn]
 <= copy-config-to-instance
 filename = sib23.jinja2.asn
+[mt_call_qos.jinja2.sdp]
+<= copy-config-to-instance
 [ue_db.jinja2.cfg]
 <= copy-config-to-instance
 filename = ue_db.jinja2.cfg