summaryrefslogtreecommitdiffstats
path: root/java/jvpp/gen/jvppgen/jni_type_handlers_gen.py
blob: 05c3e522b448734d4e467239352d4a1e8d19bae6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
#!/usr/bin/env python2
#
# Copyright (c) 2018 Cisco and/or its affiliates.
# 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.
#
from string import Template

from jni_common_gen import generate_j2c_swap, generate_j2c_field_swap, generate_j2c_identifiers, generate_c2j_swap
from jvpp_model import Class, Enum, Union


def generate_type_handlers(model, logger):
    """
    Generates host-to-net and net-to-host functions for all custom types defined in the VPP API
    :param model: meta-model of VPP API used for jVPP generation.
    :param logger: jVPP logger
    """
    type_handlers = []
    for t in model.types:
        #TODO(VPP-1186): move the logic to JNI generators
        if isinstance(t, Class):
            _generate_class(model, t, type_handlers)
        elif isinstance(t, Enum):
            _generate_enum(model, t, type_handlers)
        elif isinstance(t, Union):
            _generate_union(model, t, type_handlers)
        else:
            logger.debug("Skipping custom JNI type handler generation for %s", t)

    return "\n".join(type_handlers)


def _generate_class(model, t, type_handlers):
    ref_name = t.java_name_lower
    is_alias = t.name in model._aliases

    type_handlers.append(_TYPE_HOST_TO_NET_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        type_reference_name=ref_name,
        class_FQN=t.jni_name,
        jni_identifiers=generate_j2c_identifiers(t, class_ref_name="%sClass" % ref_name, object_ref_name="_host"),
        type_swap=generate_j2c_swap(t, struct_ref_name="_net", is_alias=is_alias)
    ))
    type_handlers.append(_TYPE_NET_TO_HOST_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        type_reference_name=ref_name,
        class_FQN=t.jni_name,
        type_swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net", is_alias=is_alias)
    ))


_TYPE_HOST_TO_NET_TEMPLATE = Template("""
/**
 * Host to network byte order conversion for ${c_name} type.
 * Generated based on $json_filename:
$json_definition
 */
static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
{
    jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
$jni_identifiers
$type_swap
}""")

_TYPE_NET_TO_HOST_TEMPLATE = Template("""
/**
 * Network to host byte order conversion for ${c_name} type.
 * Generated based on $json_filename:
$json_definition
 */
static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
{
    jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
$type_swap
}""")


def _generate_enum(model, t, type_handlers):
    value_type = t.value.type
    type_handlers.append(_ENUM_NET_TO_HOST_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        class_FQN=t.jni_name,
        jni_signature=value_type.jni_signature,
        jni_type=value_type.jni_type,
        jni_accessor=value_type.jni_accessor,
        swap=_generate_scalar_host_to_net_swap(t.value)
    ))

    type_handlers.append(_ENUM_HOST_TO_NET_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        class_FQN=t.jni_name,
        jni_type=value_type.jni_type,
        type_swap=_generate_scalar_net_to_host_swap(t.value)
    ))


_ENUM_NET_TO_HOST_TEMPLATE = Template("""
/**
 * Host to network byte order conversion for ${c_name} enum.
 * Generated based on $json_filename:
$json_definition
 */
static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
{
    jclass enumClass = (*env)->FindClass(env, "${class_FQN}");
    jmethodID getValueMethod = (*env)->GetMethodID(env, enumClass, "ordinal", "()I");
    ${jni_type} value = (*env)->CallIntMethod(env, _host, getValueMethod);
    ${swap};
}""")

_ENUM_HOST_TO_NET_TEMPLATE = Template("""
/**
 * Network to host byte order conversion for ${c_name} type.
 * Generated based on $json_filename:
$json_definition
 */
static inline ${jni_type} _net_to_host_${c_name}(vl_api_${c_name}_t _net)
{
    return (${jni_type}) $type_swap
}""")


def _generate_scalar_host_to_net_swap(field):
    field_type = field.type
    if field_type.is_swap_needed:
        return field_type.get_host_to_net_function(field.java_name, "*_net")
    else:
        return "*_net = %s" % field.java_name


def _generate_scalar_net_to_host_swap(field):
    field_type = field.type
    if field_type.is_swap_needed:
        return "%s((%s) _net);" % (field_type.net_to_host_function, field_type.name)
    else:
        return "_net"


def _generate_union(model, t, type_handlers):
    type_handlers.append(_generate_union_host_to_net(model, t))
    type_handlers.append(_generate_union_net_to_host(model, t))


def _generate_union_host_to_net(model, t):
    swap = []
    for i, field in enumerate(t.fields):
        field_type = field.type
        is_alias = t.name in model._aliases
        swap.append(_UNION_FIELD_HOST_TO_NET_TEMPLATE.substitute(
            field_index=i,
            java_name=field.java_name,
            jni_signature=field_type.jni_signature,
            jni_type=field_type.jni_type,
            jni_accessor=field_type.jni_accessor,
            swap=generate_j2c_field_swap(field, struct_ref_name="_net", is_alias=is_alias)
        ))

    return _UNION_HOST_TO_NET_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        class_FQN=t.jni_name,
        swap="".join(swap)
    )


_UNION_FIELD_HOST_TO_NET_TEMPLATE = Template("""
    if (_activeMember == ${field_index}) {
        jfieldID fieldId = (*env)->GetFieldID(env, _class, "${java_name}", "${jni_signature}");
        ${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, _host, fieldId);
    ${swap}
    }""")

_UNION_HOST_TO_NET_TEMPLATE = Template("""
/**
 * Host to network byte order conversion for ${c_name} union.
 * Generated based on $json_filename:
$json_definition
 */
static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
{
    jclass _class = (*env)->FindClass(env, "${class_FQN}");

    jfieldID _activeMemberFieldId = (*env)->GetFieldID(env, _class, "_activeMember", "I");
    jint _activeMember = (*env)->GetIntField(env, _host, _activeMemberFieldId);
$swap
}""")


def _generate_union_net_to_host(model, t):
    is_alias = t.name in model._aliases
    return _UNION_NET_TO_HOST_TEMPLATE.substitute(
        c_name=t.name,
        json_filename=model.json_api_files,
        json_definition=t.doc,
        type_reference_name=t.java_name_lower,
        class_FQN=t.jni_name,
        swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net", is_alias=is_alias)
    )


_UNION_NET_TO_HOST_TEMPLATE = Template("""
/**
 * Network to host byte order conversion for ${c_name} union.
 * Generated based on $json_filename:
$json_definition
 */
static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
{
    jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
$swap
}""")