chiark / gitweb /
move _cleanup_ attribute in front of the type
[elogind.git] / src / python-systemd / _reader.c
index c128cf3c1475ca8f08c609973e1a48b756b6d8fa..05993b33cd2644c79fb6f814ae566917270f9354 100644 (file)
@@ -22,6 +22,7 @@
 #include <Python.h>
 #include <structmember.h>
 #include <datetime.h>
+#include <time.h>
 #include <stdio.h>
 
 #include <systemd/sd-journal.h>
@@ -64,7 +65,7 @@ PyDoc_STRVAR(MonotonicType__doc__,
 static PyStructSequence_Field MonotonicType_fields[] = {
     {(char*) "timestamp", (char*) "Time"},
     {(char*) "bootid", (char*) "Unique identifier of the boot"},
-    {NULL, NULL}
+    {} /* Sentinel */
 };
 
 static PyStructSequence_Desc Monotonic_desc = {
@@ -132,8 +133,7 @@ PyDoc_STRVAR(Reader_fileno__doc__,
              "See man:sd_journal_get_fd(3).");
 static PyObject* Reader_fileno(Reader *self, PyObject *args)
 {
-    int fd;
-    fd = sd_journal_get_fd(self->j);
+    int fd = sd_journal_get_fd(self->j);
     set_error(fd, NULL, NULL);
     if (fd < 0)
         return NULL;
@@ -148,8 +148,7 @@ PyDoc_STRVAR(Reader_reliable_fd__doc__,
              "See man:sd_journal_reliable_fd(3).");
 static PyObject* Reader_reliable_fd(Reader *self, PyObject *args)
 {
-    int r;
-    r = sd_journal_reliable_fd(self->j);
+    int r = sd_journal_reliable_fd(self->j);
     set_error(r, NULL, NULL);
     if (r < 0)
         return NULL;
@@ -157,6 +156,78 @@ static PyObject* Reader_reliable_fd(Reader *self, PyObject *args)
 }
 
 
+PyDoc_STRVAR(Reader_get_events__doc__,
+             "get_events() -> int\n\n"
+             "Returns a mask of poll() events to wait for on the file\n"
+             "descriptor returned by .fileno().\n\n"
+             "See man:sd_journal_get_events(3) for further discussion.");
+static PyObject* Reader_get_events(Reader *self, PyObject *args)
+{
+    int r = sd_journal_get_events(self->j);
+    set_error(r, NULL, NULL);
+    if (r < 0)
+        return NULL;
+    return long_FromLong(r);
+}
+
+
+PyDoc_STRVAR(Reader_get_timeout__doc__,
+             "get_timeout() -> int or None\n\n"
+             "Returns a timeout value for usage in poll(), the time since the\n"
+             "epoch of clock_gettime(2) in microseconds, or None if no timeout\n"
+             "is necessary.\n\n"
+             "The return value must be converted to a relative timeout in \n"
+             "milliseconds if it is to be used as an argument for poll().\n"
+             "See man:sd_journal_get_timeout(3) for further discussion.");
+static PyObject* Reader_get_timeout(Reader *self, PyObject *args)
+{
+    int r;
+    uint64_t t;
+
+    r = sd_journal_get_timeout(self->j, &t);
+    set_error(r, NULL, NULL);
+    if (r < 0)
+        return NULL;
+
+    if (t == (uint64_t) -1)
+        Py_RETURN_NONE;
+
+    assert_cc(sizeof(unsigned long long) == sizeof(t));
+    return PyLong_FromUnsignedLongLong(t);
+}
+
+
+PyDoc_STRVAR(Reader_get_timeout_ms__doc__,
+             "get_timeout_ms() -> int\n\n"
+             "Returns a timeout value suitable for usage in poll(), the value\n"
+             "returned by .get_timeout() converted to relative ms, or -1 if\n"
+             "no timeout is necessary.");
+static PyObject* Reader_get_timeout_ms(Reader *self, PyObject *args)
+{
+    int r;
+    uint64_t t;
+
+    r = sd_journal_get_timeout(self->j, &t);
+    set_error(r, NULL, NULL);
+    if (r < 0)
+        return NULL;
+
+    if (t == (uint64_t) -1)
+        return PyLong_FromLong(-1);
+    else {
+        struct timespec ts;
+        uint64_t n;
+        int msec;
+
+        clock_gettime(CLOCK_MONOTONIC, &ts);
+        n = (uint64_t) ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
+        msec = t > n ? (int) ((t - n + 999) / 1000) : 0;
+
+        return PyLong_FromLong(msec);
+    }
+}
+
+
 PyDoc_STRVAR(Reader_close__doc__,
              "close() -> None\n\n"
              "Free resources allocated by this Reader object.\n"
@@ -175,10 +246,10 @@ static PyObject* Reader_close(Reader *self, PyObject *args)
 
 PyDoc_STRVAR(Reader_get_usage__doc__,
              "get_usage() -> int\n\n"
-             "Returns the total disk space currently used by journal"
-             "files (in bytes). If `SD_JOURNAL_LOCAL_ONLY` was"
-             "passed when opening the journal this value will only reflect"
-             "the size of journal files of the local host, otherwise"
+             "Returns the total disk space currently used by journal\n"
+             "files (in bytes). If `SD_JOURNAL_LOCAL_ONLY` was\n"
+             "passed when opening the journal this value will only reflect\n"
+             "the size of journal files of the local host, otherwise\n"
              "of all hosts.\n\n"
              "This method invokes sd_journal_get_usage().\n"
              "See man:sd_journal_get_usage(3).");
@@ -260,48 +331,108 @@ static PyObject* Reader_next(Reader *self, PyObject *args)
     return PyBool_FromLong(r);
 }
 
+PyDoc_STRVAR(Reader_previous__doc__,
+             "previous([skip]) -> bool\n\n"
+             "Go to the previous log entry. Optional skip value means to \n"
+             "go to the `skip`\\-th previous log entry.\n"
+             "Returns False if at start of file, True otherwise.");
+static PyObject* Reader_previous(Reader *self, PyObject *args)
+{
+    int64_t skip = 1LL;
+    if (!PyArg_ParseTuple(args, "|L:previous", &skip))
+        return NULL;
+
+    return PyObject_CallMethod((PyObject *)self, (char*) "_next",
+                               (char*) "L", -skip);
+}
+
+
+static int extract(const char* msg, size_t msg_len,
+                   PyObject **key, PyObject **value) {
+    PyObject *k = NULL, *v;
+    const char *delim_ptr;
+
+    delim_ptr = memchr(msg, '=', msg_len);
+    if (!delim_ptr) {
+        PyErr_SetString(PyExc_OSError,
+                        "journal gave us a field without '='");
+        return -1;
+    }
+
+    if (key) {
+        k = unicode_FromStringAndSize(msg, delim_ptr - (const char*) msg);
+        if (!k)
+            return -1;
+    }
 
-PyDoc_STRVAR(Reader_get_next__doc__,
-             "get_next([skip]) -> dict\n\n"
-             "Return dictionary of the next log entry. Optional skip value will\n"
-             "return the `skip`\\-th log entry. Returns an empty dict on EOF.");
-static PyObject* Reader_get_next(Reader *self, PyObject *args)
+    if (value) {
+        v = PyBytes_FromStringAndSize(delim_ptr + 1,
+                             (const char*) msg + msg_len - (delim_ptr + 1));
+        if (!v) {
+            Py_XDECREF(k);
+            return -1;
+        }
+
+        *value = v;
+    }
+
+    if (key)
+        *key = k;
+
+    return 0;
+}
+
+PyDoc_STRVAR(Reader_get__doc__,
+             "get(str) -> str\n\n"
+             "Return data associated with this key in current log entry.\n"
+             "Throws KeyError is the data is not available.");
+static PyObject* Reader_get(Reader *self, PyObject *args)
 {
-    PyObject _cleanup_Py_DECREF_ *tmp = NULL;
-    PyObject *dict;
-    const void *msg;
+    const char* field;
+    const void* msg;
     size_t msg_len;
+    PyObject *value;
     int r;
 
-    tmp = Reader_next(self, args);
-    if (!tmp)
+    assert(self);
+    assert(args);
+
+    if (!PyArg_ParseTuple(args, "s:get", &field))
+        return NULL;
+
+    r = sd_journal_get_data(self->j, field, &msg, &msg_len);
+    if (r == -ENOENT) {
+        PyErr_SetString(PyExc_KeyError, field);
         return NULL;
-    if (tmp == Py_False) /* EOF */
-        return PyDict_New();
+    } else if (set_error(r, NULL, "field name is not valid"))
+        return NULL;
+
+    r = extract(msg, msg_len, NULL, &value);
+    if (r < 0)
+        return NULL;
+    return value;
+}
+
+
+PyDoc_STRVAR(Reader_get_all__doc__,
+             "_get_all() -> dict\n\n"
+             "Return dictionary of the current log entry.");
+static PyObject* Reader_get_all(Reader *self, PyObject *args)
+{
+    PyObject *dict;
+    const void *msg;
+    size_t msg_len;
+    int r;
 
     dict = PyDict_New();
     if (!dict)
             return NULL;
 
     SD_JOURNAL_FOREACH_DATA(self->j, msg, msg_len) {
-        PyObject _cleanup_Py_DECREF_ *key = NULL, *value = NULL;
-        const char *delim_ptr;
-
-        delim_ptr = memchr(msg, '=', msg_len);
-        if (!delim_ptr) {
-            PyErr_SetString(PyExc_OSError,
-                            "journal gave us a field without '='");
-            goto error;
-        }
+        _cleanup_Py_DECREF_ PyObject *key = NULL, *value = NULL;
 
-        key = unicode_FromStringAndSize(msg, delim_ptr - (const char*) msg);
-        if (!key)
-            goto error;
-
-        value = PyBytes_FromStringAndSize(
-                delim_ptr + 1,
-                (const char*) msg + msg_len - (delim_ptr + 1) );
-        if (!value)
+        r = extract(msg, msg_len, &key, &value);
+        if (r < 0)
             goto error;
 
         if (PyDict_Contains(dict, key)) {
@@ -312,7 +443,7 @@ static PyObject* Reader_get_next(Reader *self, PyObject *args)
                 if (r < 0)
                     goto error;
             } else {
-                PyObject _cleanup_Py_DECREF_ *tmp_list = PyList_New(0);
+                _cleanup_Py_DECREF_ PyObject *tmp_list = PyList_New(0);
                 if (!tmp_list)
                     goto error;
 
@@ -336,6 +467,7 @@ static PyObject* Reader_get_next(Reader *self, PyObject *args)
     }
 
     return dict;
+
 error:
     Py_DECREF(dict);
     return NULL;
@@ -411,22 +543,6 @@ static PyObject* Reader_get_monotonic(Reader *self, PyObject *args)
     return tuple;
 }
 
-
-PyDoc_STRVAR(Reader_get_previous__doc__,
-             "get_previous([skip]) -> dict\n\n"
-             "Return dictionary of the previous log entry. Optional skip value\n"
-             "will return the -`skip`\\-th log entry. Equivalent to get_next(-skip).");
-static PyObject* Reader_get_previous(Reader *self, PyObject *args)
-{
-    int64_t skip = 1LL;
-    if (!PyArg_ParseTuple(args, "|L:get_previous", &skip))
-        return NULL;
-
-    return PyObject_CallMethod((PyObject *)self, (char*) "get_next",
-                               (char*) "L", -skip);
-}
-
-
 PyDoc_STRVAR(Reader_add_match__doc__,
              "add_match(match) -> None\n\n"
              "Add a match to filter journal log entries. All matches of different\n"
@@ -566,6 +682,30 @@ static PyObject* Reader_seek_monotonic(Reader *self, PyObject *args)
 }
 
 
+PyDoc_STRVAR(Reader_process__doc__,
+             "process() -> state change (integer)\n\n"
+             "Process events and reset the readable state of the file\n"
+             "descriptor returned by .fileno().\n\n"
+             "Will return constants: NOP if no change; APPEND if new\n"
+             "entries have been added to the end of the journal; and\n"
+             "INVALIDATE if journal files have been added or removed.\n\n"
+             "See man:sd_journal_process(3) for further discussion.");
+static PyObject* Reader_process(Reader *self, PyObject *args)
+{
+    int r;
+
+    assert(!args);
+
+    Py_BEGIN_ALLOW_THREADS
+    r = sd_journal_process(self->j);
+    Py_END_ALLOW_THREADS
+    if (set_error(r, NULL, NULL) < 0)
+        return NULL;
+
+    return long_FromLong(r);
+}
+
+
 PyDoc_STRVAR(Reader_wait__doc__,
              "wait([timeout]) -> state change (integer)\n\n"
              "Wait for a change in the journal. Argument `timeout` specifies\n"
@@ -574,7 +714,8 @@ PyDoc_STRVAR(Reader_wait__doc__,
              "then block forever.\n\n"
              "Will return constants: NOP if no change; APPEND if new\n"
              "entries have been added to the end of the journal; and\n"
-             "INVALIDATE if journal files have been added or removed.");
+             "INVALIDATE if journal files have been added or removed.\n\n"
+             "See man:sd_journal_wait(3) for further discussion.");
 static PyObject* Reader_wait(Reader *self, PyObject *args)
 {
     int r;
@@ -619,7 +760,7 @@ PyDoc_STRVAR(Reader_get_cursor__doc__,
              "Wraps sd_journal_get_cursor(). See man:sd_journal_get_cursor(3).");
 static PyObject* Reader_get_cursor(Reader *self, PyObject *args)
 {
-    char _cleanup_free_ *cursor = NULL;
+    _cleanup_free_ char *cursor = NULL;
     int r;
 
     assert(self);
@@ -656,32 +797,6 @@ static PyObject* Reader_test_cursor(Reader *self, PyObject *args)
     return PyBool_FromLong(r);
 }
 
-
-static PyObject* Reader_iter(PyObject *self)
-{
-    Py_INCREF(self);
-    return self;
-}
-
-static PyObject* Reader_iternext(PyObject *self)
-{
-    PyObject *dict;
-    Py_ssize_t dict_size;
-
-    dict = PyObject_CallMethod(self, (char*) "get_next", (char*) "");
-    if (PyErr_Occurred())
-        return NULL;
-    dict_size = PyDict_Size(dict);
-    if ((int64_t) dict_size > 0LL) {
-        return dict;
-    } else {
-        Py_DECREF(dict);
-        PyErr_SetNone(PyExc_StopIteration);
-        return NULL;
-    }
-}
-
-
 PyDoc_STRVAR(Reader_query_unique__doc__,
              "query_unique(field) -> a set of values\n\n"
              "Return a set of unique values appearing in journal for the\n"
@@ -724,11 +839,14 @@ static PyObject* Reader_query_unique(Reader *self, PyObject *args)
 PyDoc_STRVAR(Reader_get_catalog__doc__,
              "get_catalog() -> str\n\n"
              "Retrieve a message catalog entry for the current journal entry.\n"
+             "Will throw IndexError if the entry has no MESSAGE_ID\n"
+             "and KeyError is the id is specified, but hasn't been found\n"
+             "in the catalog.\n\n"
              "Wraps man:sd_journal_get_catalog(3).");
 static PyObject* Reader_get_catalog(Reader *self, PyObject *args)
 {
     int r;
-    char _cleanup_free_ *msg = NULL;
+    _cleanup_free_ char *msg = NULL;
 
     assert(self);
     assert(!args);
@@ -736,7 +854,22 @@ static PyObject* Reader_get_catalog(Reader *self, PyObject *args)
     Py_BEGIN_ALLOW_THREADS
     r = sd_journal_get_catalog(self->j, &msg);
     Py_END_ALLOW_THREADS
-    if (set_error(r, NULL, NULL))
+    if (r == -ENOENT) {
+        const void* mid;
+        size_t mid_len;
+
+        r = sd_journal_get_data(self->j, "MESSAGE_ID", &mid, &mid_len);
+        if (r == 0) {
+            const int l = sizeof("MESSAGE_ID");
+            assert(mid_len > l);
+            PyErr_Format(PyExc_KeyError, "%.*s", (int) mid_len - l,
+                         (const char*) mid + l);
+        } else if (r == -ENOENT)
+            PyErr_SetString(PyExc_IndexError, "no MESSAGE_ID field");
+        else
+            set_error(r, NULL, NULL);
+        return NULL;
+    } else if (set_error(r, NULL, NULL))
         return NULL;
 
     return unicode_FromString(msg);
@@ -752,7 +885,7 @@ static PyObject* get_catalog(PyObject *self, PyObject *args)
     int r;
     char *id_ = NULL;
     sd_id128_t id;
-    char _cleanup_free_ *msg = NULL;
+    _cleanup_free_ char *msg = NULL;
 
     assert(!self);
     assert(args);
@@ -826,21 +959,25 @@ static PyGetSetDef Reader_getsetters[] = {
      NULL,
      (char*) closed__doc__,
      NULL},
-    {NULL}
+    {} /* Sentinel */
 };
 
 static PyMethodDef Reader_methods[] = {
     {"fileno",          (PyCFunction) Reader_fileno, METH_NOARGS, Reader_fileno__doc__},
     {"reliable_fd",     (PyCFunction) Reader_reliable_fd, METH_NOARGS, Reader_reliable_fd__doc__},
+    {"get_events",      (PyCFunction) Reader_get_events, METH_NOARGS, Reader_get_events__doc__},
+    {"get_timeout",     (PyCFunction) Reader_get_timeout, METH_NOARGS, Reader_get_timeout__doc__},
+    {"get_timeout_ms",  (PyCFunction) Reader_get_timeout_ms, METH_NOARGS, Reader_get_timeout_ms__doc__},
     {"close",           (PyCFunction) Reader_close, METH_NOARGS, Reader_close__doc__},
     {"get_usage",       (PyCFunction) Reader_get_usage, METH_NOARGS, Reader_get_usage__doc__},
     {"__enter__",       (PyCFunction) Reader___enter__, METH_NOARGS, Reader___enter____doc__},
     {"__exit__",        (PyCFunction) Reader___exit__, METH_VARARGS, Reader___exit____doc__},
-    {"next",            (PyCFunction) Reader_next, METH_VARARGS, Reader_next__doc__},
-    {"get_next",        (PyCFunction) Reader_get_next, METH_VARARGS, Reader_get_next__doc__},
-    {"get_previous",    (PyCFunction) Reader_get_previous, METH_VARARGS, Reader_get_previous__doc__},
-    {"get_realtime",    (PyCFunction) Reader_get_realtime, METH_NOARGS, Reader_get_realtime__doc__},
-    {"get_monotonic",   (PyCFunction) Reader_get_monotonic, METH_NOARGS, Reader_get_monotonic__doc__},
+    {"_next",           (PyCFunction) Reader_next, METH_VARARGS, Reader_next__doc__},
+    {"_previous",       (PyCFunction) Reader_previous, METH_VARARGS, Reader_previous__doc__},
+    {"_get",            (PyCFunction) Reader_get, METH_VARARGS, Reader_get__doc__},
+    {"_get_all",        (PyCFunction) Reader_get_all, METH_NOARGS, Reader_get_all__doc__},
+    {"_get_realtime",   (PyCFunction) Reader_get_realtime, METH_NOARGS, Reader_get_realtime__doc__},
+    {"_get_monotonic",  (PyCFunction) Reader_get_monotonic, METH_NOARGS, Reader_get_monotonic__doc__},
     {"add_match",       (PyCFunction) Reader_add_match, METH_VARARGS|METH_KEYWORDS, Reader_add_match__doc__},
     {"add_disjunction", (PyCFunction) Reader_add_disjunction, METH_NOARGS, Reader_add_disjunction__doc__},
     {"flush_matches",   (PyCFunction) Reader_flush_matches, METH_NOARGS, Reader_flush_matches__doc__},
@@ -848,13 +985,14 @@ static PyMethodDef Reader_methods[] = {
     {"seek_tail",       (PyCFunction) Reader_seek_tail, METH_NOARGS, Reader_seek_tail__doc__},
     {"seek_realtime",   (PyCFunction) Reader_seek_realtime, METH_VARARGS, Reader_seek_realtime__doc__},
     {"seek_monotonic",  (PyCFunction) Reader_seek_monotonic, METH_VARARGS, Reader_seek_monotonic__doc__},
+    {"process",         (PyCFunction) Reader_process, METH_NOARGS, Reader_process__doc__},
     {"wait",            (PyCFunction) Reader_wait, METH_VARARGS, Reader_wait__doc__},
     {"seek_cursor",     (PyCFunction) Reader_seek_cursor, METH_VARARGS, Reader_seek_cursor__doc__},
-    {"get_cursor",      (PyCFunction) Reader_get_cursor, METH_NOARGS, Reader_get_cursor__doc__},
+    {"_get_cursor",     (PyCFunction) Reader_get_cursor, METH_NOARGS, Reader_get_cursor__doc__},
     {"test_cursor",     (PyCFunction) Reader_test_cursor, METH_VARARGS, Reader_test_cursor__doc__},
     {"query_unique",    (PyCFunction) Reader_query_unique, METH_VARARGS, Reader_query_unique__doc__},
     {"get_catalog",     (PyCFunction) Reader_get_catalog, METH_NOARGS, Reader_get_catalog__doc__},
-    {NULL}  /* Sentinel */
+    {}  /* Sentinel */
 };
 
 static PyTypeObject ReaderType = {
@@ -883,8 +1021,8 @@ static PyTypeObject ReaderType = {
     0,                                        /* tp_clear */
     0,                                        /* tp_richcompare */
     0,                                        /* tp_weaklistoffset */
-    Reader_iter,                              /* tp_iter */
-    Reader_iternext,                          /* tp_iternext */
+    0,                                        /* tp_iter */
+    0,                                        /* tp_iternext */
     Reader_methods,                           /* tp_methods */
     0,                                        /* tp_members */
     Reader_getsetters,                        /* tp_getset */
@@ -899,7 +1037,7 @@ static PyTypeObject ReaderType = {
 };
 
 static PyMethodDef methods[] = {
-        { "get_catalog", get_catalog, METH_VARARGS, get_catalog__doc__},
+        { "_get_catalog", get_catalog, METH_VARARGS, get_catalog__doc__},
         { NULL, NULL, 0, NULL }        /* Sentinel */
 };