Commit 015b5b8e authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'tools-ynl-gen-split-presence-metadata' 

Jakub Kicinski says:

====================
tools: ynl-gen: split presence metadata

The presence metadata indicates whether given attribute was/should be
added to the Netlink message. We have 3 types of such metadata:
 - bit presence for simple values like integers,
 - len presence for variable size attrs, like binary and strings,
 - count for arrays.

Previously this information was spread around with first two types
living in a dedicated sub-struct called _present. The counts resided
directly in the main struct with an n_ prefix.

Reshuffle these an uniformly store them in dedicated sub-structs.
The immediate motivation is that current scheme causes name collisions
for TC.
====================

Link: https://patch.msgid.link/20250505165208.248049-1-kuba@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 3e52667a d307b9fe

tools/net/ynl/pyynl/ynl_gen_c.py

+37 −43
Original line number Diff line number Diff line
@@ -142,19 +142,19 @@ class Type(SpecAttr): 
        return self.is_recursive() and not ri.op



    def presence_type(self):

        return 'bit'

        return 'present'



    def presence_member(self, space, type_filter):

        if self.presence_type() != type_filter:

            return



        if self.presence_type() == 'bit':

        if self.presence_type() == 'present':

            pfx = '__' if space == 'user' else ''

            return f"{pfx}u32 {self.c_name}:1;"



        if self.presence_type() == 'len':

        if self.presence_type() in {'len', 'count'}:

            pfx = '__' if space == 'user' else ''

            return f"{pfx}u32 {self.c_name}_len;"

            return f"{pfx}u32 {self.c_name};"



    def _complex_member_type(self, ri):

        return None
@@ -185,8 +185,6 @@ class Type(SpecAttr): 
    def struct_member(self, ri):

        member = self._complex_member_type(ri)

        if member:

            if self.is_multi_val():

                ri.cw.p(f"unsigned int n_{self.c_name};")

            ptr = '*' if self.is_multi_val() else ''

            if self.is_recursive_for_op(ri):

                ptr = '*'
@@ -217,10 +215,9 @@ class Type(SpecAttr): 
        cw.p(f'[{self.enum_name}] = {"{"} .name = "{self.name}", {typol}{"}"},')



    def _attr_put_line(self, ri, var, line):

        if self.presence_type() == 'bit':

            ri.cw.p(f"if ({var}->_present.{self.c_name})")

        elif self.presence_type() == 'len':

            ri.cw.p(f"if ({var}->_present.{self.c_name}_len)")

        presence = self.presence_type()

        if presence in {'present', 'len'}:

            ri.cw.p(f"if ({var}->_{presence}.{self.c_name})")

        ri.cw.p(f"{line};")



    def _attr_put_simple(self, ri, var, put_type):
@@ -250,7 +247,7 @@ class Type(SpecAttr): 
        if not self.is_multi_val():

            ri.cw.p("if (ynl_attr_validate(yarg, attr))")

            ri.cw.p("return YNL_PARSE_CB_ERROR;")

            if self.presence_type() == 'bit':

            if self.presence_type() == 'present':

                ri.cw.p(f"{var}->_present.{self.c_name} = 1;")



        if init_lines:
@@ -281,7 +278,8 @@ class Type(SpecAttr): 
            presence = f"{var}->{'.'.join(ref[:i] + [''])}_present.{ref[i]}"

            # Every layer below last is a nest, so we know it uses bit presence

            # last layer is "self" and may be a complex type

            if i == len(ref) - 1 and self.presence_type() != 'bit':

            if i == len(ref) - 1 and self.presence_type() != 'present':

                presence = f"{var}->{'.'.join(ref[:i] + [''])}_{self.presence_type()}.{ref[i]}"

                continue

            code.append(presence + ' = 1;')

        ref_path = '.'.join(ref[:-1])
