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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
#!/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 jvpp_model import is_array, Class, is_retval
def generate_j2c_identifiers(element, class_ref_name, object_ref_name):
identifiers = []
for field in element.fields:
field_type = field.type
identifiers.append(_REQUEST_FIELD_IDENTIFIER_TEMPLATE.substitute(
java_name=field.java_name,
class_ref_name=class_ref_name,
jni_signature=field_type.jni_signature,
jni_type=field_type.jni_type,
jni_accessor=field_type.jni_accessor,
object_ref_name=object_ref_name
))
return "".join(identifiers)
_REQUEST_FIELD_IDENTIFIER_TEMPLATE = Template("""
jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}, "${java_name}", "${jni_signature}");
${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId);
""")
# TODO(VPP-1185): introduce host_to_net functions wrappers and simplify j2c and c2j swap generation
def generate_j2c_swap(element, struct_ref_name):
initialization = []
for field in element.fields:
field_type = field.type
if is_array(field):
template = _ARRAY_J2C_NO_SWAP_TEMPLATE
field_reference_name = field.java_name
c_name = field.name
swap_elements = None
jni_name = None
if field_type.is_swap_needed:
template = _ARRAY_J2C_SWAP_TEMPLATE
host = "%sArrayElements[_i]" % field_reference_name
net = "%s->%s[_i]" % (struct_ref_name, c_name)
swap_elements = field_type.get_host_to_net_function(host, net)
if isinstance(field_type.base_type, Class):
jni_name = field_type.base_type.jni_name
host = "%sArrayElement" % field_reference_name
net = "%s->%s[_i]" % (struct_ref_name, c_name)
swap_elements = field_type.get_host_to_net_function(host, net)
template = _CLASS_ARRAY_J2C_TEMPLATE
initialization.append(template.substitute(
field_reference_name=field_reference_name,
field_length_check=_generate_field_length_check(field),
base_type=field_type.base_type.jni_accessor,
jni_base_type=field_type.base_type.jni_type,
struct_reference_name=struct_ref_name,
jni_name=jni_name,
c_name=c_name,
swap_elements=swap_elements
))
else:
if field_type.is_swap_needed:
host = field.java_name
net = "%s->%s" % (struct_ref_name, field.name)
initialization.append(" %s;" % field_type.get_host_to_net_function(host, net))
else:
initialization.append(" %s->%s = %s;" % (struct_ref_name, field.name, field.java_name))
return "\n".join(initialization)
_ARRAY_J2C_NO_SWAP_TEMPLATE = Template("""
if (${field_reference_name}) {
jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
${field_length_check}
(*env)->Get${base_type}ArrayRegion(env, ${field_reference_name}, 0, cnt, (${jni_base_type} *)${struct_reference_name}->${c_name});
}
""")
_ARRAY_J2C_SWAP_TEMPLATE = Template("""
if (${field_reference_name}) {
${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
size_t _i;
jsize cnt = (*env)->GetArrayLength(env, ${field_reference_name});
${field_length_check}
for (_i = 0; _i < cnt; _i++) {
${swap_elements};
}
(*env)->Release${base_type}ArrayElements (env, ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
}
""")
_CLASS_ARRAY_J2C_TEMPLATE = Template("""
{
if (${field_reference_name}) {
size_t _i;
jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
${field_length_check}
for (_i = 0; _i < cnt; _i++) {
jobject ${field_reference_name}ArrayElement = (*env)->GetObjectArrayElement(env, ${field_reference_name}, _i);
${swap_elements};
}
}
}
""")
def _generate_field_length_check(field):
# Enforce max length if array has fixed length or uses variable length syntax
field_length = str(field.array_len)
if field.array_len_field:
field_length = field.array_len_field.java_name
# TODO: remove when ZLAs without length field are disabled
if field_length != "0":
return _FIELD_LENGTH_CHECK.substitute(field_length=field_length)
else:
return ""
# Make sure we do not write more elements that are expected
_FIELD_LENGTH_CHECK = Template("""
size_t max_size = ${field_length};
if (cnt > max_size) cnt = max_size;""")
def generate_c2j_swap(element, object_ref_name, struct_ref_name):
msg_java_name = element.java_name_lower
setters = []
for field in element.fields:
field_type = field.type
if is_retval(field):
# For retval don't generate setters and generate retval check
continue
elif is_array(field):
jni_name = ""
template = _ARRAY_C2J_SWAP_TEMPLATE if field_type.is_swap_needed else _ARRAY_C2J_NO_SWAP_TEMPLATE
if isinstance(field_type.base_type, Class):
template = _ARRAY_C2J_CLASS_SWAP_TEMPLATE
jni_name = field_type.base_type.jni_name
setters.append(template.substitute(
field_reference_name=field.java_name,
class_ref_name=msg_java_name,
jni_signature=field_type.jni_signature,
jni_type=field_type.jni_type,
jni_name=jni_name,
base_type=field_type.base_type.jni_accessor,
field_length=_generate_array_length(field, struct_ref_name),
jni_base_type=field_type.base_type.jni_type,
object_ref_name=object_ref_name,
struct_ref_name=struct_ref_name,
net_to_host_function=field_type.net_to_host_function,
c_name=field.name
))
else:
if field_type.is_swap_needed:
template = _SIMPLE_TYPE_FIELD_SETTER_TEMPLATE
jni_name = ""
if isinstance(field_type, Class):
template = _STRUCT_SETTER_TEMPLATE
jni_name = field_type.jni_name
setters.append(template.substitute(
java_name=field.java_name,
class_ref_name=msg_java_name,
jni_signature=field_type.jni_signature,
jni_name=jni_name,
jni_accessor=field_type.jni_accessor,
object_ref_name=object_ref_name,
struct_ref_name=struct_ref_name,
net_to_host_function=field_type.net_to_host_function,
c_name=field.name
))
else:
setters.append(_SIMPLE_TYPE_NO_SWAP_FIELD_SETTER_TEMPLATE.substitute(
java_name=field.java_name,
class_ref_name=msg_java_name,
jni_signature=field_type.jni_signature,
jni_accessor=field_type.jni_accessor,
object_ref_name=object_ref_name,
struct_ref_name=struct_ref_name,
c_name=field.name
))
return "".join(setters)
_SIMPLE_TYPE_FIELD_SETTER_TEMPLATE = Template("""
jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
(*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${net_to_host_function}(${struct_ref_name}->${c_name}));
""")
_STRUCT_SETTER_TEMPLATE = Template("""
jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
jclass ${java_name}Class = (*env)->FindClass(env, "${jni_name}");
jmethodID ${java_name}Constructor = (*env)->GetMethodID(env, ${java_name}Class, "<init>", "()V");
jobject ${java_name} = (*env)->NewObject(env, ${java_name}Class, ${java_name}Constructor);
${net_to_host_function}(env, &(${struct_ref_name}->${c_name}), ${java_name});
(*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${java_name});
(*env)->DeleteLocalRef(env, ${java_name});
""")
_SIMPLE_TYPE_NO_SWAP_FIELD_SETTER_TEMPLATE = Template("""
jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
(*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${struct_ref_name}->${c_name});
""")
_ARRAY_C2J_NO_SWAP_TEMPLATE = Template("""
jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
(*env)->Set${base_type}ArrayRegion(env, ${field_reference_name}, 0, ${field_length}, (const ${jni_base_type}*)${struct_ref_name}->${c_name});
(*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
(*env)->DeleteLocalRef(env, ${field_reference_name});
""")
_ARRAY_C2J_SWAP_TEMPLATE = Template("""
jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
{
${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
unsigned int _i;
for (_i = 0; _i < ${field_length}; _i++) {
${field_reference_name}ArrayElements[_i] = ${net_to_host_function}(${struct_ref_name}->${c_name}[_i]);
}
(*env)->Release${base_type}ArrayElements(env, ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
(*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
(*env)->DeleteLocalRef(env, ${field_reference_name});
}
""")
_ARRAY_C2J_CLASS_SWAP_TEMPLATE = Template("""
jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
{
jclass ${field_reference_name}Class = (*env)->FindClass(env, "${jni_name}");
jobjectArray ${field_reference_name} = (*env)->NewObjectArray(env, ${field_length}, ${field_reference_name}Class, 0);
jmethodID ${field_reference_name}Constructor = (*env)->GetMethodID(env, ${field_reference_name}Class, "<init>", "()V");
unsigned int _i;
for (_i = 0; _i < ${field_length}; _i++) {
jobject ${field_reference_name}ArrayElement = (*env)->NewObject(env, ${field_reference_name}Class, ${field_reference_name}Constructor);
${net_to_host_function}(env, &(${struct_ref_name}->${c_name}[_i]), ${field_reference_name}ArrayElement);
(*env)->SetObjectArrayElement(env, ${field_reference_name}, _i, ${field_reference_name}ArrayElement);
(*env)->DeleteLocalRef(env, ${field_reference_name}ArrayElement);
}
(*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
(*env)->DeleteLocalRef(env, ${field_reference_name});
}
""")
def _generate_array_length(field, struct_ref_name):
if field.array_len_field:
len_field = field.array_len_field
if len_field.type.is_swap_needed:
return "%s(%s->%s)" % (len_field.type.host_to_net_function, struct_ref_name, len_field.name)
else:
return "%s->%s" % (struct_ref_name, len_field.name)
return field.array_len
|
