python: Add ovs_error() helper function to Python.

[openvswitch] / python / ovs / util.py

diff --git a/python/ovs/util.py b/python/ovs/util.py
index 036621a1b0481a2a043373ac9cabb4ef5ac59ed4..66e429b2c2c469c29a7a3c9176c2da69a9f992c5 100644 (file)
--- a/python/ovs/util.py
+++ b/python/ovs/util.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2010, 2011 Nicira Networks
+# Copyright (c) 2010, 2011, 2012 Nicira Networks
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@ import os.path
 import sys
 
 PROGRAM_NAME = os.path.basename(sys.argv[0])
+EOF = -1
 
 
 def abs_file_name(dir_, file_name):
@@ -42,3 +43,51 @@ def abs_file_name(dir_, file_name):
             return dir_ + file_name
         else:
             return "%s/%s" % (dir_, file_name)
+
+
+def ovs_retval_to_string(retval):
+    """Many OVS functions return an int which is one of:
+    - 0: no error yet
+    - >0: errno value
+    - EOF: end of file (not necessarily an error; depends on the function
+      called)
+
+    Returns the appropriate human-readable string."""
+
+    if not retval:
+        return ""
+    if retval > 0:
+        return os.strerror(retval)
+    if retval == EOF:
+        return "End of file"
+    return "***unknown return value: %s***" % retval
+
+
+def ovs_error(err_no, message, vlog=None):
+    """Prints 'message' on stderr and emits an ERROR level log message to
+    'vlog' if supplied.  If 'err_no' is nonzero, then it is formatted with
+    ovs_retval_to_string() and appended to the message inside parentheses.
+
+    'message' should not end with a new-line, because this function will add
+    one itself."""
+
+    err_msg = "%s: %s" % (PROGRAM_NAME, message)
+    if err_no:
+        err_msg += " (%s)" % ovs_retval_to_string(err_no)
+
+    sys.stderr.write("%s\n" % err_msg)
+    if vlog:
+        vlog.err(err_msg)
+
+
+def ovs_fatal(*args, **kwargs):
+    """Prints 'message' on stderr and emits an ERROR level log message to
+    'vlog' if supplied.  If 'err_no' is nonzero, then it is formatted with
+    ovs_retval_to_string() and appended to the message inside parentheses.
+    Then, terminates with exit code 1 (indicating a failure).
+
+    'message' should not end with a new-line, because this function will add
+    one itself."""
+
+    ovs_error(*args, **kwargs)
+    sys.exit(1)