1 # Copyright (c) 2009, 2010, 2011 Nicira Networks
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at:
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
17 from ovs.db import error
22 class AtomicType(object):
23 def __init__(self, name, default):
25 self.default = default
30 for atomic_type in ATOMIC_TYPES:
31 if s == atomic_type.name:
33 raise error.Error('"%s" is not an atomic type' % s)
37 if type(json) not in [str, unicode]:
38 raise error.Error("atomic-type expected", json)
40 return AtomicType.from_string(json)
42 raise error.Error('"%s" is not an atomic-type' % json, json)
53 def default_atom(self):
54 return ovs.db.data.Atom(self, self.default)
56 VoidType = AtomicType("void", None)
57 IntegerType = AtomicType("integer", 0)
58 RealType = AtomicType("real", 0.0)
59 BooleanType = AtomicType("boolean", False)
60 StringType = AtomicType("string", "")
61 UuidType = AtomicType("uuid", ovs.ovsuuid.UUID.zero())
63 ATOMIC_TYPES = [VoidType, IntegerType, RealType, BooleanType, StringType,
66 def escapeCString(src):
87 dst += '\\%03o' % ord(c)
93 """Returns integer x formatted in decimal with thousands set off by
95 return _commafy("%d" % x)
98 return '-' + _commafy(s[1:])
102 return _commafy(s[:-3]) + ',' + _commafy(s[-3:])
104 def returnUnchanged(x):
107 class BaseType(object):
108 def __init__(self, type_, enum=None, min=None, max=None,
109 min_length = 0, max_length=sys.maxint, ref_table=None):
110 assert isinstance(type_, AtomicType)
115 self.min_length = min_length
116 self.max_length = max_length
117 self.ref_table = ref_table
120 return ovs.db.data.Atom.default(self.type)
122 def __eq__(self, other):
123 if not isinstance(other, BaseType):
124 return NotImplemented
125 return (self.type == other.type and self.enum == other.enum and
126 self.min == other.min and self.max == other.max and
127 self.min_length == other.min_length and
128 self.max_length == other.max_length and
129 self.ref_table == other.ref_table)
131 def __ne__(self, other):
132 if not isinstance(other, BaseType):
133 return NotImplemented
135 return not (self == other)
138 def __parse_uint(parser, name, default):
139 value = parser.get_optional(name, [int, long])
143 max_value = 2**32 - 1
144 if not (0 <= value <= max_value):
145 raise error.Error("%s out of valid range 0 to %d"
146 % (name, max_value), value)
151 if type(json) == unicode:
152 return BaseType(AtomicType.from_json(json))
154 parser = ovs.db.parser.Parser(json, "ovsdb type")
155 atomic_type = AtomicType.from_json(parser.get("type", [str, unicode]))
157 base = BaseType(atomic_type)
159 enum = parser.get_optional("enum", [])
161 base.enum = ovs.db.data.Datum.from_json(BaseType.get_enum_type(base.type), enum)
162 elif base.type == IntegerType:
163 base.min = parser.get_optional("minInteger", [int, long])
164 base.max = parser.get_optional("maxInteger", [int, long])
165 if base.min is not None and base.max is not None and base.min > base.max:
166 raise error.Error("minInteger exceeds maxInteger", json)
167 elif base.type == RealType:
168 base.min = parser.get_optional("minReal", [int, long, float])
169 base.max = parser.get_optional("maxReal", [int, long, float])
170 if base.min is not None and base.max is not None and base.min > base.max:
171 raise error.Error("minReal exceeds maxReal", json)
172 elif base.type == StringType:
173 base.min_length = BaseType.__parse_uint(parser, "minLength", 0)
174 base.max_length = BaseType.__parse_uint(parser, "maxLength",
176 if base.min_length > base.max_length:
177 raise error.Error("minLength exceeds maxLength", json)
178 elif base.type == UuidType:
179 base.ref_table = parser.get_optional("refTable", ['id'])
181 base.ref_type = parser.get_optional("refType", [str, unicode],
183 if base.ref_type not in ['strong', 'weak']:
184 raise error.Error('refType must be "strong" or "weak" '
185 '(not "%s")' % base.ref_type)
191 if not self.has_constraints():
192 return self.type.to_json()
194 json = {'type': self.type.to_json()}
197 json['enum'] = self.enum.to_json()
199 if self.type == IntegerType:
200 if self.min is not None:
201 json['minInteger'] = self.min
202 if self.max is not None:
203 json['maxInteger'] = self.max
204 elif self.type == RealType:
205 if self.min is not None:
206 json['minReal'] = self.min
207 if self.max is not None:
208 json['maxReal'] = self.max
209 elif self.type == StringType:
210 if self.min_length != 0:
211 json['minLength'] = self.min_length
212 if self.max_length != sys.maxint:
213 json['maxLength'] = self.max_length
214 elif self.type == UuidType:
216 json['refTable'] = self.ref_table
217 if self.ref_type != 'strong':
218 json['refType'] = self.ref_type
222 return BaseType(self.type, self.enum.clone(), self.min, self.max,
223 self.min_length, self.max_length, self.ref_table)
226 if self.type in (VoidType, BooleanType, UuidType):
228 elif self.type in (IntegerType, RealType):
229 return self.min is None or self.max is None or self.min <= self.max
230 elif self.type == StringType:
231 return self.min_length <= self.max_length
235 def has_constraints(self):
236 return (self.enum is not None or self.min is not None or self.max is not None or
237 self.min_length != 0 or self.max_length != sys.maxint or
238 self.ref_table is not None)
240 def without_constraints(self):
241 return BaseType(self.type)
244 def get_enum_type(atomic_type):
245 """Returns the type of the 'enum' member for a BaseType whose
246 'type' is 'atomic_type'."""
247 return Type(BaseType(atomic_type), None, 1, sys.maxint)
250 return self.type == UuidType and self.ref_table is not None
252 def is_strong_ref(self):
253 return self.is_ref() and self.ref_type == 'strong'
255 def is_weak_ref(self):
256 return self.is_ref() and self.ref_type == 'weak'
258 def toEnglish(self, escapeLiteral=returnUnchanged):
259 if self.type == UuidType and self.ref_table:
260 s = escapeLiteral(self.ref_table)
261 if self.ref_type == 'weak':
262 s = "weak reference to " + s
265 return self.type.to_string()
267 def constraintsToEnglish(self, escapeLiteral=returnUnchanged):
269 literals = [value.toEnglish(escapeLiteral)
270 for value in self.enum.values]
271 if len(literals) == 2:
272 return 'either %s or %s' % (literals[0], literals[1])
274 return 'one of %s, %s, or %s' % (literals[0],
275 ', '.join(literals[1:-1]),
277 elif self.min is not None and self.max is not None:
278 if self.type == IntegerType:
279 return 'in range %s to %s' % (commafy(self.min),
282 return 'in range %g to %g' % (self.min, self.max)
283 elif self.min is not None:
284 if self.type == IntegerType:
285 return 'at least %s' % commafy(self.min)
287 return 'at least %g' % self.min
288 elif self.max is not None:
289 if self.type == IntegerType:
290 return 'at most %s' % commafy(self.max)
292 return 'at most %g' % self.max
293 elif self.min_length != 0 and self.max_length != sys.maxint:
294 if self.min_length == self.max_length:
295 return 'exactly %d characters long' % (self.min_length)
297 return 'between %d and %d characters long' % (self.min_length, self.max_length)
298 elif self.min_length != 0:
299 return 'at least %d characters long' % self.min_length
300 elif self.max_length != sys.maxint:
301 return 'at most %d characters long' % self.max_length
305 def toCType(self, prefix):
307 return "struct %s%s *" % (prefix, self.ref_table.lower())
309 return {IntegerType: 'int64_t ',
311 UuidType: 'struct uuid ',
312 BooleanType: 'bool ',
313 StringType: 'char *'}[self.type]
315 def toAtomicType(self):
316 return "OVSDB_TYPE_%s" % self.type.to_string().upper()
318 def copyCValue(self, dst, src):
319 args = {'dst': dst, 'src': src}
321 return ("%(dst)s = %(src)s->header_.uuid;") % args
322 elif self.type == StringType:
323 return "%(dst)s = xstrdup(%(src)s);" % args
325 return "%(dst)s = %(src)s;" % args
327 def initCDefault(self, var, is_optional):
329 return "%s = NULL;" % var
330 elif self.type == StringType and not is_optional:
331 return '%s = "";' % var
333 pattern = {IntegerType: '%s = 0;',
334 RealType: '%s = 0.0;',
335 UuidType: 'uuid_zero(&%s);',
336 BooleanType: '%s = false;',
337 StringType: '%s = NULL;'}[self.type]
340 def cInitBaseType(self, indent, var):
342 stmts.append('ovsdb_base_type_init(&%s, OVSDB_TYPE_%s);' % (
343 var, self.type.to_string().upper()),)
345 stmts.append("%s.enum_ = xmalloc(sizeof *%s.enum_);"
347 stmts += self.enum.cInitDatum("%s.enum_" % var)
348 if self.type == IntegerType:
349 if self.min is not None:
350 stmts.append('%s.u.integer.min = INT64_C(%d);' % (var, self.min))
351 if self.max is not None:
352 stmts.append('%s.u.integer.max = INT64_C(%d);' % (var, self.max))
353 elif self.type == RealType:
354 if self.min is not None:
355 stmts.append('%s.u.real.min = %d;' % (var, self.min))
356 if self.max is not None:
357 stmts.append('%s.u.real.max = %d;' % (var, self.max))
358 elif self.type == StringType:
359 if self.min_length is not None:
360 stmts.append('%s.u.string.minLen = %d;' % (var, self.min_length))
361 if self.max_length != sys.maxint:
362 stmts.append('%s.u.string.maxLen = %d;' % (var, self.max_length))
363 elif self.type == UuidType:
364 if self.ref_table is not None:
365 stmts.append('%s.u.uuid.refTableName = "%s";' % (var, escapeCString(self.ref_table)))
366 stmts.append('%s.u.uuid.refType = OVSDB_REF_%s;' % (var, self.ref_type.upper()))
367 return '\n'.join([indent + stmt for stmt in stmts])
370 def __init__(self, key, value=None, n_min=1, n_max=1):
377 if self.value is None:
380 value = self.value.clone()
381 return Type(self.key.clone(), value, self.n_min, self.n_max)
383 def __eq__(self, other):
384 if not isinstance(other, Type):
385 return NotImplemented
386 return (self.key == other.key and self.value == other.value and
387 self.n_min == other.n_min and self.n_max == other.n_max)
389 def __ne__(self, other):
390 if not isinstance(other, Type):
391 return NotImplemented
393 return not (self == other)
396 return (self.key.type != VoidType and self.key.is_valid() and
397 (self.value is None or
398 (self.value.type != VoidType and self.value.is_valid())) and
399 self.n_min <= 1 <= self.n_max)
402 return self.n_min == 1 and self.n_max == 1 and not self.value
404 def is_optional(self):
405 return self.n_min == 0 and self.n_max == 1
407 def is_composite(self):
408 return self.n_max > 1
411 return self.value is None and (self.n_min != 1 or self.n_max != 1)
414 return self.value is not None
416 def is_optional_pointer(self):
417 return (self.is_optional() and not self.value
418 and (self.key.type == StringType or self.key.ref_table))
421 def __n_from_json(json, default):
424 elif type(json) == int and 0 <= json <= sys.maxint:
427 raise error.Error("bad min or max value", json)
431 if type(json) in [str, unicode]:
432 return Type(BaseType.from_json(json))
434 parser = ovs.db.parser.Parser(json, "ovsdb type")
435 key_json = parser.get("key", [dict, unicode])
436 value_json = parser.get_optional("value", [dict, unicode])
437 min_json = parser.get_optional("min", [int])
438 max_json = parser.get_optional("max", [int, str, unicode])
441 key = BaseType.from_json(key_json)
443 value = BaseType.from_json(value_json)
447 n_min = Type.__n_from_json(min_json, 1)
449 if max_json == 'unlimited':
452 n_max = Type.__n_from_json(max_json, 1)
454 type_ = Type(key, value, n_min, n_max)
455 if not type_.is_valid():
456 raise error.Error("ovsdb type fails constraint checks", json)
460 if self.is_scalar() and not self.key.has_constraints():
461 return self.key.to_json()
463 json = {"key": self.key.to_json()}
464 if self.value is not None:
465 json["value"] = self.value.to_json()
467 json["min"] = self.n_min
468 if self.n_max == sys.maxint:
469 json["max"] = "unlimited"
470 elif self.n_max != 1:
471 json["max"] = self.n_max
474 def toEnglish(self, escapeLiteral=returnUnchanged):
475 keyName = self.key.toEnglish(escapeLiteral)
477 valueName = self.value.toEnglish(escapeLiteral)
481 elif self.is_optional():
483 return "optional %s-%s pair" % (keyName, valueName)
485 return "optional %s" % keyName
487 if self.n_max == sys.maxint:
489 quantity = "%d or more " % self.n_min
493 quantity = "%d to %d " % (self.n_min, self.n_max)
495 quantity = "up to %d " % self.n_max
498 return "map of %s%s-%s pairs" % (quantity, keyName, valueName)
500 if keyName.endswith('s'):
501 plural = keyName + "es"
503 plural = keyName + "s"
504 return "set of %s%s" % (quantity, plural)
506 def constraintsToEnglish(self, escapeLiteral=returnUnchanged):
510 keyConstraints = self.key.constraintsToEnglish(escapeLiteral)
513 constraints.append('key %s' % keyConstraints)
515 constraints.append(keyConstraints)
518 valueConstraints = self.value.constraintsToEnglish(escapeLiteral)
520 constraints.append('value %s' % valueConstraints)
522 return ', '.join(constraints)
524 def cDeclComment(self):
525 if self.n_min == 1 and self.n_max == 1 and self.key.type == StringType:
526 return "\t/* Always nonnull. */"
530 def cInitType(self, indent, var):
531 initKey = self.key.cInitBaseType(indent, "%s.key" % var)
533 initValue = self.value.cInitBaseType(indent, "%s.value" % var)
535 initValue = ('%sovsdb_base_type_init(&%s.value, '
536 'OVSDB_TYPE_VOID);' % (indent, var))
537 initMin = "%s%s.n_min = %s;" % (indent, var, self.n_min)
538 if self.n_max == sys.maxint:
542 initMax = "%s%s.n_max = %s;" % (indent, var, max)
543 return "\n".join((initKey, initValue, initMin, initMax))