From e5875001247e6a6ac4f474157a51a8c54f94ae49 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 14 Mar 2013 16:01:25 +0100 Subject: Convert XML files to UTF-8 --- lib/diameter/doc/src/book.xml | 4 ++-- lib/diameter/doc/src/diameter.xml | 2 +- lib/diameter/doc/src/diameter_app.xml | 2 +- lib/diameter/doc/src/diameter_codec.xml | 4 ++-- lib/diameter/doc/src/diameter_compile.xml | 2 +- lib/diameter/doc/src/diameter_dict.xml | 2 +- lib/diameter/doc/src/diameter_examples.xml | 4 ++-- lib/diameter/doc/src/diameter_intro.xml | 4 ++-- lib/diameter/doc/src/diameter_make.xml | 2 +- lib/diameter/doc/src/diameter_sctp.xml | 2 +- lib/diameter/doc/src/diameter_soc.xml | 2 +- lib/diameter/doc/src/diameter_soc_rfc6733.xml | 4 ++-- lib/diameter/doc/src/diameter_tcp.xml | 2 +- lib/diameter/doc/src/diameter_transport.xml | 2 +- lib/diameter/doc/src/diameter_using.xml | 4 ++-- lib/diameter/doc/src/notes.xml | 2 +- lib/diameter/doc/src/ref_man.xml | 4 ++-- lib/diameter/doc/src/user_man.xml | 4 ++-- 18 files changed, 26 insertions(+), 26 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/book.xml b/lib/diameter/doc/src/book.xml index 960296528b..7b606c84d0 100644 --- a/lib/diameter/doc/src/book.xml +++ b/lib/diameter/doc/src/book.xml @@ -1,11 +1,11 @@ - +
-2011 +20112013 Ericsson AB. All Rights Reserved. diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 318c98f786..77d2381d2e 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -1,4 +1,4 @@ - + erlang:nodes/0'> diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index d4fb792787..36a560b33c 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -1,4 +1,4 @@ - + message()'> + diameter_dict(4)'> @@ -13,7 +13,7 @@
-2012 +20122013 Ericsson AB. All Rights Reserved. diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml index fc81e4efed..65228c7c7a 100644 --- a/lib/diameter/doc/src/diameter_compile.xml +++ b/lib/diameter/doc/src/diameter_compile.xml @@ -1,4 +1,4 @@ - + dictionary file'> diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index 419dc143af..becac23278 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -1,4 +1,4 @@ - + FILE FORMAT'> diff --git a/lib/diameter/doc/src/diameter_examples.xml b/lib/diameter/doc/src/diameter_examples.xml index 1fd7755695..7808d64b8d 100644 --- a/lib/diameter/doc/src/diameter_examples.xml +++ b/lib/diameter/doc/src/diameter_examples.xml @@ -1,11 +1,11 @@ - +
-20112012 +20112013 Ericsson AB. All Rights Reserved. diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml index fd578ccf45..4788fcc7b8 100644 --- a/lib/diameter/doc/src/diameter_intro.xml +++ b/lib/diameter/doc/src/diameter_intro.xml @@ -1,4 +1,4 @@ - + %also; @@ -7,7 +7,7 @@
-20112012 +20112013 Ericsson AB. All Rights Reserved. diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index ec71251be1..c9023fd8fb 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -1,4 +1,4 @@ - + file:name()'> diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index df140b16b9..5e65e8dad7 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -1,4 +1,4 @@ - + gen_sctp(3)'> + %also; diff --git a/lib/diameter/doc/src/diameter_soc_rfc6733.xml b/lib/diameter/doc/src/diameter_soc_rfc6733.xml index 8d85569650..d7f69c4818 100644 --- a/lib/diameter/doc/src/diameter_soc_rfc6733.xml +++ b/lib/diameter/doc/src/diameter_soc_rfc6733.xml @@ -1,9 +1,9 @@ - + +
diameter 1.4.3 + +
Fixed Bugs and Malfunctions + + +

+ Fix UTF8String encode.

+

+ Encode now accepts any nested list of codepoints and + binaries. A list containing a binary was previously + misinterpreted and the documentation was incomplete.

+

+ Own Id: OTP-11172

+ + +

+ Ensure DWR isn't sent immediately after DWA.

+

+ This was possible if the timing was unfortunate. An + incoming DWR now properly resets the watchdog timer.

+

+ Own Id: OTP-11184

+ + +

+ Fix faulty encode of Failed-AVP

+

+ Reception of a CER, DWR or DPR that has decode failures + caused encode of the corresponding answer message to + fail.

+

+ Own Id: OTP-11293

+ + +

+ Fix broken service_opt() spawn_opt.

+

+ The option was ignored.

+

+ Own Id: OTP-11299

+ + +
+ +
+
diameter 1.4.2
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 059109a20023043aca767b6f208f9c812c42eb20 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 4 Nov 2013 09:34:07 +0100 Subject: Update release notes --- lib/diameter/doc/src/notes.xml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index 32082e565d..cf87a13225 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,36 @@ first.

+
diameter 1.4.4 + +
Known Bugs and Problems + + +

+ Fix setting of End-to-End and Hop-by-Hop Identifiers in + outgoing DWA.

+

+ Broken by OTP-11184, which caused the identifiers to be + set anew, discarding the values from the incoming DWR.

+

+ Own Id: OTP-11367

+ + +

+ Fix handling of 5014, DIAMETER_INVALID_AVP_LENGTH.

+

+ The error was detected as 5004, + DIAMETER_INVALID_AVP_VALUE, for some Diameter types, in + which case an AVP length that pointed past the end of a + message resulted in encode failure.

+

+ Own Id: OTP-11395

+ + +
+ +
+
diameter 1.4.3
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 265c88664b93f9069c86bf6c25e5d07b7f41d2dc Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Mon, 23 Sep 2013 10:31:21 +0200 Subject: Extend diameter_make:codec/2 Function can now take a literal dictionary as input, instead of a path, and can return results instead of writing them to the filesystem. --- lib/diameter/doc/src/diameter_make.xml | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index ec71251be1..2e69fca1ae 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -64,12 +64,15 @@ interface.

-codec(Path::string(), [Opt]) -> ok | {error, Reason} +codec(File :: iolist() | binary(), [Opt]) -> ok | {ok, Ret} | {error, Reason} Compile a dictionary file into Erlang source.

Compile a single dictionary file to Erlang source. +The input File can be either a path or a literal dictionary, +the occurrence of newline (ascii NL) or carriage return (ascii CR) +identifying the latter. Opt can have the following types.

@@ -93,6 +96,13 @@ Write generated source to the specified directory. Defaults to the current working directory.

+return + +

+Return erl and hrl source as two iolists rather than writing them to +the filesystem.

+ + {name|prefix, string()}

@@ -127,6 +137,13 @@ Multiple inherits options can be specified.

 +

+Note that a dictionary's &dict_name;, together with the +outdir option, determine the output paths when the +return option is not specified. +The &dict_name; of a literal input dictionary defaults to +dictionary.

+ -- cgit v1.2.3 From 6ddc5e7333ed60beca93a94d3ab0c302dcc472e2 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 29 Nov 2013 17:08:29 +0100 Subject: Fix documentation typos --- lib/diameter/doc/src/diameter.xml | 14 +++++++------- lib/diameter/doc/src/diameter_app.xml | 4 ++-- lib/diameter/doc/src/diameter_codec.xml | 8 ++++---- lib/diameter/doc/src/diameter_compile.xml | 4 ++-- lib/diameter/doc/src/diameter_dict.xml | 2 +- lib/diameter/doc/src/diameter_intro.xml | 4 ++-- lib/diameter/doc/src/diameter_make.xml | 2 +- lib/diameter/doc/src/diameter_sctp.xml | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index db19fbb271..8740f7f4d2 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -575,7 +575,7 @@ The RFC 3539 watchdog state machine has transitioned into (up) or out of (down) the OKAY state. If a #diameter_packet{} is present in an up event -then there has been a capabilties exchange on a newly established +then there has been a capabilities exchange on a newly established transport connection and the record contains the received CER or CEA. Otherwise a connection has reestablished without the loss or connectivity.

@@ -584,7 +584,7 @@ connectivity.

Note that a single up or down event for a given peer corresponds to multiple &app_peer_up; or &app_peer_down; callbacks, one for each of the Diameter applications negotiated during -capablilities exchange. +capabilities exchange. That is, the event communicates connectivity with the peer as a whole while the callbacks communicate connectivity with respect to individual Diameter applications.

@@ -765,7 +765,7 @@ the application's &dictionary; file.

The capabilities advertised by a node must match its configured applications. In particular, application configuration must be matched by corresponding &capability; configuration, of -Application-Id AVP's in particular.

+*-Application-Id AVPs in particular.

@@ -804,7 +804,7 @@ Defaults to nodes.

Specifies a constant value H for the topmost 32-N bits of of 32-bit End-to-End and Hop-by-Hop identifiers generated -by the service, either explicity or as a return value of a function +by the service, either explicitly or as a return value of a function to be evaluated at &start_service;. In particular, an identifier Id is mapped to a new identifier as follows.

@@ -946,7 +946,7 @@ Applications not configured on the service in question are ignored.

The capabilities advertised by a node must match its configured applications. In particular, setting applications on a transport typically -implies having to set matching Application-Id AVP's in a +implies having to set matching *-Application-Id AVPs in a &capabilities; tuple.

@@ -956,7 +956,7 @@ implies having to set matching Application-Id AVP's in a {capabilities, [&capability;]}

-AVP's used to construct outgoing CER/CEA messages. +AVPs used to construct outgoing CER/CEA messages. Values take precedence over any specified on the service in question.

@@ -1661,7 +1661,7 @@ R_Flag}.

Note that watchdog, peer, apps, caps and port entries depend on connectivity with the peer and may not be present. -Note also that the statistics entry presents values acuumulated +Note also that the statistics entry presents values accumulated during the lifetime of the transport configuration.

diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index e6c9cc9a90..0b6839dcb2 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -308,7 +308,7 @@ The return value {Peer, NewState} is only allowed if the Diameter application in question was configured with the &mod_application_opt; {call_mutates_state, true}. Otherwise, the State argument is always -the intial value as configured on the application, not any subsequent +the initial value as configured on the application, not any subsequent value returned by a &peer_up; or &peer_down; callback.

@@ -565,7 +565,7 @@ Equivalent to

where Avps sets the Origin-Host, Origin-Realm, the specified -Result-Code and (if the request contained one) Session-Id AVP's, and +Result-Code and (if the request contained one) Session-Id AVPs, and possibly Failed-AVP as described below.

diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml index 4a77d5435b..9d26466b25 100644 --- a/lib/diameter/doc/src/diameter_codec.xml +++ b/lib/diameter/doc/src/diameter_codec.xml @@ -13,7 +13,7 @@

-2012 +20122013 Ericsson AB. All Rights Reserved. @@ -73,7 +73,7 @@ are defined in diameter.hrl, which can be included as follows.

-Application-specific records are definied in the hrl +Application-specific records are defined in the hrl files resulting from dictionary file compilation.

@@ -122,7 +122,7 @@ Fields have the following types.

Values in the AVP header, corresponding to AVP Code, the M flag, P -flags and Vendor-ID respectivelty. +flags and Vendor-ID respectively. A Vendor-ID other than undefined implies a set V flag.

 @@ -222,7 +222,7 @@ header.

is_retransmitted = boolean()

-Values correspoding to the R(equest), P(roxiable), E(rror) +Values corresponding to the R(equest), P(roxiable), E(rror) and T(Potentially re-transmitted message) flags of the Diameter header.

 diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml index 6630019e5c..820bde6986 100644 --- a/lib/diameter/doc/src/diameter_compile.xml +++ b/lib/diameter/doc/src/diameter_compile.xml @@ -41,7 +41,7 @@ supplied. The diameterc utility is used to compile a diameter &dictionary; into Erlang source. The resulting source implements the interface diameter required -to encode and decode the dictionary's messages and AVP's.

+to encode and decode the dictionary's messages and AVPs.

The module &man_make; provides an alternate compilation interface.

@@ -83,7 +83,7 @@ Defaults to the current working directory.

-Supress erl and hrl generation, respectively.

+Suppress erl and hrl generation, respectively.

 ]]> diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index 8bf4a14240..4f51a12ebc 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -431,7 +431,7 @@ equivalent to specifying it with @avp_vendor_id.

Defines values of AVP Name having type Enumerated. Section content consists of names and corresponding integer values. Integer values can be prefixed with 0x to be interpreted as -hexidecimal.

+hexadecimal.

Note that the AVP in question can be defined in an inherited diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml index 288ebc0c7c..6c1d1910d2 100644 --- a/lib/diameter/doc/src/diameter_intro.xml +++ b/lib/diameter/doc/src/diameter_intro.xml @@ -40,7 +40,7 @@ under the License. The diameter application is an implementation of the Diameter protocol as defined by &the_rfc;. It supports arbitrary Diameter applications by way of a -dictionary interface that allows messages and AVP's to be +dictionary interface that allows messages and AVPs to be defined and input into diameter as configuration. It has support for all roles defined in the RFC: client, server and agent. @@ -69,7 +69,7 @@ interface.

While a service typically implements a single Diameter node (as identified by an Origin-Host AVP), transports can themselves be -associated with capabilities AVP's so that a single service can be +associated with capabilities AVPs so that a single service can be used to implement more than one Diameter node.

diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index ec71251be1..83ef42552a 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -51,7 +51,7 @@ under the License. The function &codec; is used to compile a diameter &dictionary; into Erlang source. The resulting source implements the interface diameter required -to encode and decode the dictionary's messages and AVP's.

+to encode and decode the dictionary's messages and AVPs.

The utility &man_compile; provides an alternate compilation diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 5fe14b1ef6..2be77e3dfd 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -90,7 +90,7 @@ Options raddr and rport specify the remote address and port for a connecting transport and not valid for a listening transport: the former is required while latter defaults to 3868 if unspecified. -Mupltiple raddr options can be specified, in which case the +Multiple raddr options can be specified, in which case the connecting transport in question attempts each in sequence until an association is established.

-- cgit v1.2.3 From abea7186dd2590a0283396e94cf03dfb087277e5 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 29 Nov 2013 18:44:41 +0100 Subject: Rename reconnect_timer -> connect_timer The former was misleading since the timer only applies to initial connection attempts, reconnection attempts being governed by watchdog_timer. The name is a historic remnant from a (dark, pre-OTP) time in which RFC 3539 was followed less slavishly than it is now, and the timer actually did apply to reconnection attempts. Note that connect_timer corresponds to RFC 6733 Tc, while watchdog_timer corresponds to RFC 3539 TwInit. The latter RFC makes clear that TwInit should apply to reconnection attempts. It's less clear if only RFC 6733 is read. Note also that reconnect_timer is still accepted for backwards compatibility. It would be possible to add an option to make reconnect_timer behave strictly as the name suggests (ie. ignore RFC 3539 and interpret RFC 6733 at face value; something that has some value for testing at least) but no such option is implemented in this commit. --- lib/diameter/doc/src/diameter.xml | 64 +++++++++++++-------------- lib/diameter/doc/src/diameter_soc_rfc6733.xml | 2 +- lib/diameter/doc/src/seealso.ent | 2 +- 3 files changed, 34 insertions(+), 34 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index db19fbb271..06278d1a55 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -599,7 +599,7 @@ Opts = [&transport_opt;]

A connecting transport is attempting to establish/reestablish a -transport connection with a peer following &reconnect_timer; or +transport connection with a peer following &connect_timer; or &watchdog_timer; expiry.

@@ -1022,13 +1022,43 @@ The number of milliseconds after which a transport process having an established transport connection will be terminated if the expected capabilities exchange message (CER or CEA) is not received from the peer. For a connecting transport, the timing of reconnection attempts is -governed by &watchdog_timer; or &reconnect_timer; expiry. +governed by &watchdog_timer; or &connect_timer; expiry. For a listening transport, the peer determines the timing.

Defaults to 10000.

+ +{connect_timer, Tc} + +
+Tc = &dict_Unsigned32;
+
+ +

+For a connecting transport, the &the_rfc; Tc timer, in milliseconds. +Note that this timer determines the frequency with which a transport +will attempt to establish an initial connection with its peer +following transport configuration: once an initial connection has been +established it's &watchdog_timer; that determines the frequency of +reconnection attempts, as required by RFC 3539.

+ +

+For a listening transport, the timer specifies the time after which a +previously connected peer will be forgotten: a connection after this time is +regarded as an initial connection rather than a reestablishment, +causing the RFC 3539 state machine to pass to state OKAY rather than +REOPEN. +Note that these semantics are not governed by the RFC and +that a listening transport's &connect_timer; should be greater +than its peer's Tw plus jitter.

+ +

+Defaults to 30000 for a connecting transport and 60000 for a listening +transport.

+ + {disconnect_cb, &evaluable;} @@ -1145,36 +1175,6 @@ See &man_tcp; for the behaviour of that module.

- -{reconnect_timer, Tc} - -
-Tc = &dict_Unsigned32;
-
- -

-For a connecting transport, the &the_rfc; Tc timer, in milliseconds. -Note that this timer determines the frequency with which a transport -will attempt to establish a connection with its peer only before -an initial connection is established: once there is an initial -connection it's &watchdog_timer; that determines the -frequency of reconnection attempts, as required by RFC 3539.

- -

-For a listening transport, the timer specifies the time after which a -previously connected peer will be forgotten: a connection after this time is -regarded as an initial connection rather than a reestablishment, -causing the RFC 3539 state machine to pass to state OKAY rather than -REOPEN. -Note that these semantics are not governed by the RFC and -that a listening transport's &reconnect_timer; should be greater -than its peer's Tw plus jitter.

- -

-Defaults to 30000 for a connecting transport and 60000 for a listening -transport.