@@ -501,7 +499,7 @@ class TypeString(Type): 
        self._attr_put_simple(ri, var, 'str')



    def _attr_get(self, ri, var):

        len_mem = var + '->_present.' + self.c_name + '_len'

        len_mem = var + '->_len.' + self.c_name

        return [f"{len_mem} = len;",

                f"{var}->{self.c_name} = malloc(len + 1);",

                f"memcpy({var}->{self.c_name}, ynl_attr_get_str(attr), len);",
@@ -510,10 +508,10 @@ class TypeString(Type): 
               ['unsigned int len;']



    def _setter_lines(self, ri, member, presence):

        return [f"{presence}_len = strlen({self.c_name});",

                f"{member} = malloc({presence}_len + 1);",

                f'memcpy({member}, {self.c_name}, {presence}_len);',

                f'{member}[{presence}_len] = 0;']

        return [f"{presence} = strlen({self.c_name});",

                f"{member} = malloc({presence} + 1);",

                f'memcpy({member}, {self.c_name}, {presence});',

                f'{member}[{presence}] = 0;']





class TypeBinary(Type):
@@ -552,10 +550,10 @@ class TypeBinary(Type): 


    def attr_put(self, ri, var):

        self._attr_put_line(ri, var, f"ynl_attr_put(nlh, {self.enum_name}, " +

                            f"{var}->{self.c_name}, {var}->_present.{self.c_name}_len)")

                            f"{var}->{self.c_name}, {var}->_len.{self.c_name})")



    def _attr_get(self, ri, var):

        len_mem = var + '->_present.' + self.c_name + '_len'

        len_mem = var + '->_len.' + self.c_name

        return [f"{len_mem} = len;",

                f"{var}->{self.c_name} = malloc(len);",

                f"memcpy({var}->{self.c_name}, ynl_attr_data(attr), len);"], \
@@ -563,9 +561,9 @@ class TypeBinary(Type): 
               ['unsigned int len;']



    def _setter_lines(self, ri, member, presence):

        return [f"{presence}_len = len;",

                f"{member} = malloc({presence}_len);",

                f'memcpy({member}, {self.c_name}, {presence}_len);']

        return [f"{presence} = len;",

                f"{member} = malloc({presence});",

                f'memcpy({member}, {self.c_name}, {presence});']





class TypeBitfield32(Type):
@@ -678,13 +676,13 @@ class TypeMultiAttr(Type): 
            lines += [f"free({var}->{ref}{self.c_name});"]

        elif self.attr['type'] == 'string':

            lines += [

                f"for (i = 0; i < {var}->{ref}n_{self.c_name}; i++)",

                f"for (i = 0; i < {var}->{ref}_count.{self.c_name}; i++)",

                f"free({var}->{ref}{self.c_name}[i]);",

                f"free({var}->{ref}{self.c_name});",

            ]

        elif 'type' not in self.attr or self.attr['type'] == 'nest':

            lines += [

                f"for (i = 0; i < {var}->{ref}n_{self.c_name}; i++)",

                f"for (i = 0; i < {var}->{ref}_count.{self.c_name}; i++)",

                f'{self.nested_render_name}_free(&{var}->{ref}{self.c_name}[i]);',

                f"free({var}->{ref}{self.c_name});",

            ]
