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, s)
37 if type(json) not in [str, unicode]:
38 raise error.Error("atomic-type expected", json)
40 return AtomicType.from_string(json)
51 def default_atom(self):
52 return ovs.db.data.Atom(self, self.default)
54 VoidType = AtomicType("void", None)
55 IntegerType = AtomicType("integer", 0)
56 RealType = AtomicType("real", 0.0)
57 BooleanType = AtomicType("boolean", False)
58 StringType = AtomicType("string", "")
59 UuidType = AtomicType("uuid", ovs.ovsuuid.UUID.zero())
61 ATOMIC_TYPES = [VoidType, IntegerType, RealType, BooleanType, StringType,
64 def escapeCString(src):
85 dst += '\\%03o' % ord(c)
91 """Returns integer x formatted in decimal with thousands set off by
93 return _commafy("%d" % x)
96 return '-' + _commafy(s[1:])
100 return _commafy(s[:-3]) + ',' + _commafy(s[-3:])
102 def returnUnchanged(x):
105 class BaseType(object):
106 def __init__(self, type_, enum=None, min=None, max=None,
107 min_length = 0, max_length=sys.maxint, ref_table=None):
108 assert isinstance(type_, AtomicType)
113 self.min_length = min_length
114 self.max_length = max_length
115 self.ref_table = ref_table
118 return ovs.db.data.Atom.default(self.type)
120 def __eq__(self, other):
121 if not isinstance(other, BaseType):
122 return NotImplemented
123 return (self.type == other.type and self.enum == other.enum and
124 self.min == other.min and self.max == other.max and
125 self.min_length == other.min_length and
126 self.max_length == other.max_length and
127 self.ref_table == other.ref_table)
129 def __ne__(self, other):
130 if not isinstance(other, BaseType):
131 return NotImplemented
133 return not (self == other)
136 def __parse_uint(parser, name, default):
137 value = parser.get_optional(name, [int, long])
141 max_value = 2**32 - 1
142 if not (0 <= value <= max_value):
143 raise error.Error("%s out of valid range 0 to %d"
144 % (name, max_value), value)
149 if type(json) == unicode:
150 return BaseType(AtomicType.from_json(json))
152 parser = ovs.db.parser.Parser(json, "ovsdb type")
153 atomic_type = AtomicType.from_json(parser.get("type", [str, unicode]))
155 base = BaseType(atomic_type)
157 enum = parser.get_optional("enum", [])
159 base.enum = ovs.db.data.Datum.from_json(BaseType.get_enum_type(base.type), enum)
160 elif base.type == IntegerType:
161 base.min = parser.get_optional("minInteger", [int, long])
162 base.max = parser.get_optional("maxInteger", [int, long])
163 if base.min is not None and base.max is not None and base.min > base.max:
164 raise error.Error("minInteger exceeds maxInteger", json)
165 elif base.type == RealType:
166 base.min = parser.get_optional("minReal", [int, long, float])
167 base.max = parser.get_optional("maxReal", [int, long, float])
168 if base.min is not None and base.max is not None and base.min > base.max:
169 raise error.Error("minReal exceeds maxReal", json)
170 elif base.type == StringType:
171 base.min_length = BaseType.__parse_uint(parser, "minLength", 0)
172 base.max_length = BaseType.__parse_uint(parser, "maxLength",
174 if base.min_length > base.max_length:
175 raise error.Error("minLength exceeds maxLength", json)
176 elif base.type == UuidType:
177 base.ref_table = parser.get_optional("refTable", ['id'])
179 base.ref_type = parser.get_optional("refType", [str, unicode],
181 if base.ref_type not in ['strong', 'weak']:
182 raise error.Error('refType must be "strong" or "weak" '
183 '(not "%s")' % base.ref_type)
189 if not self.has_constraints():
190 return self.type.to_json()
192 json = {'type': self.type.to_json()}
195 json['enum'] = self.enum.to_json()
197 if self.type == IntegerType:
198 if self.min is not None:
199 json['minInteger'] = self.min
200 if self.max is not None:
201 json['maxInteger'] = self.max
202 elif self.type == RealType:
203 if self.min is not None:
204 json['minReal'] = self.min
205 if self.max is not None:
206 json['maxReal'] = self.max
207 elif self.type == StringType:
208 if self.min_length != 0:
209 json['minLength'] = self.min_length
210 if self.max_length != sys.maxint:
211 json['maxLength'] = self.max_length
212 elif self.type == UuidType:
214 json['refTable'] = self.ref_table
215 if self.ref_type != 'strong':
216 json['refType'] = self.ref_type
220 return BaseType(self.type, self.enum.clone(), self.min, self.max,
221 self.min_length, self.max_length, self.ref_table)
224 if self.type in (VoidType, BooleanType, UuidType):
226 elif self.type in (IntegerType, RealType):
227 return self.min is None or self.max is None or self.min <= self.max
228 elif self.type == StringType:
229 return self.min_length <= self.max_length
233 def has_constraints(self):
234 return (self.enum is not None or self.min is not None or self.max is not None or
235 self.min_length != 0 or self.max_length != sys.maxint or
236 self.ref_table is not None)
238 def without_constraints(self):
239 return BaseType(self.type)
242 def get_enum_type(atomic_type):
243 """Returns the type of the 'enum' member for a BaseType whose
244 'type' is 'atomic_type'."""
245 return Type(BaseType(atomic_type), None, 1, sys.maxint)
248 return self.type == UuidType and self.ref_table is not None
250 def is_strong_ref(self):
251 return self.is_ref() and self.ref_type == 'strong'
253 def is_weak_ref(self):
254 return self.is_ref() and self.ref_type == 'weak'
256 def toEnglish(self, escapeLiteral=returnUnchanged):
257 if self.type == UuidType and self.ref_table:
258 s = escapeLiteral(self.ref_table)
259 if self.ref_type == 'weak':
260 s = "weak reference to " + s
263 return self.type.to_string()
265 def constraintsToEnglish(self, escapeLiteral=returnUnchanged):
267 literals = [value.toEnglish(escapeLiteral)
268 for value in self.enum.values]
269 if len(literals) == 2:
270 return 'either %s or %s' % (literals[0], literals[1])
272 return 'one of %s, %s, or %s' % (literals[0],
273 ', '.join(literals[1:-1]),
275 elif self.min is not None and self.max is not None:
276 if self.type == IntegerType:
277 return 'in range %s to %s' % (commafy(self.min),
280 return 'in range %g to %g' % (self.min, self.max)
281 elif self.min is not None:
282 if self.type == IntegerType:
283 return 'at least %s' % commafy(self.min)
285 return 'at least %g' % self.min
286 elif self.max is not None:
287 if self.type == IntegerType:
288 return 'at most %s' % commafy(self.max)
290 return 'at most %g' % self.max
291 elif self.min_length != 0 and self.max_length != sys.maxint:
292 if self.min_length == self.max_length:
293 return 'exactly %d characters long' % (self.min_length)
295 return 'between %d and %d characters long' % (self.min_length, self.max_length)
296 elif self.min_length != 0:
297 return 'at least %d characters long' % self.min_length
298 elif self.max_length != sys.maxint:
299 return 'at most %d characters long' % self.max_length
303 def toCType(self, prefix):
305 return "struct %s%s *" % (prefix, self.ref_table.lower())
307 return {IntegerType: 'int64_t ',
309 UuidType: 'struct uuid ',
310 BooleanType: 'bool ',
311 StringType: 'char *'}[self.type]
313 def toAtomicType(self):
314 return "OVSDB_TYPE_%s" % self.type.to_string().upper()
316 def copyCValue(self, dst, src):
317 args = {'dst': dst, 'src': src}
319 return ("%(dst)s = %(src)s->header_.uuid;") % args
320 elif self.type == StringType:
321 return "%(dst)s = xstrdup(%(src)s);" % args
323 return "%(dst)s = %(src)s;" % args
325 def initCDefault(self, var, is_optional):
327 return "%s = NULL;" % var
328 elif self.type == StringType and not is_optional:
329 return '%s = "";' % var
331 pattern = {IntegerType: '%s = 0;',
332 RealType: '%s = 0.0;',
333 UuidType: 'uuid_zero(&%s);',
334 BooleanType: '%s = false;',
335 StringType: '%s = NULL;'}[self.type]
338 def cInitBaseType(self, indent, var):
340 stmts.append('ovsdb_base_type_init(&%s, %s);' % (
341 var, self.toAtomicType()))
343 stmts.append("%s.enum_ = xmalloc(sizeof *%s.enum_);"
345 stmts += self.enum.cInitDatum("%s.enum_" % var)
346 if self.type == IntegerType:
347 if self.min is not None:
348 stmts.append('%s.u.integer.min = INT64_C(%d);' % (var, self.min))
349 if self.max is not None:
350 stmts.append('%s.u.integer.max = INT64_C(%d);' % (var, self.max))
351 elif self.type == RealType:
352 if self.min is not None:
353 stmts.append('%s.u.real.min = %d;' % (var, self.min))
354 if self.max is not None:
355 stmts.append('%s.u.real.max = %d;' % (var, self.max))
356 elif self.type == StringType:
357 if self.min_length is not None:
358 stmts.append('%s.u.string.minLen = %d;' % (var, self.min_length))
359 if self.max_length != sys.maxint:
360 stmts.append('%s.u.string.maxLen = %d;' % (var, self.max_length))
361 elif self.type == UuidType:
362 if self.ref_table is not None:
363 stmts.append('%s.u.uuid.refTableName = "%s";' % (var, escapeCString(self.ref_table)))
364 stmts.append('%s.u.uuid.refType = OVSDB_REF_%s;' % (var, self.ref_type.upper()))
365 return '\n'.join([indent + stmt for stmt in stmts])
368 def __init__(self, key, value=None, n_min=1, n_max=1):
375 if self.value is None:
378 value = self.value.clone()
379 return Type(self.key.clone(), value, self.n_min, self.n_max)
381 def __eq__(self, other):
382 if not isinstance(other, Type):
383 return NotImplemented
384 return (self.key == other.key and self.value == other.value and
385 self.n_min == other.n_min and self.n_max == other.n_max)
387 def __ne__(self, other):
388 if not isinstance(other, Type):
389 return NotImplemented
391 return not (self == other)
394 return (self.key.type != VoidType and self.key.is_valid() and
395 (self.value is None or
396 (self.value.type != VoidType and self.value.is_valid())) and
397 self.n_min <= 1 <= self.n_max)
400 return self.n_min == 1 and self.n_max == 1 and not self.value
402 def is_optional(self):
403 return self.n_min == 0 and self.n_max == 1
405 def is_composite(self):
406 return self.n_max > 1
409 return self.value is None and (self.n_min != 1 or self.n_max != 1)
412 return self.value is not None
414 def is_optional_pointer(self):
415 return (self.is_optional() and not self.value
416 and (self.key.type == StringType or self.key.ref_table))
419 def __n_from_json(json, default):
422 elif type(json) == int and 0 <= json <= sys.maxint:
425 raise error.Error("bad min or max value", json)
429 if type(json) in [str, unicode]:
430 return Type(BaseType.from_json(json))
432 parser = ovs.db.parser.Parser(json, "ovsdb type")
433 key_json = parser.get("key", [dict, unicode])
434 value_json = parser.get_optional("value", [dict, unicode])
435 min_json = parser.get_optional("min", [int])
436 max_json = parser.get_optional("max", [int, str, unicode])
439 key = BaseType.from_json(key_json)
441 value = BaseType.from_json(value_json)
445 n_min = Type.__n_from_json(min_json, 1)
447 if max_json == 'unlimited':
450 n_max = Type.__n_from_json(max_json, 1)
452 type_ = Type(key, value, n_min, n_max)
453 if not type_.is_valid():
454 raise error.Error("ovsdb type fails constraint checks", json)
458 if self.is_scalar() and not self.key.has_constraints():
459 return self.key.to_json()
461 json = {"key": self.key.to_json()}
462 if self.value is not None:
463 json["value"] = self.value.to_json()
465 json["min"] = self.n_min
466 if self.n_max == sys.maxint:
467 json["max"] = "unlimited"
468 elif self.n_max != 1:
469 json["max"] = self.n_max
472 def toEnglish(self, escapeLiteral=returnUnchanged):
473 keyName = self.key.toEnglish(escapeLiteral)
475 valueName = self.value.toEnglish(escapeLiteral)
479 elif self.is_optional():
481 return "optional %s-%s pair" % (keyName, valueName)
483 return "optional %s" % keyName
485 if self.n_max == sys.maxint:
487 quantity = "%d or more " % self.n_min
491 quantity = "%d to %d " % (self.n_min, self.n_max)
493 quantity = "up to %d " % self.n_max
496 return "map of %s%s-%s pairs" % (quantity, keyName, valueName)
498 if keyName.endswith('s'):
499 plural = keyName + "es"
501 plural = keyName + "s"
502 return "set of %s%s" % (quantity, plural)
504 def constraintsToEnglish(self, escapeLiteral=returnUnchanged):
508 keyConstraints = self.key.constraintsToEnglish(escapeLiteral)
511 constraints.append('key %s' % keyConstraints)
513 constraints.append(keyConstraints)
516 valueConstraints = self.value.constraintsToEnglish(escapeLiteral)
518 constraints.append('value %s' % valueConstraints)
520 return ', '.join(constraints)
522 def cDeclComment(self):
523 if self.n_min == 1 and self.n_max == 1 and self.key.type == StringType:
524 return "\t/* Always nonnull. */"
528 def cInitType(self, indent, var):
529 initKey = self.key.cInitBaseType(indent, "%s.key" % var)
531 initValue = self.value.cInitBaseType(indent, "%s.value" % var)
533 initValue = ('%sovsdb_base_type_init(&%s.value, '
534 'OVSDB_TYPE_VOID);' % (indent, var))
535 initMin = "%s%s.n_min = %s;" % (indent, var, self.n_min)
536 if self.n_max == sys.maxint:
540 initMax = "%s%s.n_max = %s;" % (indent, var, max)
541 return "\n".join((initKey, initValue, initMin, initMax))