journal: add native protocol to journald, and client side API to send journal messages

[elogind.git] / src / journal / sd-journal.h

diff --git a/src/journal/sd-journal.h b/src/journal/sd-journal.h
index 55e58601fe9843905a0b83750a4d099580972094..e42293ffe74543a684570e900446d710a8b6b7d4 100644 (file)
--- a/src/journal/sd-journal.h
+++ b/src/journal/sd-journal.h
@@ -24,18 +24,37 @@
 
 #include <inttypes.h>
 #include <sys/types.h>
+#include <stdarg.h>
+#include <sys/uio.h>
+
+#include "sd-id128.h"
 
 /* TODO:
  *
- *   - implement rotation
  *   - check LE/BE conversion for 8bit, 16bit, 32bit values
- *   - implement parallel traversal
  *   - implement inotify usage on client
  *   - implement audit gateway
  *   - implement native gateway
- *   - extend hash table/bisect table as we go
+ *   - implement stdout gateway
+ *   - extend hash tables table as we go
+ *   - accelerate looking for "all hostnames" and suchlike.
+ *   - throttling
+ *   - enforce limit on open journal files in journald and journalctl
+ *   - cryptographic hash
+ *   - fix space reservation logic
+ *   - comm, argv can be manipulated, should it be _COMM=, _CMDLINE= or COMM=, CMDLINE=?
  */
 
+/* Write to daemon */
+
+int sd_journal_print(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
+int sd_journal_printv(const char *format, va_list ap);
+
+int sd_journal_send(const char *format, ...) __attribute__((sentinel));
+int sd_journal_sendv(const struct iovec *iov, int n);
+
+/* Browse journal stream */
+
 typedef struct sd_journal sd_journal;
 
 int sd_journal_open(sd_journal **ret);
@@ -44,24 +63,52 @@ void sd_journal_close(sd_journal *j);
 int sd_journal_previous(sd_journal *j);
 int sd_journal_next(sd_journal *j);
 
-int sd_journal_get(sd_journal *j, const char *field, const void **data, size_t *size);
-int sd_journal_get_seqnum(sd_journal *j, uint64_t *ret);
+int sd_journal_previous_skip(sd_journal *j, uint64_t skip);
+int sd_journal_next_skip(sd_journal *j, uint64_t skip);
+
 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
-int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret);
+int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
+int sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
+int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
+void sd_journal_restart_data(sd_journal *j);
 
-int sd_journal_add_match(sd_journal *j, const char *field, const void *data, size_t size);
+int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
 void sd_journal_flush_matches(sd_journal *j);
 
 int sd_journal_seek_head(sd_journal *j);
 int sd_journal_seek_tail(sd_journal *j);
-
-int sd_journal_seek_seqnum(sd_journal *j, uint64_t seqnum);
-int sd_journal_seek_monotonic_usec(sd_journal *j, uint64_t usec);
+int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
+int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
+
+int sd_journal_get_cursor(sd_journal *j, char **cursor);
+
+int sd_journal_query_unique(sd_journal *j, const char *field);      /* missing */
+int sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l); /* missing */
+void sd_journal_restart_unique(sd_journal *j);                      /* missing */
+
+enum {
+        SD_JOURNAL_NOP,
+        SD_JOURNAL_APPEND,
+        SD_JOURNAL_INVALIDATE_ADD,
+        SD_JOURNAL_INVALIDATE_REMOVE
+};
+
+int sd_journal_get_fd(sd_journal *j);                              /* missing */
+int sd_journal_process(sd_journal *j);                             /* missing */
+
+#define SD_JOURNAL_FOREACH(j)                                           \
+        if (sd_journal_seek_head(j) >= 0)                               \
+                while (sd_journal_next(j) > 0)                          \
+
+#define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
+        if (sd_journal_seek_tail(j) >= 0)                               \
+                while (sd_journal_previous(j) > 0)                      \
 
-int sd_journal_get_cursor(sd_journal *j, void **cursor, size_t *size);
-int sd_journal_set_cursor(sd_journal *j, const void *cursor, size_t size);
+#define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
+        for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 
-int sd_journal_get_fd(sd_journal *j);
+#define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \
+        for (sd_journal_restart_unique(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 
 #endif