python/ovs/ovsuuid.py

   1 # Copyright (c) 2009, 2010, 2011 Nicira, Inc.
   2 #
   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:
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   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.
  14
  15 import re
  16 import uuid
  17
  18 from ovs.db import error
  19 import ovs.db.parser
  20
  21 uuidRE = re.compile("^xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx$"
  22                     .replace('x', '[0-9a-fA-F]'))
  23
  24
  25 def zero():
  26     return uuid.UUID(int=0)
  27
  28
  29 def is_valid_string(s):
  30     return uuidRE.match(s) is not None
  31
  32
  33 def from_string(s):
  34     if not is_valid_string(s):
  35         raise error.Error("%s is not a valid UUID" % s)
  36     return uuid.UUID(s)
  37
  38
  39 def from_json(json, symtab=None):
  40     try:
  41         s = ovs.db.parser.unwrap_json(json, "uuid", [str, unicode], "string")
  42         if not uuidRE.match(s):
  43             raise error.Error("\"%s\" is not a valid UUID" % s, json)
  44         return uuid.UUID(s)
  45     except error.Error, e:
  46         if not symtab:
  47             raise e
  48         try:
  49             name = ovs.db.parser.unwrap_json(json, "named-uuid",
  50                                              [str, unicode], "string")
  51         except error.Error:
  52             raise e
  53
  54         if name not in symtab:
  55             symtab[name] = uuid.uuid4()
  56         return symtab[name]
  57
  58
  59 def to_json(uuid_):
  60     return ["uuid", str(uuid_)]
  61
  62
  63 def to_c_assignment(uuid_, var):
  64     """Returns an array of strings, each of which contain a C statement.  The
  65     statements assign 'uuid_' to a "struct uuid" as defined in Open vSwitch
  66     lib/uuid.h."""
  67
  68     hex_string = uuid_.hex
  69     return ["%s.parts[%d] = 0x%s;" % (var, x, hex_string[x * 8:(x + 1) * 8])
  70             for x in range(4)]