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