Re: [netconf] YANG encoding in CBOR

Carsten Bormann <cabo@tzi.org> Sat, 23 March 2019 10:27 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: netconf@ietfa.amsl.com
Delivered-To: netconf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6295612D84C; Sat, 23 Mar 2019 03:27:13 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.2
X-Spam-Level:
X-Spam-Status: No, score=-4.2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id QiGe99i_Qcwl; Sat, 23 Mar 2019 03:27:11 -0700 (PDT)
Received: from smtp.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id AA2E612D4F2; Sat, 23 Mar 2019 03:27:10 -0700 (PDT)
Received: from dhcp-8804.meeting.ietf.org (dhcp-8804.meeting.ietf.org [31.133.136.4]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.uni-bremen.de (Postfix) with ESMTPSA id 44RGt44Q06zyw5; Sat, 23 Mar 2019 11:27:08 +0100 (CET)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 11.5 \(3445.9.1\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <20190323101003.gp3zvsvqqwc26jip@anna.jacobs.jacobs-university.de>
Date: Sat, 23 Mar 2019 11:27:08 +0100
Cc: Michel Veillette <Michel.Veillette@trilliant.com>, "netconf@ietf.org" <netconf@ietf.org>, "core@ietf.org" <core@ietf.org>
X-Mao-Original-Outgoing-Id: 575029626.264401-255d07e5b71704ba7c6158fb07a891bf
Content-Transfer-Encoding: quoted-printable
Message-Id: <6BAAAC0E-F91B-411B-8768-F628C57FF2E0@tzi.org>
References: <6235c6683ff14848a661f8b8cec94280@XCH-RCD-007.cisco.com> <BL0PR06MB5042823429DB7CDA0F33408B9A430@BL0PR06MB5042.namprd06.prod.outlook.com> <588401AB-483E-40F5-95BB-20A066E56DAC@tzi.org> <15fbaf84b20343a1b83f40b571149a14@XCH-RCD-007.cisco.com> <1ADF8201-ABB4-44FD-A515-F3F8E0DBF5FC@tzi.org> <20190323101003.gp3zvsvqqwc26jip@anna.jacobs.jacobs-university.de>
To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
X-Mailer: Apple Mail (2.3445.9.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/StlANHuJGiARCy4-kYuyprOUBik>
Subject: Re: [netconf] YANG encoding in CBOR
X-BeenThere: netconf@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETCONF WG list <netconf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netconf>, <mailto:netconf-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netconf/>
List-Post: <mailto:netconf@ietf.org>
List-Help: <mailto:netconf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netconf>, <mailto:netconf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sat, 23 Mar 2019 10:27:14 -0000

On Mar 23, 2019, at 11:10, Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>; wrote:
> 
> I think we need to look at the whole picture and in which direction we
> want to go. In the longer term, I would prefer a solution where the
> values of a union are discriminated. The current XML encoding
> behaviour of ‘first match wins'

Can you point to chapter and verse?

> is fragile (for example, if someone
> adds an enum to a type, the interpretation of data can change).
> 
> Look at this:
> 
> typedef bar {
>  type union {
>    type enumeration { enum "1"; value 2; enum "2"; value 1; }
>    type uint8;
>  }
> }
> 
> We have some encodings that send the string representations of the
> values and some encodings that prefer to send numeric representations
> where possible. In order to have a robust solution, encodings should
> likely indicate to which type the value belongs.

In a serialization that has more type information (such as yang-cbor), you can reliably distinguish any usage of the uint8 from the usage of the enumerations.  We put in the CBOR tags to enable that even though enumeration values are normally represented by their “value” field.

The part that I don’t understand is what is the plan with handling conflicts between the enumerations.  I’m not sure what the equivalence model is, here — do YANG enums employ structural equivalence?  There is no name up there, so it can’t really be name equivalence, unless there is an implicit name being inferred from the schema tree.

Grüße, Carsten




> 
> /js
> 
> On Sat, Mar 23, 2019 at 10:03:32AM +0100, Carsten Bormann wrote:
>> Well, if that is a problem, we can go for a longer representation within unions (section 6.12).  Theoretically, we could do that only of there is more than one enum in the union type (so things stay efficient if there is only one), but that might pose difficulties with model evolution.
>> 
>> Going for a string representation repeats the feature of XML YANG (which was ported over to JSON YANG):
>> 
>> typedef foo {
>>  type union {
>>    type enumeration {
>>      enum red { value 1; }
>>      enum breen { value 2; }
>>      enum glue { value 3; }
>>    }
>>    type enumeration {
>>      enum tacks { value 1; }
>>      enum nails { value 2; }
>>      enum glue { value 3; }
>>    }
>>  }
>> }
>> 
>> If you use “glue”, you don’t know which of the enumerations are being used.
>> 
>> Using SIDs, we can do better.
>> 
>> So what do we have to do to get the SID tool to allocate SIDs for enum values?
>> 
>> We could then define the CBOR tag for enums in unions to take the usual SID difference (delta relative to the environment, I’d think), not an integer value.
>> 
>> Several of us are at the hackathon and could make something happen today and tomorrow.
>> 
>> Grüße, Carsten
>> 
>> 
>>> On Mar 22, 2019, at 18:30, Rob Wilton (rwilton) <rwilton@cisco.com>; wrote:
>>> 
>>> I guess that the concern is that this introduces more variation in how data is interpreted between the different XML/JSON/CBOR encodings.
>>> 
>>> E.g. if someone switched from XML to CBOR, suddenly the configuration or state data may have a different meaning.
>>> 
>>> Thanks,
>>> Rob
>>> 
>>> 
>>>> -----Original Message-----
>>>> From: Carsten Bormann <cabo@tzi.org>;
>>>> Sent: 22 March 2019 16:08
>>>> To: Michel Veillette <Michel.Veillette@trilliant.com>;
>>>> Cc: Rob Wilton (rwilton) <rwilton@cisco.com>;; core@ietf.org;
>>>> netconf@ietf.org
>>>> Subject: Re: [netconf] YANG encoding in CBOR
>>>> 
>>>> On Mar 22, 2019, at 16:45, Michel Veillette <Michel.Veillette@trilliant.com>;
>>>> wrote:
>>>>> 
>>>>> The only potential problem I aware is when multiple enumerations are part of
>>>> the same union.
>>>>> Value 4 from enumeration A will be encoded the same way as Value 4 from
>>>> enumeration B.
>>>> 
>>>> … and that is not a problem for the XML version, because the string is being used
>>>> instead of the value.  (But then if two enumerations share a string, you have the
>>>> equivalent problem in the XML serialization.)
>>>> 
>>>> Anyway, I haven’t seen a piece of real-world YANG that actually has this
>>>> problem, so I would be a bit reluctant to make CBOR-based implementations
>>>> more complex (and less efficient) so solve this (non-?)problem.
>>>> 
>>>> Grüße, Carsten
>>> 
>>> 
>>> 
>> 
>> _______________________________________________
>> netconf mailing list
>> netconf@ietf.org
>> https://www.ietf.org/mailman/listinfo/netconf
> 
> -- 
> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
> Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>
> 
> 
> On Sat, Mar 23, 2019 at 10:03:32AM +0100, Carsten Bormann wrote:
>> Well, if that is a problem, we can go for a longer representation within unions (section 6.12).  Theoretically, we could do that only of there is more than one enum in the union type (so things stay efficient if there is only one), but that might pose difficulties with model evolution.
>> 
>> Going for a string representation repeats the feature of XML YANG (which was ported over to JSON YANG):
>> 
>> typedef foo {
>>  type union {
>>    type enumeration {
>>      enum red { value 1; }
>>      enum breen { value 2; }
>>      enum glue { value 3; }
>>    }
>>    type enumeration {
>>      enum tacks { value 1; }
>>      enum nails { value 2; }
>>      enum glue { value 3; }
>>    }
>>  }
>> }
>> 
>> If you use “glue”, you don’t know which of the enumerations are being used.
>> 
>> Using SIDs, we can do better.
>> 
>> So what do we have to do to get the SID tool to allocate SIDs for enum values?
>> 
>> We could then define the CBOR tag for enums in unions to take the usual SID difference (delta relative to the environment, I’d think), not an integer value.
>> 
>> Several of us are at the hackathon and could make something happen today and tomorrow.
>> 
>> Grüße, Carsten
>> 
>> 
>>> On Mar 22, 2019, at 18:30, Rob Wilton (rwilton) <rwilton@cisco.com>; wrote:
>>> 
>>> I guess that the concern is that this introduces more variation in how data is interpreted between the different XML/JSON/CBOR encodings.
>>> 
>>> E.g. if someone switched from XML to CBOR, suddenly the configuration or state data may have a different meaning.
>>> 
>>> Thanks,
>>> Rob
>>> 
>>> 
>>>> -----Original Message-----
>>>> From: Carsten Bormann <cabo@tzi.org>;
>>>> Sent: 22 March 2019 16:08
>>>> To: Michel Veillette <Michel.Veillette@trilliant.com>;
>>>> Cc: Rob Wilton (rwilton) <rwilton@cisco.com>;; core@ietf.org;
>>>> netconf@ietf.org
>>>> Subject: Re: [netconf] YANG encoding in CBOR
>>>> 
>>>> On Mar 22, 2019, at 16:45, Michel Veillette <Michel.Veillette@trilliant.com>;
>>>> wrote:
>>>>> 
>>>>> The only potential problem I aware is when multiple enumerations are part of
>>>> the same union.
>>>>> Value 4 from enumeration A will be encoded the same way as Value 4 from
>>>> enumeration B.
>>>> 
>>>> … and that is not a problem for the XML version, because the string is being used
>>>> instead of the value.  (But then if two enumerations share a string, you have the
>>>> equivalent problem in the XML serialization.)
>>>> 
>>>> Anyway, I haven’t seen a piece of real-world YANG that actually has this
>>>> problem, so I would be a bit reluctant to make CBOR-based implementations
>>>> more complex (and less efficient) so solve this (non-?)problem.
>>>> 
>>>> Grüße, Carsten
>>> 
>>> 
>>> 
>> 
>> _______________________________________________
>> netconf mailing list
>> netconf@ietf.org
>> https://www.ietf.org/mailman/listinfo/netconf
> 
> -- 
> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
> Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>
> 
>