_reader.c revision 5afbe712db5cc68213a24c45396ffb43fab05e3e
/*-*- Mode: C; c-basic-offset: 4; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2013 Steven Hiscocks, Zbigniew Jędrzejewski-Szmek
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <Python.h>
#include <structmember.h>
#include <datetime.h>
#include <time.h>
#include <stdio.h>
#include <systemd/sd-journal.h>
#include "pyutil.h"
#include "macro.h"
#include "util.h"
#include "build.h"
typedef struct {
sd_journal *j;
} Reader;
static PyTypeObject ReaderType;
if (r >= 0)
return r;
if (r == -EINVAL && invalid_message)
else if (r == -ENOMEM)
else {
errno = -r;
}
return -1;
}
"Class to reads the systemd journal similar to journalctl.");
#if PY_MAJOR_VERSION >= 3
static PyTypeObject MonotonicType;
"A tuple of (timestamp, bootid) for holding monotonic timestamps");
static PyStructSequence_Field MonotonicType_fields[] = {
{(char*) "timestamp", (char*) "Time"},
{(char*) "bootid", (char*) "Unique identifier of the boot"},
{} /* Sentinel */
};
static PyStructSequence_Desc Monotonic_desc = {
(char*) "journal.Monotonic",
2,
};
#endif
{
sd_journal_close(self->j);
}
"_Reader([flags | path]) -> ...\n\n"
"_Reader allows filtering and retrieval of Journal entries.\n"
"Note: this is a low-level interface, and probably not what you\n"
"want, use systemd.journal.Reader instead.\n\n"
"Argument `flags` sets open flags of the journal, which can be one\n"
"of, or ORed combination of constants: LOCAL_ONLY (default) opens\n"
"journal on local machine only; RUNTIME_ONLY opens only\n"
"volatile journal files; and SYSTEM_ONLY opens only\n"
"journal files of system services and the kernel.\n\n"
"Argument `path` is the directory of journal files. Note that\n"
"`flags` and `path` are exclusive.\n\n"
"_Reader implements the context manager protocol: the journal\n"
"will be closed when exiting the block.");
{
int flags = 0, r;
return -1;
if (!flags)
else
if (path) {
return -1;
}
if (path)
else
}
"fileno() -> int\n\n"
"Get a file descriptor to poll for changes in the journal.\n"
"This method invokes sd_journal_get_fd().\n"
"See man:sd_journal_get_fd(3).");
{
if (fd < 0)
return NULL;
return long_FromLong(fd);
}
"reliable_fd() -> bool\n\n"
"Returns True iff the journal can be polled reliably.\n"
"This method invokes sd_journal_reliable_fd().\n"
"See man:sd_journal_reliable_fd(3).");
{
int r = sd_journal_reliable_fd(self->j);
if (r < 0)
return NULL;
return PyBool_FromLong(r);
}
"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.");
{
int r = sd_journal_get_events(self->j);
if (r < 0)
return NULL;
return long_FromLong(r);
}
"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.");
{
int r;
uint64_t t;
r = sd_journal_get_timeout(self->j, &t);
if (r < 0)
return NULL;
if (t == (uint64_t) -1)
assert_cc(sizeof(unsigned long long) == sizeof(t));
return PyLong_FromUnsignedLongLong(t);
}
"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.");
{
int r;
uint64_t t;
r = sd_journal_get_timeout(self->j, &t);
if (r < 0)
return NULL;
if (t == (uint64_t) -1)
return PyLong_FromLong(-1);
else {
uint64_t n;
int msec;
return PyLong_FromLong(msec);
}
}
"close() -> None\n\n"
"Free resources allocated by this Reader object.\n"
"This method invokes sd_journal_close().\n"
"See man:sd_journal_close(3).");
{
sd_journal_close(self->j);
}
"get_usage() -> int\n\n"
"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).");
{
int r;
return NULL;
return PyLong_FromUnsignedLongLong(bytes);
}
"__enter__() -> self\n\n"
"Part of the context manager protocol.\n"
"Returns self.\n");
{
return self;
}
"__exit__(type, value, traceback) -> None\n\n"
"Part of the context manager protocol.\n"
"Closes the journal.\n");
{
sd_journal_close(self->j);
}
"next([skip]) -> bool\n\n"
"Go to the next log entry. Optional skip value means to go to\n"
"the `skip`\\-th log entry.\n"
"Returns False if at end of file, True otherwise.");
{
int r;
return NULL;
return NULL;
}
if (skip == 1LL)
r = sd_journal_next(self->j);
else if (skip == -1LL)
r = sd_journal_previous(self->j);
else if (skip > 1LL)
else if (skip < -1LL)
else
assert_not_reached("should not be here");
if (r < 0)
return NULL;
return PyBool_FromLong(r);
}
"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.");
{
return NULL;
(char*) "L", -skip);
}
const char *delim_ptr;
if (!delim_ptr) {
"journal gave us a field without '='");
return -1;
}
if (key) {
if (!k)
return -1;
}
if (value) {
if (!v) {
Py_XDECREF(k);
return -1;
}
*value = v;
}
if (key)
*key = k;
return 0;
}
"get(str) -> str\n\n"
"Return data associated with this key in current log entry.\n"
"Throws KeyError is the data is not available.");
{
const char* field;
const void* msg;
int r;
return NULL;
if (r == -ENOENT) {
return NULL;
return NULL;
if (r < 0)
return NULL;
return value;
}
"_get_all() -> dict\n\n"
"Return dictionary of the current log entry.");
{
const void *msg;
int r;
dict = PyDict_New();
if (!dict)
return NULL;
if (r < 0)
goto error;
if (PyList_CheckExact(cur_value)) {
if (r < 0)
goto error;
} else {
if (!tmp_list)
goto error;
if (r < 0)
goto error;
if (r < 0)
goto error;
if (r < 0)
goto error;
}
} else {
if (r < 0)
goto error;
}
}
return dict;
return NULL;
}
"get_realtime() -> int\n\n"
"Return the realtime timestamp for the current journal entry\n"
"in microseconds.\n\n"
"Wraps sd_journal_get_realtime_usec().\n"
"See man:sd_journal_get_realtime_usec(3).");
{
int r;
return NULL;
return PyLong_FromUnsignedLongLong(timestamp);
}
"get_monotonic() -> (timestamp, bootid)\n\n"
"Return the monotonic timestamp for the current journal entry\n"
"as a tuple of time in microseconds and bootid.\n\n"
"Wraps sd_journal_get_monotonic_usec().\n"
"See man:sd_journal_get_monotonic_usec(3).");
{
int r;
return NULL;
#if PY_MAJOR_VERSION >= 3
#else
#endif
return NULL;
}
#if PY_MAJOR_VERSION >= 3
#else
#endif
return tuple;
}
"add_match(match) -> None\n\n"
"Add a match to filter journal log entries. All matches of different\n"
"fields are combined with logical AND, and matches of the same field\n"
"are automatically combined with logical OR.\n"
"Match is a string of the form \"FIELD=value\".");
{
char *match;
int match_len, r;
return NULL;
if (r < 0)
return NULL;
}
"add_disjunction() -> None\n\n"
"Inserts a logical OR between matches added since previous\n"
"add_disjunction() or add_conjunction() and the next\n"
"add_disjunction() or add_conjunction().\n\n"
"See man:sd_journal_add_disjunction(3) for explanation.");
{
int r;
r = sd_journal_add_disjunction(self->j);
if (r < 0)
return NULL;
}
"add_conjunction() -> None\n\n"
"Inserts a logical AND between matches added since previous\n"
"add_disjunction() or add_conjunction() and the next\n"
"add_disjunction() or add_conjunction().\n\n"
"See man:sd_journal_add_disjunction(3) for explanation.");
{
int r;
r = sd_journal_add_conjunction(self->j);
if (r < 0)
return NULL;
}
"flush_matches() -> None\n\n"
"Clear all current match filters.");
{
}
"seek_head() -> None\n\n"
"Jump to the beginning of the journal.\n"
"This method invokes sd_journal_seek_head().\n"
"See man:sd_journal_seek_head(3).");
{
int r;
r = sd_journal_seek_head(self->j);
return NULL;
}
"seek_tail() -> None\n\n"
"Jump to the end of the journal.\n"
"This method invokes sd_journal_seek_tail().\n"
"See man:sd_journal_seek_tail(3).");
{
int r;
r = sd_journal_seek_tail(self->j);
return NULL;
}
"seek_realtime(realtime) -> None\n\n"
"Seek to nearest matching journal entry to `realtime`. Argument\n"
"`realtime` in specified in seconds.");
{
int r;
return NULL;
return NULL;
}
"seek_monotonic(monotonic[, bootid]) -> None\n\n"
"Seek to nearest matching journal entry to `monotonic`. Argument\n"
"`monotonic` is an timestamp from boot in microseconds.\n"
"Argument `bootid` is a string representing which boot the\n"
"monotonic time is reference to. Defaults to current bootid.");
{
int r;
return NULL;
if (bootid) {
return NULL;
} else {
r = sd_id128_get_boot(&id);
return NULL;
}
return NULL;
}
"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.");
{
int r;
r = sd_journal_process(self->j);
return NULL;
return long_FromLong(r);
}
"wait([timeout]) -> state change (integer)\n\n"
"Wait for a change in the journal. Argument `timeout` specifies\n"
"the maximum number of microseconds to wait before returning\n"
"regardless of wheter the journal has changed. If `timeout` is -1,\n"
"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.\n\n"
"See man:sd_journal_wait(3) for further discussion.");
{
int r;
return NULL;
return NULL;
return long_FromLong(r);
}
"seek_cursor(cursor) -> None\n\n"
"Seek to journal entry by given unique reference `cursor`.");
{
const char *cursor;
int r;
return NULL;
return NULL;
}
"get_cursor() -> str\n\n"
"Return a cursor string for the current journal entry.\n\n"
"Wraps sd_journal_get_cursor(). See man:sd_journal_get_cursor(3).");
{
int r;
return NULL;
return unicode_FromString(cursor);
}
"test_cursor(str) -> bool\n\n"
"Test whether the cursor string matches current journal entry.\n\n"
"Wraps sd_journal_test_cursor(). See man:sd_journal_test_cursor(3).");
{
const char *cursor;
int r;
return NULL;
if (r < 0)
return NULL;
return PyBool_FromLong(r);
}
"query_unique(field) -> a set of values\n\n"
"Return a set of unique values appearing in journal for the\n"
"given `field`. Note this does not respect any journal matches.");
{
char *query;
int r;
const void *uniq;
return NULL;
return NULL;
const char *delim_ptr;
delim_ptr + 1,
}
return value_set;
}
"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).");
{
int r;
if (r == -ENOENT) {
const void* mid;
if (r == 0) {
const int l = sizeof("MESSAGE_ID");
(const char*) mid + l);
} else if (r == -ENOENT)
else
return NULL;
return NULL;
return unicode_FromString(msg);
}
"get_catalog(id128) -> str\n\n"
"Retrieve a message catalog entry for the given id.\n"
"Wraps man:sd_journal_get_catalog_for_message_id(3).");
{
int r;
return NULL;
return NULL;
return NULL;
return unicode_FromString(msg);
}
"Threshold for field size truncation in bytes.\n\n"
"Fields longer than this will be truncated to the threshold size.\n"
"Defaults to 64Kb.");
{
int r;
return NULL;
return long_FromSize_t(cvalue);
}
{
int r;
return -1;
}
if (!long_Check(value)){
return -1;
}
}
"True iff journal is closed");
{
}
static PyGetSetDef Reader_getsetters[] = {
{(char*) "data_threshold",
(char*) data_threshold__doc__,
NULL},
{(char*) "closed",
NULL,
(char*) closed__doc__,
NULL},
{} /* Sentinel */
};
static PyMethodDef Reader_methods[] = {
{"add_disjunction", (PyCFunction) Reader_add_disjunction, METH_NOARGS, Reader_add_disjunction__doc__},
{"add_conjunction", (PyCFunction) Reader_add_conjunction, METH_NOARGS, Reader_add_conjunction__doc__},
{"seek_monotonic", (PyCFunction) Reader_seek_monotonic, METH_VARARGS, Reader_seek_monotonic__doc__},
{} /* Sentinel */
};
static PyTypeObject ReaderType = {
"_reader._Reader", /*tp_name*/
sizeof(Reader), /*tp_basicsize*/
0, /*tp_itemsize*/
0, /*tp_print*/
0, /*tp_getattr*/
0, /*tp_setattr*/
0, /*tp_compare*/
0, /*tp_repr*/
0, /*tp_as_number*/
0, /*tp_as_sequence*/
0, /*tp_as_mapping*/
0, /*tp_hash */
0, /*tp_call*/
0, /*tp_str*/
0, /*tp_getattro*/
0, /*tp_setattro*/
0, /*tp_as_buffer*/
Reader__doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
Reader_methods, /* tp_methods */
0, /* tp_members */
Reader_getsetters, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_alloc */
PyType_GenericNew, /* tp_new */
};
static PyMethodDef methods[] = {
};
#if PY_MAJOR_VERSION >= 3
static PyModuleDef module = {
"_reader",
-1,
};
#endif
#if PY_MAJOR_VERSION >= 3
static bool initialized = false;
#endif
#if PY_MAJOR_VERSION >= 3
PyInit__reader(void)
#else
init_reader(void)
#endif
{
PyObject* m;
if (PyType_Ready(&ReaderType) < 0)
#if PY_MAJOR_VERSION >= 3
return NULL;
#else
return;
#endif
#if PY_MAJOR_VERSION >= 3
m = PyModule_Create(&module);
if (m == NULL)
return NULL;
if (!initialized) {
initialized = true;
}
#else
if (m == NULL)
return;
#endif
#if PY_MAJOR_VERSION >= 3
#endif
#if PY_MAJOR_VERSION >= 3
#endif
#if PY_MAJOR_VERSION >= 3
Py_DECREF(m);
return NULL;
#endif
}
#if PY_MAJOR_VERSION >= 3
return m;
#endif
}