@@ -704,24 +702,22 @@ class TypeMultiAttr(Type): 
    def attr_put(self, ri, var):

        if self.attr['type'] in scalars:

            put_type = self.type

            ri.cw.p(f"for (i = 0; i < {var}->n_{self.c_name}; i++)")

            ri.cw.p(f"for (i = 0; i < {var}->_count.{self.c_name}; i++)")

            ri.cw.p(f"ynl_attr_put_{put_type}(nlh, {self.enum_name}, {var}->{self.c_name}[i]);")

        elif self.attr['type'] == 'binary' and 'struct' in self.attr:

            ri.cw.p(f"for (i = 0; i < {var}->n_{self.c_name}; i++)")

            ri.cw.p(f"for (i = 0; i < {var}->_count.{self.c_name}; i++)")

            ri.cw.p(f"ynl_attr_put(nlh, {self.enum_name}, &{var}->{self.c_name}[i], sizeof(struct {c_lower(self.attr['struct'])}));")

        elif self.attr['type'] == 'string':

            ri.cw.p(f"for (i = 0; i < {var}->n_{self.c_name}; i++)")

            ri.cw.p(f"for (i = 0; i < {var}->_count.{self.c_name}; i++)")

            ri.cw.p(f"ynl_attr_put_str(nlh, {self.enum_name}, {var}->{self.c_name}[i]->str);")

        elif 'type' not in self.attr or self.attr['type'] == 'nest':

            ri.cw.p(f"for (i = 0; i < {var}->n_{self.c_name}; i++)")

            ri.cw.p(f"for (i = 0; i < {var}->_count.{self.c_name}; i++)")

            self._attr_put_line(ri, var, f"{self.nested_render_name}_put(nlh, " +

                                f"{self.enum_name}, &{var}->{self.c_name}[i])")

        else:

            raise Exception(f"Put of MultiAttr sub-type {self.attr['type']} not supported yet")



    def _setter_lines(self, ri, member, presence):

        # For multi-attr we have a count, not presence, hack up the presence

        presence = presence[:-(len('_present.') + len(self.c_name))] + "n_" + self.c_name

        return [f"{member} = {self.c_name};",

                f"{presence} = n_{self.c_name};"]
@@ -764,7 +760,7 @@ class TypeArrayNest(Type): 
                     'ynl_attr_for_each_nested(attr2, attr) {',

                     '\tif (ynl_attr_validate(yarg, attr2))',

                     '\t\treturn YNL_PARSE_CB_ERROR;',

                     f'\t{var}->n_{self.c_name}++;',

                     f'\t{var}->_count.{self.c_name}++;',

                     '}']

        return get_lines, None, local_vars
@@ -772,19 +768,17 @@ class TypeArrayNest(Type): 
        ri.cw.p(f'array = ynl_attr_nest_start(nlh, {self.enum_name});')

        if self.sub_type in scalars:

            put_type = self.sub_type

            ri.cw.block_start(line=f'for (i = 0; i < {var}->n_{self.c_name}; i++)')

            ri.cw.block_start(line=f'for (i = 0; i < {var}->_count.{self.c_name}; i++)')

            ri.cw.p(f"ynl_attr_put_{put_type}(nlh, i, {var}->{self.c_name}[i]);")

            ri.cw.block_end()

        elif self.sub_type == 'binary' and 'exact-len' in self.checks:

            ri.cw.p(f'for (i = 0; i < {var}->n_{self.c_name}; i++)')

            ri.cw.p(f'for (i = 0; i < {var}->_count.{self.c_name}; i++)')

            ri.cw.p(f"ynl_attr_put(nlh, i, {var}->{self.c_name}[i], {self.checks['exact-len']});")

        else:

            raise Exception(f"Put for ArrayNest sub-type {self.attr['sub-type']} not supported, yet")

        ri.cw.p('ynl_attr_nest_end(nlh, array);')



    def _setter_lines(self, ri, member, presence):

        # For multi-attr we have a count, not presence, hack up the presence

        presence = presence[:-(len('_present.') + len(self.c_name))] + "n_" + self.c_name

        return [f"{member} = {self.c_name};",

                f"{presence} = n_{self.c_name};"]
@@ -1884,7 +1878,7 @@ def _multi_parse(ri, struct, init_lines, local_vars): 


        ri.cw.block_start(line=f"if (n_{aspec.c_name})")

        ri.cw.p(f"dst->{aspec.c_name} = calloc(n_{aspec.c_name}, sizeof(*dst->{aspec.c_name}));")

        ri.cw.p(f"dst->n_{aspec.c_name} = n_{aspec.c_name};")

        ri.cw.p(f"dst->_count.{aspec.c_name} = n_{aspec.c_name};")

        ri.cw.p('i = 0;')

        if 'nested-attributes' in aspec:

            ri.cw.p(f"parg.rsp_policy = &{aspec.nested_render_name}_nest;")
