X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=python%2Fovs%2Fjsonrpc.py;h=25b0229183c19adae430fae364362c0541b45bce;hb=4b23aebfca469739f6c4b03ad1c7c7bab9e902ba;hp=975d40f7128ecfaf85b148e406a1cdc9b8784536;hpb=991559357f6a03c3a5b70c053c8c2554aa8d5ee4;p=openvswitch diff --git a/python/ovs/jsonrpc.py b/python/ovs/jsonrpc.py index 975d40f7..25b02291 100644 --- a/python/ovs/jsonrpc.py +++ b/python/ovs/jsonrpc.py @@ -1,4 +1,4 @@ -# Copyright (c) 2010 Nicira Networks +# Copyright (c) 2010, 2011 Nicira Networks # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -13,15 +13,18 @@ # limitations under the License. import errno -import logging import os +import ovs.json import ovs.poller import ovs.reconnect import ovs.stream import ovs.timeval +import ovs.vlog EOF = -1 +vlog = ovs.vlog.Vlog("jsonrpc") + class Message(object): T_REQUEST = 0 # Request. @@ -33,10 +36,9 @@ class Message(object): T_NOTIFY: "notification", T_REPLY: "reply", T_ERROR: "error"} - __next_id = 0 - def __init__(self, type, method, params, result, error, id): - self.type = type + def __init__(self, type_, method, params, result, error, id): + self.type = type_ self.method = method self.params = params self.result = result @@ -44,6 +46,7 @@ class Message(object): self.id = id _next_id = 0 + @staticmethod def _create_id(): this_id = Message._next_id @@ -69,11 +72,10 @@ class Message(object): return Message(Message.T_ERROR, None, None, None, error, id) @staticmethod - def type_to_string(type): - return Message.__types[type] + def type_to_string(type_): + return Message.__types[type_] - @staticmethod - def __validate_arg(value, name, must_have): + def __validate_arg(self, value, name, must_have): if (value is not None) == (must_have != 0): return None else: @@ -96,11 +98,11 @@ class Message(object): return "invalid JSON-RPC message type %s" % self.type return ( - Message.__validate_arg(self.method, "method", pattern & 0x10000) or - Message.__validate_arg(self.params, "params", pattern & 0x1000) or - Message.__validate_arg(self.result, "result", pattern & 0x100) or - Message.__validate_arg(self.error, "error", pattern & 0x10) or - Message.__validate_arg(self.id, "id", pattern & 0x1)) + self.__validate_arg(self.method, "method", pattern & 0x10000) or + self.__validate_arg(self.params, "params", pattern & 0x1000) or + self.__validate_arg(self.result, "result", pattern & 0x100) or + self.__validate_arg(self.error, "error", pattern & 0x10) or + self.__validate_arg(self.id, "id", pattern & 0x1)) @staticmethod def from_json(json): @@ -120,7 +122,7 @@ class Message(object): params = json.pop("params", None) result = json.pop("result", None) error = json.pop("error", None) - id = json.pop("id", None) + id_ = json.pop("id", None) if len(json): return "message has unexpected member \"%s\"" % json.popitem()[0] @@ -128,12 +130,12 @@ class Message(object): msg_type = Message.T_REPLY elif error is not None: msg_type = Message.T_ERROR - elif id is not None: + elif id_ is not None: msg_type = Message.T_REQUEST else: msg_type = Message.T_NOTIFY - - msg = Message(msg_type, method, params, result, error, id) + + msg = Message(msg_type, method, params, result, error, id_) validation_error = msg.is_valid() if validation_error is not None: return validation_error @@ -166,15 +168,18 @@ class Message(object): s.append("method=\"%s\"" % self.method) if self.params is not None: s.append("params=" + ovs.json.to_string(self.params)) + if self.result is not None: + s.append("result=" + ovs.json.to_string(self.result)) if self.error is not None: s.append("error=" + ovs.json.to_string(self.error)) if self.id is not None: s.append("id=" + ovs.json.to_string(self.id)) return ", ".join(s) + class Connection(object): def __init__(self, stream): - self.name = stream.get_name() + self.name = stream.name self.stream = stream self.status = 0 self.input = "" @@ -195,8 +200,8 @@ class Connection(object): self.output = self.output[retval:] else: if retval != -errno.EAGAIN: - logging.warn("%s: send error: %s" % (self.name, - os.strerror(-retval))) + vlog.warn("%s: send error: %s" % + (self.name, os.strerror(-retval))) self.error(-retval) break @@ -215,11 +220,8 @@ class Connection(object): else: return len(self.output) - def get_name(self): - return self.name - def __log_msg(self, title, msg): - logging.debug("%s: %s %s" % (self.name, title, msg)) + vlog.dbg("%s: %s %s" % (self.name, title, msg)) def send(self, msg): if self.status: @@ -252,18 +254,18 @@ class Connection(object): return self.status, None while True: - if len(self.input) == 0: + if not self.input: error, data = self.stream.recv(4096) if error: if error == errno.EAGAIN: return error, None else: # XXX rate-limit - logging.warning("%s: receive error: %s" - % (self.name, os.strerror(error))) + vlog.warn("%s: receive error: %s" + % (self.name, os.strerror(error))) self.error(error) return self.status, None - elif len(data) == 0: + elif not data: self.error(EOF) return EOF, None else: @@ -291,15 +293,15 @@ class Connection(object): self.wait(poller) self.recv_wait(poller) poller.block() - + def transact_block(self, request): - id = request.id + id_ = request.id error = self.send(request) reply = None while not error: error, reply = self.recv_block() - if reply and reply.type == Message.T_REPLY and reply.id == id: + if reply and reply.type == Message.T_REPLY and reply.id == id_: break return error, reply @@ -308,23 +310,23 @@ class Connection(object): self.parser = None if type(json) in [str, unicode]: # XXX rate-limit - logging.warning("%s: error parsing stream: %s" % (self.name, json)) + vlog.warn("%s: error parsing stream: %s" % (self.name, json)) self.error(errno.EPROTO) return msg = Message.from_json(json) if not isinstance(msg, Message): # XXX rate-limit - logging.warning("%s: received bad JSON-RPC message: %s" - % (self.name, msg)) + vlog.warn("%s: received bad JSON-RPC message: %s" + % (self.name, msg)) self.error(errno.EPROTO) return self.__log_msg("received", msg) return msg - + def recv_wait(self, poller): - if self.status or len(self.input) > 0: + if self.status or self.input: poller.immediate_wake() else: self.stream.recv_wait(poller) @@ -334,7 +336,8 @@ class Connection(object): self.status = error self.stream.close() self.output = "" - + + class Session(object): """A JSON-RPC session with reconnection.""" @@ -350,10 +353,10 @@ class Session(object): """Creates and returns a Session that maintains a JSON-RPC session to 'name', which should be a string acceptable to ovs.stream.Stream or ovs.stream.PassiveStream's initializer. - + If 'name' is an active connection method, e.g. "tcp:127.1.2.3", the new session connects and reconnects, with back-off, to 'name'. - + If 'name' is a passive connection method, e.g. "ptcp:", the new session listens for connections to 'name'. It maintains at most one connection at any given time. Any new connection causes the previous one (if any) @@ -363,7 +366,7 @@ class Session(object): reconnect.enable(ovs.timeval.msec()) if ovs.stream.PassiveStream.is_valid_name(name): - self.reconnect.set_passive(True, ovs.timeval.msec()) + reconnect.set_passive(True, ovs.timeval.msec()) return Session(reconnect, None) @@ -371,7 +374,7 @@ class Session(object): def open_unreliably(jsonrpc): reconnect = ovs.reconnect.Reconnect(ovs.timeval.msec()) reconnect.set_quiet(True) - reconnect.set_name(jsonrpc.get_name()) + reconnect.set_name(jsonrpc.name) reconnect.set_max_tries(0) reconnect.connected(ovs.timeval.msec()) return Session(reconnect, jsonrpc) @@ -397,7 +400,7 @@ class Session(object): self.stream.close() self.stream = None self.seqno += 1 - + def __connect(self): self.__disconnect() @@ -423,8 +426,8 @@ class Session(object): if error == 0: if self.rpc or self.stream: # XXX rate-limit - logging.info("%s: new connection replacing active " - "connection" % self.reconnect.get_name()) + vlog.info("%s: new connection replacing active " + "connection" % self.reconnect.get_name()) self.__disconnect() self.reconnect.connected(ovs.timeval.msec()) self.rpc = Connection(stream) @@ -515,7 +518,7 @@ class Session(object): else: max_tries = self.reconnect.get_max_tries() return max_tries is None or max_tries > 0 - + def is_connected(self): return self.rpc is not None