- - {spawn_opt, [term()]} diff --git a/lib/diameter/doc/src/diameter_soc_rfc6733.xml b/lib/diameter/doc/src/diameter_soc_rfc6733.xml index 8d85569650..deb4d05b0f 100644 --- a/lib/diameter/doc/src/diameter_soc_rfc6733.xml +++ b/lib/diameter/doc/src/diameter_soc_rfc6733.xml @@ -1272,7 +1272,7 @@ during capabilities exchange.)

The frequency of reconnection attempts is configured with the -&mod_transport_opt; reconnect_timer and +&mod_transport_opt; connect_timer and watchdog_timer.

diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index 76b9823f79..3ec13477ab 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -66,7 +66,7 @@ significant.
 disconnect_cb'>
 transport_config'>
 transport_module'>
-reconnect_timer'>
+connect_timer'>
 watchdog_timer'>
 
 
-- 
cgit v1.2.3


From fce38d77ec95261ec7ae3694d0b5db91f1cb39c2 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Sat, 30 Nov 2013 20:02:12 +0100
Subject: Generate diameterc.1, not diameter_compile.1

---
 lib/diameter/doc/src/diameter_compile.xml | 149 ------------------------------
 lib/diameter/doc/src/diameterc.xml        | 149 ++++++++++++++++++++++++++++++
 lib/diameter/doc/src/files.mk             |   2 +-
 lib/diameter/doc/src/ref_man.xml          |   4 +-
 4 files changed, 152 insertions(+), 152 deletions(-)
 delete mode 100644 lib/diameter/doc/src/diameter_compile.xml
 create mode 100644 lib/diameter/doc/src/diameterc.xml

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml
deleted file mode 100644
index 820bde6986..0000000000
--- a/lib/diameter/doc/src/diameter_compile.xml
+++ /dev/null
@@ -1,149 +0,0 @@
-
-dictionary file'>
-  
-  
-  %also;
-  %here;
-]>
-
-
-

-
-20112013
-Ericsson AB. All Rights Reserved.
-
-
-
-The program may be used and/or copied only with the written permission
-from Ericsson AB, or in accordance with the terms and conditions
-stipulated in the agreement/contract under which the program has been
-supplied.
-
-
-
-diameterc(1)
-
-
-
-
-
-diameter_compile.xml
-

-
-diameterc
-] ]]>
-
-
-
-

-The diameterc utility is used to compile a diameter
-&dictionary; into Erlang source.
-The resulting source implements the interface diameter required
-to encode and decode the dictionary's messages and AVPs.

-
-

-The module &man_make; provides an alternate compilation interface.

-
-
-
-

-USAGE
-
-
-
-] ]]>
-
-

-Compile a single dictionary file to Erlang source.
-Valid options are as follows.

-
-
-]]>
-
-

-Prepend the specified directory to the code path.
-Use to point at beam files compiled from inherited dictionaries,
-&dict_inherits; in a dictionary file creating a beam
-dependency, not an erl/hrl dependency.

-
-

-Multiple -i options can be specified.

-
-
-]]>
-
-

-Write generated source to the specified directory.
-Defaults to the current working directory.

-
-
-
-
-
-

-Suppress erl and hrl generation, respectively.

-
-
-]]>
-]]>
-
-

-Transform the input dictionary before compilation, setting
-&dict_name; or &dict_prefix; to the specified
-string.

-
-
-]]>
-
-

-Transform the input dictionary before compilation, appending
-&dict_inherits; of the specified string.

-
-

-Two forms of --inherits have special meaning:

-
-
---inherits -
---inherits Prev/Mod
-

-
-

-The first has the effect of clearing any previous inherits, the second
-of replacing a previous inherits of Prev to one of Mod.
-This allows the semantics of the input dictionary to be changed without
-modifying the file itself.

-
-

-Multiple --inherits options can be specified.

-
-
-
-
-
-
-
-

-
-
-
-

-EXIT STATUS
-
-

-Returns 0 on success, non-zero on failure.

-
-

-
-
-
-

-SEE ALSO
-
-

-&man_make;, &man_dict;

-
-

-
-
diff --git a/lib/diameter/doc/src/diameterc.xml b/lib/diameter/doc/src/diameterc.xml
new file mode 100644
index 0000000000..039f4f9cdd
--- /dev/null
+++ b/lib/diameter/doc/src/diameterc.xml
@@ -0,0 +1,149 @@
+
+dictionary file'>
+  
+  
+  %also;
+  %here;
+]>
+
+
+

+
+20112013
+Ericsson AB. All Rights Reserved.
+
+
+
+The program may be used and/or copied only with the written permission
+from Ericsson AB, or in accordance with the terms and conditions
+stipulated in the agreement/contract under which the program has been
+supplied.
+
+
+
+diameterc(1)
+
+
+
+
+
+diameterc.xml
+

+
+diameterc
+] ]]>
+
+
+
+

+The diameterc utility is used to compile a diameter
+&dictionary; into Erlang source.
+The resulting source implements the interface diameter required
+to encode and decode the dictionary's messages and AVPs.

+
+

+The module &man_make; provides an alternate compilation interface.

+
+
+
+

+USAGE
+
+
+
+] ]]>
+
+

+Compile a single dictionary file to Erlang source.
+Valid options are as follows.

+
+
+]]>
+
+

+Prepend the specified directory to the code path.
+Use to point at beam files compiled from inherited dictionaries,
+&dict_inherits; in a dictionary file creating a beam
+dependency, not an erl/hrl dependency.

+
+

+Multiple -i options can be specified.

+
+
+]]>
+
+

+Write generated source to the specified directory.
+Defaults to the current working directory.

+
+
+
+
+
+

+Suppress erl and hrl generation, respectively.

+
+
+]]>
+]]>
+
+

+Transform the input dictionary before compilation, setting
+&dict_name; or &dict_prefix; to the specified
+string.

+
+
+]]>
+
+

+Transform the input dictionary before compilation, appending
+&dict_inherits; of the specified string.

+
+

+Two forms of --inherits have special meaning:

+
+
+--inherits -
+--inherits Prev/Mod
+

+
+

+The first has the effect of clearing any previous inherits, the second
+of replacing a previous inherits of Prev to one of Mod.
+This allows the semantics of the input dictionary to be changed without
+modifying the file itself.

+
+

+Multiple --inherits options can be specified.

+
+
+
+
+
+
+
+

+
+
+
+

+EXIT STATUS
+
+

+Returns 0 on success, non-zero on failure.

+
+

+
+
+
+

+SEE ALSO
+
+

+&man_make;, &man_dict;

+
+

+
+
diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk
index 510786a7fb..6e8b1f9068 100644
--- a/lib/diameter/doc/src/files.mk
+++ b/lib/diameter/doc/src/files.mk
@@ -21,7 +21,7 @@ XML_APPLICATION_FILES = \
 	ref_man.xml
 
 XML_REF1_FILES = \
-	diameter_compile.xml
+	diameterc.xml
 
 XML_REF3_FILES = \
 	diameter.xml \
diff --git a/lib/diameter/doc/src/ref_man.xml b/lib/diameter/doc/src/ref_man.xml
index 4b99fe716d..1095887144 100644
--- a/lib/diameter/doc/src/ref_man.xml
+++ b/lib/diameter/doc/src/ref_man.xml
@@ -6,7 +6,7 @@
 

 
 2011
-2012
+2013
 Ericsson AB. All Rights Reserved.
 
 
@@ -39,7 +39,7 @@ applications on top of the Diameter protocol. 

 
 
 
-
+
 
 
 
-- 
cgit v1.2.3


From 743773a87e24db2ba0f0222bcf4dcaba7ae7adcf Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Thu, 10 Oct 2013 10:47:45 +0200
Subject: Document diameter_make:format/1 and diameter_make:flatten/1

---
 lib/diameter/doc/src/diameter_make.xml | 78 ++++++++++++++++++++++++++++------
 lib/diameter/doc/src/seealso.ent       |  2 +
 2 files changed, 68 insertions(+), 12 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index 2e69fca1ae..c8c0f2fbc7 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -64,19 +64,48 @@ interface.

 
 
 
-codec(File :: iolist() | binary(), [Opt]) -> ok | {ok, Ret} | {error, Reason}
+codec(File :: iolist() | binary(), [Opt]) -> ok
+                                                 | {ok, [Out]}
+                                                 | {error, Reason}
 Compile a dictionary file into Erlang source.
 
 
 

-Compile a single dictionary file to Erlang source.
+Compile a single dictionary file.
 The input File can be either a path or a literal dictionary,
 the occurrence of newline (ascii NL) or carriage return (ascii CR)
 identifying the latter.
-Opt can have the following types.

+Opt determines the format of the results and whether they are
+written to file or returned, and can have the following types.

 
 
 
+parse | forms | erl | hrl | beam
+
+

+Specifies an output format.
+Whether the output is returned or written to file depends on whether
+or not option return is specified.
+When written to file, the resulting file(s) will have extensions
+.D, .F, .erl, .hrl and .beam
+respectively, basenames defaulting to dictionary if the input
+dictionary is literal and does not specify &dict_name;.
+When returned, results are returned in the Out list  in the
+order specified.
+Format options default to erl and hrl (in this order) if
+unspecified.

+
+

+The parsed format is an internal representation that can be
+passed to &format; and &flatten;, while the forms format is
+only intended for debugging purposes.
+Output for the erl and hrl formats are returned as
+iolists, while the beam format returns a {module(),
+binary()} tuple.

+
+
+
 {include, string()}
 
 

@@ -93,14 +122,15 @@ Multiple include options can be specified.

 
 

 Write generated source to the specified directory.
-Defaults to the current working directory.

+Defaults to the current working directory.
+Has no effect if option return is specified.

 
 
 return
 
 

-Return erl and hrl source as two iolists rather than writing them to
-the filesystem.

+Return results in a {ok, [Out]} tuple instead of writing to
+file and returning ok.

 
 
 {name|prefix, string()}
@@ -118,7 +148,7 @@ Transform the input dictionary before compilation, appending
 &dict_inherits; of the specified string.

 
 

-Two forms of @inherits have special meaning:

+Two forms have special meaning:

 
 
 {inherits, "-"}
@@ -147,6 +177,34 @@ The &dict_name; of a literal input dictionary defaults to
 
 
 
+
+
+
+format(Parsed) -> iolist()
+Format a parsed dictionary.
+
+

+Turns a parsed dictionary, as returned by &codec;, back into the
+dictionary format.

+
+
+
+
+
+
+flatten(Parsed) -> term()
+Flatten a parsed dictionary.
+
+
+

+Reconstitute a parsed dictionary, as returned by &codec;, without
+using &dict_inherits;.
+That is, construct an equivalent dictionary in which all AVP's are
+definined in the dictionary itself.
+The return value is also a parsed dictionary.

+
+
+
 
 
 
@@ -155,11 +213,7 @@ The &dict_name; of a literal input dictionary defaults to
 BUGS
 
 

-All options are string-valued.
-In particular, it is not currently possible to specify
-an &dict_inherits; module as an atom(), or a path as an arbitrary
-&filename;

-
+Unrecognized options are silently ignored.
diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent index 76b9823f79..d3305853af 100644 --- a/lib/diameter/doc/src/seealso.ent +++ b/lib/diameter/doc/src/seealso.ent @@ -115,6 +115,8 @@ significant. diameter_make:codec/2'> +diameter_make:format/1'> +diameter_make:flatten/1'> -- cgit v1.2.3 From 2eb76ba556b8775cffc94eac26b448eac70af267 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sun, 1 Dec 2013 14:19:27 +0100 Subject: Return compilable forms instead of beam That is, preprocessed forms that can be passed to compile:forms/1,2. --- lib/diameter/doc/src/diameter_make.xml | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index c8c0f2fbc7..68780b1e05 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -1,5 +1,7 @@ compile:forms/2'> file:name()'> -parse | forms | erl | hrl | beam +parse | forms | erl | hrl

Specifies an output format. Whether the output is returned or written to file depends on whether or not option return is specified. When written to file, the resulting file(s) will have extensions -.D, .F, .erl, .hrl and .beam +.D, .F, .erl, and .hrl respectively, basenames defaulting to dictionary if the input dictionary is literal and does not specify &dict_name;. -When returned, results are returned in the Out list in the -order specified. +When returned, results are in the order of the corresponding format +options. Format options default to erl and hrl (in this order) if unspecified.

-The parsed format is an internal representation that can be -passed to &format; and &flatten;, while the forms format is -only intended for debugging purposes. -Output for the erl and hrl formats are returned as -iolists, while the beam format returns a {module(), -binary()} tuple.

+The parse format is an internal representation that can be +passed to &flatten; and &format;, while the forms format can be +passed to &compile_forms2;. +The erl and hrl formats are returned as +iolists.

 -- cgit v1.2.3 From b92eca6bf8026c97e7a0d54078515a71bfa490dc Mon Sep 17 00:00:00 2001 From: Anthony Ramine Date: Thu, 21 Nov 2013 18:29:09 +0100 Subject: diameter: Fix silent make rule --- lib/diameter/doc/src/Makefile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/Makefile b/lib/diameter/doc/src/Makefile index bd2b6b103a..229812fd08 100644 --- a/lib/diameter/doc/src/Makefile +++ b/lib/diameter/doc/src/Makefile @@ -82,6 +82,7 @@ gifs: $(GIF_FILES:%=$(HTMLDIR)/%) man: $(MAN1_FILES) $(MAN3_FILES) $(MAN4_FILES) $(INDEX_TARGET): $(INDEX_SRC) $(APP_FILE) + $(gen_verbose) \ sed -e 's/%VSN%/$(VSN)/; \ s/%ERLANG_SITE%/www\.erlang\.se\//; \ s/%UP_ONE_LEVEL%/..\/..\/..\/doc\/index.html/; \ @@ -140,7 +141,10 @@ release_spec: depend.mk: depend.sed Makefile seealso.ent \ $(XML_REF_FILES) $(XML_CHAPTER_FILES) + $(gen_verbose) + $(V_at) \ sed -f seehere.sed seealso.ent > seehere.ent + $(V_at) \ (for f in $(XML_REF_FILES) $(XML_CHAPTER_FILES); do \ sed -f $< $$f | sed "s@%FILE%@`basename $$f .xml`@g"; \ done) \ -- cgit v1.2.3 From 771ac5f65170696192a5e8e0c6daa2595dc2f952 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Mon, 2 Dec 2013 17:48:01 +0100 Subject: Assorted doc fixes/tweaks --- lib/diameter/doc/src/diameter.xml | 150 +++++++++++++++++++------------------- 1 file changed, 75 insertions(+), 75 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 726343abb2..9864b21bc5 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -130,7 +130,7 @@ ExtraArgs = list()

A module implementing the callback interface defined in &man_app;, along with any -extra arguments to be appended to those documented for the interface. +extra arguments to be appended to those documented. Note that extra arguments specific to an outgoing request can be specified to &call;, in which case those are are appended to any module-specific extra arguments.

@@ -138,7 +138,7 @@ those are are appended to any module-specific extra arguments.

Specifying a #diameter_callback{} record allows individual functions to be configured in place of the usual &man_app; callbacks. -See that module for details.

+See diameter_callback.erl for details.

@@ -155,7 +155,7 @@ Has one the following types.

{alias, &application_alias;}

-An unique identifier for the application in the scope of the +A unique identifier for the application in the scope of the service. Defaults to the value of the dictionary option if unspecified.

@@ -166,8 +166,8 @@ unspecified.

The name of an encode/decode module for the Diameter messages defined by the application. -These modules are generated from a specification file whose format is -documented in &man_dict;.

+These modules are generated from files whose format is documented in +&man_dict;.

 {module, &application_module;} @@ -195,15 +195,14 @@ Specifies whether or not the &app_pick_peer; application callback can modify the application state. Defaults to false if unspecified.

- +

-&app_pick_peer; callbacks -are serialized when these are allowed to modify state, which is a -potential performance bottleneck. +&app_pick_peer; callbacks are serialized when this option is true, +which is a potential performance bottleneck. A simple Diameter client may suffer no ill effects from using mutable state but a server or agent that responds to incoming request should probably avoid it.

- + {answer_errors, callback|report|discard} @@ -234,7 +233,7 @@ Defaults to report if unspecified.