@@ -1909,7 +1903,7 @@ def _multi_parse(ri, struct, init_lines, local_vars): 
        aspec = struct[anest]

        ri.cw.block_start(line=f"if (n_{aspec.c_name})")

        ri.cw.p(f"dst->{aspec.c_name} = calloc(n_{aspec.c_name}, sizeof(*dst->{aspec.c_name}));")

        ri.cw.p(f"dst->n_{aspec.c_name} = n_{aspec.c_name};")

        ri.cw.p(f"dst->_count.{aspec.c_name} = n_{aspec.c_name};")

        ri.cw.p('i = 0;')

        if 'nested-attributes' in aspec:

            ri.cw.p(f"parg.rsp_policy = &{aspec.nested_render_name}_nest;")
@@ -2186,9 +2180,9 @@ def _print_type(ri, direction, struct): 
        ri.cw.p(ri.fixed_hdr + ' _hdr;')

        ri.cw.nl()



    for type_filter in ['present', 'len', 'count']:

        meta_started = False

        for _, attr in struct.member_list():

        for type_filter in ['len', 'bit']:

            line = attr.presence_member(ri.ku_space, type_filter)

            if line:

                if not meta_started:
@@ -2196,7 +2190,7 @@ def _print_type(ri, direction, struct): 
                    meta_started = True

                ri.cw.p(line)

        if meta_started:

        ri.cw.block_end(line='_present;')

            ri.cw.block_end(line=f'_{type_filter};')

    ri.cw.nl()



    for arg in struct.inherited:

tools/net/ynl/samples/devlink.c

+4 −3
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ int main(int argc, char **argv) 
	ynl_dump_foreach(devs, d) {

		struct devlink_info_get_req *info_req;

		struct devlink_info_get_rsp *info_rsp;

		unsigned i;



		printf("%s/%s:\n", d->bus_name, d->dev_name);
@@ -34,11 +35,11 @@ int main(int argc, char **argv) 
		if (!info_rsp)

			goto err_free_devs;



		if (info_rsp->_present.info_driver_name_len)

		if (info_rsp->_len.info_driver_name)

			printf("    driver: %s\n", info_rsp->info_driver_name);

		if (info_rsp->n_info_version_running)

		if (info_rsp->_count.info_version_running)

			printf("    running fw:\n");

		for (unsigned i = 0; i < info_rsp->n_info_version_running; i++)

		for (i = 0; i < info_rsp->_count.info_version_running; i++)

			printf("        %s: %s\n",

			       info_rsp->info_version_running[i].info_version_name,

			       info_rsp->info_version_running[i].info_version_value);

tools/net/ynl/samples/rt-addr.c

+2 −2
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ static void rt_addr_print(struct rt_addr_getaddr_rsp *a) 
	if (name)

		printf("%16s: ", name);



	switch (a->_present.address_len) {

	switch (a->_len.address) {

	case 4:

		addr = inet_ntop(AF_INET, a->address,

				 addr_str, sizeof(addr_str));
@@ -36,7 +36,7 @@ static void rt_addr_print(struct rt_addr_getaddr_rsp *a) 
	if (addr)

		printf("%s", addr);

	else

		printf("[%d]", a->_present.address_len);

		printf("[%d]", a->_len.address);



	printf("\n");

}

tools/net/ynl/samples/rt-route.c

+2 −2
Original line number Diff line number Diff line
@@ -26,13 +26,13 @@ static void rt_route_print(struct rt_route_getroute_rsp *r) 
			printf("oif: %-16s ", name);

	}



	if (r->_present.dst_len) {

	if (r->_len.dst) {

		route = inet_ntop(r->_hdr.rtm_family, r->dst,

				  route_str, sizeof(route_str));

		printf("dst: %s/%d", route, r->_hdr.rtm_dst_len);

	}



	if (r->_present.gateway_len) {

	if (r->_len.gateway) {

		route = inet_ntop(r->_hdr.rtm_family, r->gateway,

				  route_str, sizeof(route_str));

		printf("gateway: %s ", route);