Determines the manner in which incoming requests are handled when an -error other than 3007, DIAMETER_APPLICATION_UNSUPPORTED (which cannot +error other than 3007 (DIAMETER_APPLICATION_UNSUPPORTED, which cannot be associated with an application callback module), is detected.

@@ -244,7 +243,8 @@ If answer then even 5xxx errors are answered without a callback unless the connection in question has configured the RFC 3588 common dictionary as noted below. If callback then a &app_handle_request; callback always takes -place and the return value determines the answer sent to the peer.

+place and its return value determines the answer sent to the peer, if +any.

Defaults to answer_3xxx if unspecified.

@@ -252,13 +252,14 @@ Defaults to answer_3xxx if unspecified.

Answers sent by diameter set the E-bit in the Diameter Header. -Since RFC 3588 allowed only 3xxx result codes in an +Since RFC 3588 allows only 3xxx result codes in an answer-message, answer has the same semantics as -answer_3xxx if the peer connection in question has configured -the RFC 3588 common dictionary, diameter_gen_base_rfc3588. -RFC 6733 allows both 3xxx and 5xxx result codes in an -answer-message so a connection configured with the RFC 6733 -common dictionary, diameter_gen_base_rfc6733, does +answer_3xxx when the transport in question has +been configured with diameter_gen_base_rfc3588 as its common +dictionary. +Since RFC 6733 allows both 3xxx and 5xxx result codes in an +answer-message, a transport with +diameter_gen_base_rfc6733 as its common dictionary does distinguish between answer_3xxx and answer.

 @@ -291,9 +292,8 @@ Multiple options append to the argument list.

{filter, &peer_filter;}

-A filter to apply to the list of available peers before passing them to -the &app_pick_peer; -callback for the application in question. +A filter to apply to the list of available peers before passing it to +the &app_pick_peer; callback for the application in question. Multiple options are equivalent a single all filter on the corresponding list of filters. Defaults to none.

@@ -312,7 +312,7 @@ Defaults to 5000.

Causes &call; to return ok as soon as the request in -question has been encoded instead of waiting for and returning +question has been encoded, instead of waiting for and returning the result from a subsequent &app_handle_answer; or &app_handle_error; callback.

 @@ -331,8 +331,8 @@ An invalid option will cause &call; to fail.

AVP values sent in outgoing CER or CEA messages during capabilities exchange. -Can be configured both on a service and a transport, values specified -on the latter taking precedence over any specified on the former. +Can be configured both on a service and a transport, values +on the latter taking precedence. Has one of the following types.

@@ -358,7 +358,7 @@ question communicates an address list as described in Origin-State-Id is optional but will be included in outgoing messages sent by diameter itself: CER/CEA, DWR/DWA and DPR/DPA. Setting a value of 0 (zero) is equivalent to not setting a -value as documented in &the_rfc;. +value, as documented in &the_rfc;. The function &origin_state_id; can be used as to retrieve a value that is computed when the diameter application is started.

@@ -370,8 +370,8 @@ application is started.

Inband-Security-Id defaults to the empty list, which is equivalent to a -list containing only 0 (= NO_INBAND_SECURITY). -If 1 (= TLS) is specified then TLS is selected if the CER/CEA received +list containing only 0 (NO_INBAND_SECURITY). +If 1 (TLS) is specified then TLS is selected if the CER/CEA received from the peer offers it.

 @@ -437,38 +437,38 @@ Has one of the following types.

Matches any peer. This is a convenience that provides a filter equivalent to no -filter at all.

+filter.

host

-Matches only those peers whose Origin-Host has the same value -as Destination-Host in the outgoing request in question, +Matches only those peers whose Origin-Host has the same value +as Destination-Host in the outgoing request in question, or any peer if the request does not contain -a Destination-Host AVP.

+a Destination-Host AVP.

 realm

-Matches only those peers whose Origin-Realm has the same value -as Destination-Realm in the outgoing request in question, +Matches only those peers whose Origin-Realm has the same value +as Destination-Realm in the outgoing request in question, or any peer if the request does not contain -a Destination-Realm AVP.

+a Destination-Realm AVP.

 {host, any|&dict_DiameterIdentity;}

-Matches only those peers whose Origin-Host has the +Matches only those peers whose Origin-Host has the specified value, or all peers if the atom any.

 {realm, any|&dict_DiameterIdentity;

-Matches only those peers whose Origin-Realm has the +Matches only those peers whose Origin-Realm has the specified value, or all peers if the atom any.

 @@ -477,7 +477,8 @@ specified value, or all peers if the atom any.

Matches only those peers for which the specified &evaluable; returns -true on the connection's diameter_caps record. +true when applied to the connection's diameter_caps +record. Any other return value or exception is equivalent to false.

@@ -508,10 +509,10 @@ that matches no peer.

-The host and realm filters examine the -outgoing request as passed to &call;, -assuming that this is a record- or list-valued &codec_message;, -and that the message contains at most one of each AVP. +The host and realm filters cause the Destination-Host +and Destination-Realm AVPs to be extracted from the +outgoing request, assuming it to be a record- or list-valued +&codec_message;, and assuming at most one of each AVP. If this is not the case then the {host|realm, &dict_DiameterIdentity;} filters must be used to achieve the desired result. An empty &dict_DiameterIdentity; @@ -555,7 +556,7 @@ Can have one of the following types.

The service is being started or stopped. No event precedes a start event. -No event follows a stop event and this event +No event follows a stop event, and this event implies the termination of all transport processes.

@@ -576,9 +577,8 @@ transitioned into (up) or out of (down) the OKAY state. If a #diameter_packet{} is present in an up event then there has been a capabilities exchange on a newly established -transport connection and the record contains the received CER or CEA. -Otherwise a connection has reestablished without the loss or -connectivity.

+transport connection and the record contains the received CER or +CEA.

Note that a single up or down event for a given peer @@ -627,10 +627,10 @@ CB = &evaluable;

-An incoming CER has been answered with the indicated result code or +An incoming CER has been answered with the indicated result code, or discarded. -Caps contains pairs of values for the local node and remote -peer. +Caps contains pairs of values, for the local node and remote +peer respectively. Pkt contains the CER in question. In the case of rejection by a capabilities callback, the tuple contains the rejecting callback.

@@ -647,7 +647,7 @@ Pkt = #diameter_packet{}

An incoming CER contained errors and has been answered with the indicated result code. -Caps contains only values for the local node. +Caps contains values for the local node only. Pkt contains the CER in question.

@@ -754,7 +754,7 @@ Defines a Diameter application supported by the service.

A service must configure one tuple for each Diameter application it intends to support. -For an outgoing Diameter request, the relevant &application_alias; is +For an outgoing request, the relevant &application_alias; is passed to &call;, while for an incoming request the application identifier in the message header determines the application, the identifier being specified in @@ -778,10 +778,11 @@ be matched by corresponding &capability; configuration, of

Specifies the degree to which the service allows multiple transport -connections to the same peer.

+connections to the same peer, as identified by its Origin-Host +at capabilities exchange.

-If type [node()] then a connection is rejected if another already +If [node()] then a connection is rejected if another already exists on any of the specified nodes. Types false, node, nodes and &evaluable; are equivalent to @@ -803,7 +804,7 @@ Defaults to nodes.

Specifies a constant value H for the topmost 32-N bits of -of 32-bit End-to-End and Hop-by-Hop identifiers generated +of 32-bit End-to-End and Hop-by-Hop Identifiers generated by the service, either explicitly or as a return value of a function to be evaluated at &start_service;. In particular, an identifier Id is mapped to a new identifier @@ -812,11 +813,11 @@ as follows.

(H bsl N) bor (Id band ((1 bsl N) - 1))

-Note that &the_rfc; requires that End-to-End identifiers remain unique +Note that &the_rfc; requires that End-to-End Identifiers remain unique for a period of at least 4 minutes and that this and the call rate -places a lower bound on the appropriate values of N: -at a rate of R requests per second an N-bit counter -traverses all of its values in (1 bsl N) div (R*60) minutes so +places a lower bound on appropriate values of N: +at a rate of R requests per second, an N-bit counter +traverses all of its values in (1 bsl N) div (R*60) minutes, so the bound is 4*R*60 =< 1 bsl N.

N must lie in the range 0..32 and H must be a @@ -829,7 +830,7 @@ Defaults to {0,32}.

Multiple Erlang nodes implementing the same Diameter node should be configured with different sequence masks to ensure that each node -uses a unique range of End-to-End and Hop-by-Hop identifiers for +uses a unique range of End-to-End and Hop-by-Hop Identifiers for outgoing requests.

 @@ -852,7 +853,7 @@ by the specified function, evaluated whenever a peer connection becomes available or a remote service requests information about local connections. The value true is equivalent to fun &nodes;. -The value node() in a node list is ignored, so a collection of +The value node() in a list is ignored, so a collection of services can all be configured to share with the same list of nodes.

@@ -899,7 +900,7 @@ If evaluable() then only peers returned by the specified function are used, evaluated whenever a remote service communicates information about an available peer connection. The value true is equivalent to fun &nodes;. -The value node() in a node list is ignored.

+The value node() in a list is ignored.

Defaults to false.

@@ -1021,8 +1022,8 @@ case the corresponding callbacks are applied until either all return The number of milliseconds after which a transport process having an established transport connection will be terminated if the expected capabilities exchange message (CER or CEA) is not received from the peer. -For a connecting transport, the timing of reconnection attempts is -governed by &watchdog_timer; or &connect_timer; expiry. +For a connecting transport, the timing of connection attempts is +governed by &connect_timer; or &watchdog_timer; expiry. For a listening transport, the peer determines the timing.

@@ -1038,16 +1039,17 @@ Tc = &dict_Unsigned32;

For a connecting transport, the &the_rfc; Tc timer, in milliseconds. -Note that this timer determines the frequency with which a transport -will attempt to establish an initial connection with its peer -following transport configuration: once an initial connection has been -established it's &watchdog_timer; that determines the frequency of +This timer determines the frequency with which a transport +attempts to establish an initial connection with its peer +following transport configuration. +Once an initial connection has been +established, &watchdog_timer; determines the frequency of reconnection attempts, as required by RFC 3539.

For a listening transport, the timer specifies the time after which a previously connected peer will be forgotten: a connection after this time is -regarded as an initial connection rather than a reestablishment, +regarded as an initial connection rather than reestablishment, causing the RFC 3539 state machine to pass to state OKAY rather than REOPEN. Note that these semantics are not governed by the RFC and @@ -1066,14 +1068,12 @@ transport.

A callback invoked prior to terminating the transport process of a transport connection having watchdog state OKAY. -Applied to Reason=transport|service|application and the -&transport_ref; and -&app_peer; -in question, Reason indicating whether the diameter -application is being stopped, the service in question is being stopped -at &stop_service; or -the transport in question is being removed at &remove_transport;, -respectively.

+Applied to application|service|transport and the +&transport_ref; and &app_peer; in question: +application indicates that the diameter application is +being stopped, service that the service in question is being +stopped by &stop_service;, and transport that the transport in +question is being removed by &remove_transport;.

The return value can have one of the following types.

-- cgit v1.2.3 From 25237481ccccd3ddfa74582dc267632ad618ba30 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 9 Dec 2013 20:12:33 +0100 Subject: Prepare release --- lib/diameter/doc/src/notes.xml | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index cf87a13225..18c712ec3d 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,48 @@ first.

+
diameter 1.5 + +
Improvements and New Features + + +

+ Rename reconnect_timer to connect_timer.

+

+ The former is still accepted for backwards compatibility, + but the name is misleading given the semantics of the + timer.

+

+ Own Id: OTP-11168

+ + +

+ Extend diameter_make(3).

+

+ Dictionaries can now be compiled from strings, not just + filesystem paths, and results can be returned instead of + written to the filesystem.

+

+ Own Id: OTP-11348

+ + +

+ Remove hardcoding of diameter_base as @prefix on + dictionaries for application id 0.

+

+ Own Id: OTP-11361

+ + +

+ Fix silent make rules (Thanks to Anthony Ramine)

+

+ Own Id: OTP-11514

+ + +
+ +
+
diameter 1.4.4
Known Bugs and Problems -- cgit v1.2.3 From 3f79e7bd7e743ffd40b624caf680aef2bdb15dc7 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 16 Jan 2014 12:57:43 +0100 Subject: Don't format diameter_make:codec/2 errors Instead, add diameter_make:format_error/1 to allow the caller to format if desired, which is what applications like compiler and yecc do. Use this to check that the expected error is the one actually generated in the compiler suite. --- lib/diameter/doc/src/diameter_make.xml | 18 +++++++++++++++++- lib/diameter/doc/src/seealso.ent | 3 ++- 2 files changed, 19 insertions(+), 2 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index 1c1eff6c6a..16ef49d4b2 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -16,7 +16,7 @@
2012 -2013 +2014 Ericsson AB. All Rights Reserved. @@ -175,6 +175,10 @@ Note that a dictionary's &dict_name;, together with the The &dict_name; of a literal input dictionary defaults to dictionary.

+

+A returned error reason can be converted into a readable string using +&format_error;.

+ @@ -206,6 +210,18 @@ The return value is also a parsed dictionary.

+ + + +format_error(Reason) -> string() +Turn an error reason into a readable string. + + +

+Turn an error reason returned by &codec; into a readable string.

+ + + diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent index 7bf7460351..44541afb9b 100644 --- a/lib/diameter/doc/src/seealso.ent +++ b/lib/diameter/doc/src/seealso.ent @@ -4,7 +4,7 @@ %CopyrightBegin% -Copyright Ericsson AB 2012-2013. All Rights Reserved. +Copyright Ericsson AB 2012-2014. All Rights Reserved. The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in @@ -117,6 +117,7 @@ significant. diameter_make:codec/2'> diameter_make:format/1'> diameter_make:flatten/1'> +diameter_make:format_error/1'> -- cgit v1.2.3 From ed6395a69435354c9d3d5accbd3adbfc45d5becf Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 23 Jan 2014 09:20:46 +0100 Subject: Change interface for communicating outbound stream id to diameter_sctp The module uses the transport_data field of record diameter_packet to communicate the stream on which the an incoming message is received and on which an outgoing message should be sent, the previous interface being that both are communicated as a tuple of the form {stream, Id}. However, since diameter retains the value of an incoming request's transport_data unless the corresponding answer message specifies otherwise, the behaviour in this case is to send an answer on the outbound stream with the same identifier as the that of the inbound stream on which the request was received. If the inbound stream id is greater than or equal to the number of outbound streams then this is guaranteed to fail, causing the transport process in question to terminate. There is no relationship between inbound and outbound stream identifiers so diameter_sctp's imposition of one is simply wrong. Outbound stream ids are now communicated with a different tuple: {outstream, Id}, interpreted modulo the number of outbound streams. Thus, retention of an inbound request's transport_data has no effect on the selection of an outbound stream. The change in interface is not strictly backwards compatible because of the new atom for the outbound stream. However, as there is currently no documented way of obtaining the available number of outbound streams for a peer connection, there is no way for a client to have known the range of ids from which it could reliably have chosen with the previous interface, so any setting of the outbound stream has probably been unintentional. Not explicitly specifying an outbound stream now results in a round-robin selection. --- lib/diameter/doc/src/diameter_sctp.xml | 36 ++++++++++++++-------------------- 1 file changed, 15 insertions(+), 21 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 2be77e3dfd..021770b63a 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -15,7 +15,8 @@
-20112013 +2011 +2014 Ericsson AB. All Rights Reserved. @@ -113,7 +114,7 @@ and port respectively.

Multiple ip options can be specified for a multihomed peer. If none are specified then the values of Host-IP-Address -in the #diameter_service{} record are used. +in the diameter_service record are used. (In particular, one of these must be specified.) Option port defaults to 3868 for a listening transport and 0 for a connecting transport.

@@ -131,25 +132,18 @@ the buffer size.

-diameter_sctp uses the transport_data field of -the #diameter_packet{} record to communicate the stream on which an -inbound message has been received, or on which an outbound message -should be sent: the value will be of the form {stream, Id} -on an inbound message passed to a &app_handle_request; or -&app_handle_answer; callback. -For an outbound message, either undefined (explicitly or -by receiving the outbound message as a binary()) or a tuple -should be set in the return value of &app_handle_request; -(typically by retaining the value passed into this function) -or &app_prepare_request;. -The value undefined uses a "next outbound stream" id and -increments this modulo the total number outbound streams. -That is, successive values of undefined cycle through all -outbound streams.

- - - - +The transport_data field of record diameter_packet +is used to communicate the stream on which an inbound message +has been received, or on which an outbound message should be sent. +The value will be of the form {stream, Id} for an inbound +message passed to a &app_handle_request; or &app_handle_answer; +callback. +For an outbound message, {outstream, Id} in the return value of +&app_handle_request; or &app_prepare_retransmit; sets the outbound +stream, the stream id being interpreted modulo the number of outbound +streams. +Any other value, or not setting a value, causes successive such sends +to cycle though all outbound streams.

-- cgit v1.2.3 From 771d69cae6e0d16814f394496c0ecf0cd30f7bd1 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Mon, 20 Jan 2014 17:52:25 +0100 Subject: Correct doc on the setting of Origin-State-Id It was incorrectly stated that the AVP would be set in an outgoing DPR/DPA. --- lib/diameter/doc/src/diameter.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 9864b21bc5..1adcad31af 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -20,7 +20,8 @@
-20112013 +2011 +2014 Ericsson AB. All Rights Reserved. @@ -355,8 +356,8 @@ question communicates an address list as described in {'Origin-State-Id', &dict_Unsigned32;}

-Origin-State-Id is optional but will be included in outgoing messages -sent by diameter itself: CER/CEA, DWR/DWA and DPR/DPA. +Origin-State-Id is optional but, if configured, will be included in +outgoing CER/CEA and DWR/DWA messages. Setting a value of 0 (zero) is equivalent to not setting a value, as documented in &the_rfc;. The function &origin_state_id; -- cgit v1.2.3 From 77b40155ddfa6657a62d6b5cf4ab49084ff6ed3e Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Wed, 19 Mar 2014 12:53:54 +0100 Subject: Remove release note unrelated to functionality --- lib/diameter/doc/src/notes.xml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index 18c712ec3d..caedb890d0 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -11,7 +11,7 @@

2011 -2013 +2014 Ericsson AB. All Rights Reserved. @@ -73,12 +73,6 @@ first.

Own Id: OTP-11361

- -

- Fix silent make rules (Thanks to Anthony Ramine)

-

- Own Id: OTP-11514

-
-- cgit v1.2.3 From 174fb0a3ed8bee95ac3293866905dc28bed54f96 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 27 Jun 2013 12:41:03 +0200 Subject: Fix doc typo: required -> requires --- lib/diameter/doc/src/diameter_make.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index 1c1eff6c6a..95f91ff3b2 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -52,7 +52,7 @@ under the License.

The function &codec; is used to compile a diameter &dictionary; into Erlang source. -The resulting source implements the interface diameter required +The resulting source implements the interface diameter requires to encode and decode the dictionary's messages and AVPs.

-- cgit v1.2.3 From f719d0fe308f00b85f92c29d7cdf9b0dc20d98a2 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 7 Apr 2014 19:52:48 +0200 Subject: Update release notes --- lib/diameter/doc/src/notes.xml | 158 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index e2390df37c..675ffcfd18 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,164 @@ first.

+
diameter 1.6 + +
Fixed Bugs and Malfunctions + + +

+ Add missing check at dictionary compilation.

+

+ In particular, that an AVP defined as having type Grouped + in an @avp_types section has a corresponding definition + in a @grouped section.

+

+ Own Id: OTP-11561

+ + +

+ Correct documentation on the setting of Origin-State-Id

+

+ It was incorrectly stated that the AVP would be set in an + outgoing DPR/DPA.

+

+ Own Id: OTP-11583

+ + +

+ Change interface for communicating outbound stream id to + diameter_sctp

+

+ The module uses the transport_data field of record + diameter_packet to communicate the stream on which the an + incoming message is received and on which an outgoing + message should be sent, the previous interface being that + both are communicated as a tuple of the form {stream, + Id}. However, since diameter retains the value of an + incoming request's transport_data unless the + corresponding answer message specifies otherwise, the + behaviour in this case is to send an answer on the + outbound stream with the same identifier as the that of + the inbound stream on which the request was received. If + the inbound stream id is greater than or equal to the + number of outbound streams then this is guaranteed to + fail, causing the transport process in question to + terminate. There is no relationship between inbound and + outbound stream identifiers so diameter_sctp's imposition + of one is simply wrong.

+

+ Outbound stream ids are now communicated with a different + tuple: {outstream, Id}, interpreted modulo the number of + outbound streams. Thus, retention of an inbound request's + transport_data has no effect on the selection of an + outbound stream.

+

+ The change in interface is not strictly backwards + compatible because of the new atom for the outbound + stream. However, as there is currently no documented way + of obtaining the available number of outbound streams for + a peer connection, there is no way for a client to have + known the range of ids from which it could reliably have + chosen with the previous interface, so any setting of the + outbound stream has probably been unintentional. Not + explicitly specifying an outbound stream now results in a + round-robin selection.

+

+ Thanks to Sharmila Pillai for reporting the problem.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-11593

+ + +

+ Fix unicode path failure in diameter_make:codec/2.

+

+ A dictionary path containing a unicode codepoint > 255 + caused the function to fail.

+

+ Own Id: OTP-11655

+ + +

+ Fix 'accept' config to diameter_sctp.

+

+ OTP-10893 added support for {accept, Match} tuples to + specify addresses or regexps that should be matched + against peer addresses to decide whether or not a newly + established association should be retained, but this + hasn't been functional in the SCTP case because of + missing support in inet(3).

+

+ The display of both local and peer addresses in + diameter:service_info/2 output has also been corrected.

+

+ Own Id: OTP-11661 Aux Id: OTP-10229

+ + +

+ Be lenient with the M-bit in Grouped AVPs.

+

+ RFC 6733 says this, in 4.4:

+

+

Receivers of a Grouped AVP that does + not have the 'M' (mandatory) bit set and one or more of + the encapsulated AVPs within the group has the 'M' + (mandatory) bit set MAY simply be ignored if the Grouped + AVP itself is unrecognized. The rule applies even if the + encapsulated AVP with its 'M' (mandatory) bit set is + further encapsulated within other sub-groups, i.e., other + Grouped AVPs embedded within the Grouped + AVP.

+

+ The first sentence is mangled but take it to mean this:

+

+

An unrecognized AVP of type Grouped + that does not set the 'M' bit MAY be ignored even if one + of its encapsulated AVPs sets the 'M' + bit.

+

+ This is a bit of a non-statement since if the AVP is + unrecognized then its type is unknown. We therefore don't + know that its data bytes contain encapsulated AVPs, so + can't but ignore any of those that set the M-bit. Doing + anything else when the type *is* known would be + inconsistent.

+

+ OTP-11087 (R16B03) caused the M-bit on any unrecognized + AVP to be regarded as an error, unrecognized being taken + to mean "not explicitly defined as a member of its + container". (That is, an AVP that can't be packed into a + dedicated record field, which is slightly stronger than + "not defined".) This fixed the original intention for + top-level AVPs but broke the required leniency for + Grouped AVPs whose type is known. This leniency is now + restored.

+

+ Note that dictionary files need to be recompiled for the + change to have effect.

+

+ Thanks to Rory McKeown for reporting the problem.

+

+ Own Id: OTP-11675 Aux Id: OTP-11087

+ + +

+ Fix pick_peer case clause failure.

+

+ In the case of {call_mutates_state, true} configuration + on the service in question, any peer selection that + failed to select a peer resulted in a case clause + failure. This was noticed in the case of a peer failover + in which an alternate peer wasn't available.

+

+ Own Id: OTP-11789

+ + +
+ +
+
diameter 1.5
Improvements and New Features -- cgit v1.2.3 From 631522514dbd409dbb789103b54bd81c879aff34 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Tue, 27 May 2014 09:45:54 +0200 Subject: Change answer_errors default from report to discard In the same vein as commit 00584303, to avoid logging traffic-related happenings. Not that the value in diameter.hrl is just documentation: the value is set explicitly when diameter:start_service/2 creates diameter_app records. --- lib/diameter/doc/src/diameter.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 7d6a28e51c..ab9ad25a3a 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -227,7 +227,7 @@ question is as if a callback had taken place and returned {error, failure}.

-Defaults to report if unspecified.

+Defaults to discard if unspecified.

{request_errors, answer_3xxx|answer|callback} -- cgit v1.2.3 From 60a406953743500a08cc3efcc0d2c25497d7e58b Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Mon, 26 May 2014 15:21:41 +0200 Subject: Fix broken release note for diameter-1.4.4 Those were bug fixes, not known issues. --- lib/diameter/doc/src/notes.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index 675ffcfd18..68e69dbfeb 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -238,7 +238,7 @@ first.

diameter 1.4.4 -
Known Bugs and Problems +
Fixed Bugs and Malfunctions

-- cgit v1.2.3 From 77da984614ae462912a1896ba1bb73c798ffd4f8 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Thu, 19 Jun 2014 13:47:21 +0200 Subject: Prepare release --- lib/diameter/doc/src/notes.xml | 129 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index 68e69dbfeb..d89e1dfd26 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,135 @@ first.

+
diameter 1.7 + +
Fixed Bugs and Malfunctions + + +

+ Improve robustness.

+

+ Counters returned by diameter:service_info/2 now only + count messages known to the dictionary in question, so + that an attacker cannot cause arbitrarily many counters + to be created.

+

+ Messages to the Erlang log have been minimized, and those + related to traffic have been removed entirely since an + attacker could cause a node to be logged to death. + Consequently, the default answer_errors configuration has + been changed from report to discard. A service needs to + be restarted for the change in default to take effect.

+

+ Own Id: OTP-11721

+ + +

+ Fix request table leak.

+

+ Outgoing Diameter requests are stored in a table until an + answer is received or times out. Calling + diameter:stop_service/1 before this took place would + orphan the entries, resulting in a memory leak.

+

+ Own Id: OTP-11893

+ + +

+ Fix broken SCTP transport.

+

+ OTP-11593 caused the sending of answer messages over SCTP + to fail.

+

+ Own Id: OTP-11901 Aux Id: OTP-11593

+ + +

+ Fix watchdog process leak.

+

+ A failed capabilities exchange on a listening transport + would orphan a process, causing a memory leak.

+

+ Own Id: OTP-11934

+ + +

+ Fix incorrect handling of incoming DPR.

+

+ In the case of a listening transport, a reconnection by a + peer following DPR could transition the watchdog state to + REOPEN instead of OKAY.

+

+ Own Id: OTP-11938

+ + +

+ Fix handling of AVP length errors on unknown AVPs.

+

+ An AVP (Header) length that pointed past the end of the + message was not flagged as a 5014 error in this case. + Moreover, encoding such an AVP in the Failed-AVP of an + answer message as a consequence of other errors (eg. + M-bit, resulting in 5001) failed if the AVP contained a + complete header.

+

+ Own Id: OTP-11946

+ + +

+ Fix broken check in dictionary compilation.

+

+ That an AVP specified in the content of a @codecs or + @custom_types section was undefined went undetected, + causing compilation to fail when attempting to lookup the + AVP's type.

+

+ Own Id: OTP-11958

+ + +
+ + +
Improvements and New Features + + +

+ Add result code counters for CEA, DWA, and DPA.

+

+ In addition to the existing result code counters on other + answer messages.

+

+ Own Id: OTP-11891

+ + +

+ Add best-effort decode of AVPs within Failed-AVP.

+

+ OTP-11007 disabled the decode of AVPs in Failed-AVP since + errors could cause the decode of Failed-AVP itself to + fail. Component AVPs are now decoded if possible, + otherwise not. AVPs of type Grouped are decoded as much + as possible, as deeply as possible.

+

+ Own Id: OTP-11936 Aux Id: OTP-11007

+ + +

+ Add counters for encode errors in outgoing Diameter + messages.

+

+ In addition to the existing counters on decode errors. + The latter now count independently of result codes in + answer messages since decode errors do not preclude the + presence of a result code.

+

+ Own Id: OTP-11937

+ + +
+ +
+
diameter 1.6
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 99c1df966b7065345b711086a2286b85d477869b Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sun, 14 Sep 2014 08:12:37 +0200 Subject: Add recompilation admonition to 17.2 release notes That dictionaries need to be recompiled, which is the case whenever diameter_gen.hrl is modified. --- lib/diameter/doc/src/notes.xml | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index d89e1dfd26..b3cd53c497 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -113,6 +113,9 @@ first.

answer message as a consequence of other errors (eg. M-bit, resulting in 5001) failed if the AVP contained a complete header.

+

+ Dictionary files must be recompiled for the fix to have + effect.

Own Id: OTP-11946

@@ -151,6 +154,9 @@ first.

fail. Component AVPs are now decoded if possible, otherwise not. AVPs of type Grouped are decoded as much as possible, as deeply as possible.

+

+ Dictionary files must be recompiled for the fix to have + effect.

Own Id: OTP-11936 Aux Id: OTP-11007

-- cgit v1.2.3 From 950d808c97a4c5b579f4f1cc16b95f2d419d3505 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 15 Sep 2014 12:02:14 +0200 Subject: Update release notes --- lib/diameter/doc/src/notes.xml | 53 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index b3cd53c497..7f69bdbfbf 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,59 @@ first.

+
diameter 1.7.1 + +
Fixed Bugs and Malfunctions + + +

+ Don't leave extra bit in decoded AVP data.

+

+ An extra bit could be communicated in the data field of a + diameter_avp record in the case of length errors. Of no + consequence for code using the record encoding of + Diameter messages, but code examining diameter_avp + records would see this bit.

+

+ Dictionary files must be recompiled for the fix to have + effect.

+

+ Own Id: OTP-12074

+ + +

+ Fix counting of outgoing requests and answers setting the + E-bit.

+

+ OTP-11721 broke these counters for all outgoing requests + except DWR, and caused answers setting the E-bit to be + counted as unknown messages.

+

+ Own Id: OTP-12080

+ + +

+ Fix Failed-AVP decode.

+

+ The best-effort decode only worked for AVPs in the common + dictionary, not for those in the dictionary of the + application identified in the Diameter Header of the + answer message in question.

+

+ Failed-AVP in an answer decoded with the RFC 3588 common + dictionary (diameter_gen_base_rfc3588) was regarded as an + error. The RFC 6733 dictionary was unaffected.

+

+ Dictionary files must be recompiled for the fix to have + effect.

+

+ Own Id: OTP-12094

+ + +
+ +
+
diameter 1.7
Fixed Bugs and Malfunctions -- cgit v1.2.3 From c29dd0129b35390334bb6d2bbed5500b7089a532 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 13 Nov 2014 21:56:03 +0100 Subject: Order peers in pick_peer callbacks The order of peers presented to a diameter_app(3) pick_peer callback has previously not been documented, but there are use cases that are simplified by an ordering. For example, consider preferring a direct connection to a specified Destination-Host/Realm to any host in the realm. The implementation previously treated this as a special case by placing matching hosts at the head of the peers list, but the documentation made no guarantees. Now present peers in match-order, so that the desired sorting is the result of the following filter. {any, [{all, [host, realm]}, realm]} The implementation is not backwards compatible in the sense that a realm filter alone is no longer equivalent in this case. However, as stated, the documentation never made any guarantees regarding the sorting. --- lib/diameter/doc/src/diameter.xml | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index ab9ad25a3a..00b54ffbc4 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -500,6 +500,18 @@ Matches only those peers matched by each filter in the specified list.

Matches only those peers matched by at least one filter in the specified list.

+ +

+The resulting peer list will be in match order, peers matching the +first filter of the list sorting before those matched by the second, +and so on. +For example, the following filter causes peers matching both the host +and realm filters to be presented before those matching only the realm +filter.

+ +
+{any, [{all, [host, realm]}, realm]}
+
-- cgit v1.2.3 From 7f3486a5ddc02a366f2945dfd009c4a2697a2b98 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 9 Dec 2014 15:21:47 +0100 Subject: Prepare release --- lib/diameter/doc/src/notes.xml | 62 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml index 7f69bdbfbf..e6ac332c10 100644 --- a/lib/diameter/doc/src/notes.xml +++ b/lib/diameter/doc/src/notes.xml @@ -42,6 +42,68 @@ first.

+
diameter 1.8 + +
Fixed Bugs and Malfunctions + + +

+ Fix remote diameter_request table leak.

+

+ An outgoing request whose pick_peer callback selected a + transport on another node resulted in an orphaned table + entry on that node.

+

+ Own Id: OTP-12196

+ + +

+ Fix handling of 3xxx Result-Code without E-bit.

+

+ OTP-12233 broke the population of the errors field of the + diameter_packet record when an incoming request with an + E-bit/Result-Code mismatch was detected, causing a + 4-tuple to be inserted as Result-Code in a diameter_avp + record.

+

+ Own Id: OTP-12233

+ + +

+ Fix ignored connect timer.

+

+ There are two timers governing the establishment of peer + connections: connect_timer and watchdog_timer. The former + is the RFC 6733 Tc timer, and is used at initial + connection establishment. The latter is RFC 3539 TwInit, + and is used for connection reestablishment. A connecting + transport erroneously used watchdog_timer in both cases.

+

+ Own Id: OTP-12281 Aux Id: seq12728

+ + +
+ + +
Improvements and New Features + + +

+ Order candidate peers in pick_peer callbacks.

+

+ The order of candidate peers presented to a + diameter_app(3) pick_peer callback has previously not + been documented, but there are use cases that are + simplified by an ordering. The order is now determined by + the filter.

+

+ Own Id: OTP-12308

+ + +
+ +
+
diameter 1.7.1
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 4b691d8d8a5eae2b0b34e1e0ec00fa5116384d69 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 23 Jan 2015 20:02:25 +0100 Subject: Add transport_opt() pool_size Transport processes are started by diameter one at a time. In the listening case, a transport process accepts a connection, tells the peer_fsm process, which tells its watchdog process, which tells its service process, which then starts a new watchdog, which starts a new peer_fsm, which starts a new transport process, which (finally) goes about accepting another connection. In other words, not particularly aggressive in accepting new connections. This behaviour doesn't do particularly well with a large number of concurrent connections: with TCP and 250 connecting peers we see connections being refused. This commit adds the possibilty of configuring a pool of accepting processes, by way of a new transport option, pool_size. Instead of diameter:add_transport/2 starting just a single process, it now starts the configured number, so that instead of a single process waiting for a connection there's now a pool. The option is even available for connecting processes, which provides an alternate to adding multiple transports when multiple connections to the same peer are required. In practice this also means configuring {restrict_connections, false}: this is not implicit. For backwards compatibility, the form of diameter:service_info(_,transport) differs in the connecting case, depending on whether or not pool_size is configured. Note that transport processes for the same transport_ref() can be started concurrently when pool_size > 1. This places additional requirements on diameter_{tcp,sctp}, that will be dealt with in a subsequent commit. --- lib/diameter/doc/src/diameter.xml | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 00b54ffbc4..538011b789 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -21,7 +21,7 @@ 2011 -2014 +2015 Ericsson AB. All Rights Reserved. @@ -1188,6 +1188,19 @@ See &man_tcp; for the behaviour of that module.

+{pool_size, pos_integer()} + +

+Number of transport processes to start. +For a listening transport, defines the size of the pool of accepting +transport processes, a larger number being desirable for processing +multiple concurrent peer connection attempts. +For a connecting transport, the &service_opt; +restrict_connections must also be configured on the service in +question to allow multiple connections to the same peer.

+ + + {spawn_opt, [term()]} @@ -1737,6 +1750,14 @@ connection might look as follows.

The information presented here is as in the connect case except that the client connections are grouped under an accept tuple.

+

+Whether or not the &transport_opt; pool_size affects the format +of the listing in the case of a connecting transport, since a value +greater than 1 implies multiple transport processes for the same +&transport_ref;, as in the listening case. +The format in this case is similar to the listening case, with a +pool tuple in place of an accept tuple.

+ connections -- cgit v1.2.3 From 85d44b58e75782c3e3ee8f092a0debd7dc0c371f Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sat, 24 Jan 2015 11:24:33 +0100 Subject: Improve language consistency in diameter(1) In particular, do away with unnecessary articles in the first sentence of item lists. --- lib/diameter/doc/src/diameter.xml | 62 ++++++++++++++++++++------------------- 1 file changed, 32 insertions(+), 30 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 538011b789..638c1c4c2b 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -111,7 +111,7 @@ Defined in &dict_data_types;.

application_alias() = term()

-A name identifying a Diameter application in +Name identifying a Diameter application in service configuration. Passed to &call; when sending requests defined by the application.

@@ -129,7 +129,7 @@ ExtraArgs = list()

-A module implementing the callback interface defined in &man_app;, +Module implementing the callback interface defined in &man_app;, along with any extra arguments to be appended to those documented. Note that extra arguments specific to an outgoing request can be @@ -156,7 +156,7 @@ Has one the following types.

{alias, &application_alias;}

-A unique identifier for the application in the scope of the +Unique identifier for the application in the scope of the service. Defaults to the value of the dictionary option if unspecified.

@@ -165,7 +165,7 @@ unspecified.

{dictionary, atom()}

-The name of an encode/decode module for the Diameter +Name of an encode/decode module for the Diameter messages defined by the application. These modules are generated from files whose format is documented in &man_dict;.

@@ -174,7 +174,7 @@ These modules are generated from files whose format is documented in {module, &application_module;}

-The callback module with which messages of the Diameter application are +Callback module in which messages of the Diameter application are handled. See &man_app; for the required interface and semantics.

 @@ -182,7 +182,7 @@ See &man_app; for the required interface and semantics.

{state, term()}

-The initial callback state. +Initial callback state. The prevailing state is passed to some &man_app; callbacks, which can then return a new state. @@ -192,7 +192,7 @@ Defaults to the value of the alias option if unspecified.

{call_mutates_state, true|false}

-Specifies whether or not the &app_pick_peer; +Whether or not the &app_pick_peer; application callback can modify the application state. Defaults to false if unspecified.

@@ -209,7 +209,7 @@ probably avoid it.

{answer_errors, callback|report|discard}

-Determines the manner in which incoming answer messages containing +Manner in which incoming answer messages containing decode errors are handled.

@@ -233,7 +233,7 @@ Defaults to discard if unspecified.

{request_errors, answer_3xxx|answer|callback}

-Determines the manner in which incoming requests are handled when an +Manner in which incoming requests are handled when an error other than 3007 (DIAMETER_APPLICATION_UNSUPPORTED, which cannot be associated with an application callback module), is detected.

@@ -293,7 +293,7 @@ Multiple options append to the argument list.

{filter, &peer_filter;}

-A filter to apply to the list of available peers before passing it to +Filter to apply to the list of available peers before passing it to the &app_pick_peer; callback for the application in question. Multiple options are equivalent a single all filter on the corresponding list of filters. @@ -311,7 +311,7 @@ Defaults to 5000.

detach

-Causes &call; to return ok as +Cause &call; to return ok as soon as the request in question has been encoded, instead of waiting for and returning the result from a subsequent &app_handle_answer; or @@ -427,7 +427,7 @@ configuration passed to &start_service; or &add_transport;.

peer_filter() = term()

-A filter passed to &call; in order to select candidate peers for a +Filter passed to &call; in order to select candidate peers for a &app_pick_peer; callback. Has one of the following types.

@@ -1032,7 +1032,7 @@ case the corresponding callbacks are applied until either all return {capx_timeout, &dict_Unsigned32;}

-The number of milliseconds after which a transport process having an +Number of milliseconds after which a transport process having an established transport connection will be terminated if the expected capabilities exchange message (CER or CEA) is not received from the peer. For a connecting transport, the timing of connection attempts is @@ -1079,7 +1079,7 @@ transport.

-A callback invoked prior to terminating the transport process of a +Callback invoked prior to terminating the transport process of a transport connection having watchdog state OKAY. Applied to application|service|transport and the &transport_ref; and &app_peer; in question: @@ -1095,7 +1095,7 @@ The return value can have one of the following types.

{dpr, [option()]}

-Causes Disconnect-Peer-Request to be sent to the peer, the transport +Send Disconnect-Peer-Request to the peer, the transport process being terminated following reception of Disconnect-Peer-Answer or timeout. An option() can be one of the following.

@@ -1104,7 +1104,7 @@ An option() can be one of the following.

{cause, 0|rebooting|1|busy|2|goaway}

-The Disconnect-Cause to send, REBOOTING, BUSY and +Disconnect-Cause to send, REBOOTING, BUSY and DO_NOT_WANT_TO_TALK_TO_YOU respectively. Defaults to rebooting for Reason=service|application and goaway for Reason=transport.

@@ -1113,7 +1113,7 @@ Defaults to rebooting for Reason=service|application and {timeout, &dict_Unsigned32;}

-The number of milliseconds after which the transport process is +Number of milliseconds after which the transport process is terminated if DPA has not been received. Defaults to 1000.

 @@ -1129,7 +1129,7 @@ Equivalent to {dpr, []}.

close

-Causes the transport process to be terminated without +Terminate the transport process without Disconnect-Peer-Request being sent to the peer.

 @@ -1156,7 +1156,7 @@ Defaults to a single callback returning dpr.

{length_errors, exit|handle|discard}

-Specifies how to deal with errors in the Message Length field of the +How to deal with errors in the Message Length field of the Diameter Header in an incoming message. An error in this context is that the length is not at least 20 bytes (the length of a Header), is not a multiple of 4 (a valid length) or @@ -1192,12 +1192,14 @@ See &man_tcp; for the behaviour of that module.

Number of transport processes to start. -For a listening transport, defines the size of the pool of accepting -transport processes, a larger number being desirable for processing -multiple concurrent peer connection attempts. -For a connecting transport, the &service_opt; -restrict_connections must also be configured on the service in -question to allow multiple connections to the same peer.

+For a listening transport, determines the size of the pool of +accepting transport processes, a larger number being desirable for +processing multiple concurrent peer connection attempts. +For a connecting transport, determines the number of connections to +the peer in question that will be attempted to be establshed: +the &service_opt;: restrict_connections should also be +configured on the service in question to allow multiple connections to +the same peer.

 @@ -1205,7 +1207,7 @@ question to allow multiple connections to the same peer.

{spawn_opt, [term()]}

-An options list passed to &spawn_opt; when spawning a process for an +Options list passed to &spawn_opt; when spawning a process for an incoming Diameter request. Options monitor and link are ignored.

@@ -1218,7 +1220,7 @@ Defaults to the list configured on the service if not specified.

{transport_config, term(), &dict_Unsigned32; | infinity}

-A term passed as the third argument to the &transport_start; function of +Term passed as the third argument to the &transport_start; function of the relevant &transport_module; in order to start a transport process. Defaults to the empty list if unspecified.

@@ -1246,7 +1248,7 @@ To listen on both SCTP and TCP, define one transport for each.

{transport_module, atom()}

-A module implementing a transport process as defined in &man_transport;. +Module implementing a transport process as defined in &man_transport;. Defaults to diameter_tcp if unspecified.

@@ -1266,7 +1268,7 @@ corresponding timeout (see below) or all fail.

{watchdog_config, [{okay|suspect, non_neg_integer()}]}

-Specifies configuration that alters the behaviour of the watchdog +Configuration that alters the behaviour of the watchdog state machine. On key okay, the non-negative number of answered DWR messages before transitioning from REOPEN to OKAY. @@ -1321,7 +1323,7 @@ in predicate functions passed to &remove_transport;.

transport_ref() = reference()

-An reference returned by &add_transport; that +Reference returned by &add_transport; that identifies the configuration.

 -- cgit v1.2.3 From deed57ed8da08e3262d61197da2ed00391b94be6 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 19 Mar 2015 23:57:43 +0100 Subject: Improve language consistency in diameter(1) Akin to commit 85d44b58. --- lib/diameter/doc/src/diameter.xml | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 638c1c4c2b..a5a99f7835 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -303,7 +303,7 @@ Defaults to none.

{timeout, &dict_Unsigned32;}

-The number of milliseconds after which the request should +Number of milliseconds after which the request should timeout. Defaults to 5000.

 @@ -742,7 +742,7 @@ info fields of forms other than the above.

service_name() = term()

-The name of a service as passed to &start_service; and with which the +Name of a service as passed to &start_service; and with which the service is identified. There can be at most one service with a given name on a given node. Note that &make_ref; @@ -754,7 +754,7 @@ can be used to generate a service name that is somewhat unique.

service_opt()

-An option passed to &start_service;. +Option passed to &start_service;. Can be any &capability; as well as the following.

@@ -762,7 +762,7 @@ Can be any &capability; as well as the following.

{application, [&application_opt;]}

-Defines a Diameter application supported by the service.

+A Diameter application supported by the service.

A service must configure one tuple for each Diameter @@ -790,7 +790,7 @@ be matched by corresponding &capability; configuration, of | evaluable()}

-Specifies the degree to which the service allows multiple transport +The degree to which the service allows multiple transport connections to the same peer, as identified by its Origin-Host at capabilities exchange.

@@ -816,7 +816,7 @@ Defaults to nodes.

{sequence, {H,N} | &evaluable;}

-Specifies a constant value H for the topmost 32-N bits of +A constant value H for the topmost 32-N bits of of 32-bit End-to-End and Hop-by-Hop Identifiers generated by the service, either explicitly or as a return value of a function to be evaluated at &start_service;. @@ -851,7 +851,7 @@ outgoing requests.

{share_peers, boolean() | [node()] | evaluable()}

-Specifies nodes to which peer connections established on the local +Nodes to which peer connections established on the local Erlang node are communicated. Shared peers become available in the remote candidates list passed to &app_pick_peer; callbacks on remote nodes whose services are @@ -890,7 +890,7 @@ of a single Diameter node across multiple Erlang nodes.

{spawn_opt, [term()]}

-An options list passed to &spawn_opt; when spawning a process for an +Options list passed to &spawn_opt; when spawning a process for an incoming Diameter request, unless the transport in question specifies another value. Options monitor and link are ignored.

@@ -902,7 +902,7 @@ Defaults to the empty list.

{use_shared_peers, boolean() | [node()] | evaluable()}

-Specifies nodes from which communicated peers are made available in +Nodes from which communicated peers are made available in the remote candidates list of &app_pick_peer; callbacks.

@@ -942,7 +942,7 @@ each node from which requests are sent.

transport_opt()

-An option passed to &add_transport;. +Option passed to &add_transport;. Has one of the following types.

@@ -950,8 +950,7 @@ Has one of the following types.

{applications, [&application_alias;]}

-The list of Diameter applications to which the transport should be -restricted. +Diameter applications to which the transport should be restricted. Defaults to all applications configured on the service in question. Applications not configured on the service in question are ignored.

@@ -984,7 +983,7 @@ TLS is desired over TCP as implemented by &man_tcp;.

{capabilities_cb, &evaluable;}

-A callback invoked upon reception of CER/CEA during capabilities +Callback invoked upon reception of CER/CEA during capabilities exchange in order to ask whether or not the connection should be accepted. Applied to the &transport_ref; and @@ -1207,7 +1206,7 @@ the same peer.

{spawn_opt, [term()]}

-Options list passed to &spawn_opt; when spawning a process for an +Options passed to &spawn_opt; when spawning a process for an incoming Diameter request. Options monitor and link are ignored.

-- cgit v1.2.3 From c0687e03e538daab2f8fddda6cd3a235fc6ed447 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sat, 7 Mar 2015 15:50:05 +0100 Subject: Add transport_opt() dpa_timeout To make the default DPA timeout configurable. The timeout say how many milliseconds to wait for DPA in response to an outgoing DPR before terminating the transport process regardless. --- lib/diameter/doc/src/diameter.xml | 15 +++++++++++++-- lib/diameter/doc/src/seealso.ent | 3 ++- 2 files changed, 15 insertions(+), 3 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 00b54ffbc4..6aab19b722 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -21,7 +21,7 @@ 2011 -2014 +2015 Ericsson AB. All Rights Reserved. @@ -1115,7 +1115,7 @@ Defaults to rebooting for Reason=service|application and

The number of milliseconds after which the transport process is terminated if DPA has not been received. -Defaults to 1000.

+Defaults to the value of &dpa_timeout;.

 @@ -1152,6 +1152,17 @@ configured them.

Defaults to a single callback returning dpr.

 + +{dpa_timeout, &dict_Unsigned32;} + +

+Number of milliseconds after which a transport connection is +terminated following an outgoing DPR if DPA is not received.

+ +

+Defaults to 1000.

+ + {length_errors, exit|handle|discard} diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent index 44541afb9b..8d87a4a5e7 100644 --- a/lib/diameter/doc/src/seealso.ent +++ b/lib/diameter/doc/src/seealso.ent @@ -4,7 +4,7 @@ %CopyrightBegin% -Copyright Ericsson AB 2012-2014. All Rights Reserved. +Copyright Ericsson AB 2012-2015. All Rights Reserved. The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in @@ -64,6 +64,7 @@ significant. capabilities_cb'> capx_timeout'> disconnect_cb'> +dpa_timeout'> transport_config'> transport_module'> connect_timer'> -- cgit v1.2.3 From 9f496aaba6e8a63180eca3a77d01205ca0fcbff7 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sat, 21 Mar 2015 10:11:51 +0100 Subject: Add transport_opt() dpr_timeout To cause a peer connection to be closed following an outgoing DPA, in case the peer fails to do so. It is the recipient of DPA that should close the connection according to RFC 6733. --- lib/diameter/doc/src/diameter.xml | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 27f2d76f28..e22da3c9d5 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -1163,6 +1163,18 @@ terminated following an outgoing DPR if DPA is not received.

Defaults to 1000.

 + +{dpr_timeout, &dict_Unsigned32;} + +

+Number of milliseconds after which a transport connection is +terminated following an incoming DPR if the peer does not close the +connection.

+ +

+Defaults to 5000.

+ + {length_errors, exit|handle|discard} -- cgit v1.2.3 From 1590920c910c030369fbf871b63f6836b988e90a Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 12 Feb 2015 11:41:59 +0100 Subject: Add service_opt() string_decode To control whether stringish Diameter types are decoded to string or left as binary. The motivation is the same as in the parent commit: to avoid large strings being copied when incoming Diameter messages are passed between processes; or *if* in the case of messages destined for handle_request and handle_answer callbacks, since these are decoded in the dedicated processes that the callbacks take place in. It would be possible to do something about other messages without requiring an option, but disabling the decode is the most effective. The value is a boolean(), true being the default for backwards compatibility. Setting false causes both diameter_caps records and decoded messages to contain binary() in relevant places that previously had string(): diameter_app(3) callbacks need to be prepared for the change. The Diameter types affected are OctetString and the derived types that can contain arbitrarily large values: OctetString, UTF8String, DiameterIdentity, DiameterURI, IPFilterRule, and QoSFilterRule. Time and Address are unaffected. The DiameterURI decode has been redone using re(3), which both simplifies and does away with a vulnerability resulting from the conversion of arbitrary strings to atom. The solution continues the use and abuse of the process dictionary for encode/decode purposes, last seen in commit 0f9cdba. --- lib/diameter/doc/src/diameter.xml | 24 ++++++++++++++++++++++++ lib/diameter/doc/src/diameter_dict.xml | 9 +++++++-- lib/diameter/doc/src/seealso.ent | 5 +++++ 3 files changed, 36 insertions(+), 2 deletions(-) (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index a5a99f7835..cb397614e5 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -899,6 +899,30 @@ Options monitor and link are ignored.

Defaults to the empty list.

 + +{string_decode, boolean()} + +

+Whether or not to decode AVPs of type &dict_OctetString; and its +derived types &dict_DiameterIdentity;, &dict_DiameterURI;, +&dict_IPFilterRule;, &dict_QoSFilterRule;, and &dict_UTF8String;. +If true then AVPs of these types are decoded to string(). +If false then values are retained as binary().

+ +

+Defaults to true.

+ + +

+This option should be set to false +since a sufficiently malicious peer can otherwise cause large amounts +of memory to be consumed when decoded Diameter messages are passed +between processes. +The default value is for backwards compatibility.

+ + + + {use_shared_peers, boolean() | [node()] | evaluable()}

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index 810a146b88..9db9bcffde 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -528,6 +528,11 @@ in a request record when sending a request, returned in a resulting answer record and passed to a &app_handle_request; callback upon reception of an incoming request.

+

+In cases in which there is a choice between list() and binary() types +for OctetString() and derived types, the representation is determined +by the value of &mod_string_decode;.

+

Basic AVP Data Formats

@@ -541,7 +546,7 @@ callback upon reception of an incoming request.

-OctetString() = [0..255]
+OctetString() = string() | binary()
 Integer32()   = -2147483647..2147483647
 Integer64()   = -9223372036854775807..9223372036854775807
 Unsigned32()  = 0..4294967295
@@ -603,7 +608,7 @@ and {{2104,2,26},{9,42,23}} (both inclusive) can be encoded.

 
 
 
-UTF8String() = [integer()]
+UTF8String() = [integer()] | binary()
 

 
 

diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index 44541afb9b..b0e3a2c712 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -69,6 +69,8 @@ significant.
 connect_timer'>
 watchdog_timer'>
 
+diameter:service_opt() string_decode'>
+
 
 
 handle_answer/4'>
@@ -102,6 +104,9 @@ significant.
 
 Address()'>
 DiameterIdentity()'>
+DiameterURI()'>
+IPFilterRule()'>
+QoSFilterRule()'>
 Grouped()'>
 OctetString()'>
 Time()'>
-- 
cgit v1.2.3


From d436ca385b6883824b768fe6b806341c86db0409 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Thu, 5 Mar 2015 08:04:58 +0100
Subject: Minor doc fix

---
 lib/diameter/doc/src/diameter.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index bb281bc0dc..37e67d8630 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -674,7 +674,7 @@ connection establishment.

 {'CEA', Result, Caps, Pkt}
 
 
-Result = integer() | atom() | {capabilities_cb, CB, ResultCode|discard}
+Result = ResultCode | atom() | {capabilities_cb, CB, ResultCode|discard}
 Caps = #diameter_caps{}
 Pkt  = #diameter_packet{}
 ResultCode = integer()
-- 
cgit v1.2.3


From 545ff7783cebddc2ca5b2af67a6f13b1a01a4d03 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Wed, 25 Mar 2015 07:21:46 +0100
Subject: Add service_opt() incoming_maxlen

To bound the length of incoming messages that will be decoded. A message
longer than the specified number of bytes is discarded. An
incoming_maxlen_exceeded counter is incremented to make note of the
occurrence.

The motivation is to prevent a sufficiently malicious peer from
generating significant load by sending long messages with many AVPs for
diameter to decode. The 24-bit message length header accomodates

  (16#FFFFFF - 20) div 12 = 1398099

Unsigned32 AVPs for example, which the current record-valued decode is
too slow with in practice. A bound of 16#FFFF bytes allows for 5461
small AVPs, which is probably more than enough for the majority of
applications, but the default is the full 16#FFFFFF.
---
 lib/diameter/doc/src/diameter.xml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 37e67d8630..6e41b01c44 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -783,6 +783,27 @@ be matched by corresponding &capability; configuration, of
 
 
 
+
+{incoming_maxlen, 0..16777215}
+
+

+Bound on the expected size of incoming Diameter messages.
+Messages larger than the specified number of bytes are discarded.

+
+

+Defaults to 16777215, the maximum value of the 24-bit Message
+Length field in a Diameter Header.

+
+
+

+This option should be set to as low a value as is sufficient for the
+Diameter applications and peers in question, since decoding incoming
+messages from a malicious peer can otherwise generate significant
+load.

+
+
+
+
 {restrict_connections, false
                              | node
                              | nodes
-- 
cgit v1.2.3


From 7edb0dd681b09df8865855eda1150e4a92b54a0a Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Thu, 26 Mar 2015 12:52:04 +0100
Subject: Limit FQDN in DiameterURI to 255 octets

As for the port number in the parent commit, a FQDN can't be arbitrarily
long, at most 255 octets. Make decode fail if it's more.
---
 lib/diameter/doc/src/diameter_dict.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 9db9bcffde..5cf1b174a0 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -529,7 +529,7 @@ answer record and passed to a &app_handle_request;
 callback upon reception of an incoming request.

 
 

-In cases in which there is a choice between list() and binary() types
+In cases in which there is a choice between string() and binary() types
 for OctetString() and derived types, the representation is determined
 by the value of &mod_string_decode;.

 
-- 
cgit v1.2.3


From 62870c998955e1498e71bfc90607885e96ecaa27 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Tue, 31 Mar 2015 12:24:04 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 183 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 183 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index e6ac332c10..479fab21b2 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,189 @@ first.

 
 
 
+
diameter 1.9
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Don't discard outgoing answers unnecessarily.

+          

+	    Answers missing a Result-Code AVP or setting an E-bit
+	    inappropriately were discarded even if encode was
+	    successful.

+          

+	    Own Id: OTP-11492

+        
+        
+          

+	    Increase supervision timeouts.

+          

+	    At diameter application shutdown, DPR could be omitted on
+	    open peer connections because of short supervision
+	    timeouts.

+          

+	    Own Id: OTP-12412

+        
+        
+          

+	    Fix retransmission of messages sent as header/avps list.

+          

+	    Extracting End-to-End and Hop-by-Hop Identifiers resulted
+	    in a function clause error, resulting in a handle_error
+	    callback.

+          

+	    Own Id: OTP-12415

+        
+        
+          

+	    Fix diameter_avp decode of Grouped AVPs having decode
+	    errors.

+          

+	    Components of such an AVP were not extracted, causing it
+	    to be represented by a single diameter_avp record instead
+	    of the intended list.

+          

+	    Dictionary files must be recompiled for the fix to have
+	    effect.

+          

+	    Own Id: OTP-12475

+        
+        
+          

+	    Fix ordering of AVPs in relayed messages.

+          

+	    The order was reversed relative to the received order,
+	    with a Route-Record AVP prepended.

+          

+	    Thanks to Andrzej Trawiński.

+          

+	    Own Id: OTP-12551

+        
+        
+          

+	    Fix issues with DiameterURI encode/decode.

+          

+	    RFC 6773 changed the default port and transport, but the
+	    RFC 3588 defaults were used even if the RFC 6733 common
+	    dictionary was in use. The RFC 3588 defaults are now only
+	    used when the common dictionary is
+	    diameter_gen_base_rfc3588.

+          

+	    Both RFC 3588 and 6733 disallow
+	    transport=udp;protocol=diameter. Encode of the
+	    combination now fails.

+          

+	    Decode of ports numbers outside the range 0-65535 and
+	    fully qualified domain names longer than 255 octets now
+	    fails.

+          

+	    Note that RFC 3588 is obsolete, and that there is a
+	    diameter_gen_base_rfc6733. The change in defaults is a
+	    potential interoperability problem when moving to RFC
+	    6733 with peers that do not send all URI components. The
+	    fact that 6733 allows 5xxx result codes in answer
+	    messages setting the E-bit, which RFC 3588 doesn't, is
+	    another.

+          

+	    Own Id: OTP-12589

+        
+      
+    

+
+
+    
Improvements and New Features
+      
+        
+          

+	    Add service_opt() string_decode.

+          

+	    To disable the decode of potentially large binaries to
+	    string. This prevents large strings from being copied
+	    when incoming Diameter messages are passed between
+	    processes, a vulnerability that can lead to memory being
+	    exhausted given sufficiently malicious peers.

+          

+	    The value is a boolean(), true being the default for
+	    backwards compatibility. Setting false causes both
+	    diameter_caps records and decoded messages to contain
+	    binary() in relevant places that previously had string():
+	    diameter_app(3) callbacks need to be prepared for the
+	    change.

+          

+	    The Diameter types affected are OctetString and the
+	    derived types UTF8String, DiameterIdentity, DiameterURI,
+	    IPFilterRule, and QoSFilterRule. Time and Address are
+	    unaffected.

+          

+	    Own Id: OTP-11952

+        
+        
+          

+	    Add transport_opt() pool_size.

+          

+	    To allow for pools of accepting transport processes,
+	    which can better service multiple simultaneous peer
+	    connections. The option can also be used with connecting
+	    transports, to establish multiple connections to the same
+	    peer without having to configure multiple transports.

+          

+	    Own Id: OTP-12428

+        
+        
+          

+	    Allow DPR to be sent with diameter:call/4.

+          

+	    It has been possible to send, but the answer was regarded
+	    as unsolicited and discarded. DPA now causes the
+	    transport process in question to be terminated, as for
+	    DPR that diameter itself sends.

+          

+	    Own Id: OTP-12542

+        
+        
+          

+	    Discard requests after DPR.

+          

+	    RFC 6733 is imprecise, but the tone is that messages
+	    received after DPR are an exception to be dealt with only
+	    because of the possibility of unordered delivery over
+	    SCTP. As a consequence, and because a request following
+	    DPR is unlikely to be answered due to the impending loss
+	    of the peer connection, discard outgoing requests
+	    following an outgoing or incoming DPR. Incoming requests
+	    are also discarded, with the exception of DPR itself.
+	    Answers are sent and received as usual.

+          

+	    Own Id: OTP-12543

+        
+        
+          

+	    Add transport_opt() dpr_timeout.

+          

+	    To cause a peer connection to be closed following an
+	    outgoing DPA when the peer fails to do so. It is the
+	    recipient of DPA that should close the connection
+	    according to RFC 6733.

+          

+	    Own Id: OTP-12609

+        
+        
+          

+	    Add service_opt() incoming_maxlen.

+          

+	    To bound the expected size of incoming Diameter messages.
+	    Messages larger than the specified number of bytes are
+	    discarded, to prevent a malicious peer from generating
+	    excessive load.

+          

+	    Own Id: OTP-12628

+        
+      
+    

+
+

+
 
diameter 1.8
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 920b80059027814d564e1c010e76c464996bdf5c Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Sun, 3 May 2015 10:49:34 +0200
Subject: Add missing doc wording

---
 lib/diameter/doc/src/diameter.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 6e41b01c44..ea175a58b8 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -1820,7 +1820,8 @@ The information presented here is as in the connect case except
 that the client connections are grouped under an accept tuple.

 
 

-Whether or not the &transport_opt; pool_size affects the format
+Whether or not the &transport_opt; pool_size has been
+configured affects the format
 of the listing in the case of a connecting transport, since a value
 greater than 1 implies multiple transport processes for the same
 &transport_ref;, as in the listening case.
-- 
cgit v1.2.3


From 512f099b247b17b3145e90293167a4ba373b9471 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Wed, 6 May 2015 10:46:46 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 479fab21b2..6931788c83 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,47 @@ first.

 
 
 
+
diameter 1.9.1
+
+    
Known Bugs and Problems
+      
+        
+          

+	    Don't leave extra bit in decoded AVP data.

+          

+	    OTP-12074 in OTP 17.3 missed one case: a length error on
+	    a trailing AVP unknown to the dictionary in question.

+          

+	    Own Id: OTP-12642

+        
+        
+          

+	    Don't confuse Result-Code and Experimental-Result

+          

+	    The errors field of a decoded diameter_packet record was
+	    populated with a Result-Code AVP when an
+	    Experimental-Result containing a 3xxx Result-Code was
+	    received in an answer not setting the E-bit. The correct
+	    AVP is now extracted from the incoming message.

+          

+	    Own Id: OTP-12654 Aux Id: seq12851 

+        
+        
+          

+	    Don't count on unknown Application Id.

+          

+	    OTP-11721 in OTP 17.1 missed the case of an Application
+	    Id not agreeing with that of the dictionary in question,
+	    causing counters to be accumulated on keys containing the
+	    unknown id.

+          

+	    Own Id: OTP-12701

+        
+      
+    

+
+

+
 
diameter 1.9
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From fda0d3c3c95b640605abde573fdd534a63095e47 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Sat, 23 May 2015 08:15:52 +0200
Subject: Fix mangled release note

---
 lib/diameter/doc/src/notes.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 6931788c83..51f905682d 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -65,7 +65,7 @@ first.

 	    received in an answer not setting the E-bit. The correct
 	    AVP is now extracted from the incoming message.

           

-	    Own Id: OTP-12654 Aux Id: seq12851 

+	    Own Id: OTP-12654

         
         
           

-- 
cgit v1.2.3


From d0a051385233f388e4d8a51b03c6894f399d7a3f Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Fri, 29 May 2015 12:40:24 +0200
Subject: Update release notes

---
 lib/diameter/doc/src/notes.xml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 51f905682d..c5df63a7f0 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,36 @@ first.

 
 
 
+
diameter 1.9.2
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Fix broken relay counters.

+          

+	    OTP-12654 in OTP 17.5.3 broke counters in the case of
+	    answer messages received in the relay application.
+	    Counters were accumulated as unknown messages or
+	    no_result_code instead of as relayed messages on the
+	    intended Result-Code and 'Experimental-Result' tuples.

+          

+	    Own Id: OTP-12741

+        
+        
+          

+	    Fix diameter_sctp listener race.

+          

+	    An oversight in OTP-12428 made it possible to start a
+	    transport process that could not establish associations.

+          

+	    Own Id: OTP-12744

+        
+      
+    

+
+

+
 
diameter 1.9.1
 
     
Known Bugs and Problems
-- 
cgit v1.2.3


From a8c986ca270721d2a687ff42fd90934dbbaab58c Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Sun, 10 May 2015 16:23:51 +0200
Subject: Fix release note typo

---
 lib/diameter/doc/src/notes.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index c5df63a7f0..8ab81a0a09 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -87,7 +87,7 @@ first.

         
         
           

-	    Don't confuse Result-Code and Experimental-Result

+	    Don't confuse Result-Code and Experimental-Result.

           

 	    The errors field of a decoded diameter_packet record was
 	    populated with a Result-Code AVP when an
-- 
cgit v1.2.3


From 738c34d4bb8f1a3811acd00af8c6c12107f8315b Mon Sep 17 00:00:00 2001
From: Bruce Yinhe 
Date: Thu, 18 Jun 2015 11:31:02 +0200
Subject: Change license text to APLv2

---
 lib/diameter/doc/src/Makefile                 | 19 ++++++++++---------
 lib/diameter/doc/src/book.xml                 | 21 +++++++++++----------
 lib/diameter/doc/src/depend.sed               | 21 +++++++++++----------
 lib/diameter/doc/src/diameter.xml             | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_app.xml         | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_codec.xml       | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_dict.xml        | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_examples.xml    | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_intro.xml       | 19 ++++++++++---------
 lib/diameter/doc/src/diameter_make.xml        | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_sctp.xml        | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_soc.xml         | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_soc_rfc6733.xml | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_tcp.xml         | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_transport.xml   | 21 +++++++++++----------
 lib/diameter/doc/src/diameter_using.xml       | 21 +++++++++++----------
 lib/diameter/doc/src/files.mk                 | 19 ++++++++++---------
 lib/diameter/doc/src/notes.xml                | 21 +++++++++++----------
 lib/diameter/doc/src/ref_man.xml              | 21 +++++++++++----------
 lib/diameter/doc/src/seealso.ent              | 21 +++++++++++----------
 lib/diameter/doc/src/seehere.sed              | 21 +++++++++++----------
 lib/diameter/doc/src/user_man.xml             | 21 +++++++++++----------
 22 files changed, 239 insertions(+), 217 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/Makefile b/lib/diameter/doc/src/Makefile
index 229812fd08..ae621c3e11 100644
--- a/lib/diameter/doc/src/Makefile
+++ b/lib/diameter/doc/src/Makefile
@@ -3,16 +3,17 @@
 #
 # Copyright Ericsson AB 2010-2013. All Rights Reserved.
 #
-# The contents of this file are subject to the Erlang Public License,
-# Version 1.1, (the "License"); you may not use this file except in
-# compliance with the License. You should have received a copy of the
-# Erlang Public License along with this software. If not, it can be
-# retrieved online at http://www.erlang.org/.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# Software distributed under the License is distributed on an "AS IS"
-# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-# the License for the specific language governing rights and limitations
-# under the License.
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 #
 # %CopyrightEnd%
 
diff --git a/lib/diameter/doc/src/book.xml b/lib/diameter/doc/src/book.xml
index 7b606c84d0..dd5a5ea30c 100644
--- a/lib/diameter/doc/src/book.xml
+++ b/lib/diameter/doc/src/book.xml
@@ -9,16 +9,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/depend.sed b/lib/diameter/doc/src/depend.sed
index 42de597f15..a878460b00 100644
--- a/lib/diameter/doc/src/depend.sed
+++ b/lib/diameter/doc/src/depend.sed
@@ -3,16 +3,17 @@
 #
 # Copyright Ericsson AB 2011. All Rights Reserved.
 #
-# The contents of this file are subject to the Erlang Public License,
-# Version 1.1, (the "License"); you may not use this file except in
-# compliance with the License. You should have received a copy of the
-# Erlang Public License along with this software. If not, it can be
-# retrieved online at http://www.erlang.org/.
-#
-# Software distributed under the License is distributed on an "AS IS"
-# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-# the License for the specific language governing rights and limitations
-# under the License.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 #
 # %CopyrightEnd%
 
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index ea175a58b8..1e1206aa2d 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -25,16 +25,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index 67c430c40a..4cd25c18c2 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -17,16 +17,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index 308a56fab7..e2ebe7acf6 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -17,16 +17,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 5cf1b174a0..087b24fb87 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -20,16 +20,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_examples.xml b/lib/diameter/doc/src/diameter_examples.xml
index 7808d64b8d..ba3b42b88d 100644
--- a/lib/diameter/doc/src/diameter_examples.xml
+++ b/lib/diameter/doc/src/diameter_examples.xml
@@ -10,16 +10,17 @@
 
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml
index 93293f2d8e..1718d1c612 100644
--- a/lib/diameter/doc/src/diameter_intro.xml
+++ b/lib/diameter/doc/src/diameter_intro.xml
@@ -12,16 +12,17 @@
 
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
 
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index 0c7e6b794d..f53ad434ae 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -20,16 +20,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml
index 6302cb1435..09c5c33004 100644
--- a/lib/diameter/doc/src/diameter_sctp.xml
+++ b/lib/diameter/doc/src/diameter_sctp.xml
@@ -20,16 +20,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_soc.xml b/lib/diameter/doc/src/diameter_soc.xml
index d9159f84b5..2ba93bf452 100644
--- a/lib/diameter/doc/src/diameter_soc.xml
+++ b/lib/diameter/doc/src/diameter_soc.xml
@@ -14,16 +14,17 @@
 
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_soc_rfc6733.xml b/lib/diameter/doc/src/diameter_soc_rfc6733.xml
index 34ec902632..61931c6b5a 100644
--- a/lib/diameter/doc/src/diameter_soc_rfc6733.xml
+++ b/lib/diameter/doc/src/diameter_soc_rfc6733.xml
@@ -8,16 +8,17 @@
 
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml
index f6bbe7dd23..5fafec283c 100644
--- a/lib/diameter/doc/src/diameter_tcp.xml
+++ b/lib/diameter/doc/src/diameter_tcp.xml
@@ -31,16 +31,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml
index 1618d05c47..fd89fbc344 100644
--- a/lib/diameter/doc/src/diameter_transport.xml
+++ b/lib/diameter/doc/src/diameter_transport.xml
@@ -18,16 +18,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/diameter_using.xml b/lib/diameter/doc/src/diameter_using.xml
index 4427d29c3c..596a6861a1 100644
--- a/lib/diameter/doc/src/diameter_using.xml
+++ b/lib/diameter/doc/src/diameter_using.xml
@@ -10,16 +10,17 @@
 
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk
index 6e8b1f9068..72f26c769e 100644
--- a/lib/diameter/doc/src/files.mk
+++ b/lib/diameter/doc/src/files.mk
@@ -4,16 +4,17 @@
 #
 # Copyright Ericsson AB 2010-2013. All Rights Reserved.
 #
-# The contents of this file are subject to the Erlang Public License,
-# Version 1.1, (the "License"); you may not use this file except in
-# compliance with the License. You should have received a copy of the
-# Erlang Public License along with this software. If not, it can be
-# retrieved online at http://www.erlang.org/.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# Software distributed under the License is distributed on an "AS IS"
-# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-# the License for the specific language governing rights and limitations
-# under the License.
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 #
 # %CopyrightEnd%
 
diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index c5df63a7f0..4ffa09c890 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -15,16 +15,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/ref_man.xml b/lib/diameter/doc/src/ref_man.xml
index 62ba02b0b5..4781878fbb 100644
--- a/lib/diameter/doc/src/ref_man.xml
+++ b/lib/diameter/doc/src/ref_man.xml
@@ -10,16 +10,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index 4e205ffad7..e5c284c6e8 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -6,16 +6,17 @@
 
 Copyright Ericsson AB 2012-2015. All Rights Reserved.
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 %CopyrightEnd%
 
diff --git a/lib/diameter/doc/src/seehere.sed b/lib/diameter/doc/src/seehere.sed
index c62a783d40..56932c4178 100644
--- a/lib/diameter/doc/src/seehere.sed
+++ b/lib/diameter/doc/src/seehere.sed
@@ -3,16 +3,17 @@
 #
 # Copyright Ericsson AB 2012. All Rights Reserved.
 #
-# The contents of this file are subject to the Erlang Public License,
-# Version 1.1, (the "License"); you may not use this file except in
-# compliance with the License. You should have received a copy of the
-# Erlang Public License along with this software. If not, it can be
-# retrieved online at http://www.erlang.org/.
-#
-# Software distributed under the License is distributed on an "AS IS"
-# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-# the License for the specific language governing rights and limitations
-# under the License.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 #
 # %CopyrightEnd%
 
diff --git a/lib/diameter/doc/src/user_man.xml b/lib/diameter/doc/src/user_man.xml
index f915fa5a66..ac5bef95f5 100644
--- a/lib/diameter/doc/src/user_man.xml
+++ b/lib/diameter/doc/src/user_man.xml
@@ -9,16 +9,17 @@
 Ericsson AB. All Rights Reserved.
 
 
-The contents of this file are subject to the Erlang Public License,
-Version 1.1, (the "License"); you may not use this file except in
-compliance with the License. You should have received a copy of the
-Erlang Public License along with this software. If not, it can be
-retrieved online at http://www.erlang.org/.
-
-Software distributed under the License is distributed on an "AS IS"
-basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-the License for the specific language governing rights and limitations
-under the License.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 
 
-- 
cgit v1.2.3


From 2955ddebc32837b66d9bacb4e925ad0ed0033168 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Tue, 23 Jun 2015 10:24:26 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 100 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 26e6e2ef7a..299d4093da 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,106 @@ first.

 
 
 
+
diameter 1.10
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Fix decode of Grouped AVPs containing errors.

+          

+	    RFC 6733 says this of Failed-AVP in 7.5:

+          

+	    
 In the case where the offending AVP
+	    is embedded within a Grouped AVP, the Failed-AVP MAY
+	    contain the grouped AVP, which in turn contains the
+	    single offending AVP. The same method MAY be employed if
+	    the grouped AVP itself is embedded in yet another grouped
+	    AVP and so on. In this case, the Failed-AVP MAY contain
+	    the grouped AVP hierarchy up to the single offending AVP.
+	    This enables the recipient to detect the location of the
+	    offending AVP when embedded in a
+	    group.

+          

+	    It says this of DIAMETER_INVALID_AVP_LENGTH in 7.1.5:

+          

+	    
 The request contained an AVP with
+	    an invalid length. A Diameter message indicating this
+	    error MUST include the offending AVPs within a Failed-AVP
+	    AVP. In cases where the erroneous AVP length value
+	    exceeds the message length or is less than the minimum
+	    AVP header length, it is sufficient to include the
+	    offending AVP header and a zero filled payload of the
+	    minimum required length for the payloads data type. If
+	    the AVP is a Grouped AVP, the Grouped AVP header with an
+	    empty payload would be sufficient to indicate the
+	    offending AVP. In the case where the offending AVP header
+	    cannot be fully decoded when the AVP length is less than
+	    the minimum AVP header length, it is sufficient to
+	    include an offending AVP header that is formulated by
+	    padding the incomplete AVP header with zero up to the
+	    minimum AVP header length.

+          

+	    The AVPs placed in the errors field of a diameter_packet
+	    record are intended to be appropriate for inclusion in a
+	    Failed-AVP, but neither of the above paragraphs has been
+	    followed in the Grouped case: the entire faulty AVP
+	    (non-faulty components and all) has been included. This
+	    made it difficult to identify the actual faulty AVP in
+	    all but simple cases.

+          

+	    The decode is now adapted to the RFC, and implements the
+	    suggested single faulty AVP, nested in as many Grouped
+	    containers as required.

+          

+	    Own Id: OTP-12721

+        
+        
+          

+	    Fix SCTP problems on Solaris.

+          

+	    The allocation of association ids in Solaris was in
+	    conflict with an assumption made in diameter_sctp,
+	    resulting in failures when accepting multiple peer
+	    connections.

+          

+	    Own Id: OTP-12768

+        
+        
+          

+	    Fix start order of alternate transports.

+          

+	    A transport configured with diameter:add_transport/2 can
+	    be passed multiple transport_module/transport_config
+	    tuples in order to specify alternate configuration,
+	    modules being attempted in order until one succeeds. This
+	    is primarily for the connecting case; for example, to
+	    allow a transport to be configured to first attempt
+	    connection over SCTP, and then TCP in case SCTP fails.
+	    Multiple module tuples can be paired with a single config
+	    tuple, but in this case the start order was reversed
+	    relative to the order in which the modules were specifed.

+          

+	    Own Id: OTP-12851

+        
+      
+    

+
+
+    
Improvements and New Features
+      
+        
+          

+	    Change license text from Erlang Public License to Apache
+	    Public License v2

+          

+	    Own Id: OTP-12845

+        
+      
+    

+
+

+
 
diameter 1.9.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 80420620b67216b67e90affc5fe35505207254a3 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Wed, 8 Jul 2015 15:07:15 +0200
Subject: Correct inaccurate doc

The warning report was removed in commit 00584303.
---
 lib/diameter/doc/src/diameter.xml | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index ea175a58b8..cb628f9529 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -1231,9 +1231,7 @@ is not the length of the message in question, as received over the
 transport interface documented in &man_transport;.

 
 

-If exit then a warning report is emitted and the parent of the
-transport process in question exits, which causes the transport
-process itself to exit as described in &man_transport;.
+If exit then the transport process in question exits.
 If handle then the message is processed as usual, a resulting
 &app_handle_request; or &app_handle_answer; callback (if one takes
 place) indicating the 5015 error (DIAMETER_INVALID_MESSAGE_LENGTH).
-- 
cgit v1.2.3


From 9ab5d8afedc6d2f56997276e3f016ec1c6dac6a5 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Tue, 7 Jul 2015 13:34:57 +0200
Subject: Don't compute AVP list length unnecessarily at AVP decode

This has had a hugely negative impact on performance when decoding
messages containing many AVP: each decode of an AVP having variable
arity computed the length of the list of previously decoded AVPs when
checking that the allowed arity was not exceeded, even if the allowed
arity was infinite, making for O(n^2) cost. Here are some execution
times, for diameter_codec:decode/2 on a representative message with n
integer AVPs in the Common application (on the host at hand):

             Before      After
             -------     ---------
  n = 1K       5 ms        2 ms
  n = 10K    500 ms       25 ms
  n = 100K    75 sec     225 ms
  n = 1M                   2.6 sec

Note the nearly linear increase following the change.

Remove the dire documentation warning for incoming_maxlen as a
consequence. It can still be useful to set, but not doing so won't have
the same consequences as previously.
---
 lib/diameter/doc/src/diameter.xml | 8 --------
 1 file changed, 8 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index cb628f9529..854bc5b432 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -794,14 +794,6 @@ Messages larger than the specified number of bytes are discarded.

 Defaults to 16777215, the maximum value of the 24-bit Message
 Length field in a Diameter Header.

 
-
-

-This option should be set to as low a value as is sufficient for the
-Diameter applications and peers in question, since decoding incoming
-messages from a malicious peer can otherwise generate significant
-load.

-
-
 
 
 {restrict_connections, false
-- 
cgit v1.2.3


From 030f3cbd61217bcd3eb49ed19de9d05987d1e6b7 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Thu, 13 Aug 2015 12:34:10 +0200
Subject: Update release notes

---
 lib/diameter/doc/src/notes.xml | 126 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index c5df63a7f0..7726d761bd 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,132 @@ first.

 
 
 
+
diameter 1.9.2.1
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Don't report 5005 (DIAMETER_AVP_MISSING) errors
+	    unnecessarily.

+          

+	    An AVP whose decode failed was reported as missing,
+	    despite having been reported with another error as a
+	    consequence of the failure.

+          

+	    Own Id: OTP-12871

+        
+        
+          

+	    Fix relay encode of nested, Grouped AVPs.

+          

+	    A fault in OTP-12475 caused encode to fail if the first
+	    AVP in a Grouped AVP was itself Grouped.

+          

+	    Own Id: OTP-12879 Aux Id: OTP-12475 

+        
+        
+          

+	    Improve decode performance.

+          

+	    The time required to decode a message increased
+	    quadratically with the number of AVPs in the worst case,
+	    leading to extremely long execution times.

+          

+	    Own Id: OTP-12891

+        
+        
+          

+	    Match acceptable peer addresses case insensitively.

+          

+	    Regular expressions passed in an 'accept' tuple to
+	    diameter_tcp or diameter_sctp inappropriately matched
+	    case.

+          

+	    Own Id: OTP-12902

+        
+        
+          

+	    Improve watchdog and statistics performance.

+          

+	    Inefficient use of timers contributed to poor performance
+	    at high load, as did ordering of the table statistics are
+	    written to.

+          

+	    Own Id: OTP-12912

+        
+        
+          

+	    Fix start order of alternate transports.

+          

+	    A transport configured with diameter:add_transport/2 can
+	    be passed multiple transport_module/transport_config
+	    tuples in order to specify alternate configuration,
+	    modules being attempted in order until one succeeds. This
+	    is primarily for the connecting case; for example, to
+	    allow a transport to be configured to first attempt
+	    connection over SCTP, and then TCP in case SCTP fails.
+	    Multiple module tuples can be paired with a single config
+	    tuple, but in this case the start order was reversed
+	    relative to the order in which the modules were specifed.

+          

+	    Own Id: OTP-12929

+        
+        
+          

+	    Fix decode of Grouped AVPs containing errors.

+          

+	    RFC 6733 says this of Failed-AVP in 7.5:

+          

+	    
 In the case where the offending AVP
+	    is embedded within a Grouped AVP, the Failed-AVP MAY
+	    contain the grouped AVP, which in turn contains the
+	    single offending AVP. The same method MAY be employed if
+	    the grouped AVP itself is embedded in yet another grouped
+	    AVP and so on. In this case, the Failed-AVP MAY contain
+	    the grouped AVP hierarchy up to the single offending AVP.
+	    This enables the recipient to detect the location of the
+	    offending AVP when embedded in a
+	    group.

+          

+	    It says this of DIAMETER_INVALID_AVP_LENGTH in 7.1.5:

+          

+	    
 The request contained an AVP with
+	    an invalid length. A Diameter message indicating this
+	    error MUST include the offending AVPs within a Failed-AVP
+	    AVP. In cases where the erroneous AVP length value
+	    exceeds the message length or is less than the minimum
+	    AVP header length, it is sufficient to include the
+	    offending AVP header and a zero filled payload of the
+	    minimum required length for the payloads data type. If
+	    the AVP is a Grouped AVP, the Grouped AVP header with an
+	    empty payload would be sufficient to indicate the
+	    offending AVP. In the case where the offending AVP header
+	    cannot be fully decoded when the AVP length is less than
+	    the minimum AVP header length, it is sufficient to
+	    include an offending AVP header that is formulated by
+	    padding the incomplete AVP header with zero up to the
+	    minimum AVP header length.

+          

+	    The AVPs placed in the errors field of a diameter_packet
+	    record are intended to be appropriate for inclusion in a
+	    Failed-AVP, but neither of the above paragraphs has been
+	    followed in the Grouped case: the entire faulty AVP
+	    (non-faulty components and all) has been included. This
+	    made it difficult to identify the actual faulty AVP in
+	    all but simple cases.

+          

+	    The decode is now adapted to the RFC, and implements the
+	    suggested single faulty AVP, nested in as many Grouped
+	    containers as required.

+          

+	    Own Id: OTP-12930

+        
+      
+    

+
+

+
 
diameter 1.9.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 8b2c875cfd6a12d3dc9ccd9198d1f6123dee8a7f Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Fri, 14 Aug 2015 00:44:02 +0200
Subject: Fix broken release notes

Broken in the parent commit.
---
 lib/diameter/doc/src/notes.xml | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 2953de95d1..c5f0d66f10 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -100,6 +100,8 @@ first.

       
     

 
+

+
 
 
 
diameter 1.10
-- 
cgit v1.2.3


From 502189ba42469d3332bc0658caa2bd0de1e3fcb9 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Mon, 24 Aug 2015 16:14:49 +0200
Subject: Add service_opt() strict_mbit

There are differing opinions on whether or not reception of an arbitrary
AVP setting the M-bit is an error. 1.3.4 of RFC 6733 says this about
how an existing Diameter application may be modified:

   o  The M-bit allows the sender to indicate to the receiver whether or
      not understanding the semantics of an AVP and its content is
      mandatory.  If the M-bit is set by the sender and the receiver
      does not understand the AVP or the values carried within that AVP,
      then a failure is generated (see Section 7).

   It is the decision of the protocol designer when to develop a new
   Diameter application rather than extending Diameter in other ways.
   However, a new Diameter application MUST be created when one or more
   of the following criteria are met:

   M-bit Setting

      An AVP with the M-bit in the MUST column of the AVP flag table is
      added to an existing Command/Application.  An AVP with the M-bit
      in the MAY column of the AVP flag table is added to an existing
      Command/Application.

The point here is presumably interoperability: that the command grammar
should specify explicitly what mandatory AVPs much be understood, and
that anything more is an error.

On the other hand, 3.2 says thus about command grammars:

   avp-name         = avp-spec / "AVP"
                      ; The string "AVP" stands for *any* arbitrary AVP
                      ; Name, not otherwise listed in that Command Code
                      ; definition.  The inclusion of this string
                      ; is recommended for all CCFs to allow for
                      ; extensibility.

This renders 1.3.4 pointless unless "*any* AVP" is qualified by "not
setting the M-bit", since the sender can effectively violate 1.3.4
without this necessitating an error at the receiver. If clients add
arbitrary AVPs setting the M-bit then request handling becomes more
implementation-dependent.

The current interpretation in diameter is strict: if a command grammar
doesn't explicitly allow an AVP setting the M-bit then reception of such
an AVP is regarded as an error. The strict_mbit option now allows this
behaviour to be changed, false turning all responsibility for the M-bit
over to the user.
---
 lib/diameter/doc/src/diameter.xml | 43 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 854bc5b432..b0cff32c9a 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -912,6 +912,49 @@ Options monitor and link are ignored.

 Defaults to the empty list.

 
 
+
+{strict_mbit, boolean()}
+
+

+Whether or not to regard an AVP setting the M-bit as erroneous when
+the command grammar in question does not explicitly allow the AVP.
+If true then such AVPs are regarded as 5001 errors,
+DIAMETER_AVP_UNSUPPORTED.
+If false then the M-bit is ignored and policing
+it becomes the receiver's responsibility.

+
+

+Defaults to true.

+
+
+

+RFC 6733 is unclear about the semantics of the M-bit.
+One the one hand, the CCF specification in section 3.2 documents AVP
+in a command grammar as meaning any arbitrary AVP; on the
+other hand, 1.3.4 states that AVPs setting the M-bit cannot be added
+to an existing command: the modified command must instead be
+placed in a new Diameter application.

+

+The reason for the latter is presumably interoperability:
+allowing arbitrary AVPs setting the M-bit in a command makes its
+interpretation implementation-dependent, since there's no
+guarantee that all implementations will understand the same set of
+arbitrary AVPs in the context of a given command.
+However, interpreting AVP in a command grammar as any
+AVP, regardless of M-bit, renders 1.3.4 meaningless, since the receiver
+can simply ignore any AVP it thinks isn't relevant, regardless of the
+sender's intent.

+

+Beware of confusing mandatory in the sense of the M-bit with mandatory
+in the sense of the command grammar.
+The former is a semantic requirement: that the receiver understand the
+semantics of the AVP in the context in question.
+The latter is a syntactic requirement: whether or not the AVP must
+occur in the message in question.

+
+
+
+
 
 {string_decode, boolean()}
 
-- 
cgit v1.2.3


From f3cf61cd87465f9424e23223b8b3d2f4aacc3ace Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Thu, 17 Sep 2015 13:35:23 +0200
Subject: Remove 1.11 release notes

These were added manually in merge commit 8c5d719a, but that was wrong:
the notes will be generated.

Note that OTP-12791 in the comment for commit 5a339bcb is wrong: it's
OTP-12891.
---
 lib/diameter/doc/src/notes.xml | 61 ------------------------------------------
 1 file changed, 61 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index c5f0d66f10..afe9117a9d 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,67 +43,6 @@ first.

 
 
 
-
diameter 1.11
-
-    
Fixed Bugs and Malfunctions
-      
-        
-          

-	    Don't report 5005 (DIAMETER_AVP_MISSING) errors
-	    unnecessarily.

-          

-	    An AVP whose decode failed was reported as missing,
-	    despite having been reported with another error as a
-	    consequence of the failure.

-          

-	    Own Id: OTP-12871

-        
-        
-          

-	    Fix relay encode of nested, Grouped AVPs.

-          

-	    A fault in OTP-12475 caused encode to fail if the first
-	    AVP in a Grouped AVP was itself Grouped.

-          

-	    Own Id: OTP-12879 Aux Id: OTP-12475 

-        
-        
-          

-	    Improve decode performance.

-          

-	    The time required to decode a message increased
-	    quadratically with the number of AVPs in the worst case,
-	    leading to extremely long execution times.

-          

-	    Own Id: OTP-12891

-        
-        
-          

-	    Match acceptable peer addresses case insensitively.

-          

-	    Regular expressions passed in an 'accept' tuple to
-	    diameter_tcp or diameter_sctp inappropriately matched
-	    case.

-          

-	    Own Id: OTP-12902

-        
-        
-          

-	    Improve watchdog and statistics performance.

-          

-	    Inefficient use of timers contributed to poor performance
-	    at high load, as did ordering of the table statistics are
-	    written to.

-          

-	    Own Id: OTP-12912

-        
-      
-    

-
-

-
-
-
 
diameter 1.10
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 6738d356a279835222b951fd213ed4cf9897eb7e Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Mon, 21 Sep 2015 17:09:23 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 88 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index afe9117a9d..61bed37682 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,94 @@ first.

 
 
 
+
diameter 1.11
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Fix relay encode of nested, Grouped AVPs.

+          

+	    A fault in OTP-12475 caused encode to fail if the first
+	    AVP in a Grouped AVP was itself Grouped.

+          

+	    Own Id: OTP-12879 Aux Id: OTP-12475 

+        
+        
+          

+	    Match acceptable peer addresses case insensitively.

+          

+	    Regular expressions passed in an 'accept' tuple to
+	    diameter_tcp or diameter_sctp inappropriately matched
+	    case.

+          

+	    Own Id: OTP-12902

+        
+        
+          

+	    Fix diameter_watchdog function clause.

+          

+	    OTP-12912 introduced an error with accepting transports
+	    setting {restrict_connections, false}, causing
+	    processes to fail when peer connections were terminated.

+          

+	    Own Id: OTP-12969

+        
+      
+    

+
+
+    
Improvements and New Features
+      
+        
+          

+	    Don't report 5005 (DIAMETER_AVP_MISSING) errors
+	    unnecessarily.

+          

+	    An AVP whose decode failed was reported as missing,
+	    despite having been reported with another error as a
+	    consequence of the failure.

+          

+	    Own Id: OTP-12871

+        
+        
+          

+	    Improve decode performance.

+          

+	    The time required to decode a message increased
+	    quadratically with the number of AVPs in the worst case,
+	    leading to extremely long execution times.

+          

+	    Own Id: OTP-12891

+        
+        
+          

+	    Improve watchdog and statistics performance.

+          

+	    Inefficient use of timers contributed to poor performance
+	    at high load, as did ordering of the table statistics are
+	    written to.

+          

+	    Own Id: OTP-12912

+        
+        
+          

+	    Add service_opt() strict_mbit.

+          

+	    There are differing opinions on whether or not reception
+	    of an arbitrary AVP setting the M-bit is an error. The
+	    default interpretation is strict: if a command grammar
+	    doesn't explicitly allow an AVP setting the M-bit then
+	    reception of such an AVP is regarded as an error. Setting
+	    {strict_mbit, false} disables this check.

+          

+	    Own Id: OTP-12947

+        
+      
+    

+
+

+
 
diameter 1.10
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From f4a0ae1736216feac5ae053610644bba2e12ed34 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Tue, 15 Dec 2015 09:45:27 +0100
Subject: Update release notes

---
 lib/diameter/doc/src/notes.xml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 61bed37682..828ade4a71 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,29 @@ first.

 
 
 
+
diameter 1.11.1
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Fix request table leaks

+          

+	    The End-to-End and Hop-by-Hop identifiers of outgoing
+	    Diameter requests are stored in a table in order for the
+	    caller to be located when the corresponding answer
+	    message is received. Entries were orphaned if the handler
+	    was terminated by an exit signal as a consequence of
+	    actions taken by callback functions, or if callbacks
+	    modified identifiers in retransmission cases.

+          

+	    Own Id: OTP-13137

+        
+      
+    

+
+

+
 
diameter 1.11
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 6a6ff0791a7de5a7a9e034366271497aa2130204 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Sun, 20 Dec 2015 16:29:15 +0100
Subject: Update release notes

---
 lib/diameter/doc/src/notes.xml | 52 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 7726d761bd..838b1ad7dc 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,58 @@ first.

 
 
 
+
diameter 1.9.2.2
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Fix diameter_watchdog function clause.

+          

+	    OTP-12912 introduced an error with accepting transports
+	    setting {restrict_connections, false}, causing
+	    processes to fail when peer connections were terminated.

+          

+	    Own Id: OTP-12969

+        
+        
+          

+	    Fix request table leaks

+          

+	    The End-to-End and Hop-by-Hop identifiers of outgoing
+	    Diameter requests are stored in a table in order for the
+	    caller to be located when the corresponding answer
+	    message is received. Entries were orphaned if the handler
+	    was terminated by an exit signal as a consequence of
+	    actions taken by callback functions, or if callbacks
+	    modified identifiers in retransmission cases.

+          

+	    Own Id: OTP-13137

+        
+      
+    

+
+
+    
Improvements and New Features
+      
+        
+          

+	    Add service_opt() strict_mbit.

+          

+	    There are differing opinions on whether or not reception
+	    of an arbitrary AVP setting the M-bit is an error. The
+	    default interpretation is strict: if a command grammar
+	    doesn't explicitly allow an AVP setting the M-bit then
+	    reception of such an AVP is regarded as an error. Setting
+	    {strict_mbit, false} disables this check.

+          

+	    Own Id: OTP-12947

+        
+      
+    

+
+

+
 
diameter 1.9.2.1
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 8fd4e5f47efd13a6bad7811239438539ae383966 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Mon, 7 Dec 2015 17:06:38 +0100
Subject: Make peer handling more efficient

Each service process maintains a dictionary of peers, mapping an
application alias to a {pid(), #diameter_caps{}} list of connected
peers. These lists are potentially large, peers were appended to the end
of the list for no particular reason, and these long lists were
constructed/deconstructed when filtering them for pick_peer callbacks.
Many simultaneous outgoing request could then slow the VM to a crawl,
with many scheduled processes mired in list manipulation.

The pseudo-dicts are now replaced by plain ets tables. The reason for
them was (once upon a time) to have an interface interchangeable with a
plain dict for debugging purposes, but strict swapablity hasn't been the
case for some time now, and in practice a swap has never taken place.

Additional tables mapping Origin-Host/Realm have also been introduced,
to minimize the size of the peers lists when peers are filtered on
host/realm. For example, a filter like

  {any, [{all, [realm, host]}, realm]}

is probably a very common case: preferring a Destination-Realm/Host
match before falling back on Destination-Realm alone. This is now more
efficiently (but not equivalently) expressed as

  {first, [{all, [realm, host]}, realm]}

to stop the search when the best match is made, and extracts peers from
host/realm tables instead of searching through the list of all peers
supporting the application in question. The code to try and start with a
lookup isn't exhaustive, and the 'any' filter is still as inefficient as
previously.
---
 lib/diameter/doc/src/diameter.xml | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index b0cff32c9a..dbbbb01138 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -466,7 +466,7 @@ Matches only those peers whose Origin-Host has the
 specified value, or all peers if the atom any.

 
 
-{realm, any|&dict_DiameterIdentity;
+{realm, any|&dict_DiameterIdentity;}
 
 

 Matches only those peers whose Origin-Realm has the
@@ -499,18 +499,22 @@ Matches only those peers matched by each filter in the specified list.

 
 

 Matches only those peers matched by at least one filter in the
-specified list.

+specified list.
+The resulting list will be in match order, peers matching the
+first filter of the list sorting before those matched by the second,
+and so on.

+
 
+{first, [&peer_filter;]}
+
 

-The resulting peer list will be in match order, peers matching the
-first filter of the list sorting before those matched by the second,
-and so on.
-For example, the following filter causes peers matching both the host
-and realm filters to be presented before those matching only the realm
-filter.

+Like any, but stops at the first filter for which there are
+matches, which can be much more efficient when there are many peers.
+For example, the following filter causes only peers best matching
+both the host and realm filters to be presented.

 
 
-{any, [{all, [host, realm]}, realm]}
+{first, [{all, [host, realm]}, realm]}
 

 
 
-- 
cgit v1.2.3


From 32b045c47a1cbba3e89a29d669af826d3ed639c1 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Tue, 26 Jan 2016 10:58:26 +0100
Subject: Update release notes

---
 lib/diameter/doc/src/notes.xml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 838b1ad7dc..2fc30db324 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -42,6 +42,27 @@ first.

 
 
 
+
diameter 1.9.2.3
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Make peer handling more efficient.

+          

+	    Inefficient lookup and manipulation of peer lists could
+	    result in poor performance when many outgoing requests
+	    were sent simultaneously, or when many peers connected
+	    simultaneously. Filtering peer lists on realm/host is now
+	    also more efficient in many cases.

+          

+	    Own Id: OTP-13164

+        
+      
+    

+
+

+
 
diameter 1.9.2.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 0f8afe80c6582f7affd17f36dc9cb48cc7946713 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Mon, 14 Mar 2016 10:46:23 +0100
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 828ade4a71..5052515d6a 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,38 @@ first.

 
 
 
+
diameter 1.11.2
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Make peer handling more efficient.

+          

+	    Inefficient lookup and manipulation of peer lists could
+	    result in poor performance when many outgoing requests
+	    were sent simultaneously, or when many peers connected
+	    simultaneously. Filtering peer lists on realm/host is now
+	    also more efficient in many cases.

+          

+	    Own Id: OTP-13164

+        
+        
+          

+	    Fix handling of shared peer connections in watchdog state
+	    SUSPECT.

+          

+	    A peer connection shared from a remote node was regarded
+	    as being up for the lifetime of the connection, ignoring
+	    watchdog transitions into state SUSPECT.

+          

+	    Own Id: OTP-13342

+        
+      
+    

+
+

+
 
diameter 1.11.1
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 6664eed554974336909d3ffe03f20349cc4c38fd Mon Sep 17 00:00:00 2001
From: Henrik Nord 
Date: Tue, 15 Mar 2016 15:19:56 +0100
Subject: update copyright-year

---
 lib/diameter/doc/src/Makefile                 | 2 +-
 lib/diameter/doc/src/book.xml                 | 2 +-
 lib/diameter/doc/src/depend.sed               | 2 +-
 lib/diameter/doc/src/diameter.xml             | 2 +-
 lib/diameter/doc/src/diameter_app.xml         | 2 +-
 lib/diameter/doc/src/diameter_codec.xml       | 2 +-
 lib/diameter/doc/src/diameter_dict.xml        | 2 +-
 lib/diameter/doc/src/diameter_examples.xml    | 2 +-
 lib/diameter/doc/src/diameter_intro.xml       | 2 +-
 lib/diameter/doc/src/diameter_make.xml        | 2 +-
 lib/diameter/doc/src/diameter_sctp.xml        | 2 +-
 lib/diameter/doc/src/diameter_soc.xml         | 2 +-
 lib/diameter/doc/src/diameter_soc_rfc6733.xml | 2 +-
 lib/diameter/doc/src/diameter_tcp.xml         | 2 +-
 lib/diameter/doc/src/diameter_transport.xml   | 2 +-
 lib/diameter/doc/src/diameter_using.xml       | 2 +-
 lib/diameter/doc/src/files.mk                 | 2 +-
 lib/diameter/doc/src/notes.xml                | 2 +-
 lib/diameter/doc/src/ref_man.xml              | 2 +-
 lib/diameter/doc/src/seehere.sed              | 2 +-
 lib/diameter/doc/src/user_man.xml             | 2 +-
 21 files changed, 21 insertions(+), 21 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/Makefile b/lib/diameter/doc/src/Makefile
index ae621c3e11..7a7546fc4d 100644
--- a/lib/diameter/doc/src/Makefile
+++ b/lib/diameter/doc/src/Makefile
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 2010-2013. All Rights Reserved.
+# Copyright Ericsson AB 2010-2016. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/lib/diameter/doc/src/book.xml b/lib/diameter/doc/src/book.xml
index dd5a5ea30c..b6cbcbc560 100644
--- a/lib/diameter/doc/src/book.xml
+++ b/lib/diameter/doc/src/book.xml
@@ -5,7 +5,7 @@
 
 

 
-20112013
+20112016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/depend.sed b/lib/diameter/doc/src/depend.sed
index a878460b00..9c0a417be2 100644
--- a/lib/diameter/doc/src/depend.sed
+++ b/lib/diameter/doc/src/depend.sed
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 2011. All Rights Reserved.
+# Copyright Ericsson AB 2011-2016. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 5cb29c80e3..66daf6bb0b 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -21,7 +21,7 @@
 
 
 2011
-2015
+2016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index 4cd25c18c2..973b6eb732 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -13,7 +13,7 @@
 

 
 
-20112013
+20112016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index e2ebe7acf6..a0313e2877 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -13,7 +13,7 @@
 
 

 
-20122013
+20122016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 087b24fb87..ae40f99aee 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -16,7 +16,7 @@
 

 
 
-20112013
+20112016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_examples.xml b/lib/diameter/doc/src/diameter_examples.xml
index ba3b42b88d..853ef96bb3 100644
--- a/lib/diameter/doc/src/diameter_examples.xml
+++ b/lib/diameter/doc/src/diameter_examples.xml
@@ -5,7 +5,7 @@
 

 
 
-20112013
+20112016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml
index 1718d1c612..cb0aa3de2a 100644
--- a/lib/diameter/doc/src/diameter_intro.xml
+++ b/lib/diameter/doc/src/diameter_intro.xml
@@ -7,7 +7,7 @@
 
 

 
-20112013
+20112016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index f53ad434ae..112355816f 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -16,7 +16,7 @@
 

 
 2012
-2014
+2016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml
index 09c5c33004..9b6d629f79 100644
--- a/lib/diameter/doc/src/diameter_sctp.xml
+++ b/lib/diameter/doc/src/diameter_sctp.xml
@@ -16,7 +16,7 @@
 

 
 2011
-2014
+2016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_soc.xml b/lib/diameter/doc/src/diameter_soc.xml
index 2ba93bf452..ae404fcda4 100644
--- a/lib/diameter/doc/src/diameter_soc.xml
+++ b/lib/diameter/doc/src/diameter_soc.xml
@@ -9,7 +9,7 @@
 

 
 2011
-2013
+2016
 Ericsson AB. All Rights Reserved.
 
 
diff --git a/lib/diameter/doc/src/diameter_soc_rfc6733.xml b/lib/diameter/doc/src/diameter_soc_rfc6733.xml
index 61931c6b5a..2098965706 100644
--- a/lib/diameter/doc/src/diameter_soc_rfc6733.xml
+++ b/lib/diameter/doc/src/diameter_soc_rfc6733.xml
@@ -3,7 +3,7 @@
 
 
+
diameter 1.12
+
+    
Improvements and New Features
+      
+        
+          

+	    Add diameter:peer_info/1.

+          

+	    That retrieves information in the style of
+	    diameter:service_info/2, but for a single peer
+	    connection.

+          

+	    Own Id: OTP-13508

+        
+      
+    

+
+

+
 
diameter 1.11.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 663e847459686604ea051f036a0e4caff18cea6f Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Thu, 12 May 2016 12:04:14 +0200
Subject: Revert "Prepare release"

This reverts commit bd64ad8e15d66e48b36dbe3584315dd5cfc8b59a.
---
 lib/diameter/doc/src/notes.xml | 19 -------------------
 1 file changed, 19 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 5ae43661fc..82448e7f51 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,25 +43,6 @@ first.

 
 
 
-
diameter 1.12
-
-    
Improvements and New Features
-      
-        
-          

-	    Add diameter:peer_info/1.

-          

-	    That retrieves information in the style of
-	    diameter:service_info/2, but for a single peer
-	    connection.

-          

-	    Own Id: OTP-13508

-        
-      
-    

-
-

-
 
diameter 1.11.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From e020f75c10410a6943cd055bfa072a2641eab7da Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Thu, 2 Jun 2016 10:55:26 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 82448e7f51..5ae43661fc 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,25 @@ first.

 
 
 
+
diameter 1.12
+
+    
Improvements and New Features
+      
+        
+          

+	    Add diameter:peer_info/1.

+          

+	    That retrieves information in the style of
+	    diameter:service_info/2, but for a single peer
+	    connection.

+          

+	    Own Id: OTP-13508

+        
+      
+    

+
+

+
 
diameter 1.11.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From c04cad3ba921deb086d19e2de2526af4854add75 Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Thu, 2 Jun 2016 11:39:07 +0200
Subject: Revert "Prepare release"

This reverts commit e020f75c10410a6943cd055bfa072a2641eab7da.
---
 lib/diameter/doc/src/notes.xml | 19 -------------------
 1 file changed, 19 deletions(-)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 5ae43661fc..82448e7f51 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,25 +43,6 @@ first.

 
 
 
-
diameter 1.12
-
-    
Improvements and New Features
-      
-        
-          

-	    Add diameter:peer_info/1.

-          

-	    That retrieves information in the style of
-	    diameter:service_info/2, but for a single peer
-	    connection.

-          

-	    Own Id: OTP-13508

-        
-      
-    

-
-

-
 
diameter 1.11.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3


From 6e51c6d19612d03abc81b86bb70b8d7da678ce5d Mon Sep 17 00:00:00 2001
From: Erlang/OTP 
Date: Tue, 21 Jun 2016 15:12:41 +0200
Subject: Prepare release

---
 lib/diameter/doc/src/notes.xml | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

(limited to 'lib/diameter/doc/src')

diff --git a/lib/diameter/doc/src/notes.xml b/lib/diameter/doc/src/notes.xml
index 82448e7f51..b1be7bdcf7 100644
--- a/lib/diameter/doc/src/notes.xml
+++ b/lib/diameter/doc/src/notes.xml
@@ -43,6 +43,41 @@ first.

 
 
 
+
diameter 1.12
+
+    
Fixed Bugs and Malfunctions
+      
+        
+          

+	    Ensure listening socket is closed at transport removal.

+          

+	    Transport removal did not immediately close a
+	    diameter_tcp/sctp listening socket, and a
+	    subsequent peer connection caused it to remain open.

+          

+	    Own Id: OTP-13611

+        
+      
+    

+
+
+    
Improvements and New Features
+      
+        
+          

+	    Add diameter:peer_info/1.

+          

+	    That retrieves information in the style of
+	    diameter:service_info/2, but for a single peer
+	    connection.

+          

+	    Own Id: OTP-13508

+        
+      
+    

+
+

+
 
diameter 1.11.2
 
     
Fixed Bugs and Malfunctions
-- 
cgit v1.2.3