Library part5

Makefile.am

@@ -7,7 +7,7 @@ EXTRA_DIST += tests/00README tests/TestDB tests/CkTestDB tests/Makefile tests/Ls
 
 # Dialect neutral sources
 lsof_SOURCES = src/arg.c src/main.c lib/node.c src/print.c src/ptti.c src/store.c src/usage.c src/util.c \
-	lib/ckkv.c lib/cvfs.c lib/dvch.c lib/fino.c lib/isfn.c lib/lkud.c lib/misc.c lib/pdvn.c lib/prfp.c lib/print.c lib/proc.c lib/ptti.c lib/rdev.c lib/rnmt.c lib/rmnt.c lib/rnam.c lib/rnch.c lib/rnmh.c
+	lib/ckkv.c lib/cvfs.c lib/dvch.c lib/fino.c lib/lsof.c lib/isfn.c lib/lkud.c lib/misc.c lib/pdvn.c lib/prfp.c lib/print.c lib/proc.c lib/ptti.c lib/rdev.c lib/rnmt.c lib/rmnt.c lib/rnam.c lib/rnch.c lib/rnmh.c
 lsof_SOURCES += lib/common.h include/lsof_fields.h lib/proto.h lib/hash.h src/cli.h
 include_HEADERS = include/lsof.h include/lsof_fields.h
 DIALECT_ROOT = $(top_srcdir)/lib/dialects

include/lsof.h

@@ -35,6 +35,16 @@
 #if !defined(LSOF_H)
 #    define LSOF_H 1
 
+#    include <stdio.h>
+
+/** lsof error returns */
+enum lsof_error {
+    LSOF_SUCCESS = 0,            /**< Success */
+    LSOF_ERROR_INVALID_ARGUMENT, /**< Invalid argument */
+    LSOF_ERROR_NO_MEMORY,        /**< No memory */
+    LSOF_ERROR_UNSUPPORTED,      /**< Unsupported operation */
+};
+
 /** File access mode */
 enum lsof_file_access_mode {
     LSOF_FILE_ACCESS_NONE = 0,  /**< None */
@@ -220,4 +230,91 @@ enum lsof_file_type {
     LSOF_FILE_VNODE_VPORT,    /**< The vnode represents a port */
 };
 
+/** API version of liblsof
+ * you may use this macro to check the existence of
+ * functions
+ */
+#    define LSOF_API_VERSION 1
+
+/** Get runtime API version of liblsof
+ *
+ * liblsof might not function properly if API version mismatched between compile
+ * time and runtime.
+ *
+ * \since API version 1
+ */
+int lsof_get_api_version();
+
+/** Get library version of liblsof
+ *
+ * \return a string like "4.xx.x". The caller must not free it.
+ *
+ * \since API version 1
+ */
+char *lsof_get_library_version();
+
+/** Create a new lsof context
+ *
+ * The context should be freed via `lsof_destroy()`.
+ *
+ * \since API version 1
+ */
+struct lsof_context *lsof_new();
+
+/** Set output stream for warning and error messages
+ *
+ * lsof may want to print warning and error messages to the user. You can allow
+ * printing by setting the output stream and whether prints warning or not. You
+ * should also supply `program_name` so that the output starts with your program
+ * name.
+ *
+ * By default, the output is suppressed. You can set fp to NULL to suppress
+ * output.
+ *
+ * \since API version 1
+ */
+enum lsof_error lsof_set_output_stream(struct lsof_context *ctx, FILE *fp,
+                                   char *program_name, int warn);
+
+/** Ask lsof to avoid using blocking functions
+ *
+ * lsof may block when calling lstat(), readlink() or stat(). Call this function
+ * with `avoid=1` to let lsof avoid calling these functions.
+ *
+ * \since API version 1
+ */
+enum lsof_error lsof_avoid_blocking(struct lsof_context *ctx, int avoid);
+
+/** Ask lsof to avoid forking
+ *
+ * To avoid being blocked by some kernel operations, liblsof does them in forked
+ * child processes. Call this function to change this behavior.
+ *
+ * \since API version 1
+ */
+enum lsof_error lsof_avoid_forking(struct lsof_context *ctx, int avoid);
+
+/** Ask lsof to AND the selections
+ *
+ * By default, lsof OR the selections, for example, if you call
+ * lsof_select_unix_socket() and lsof_select_login(), it will report unix
+ * sockets OR open files by the user. If lsof_logic_and() is called, it will
+ * report unix sockets open by the specified user.
+ *
+ * \since API version 1
+ */
+enum lsof_error lsof_logic_and(struct lsof_context *ctx);
+
+/** Ask lsof to select process by command
+ *
+ * Select process executing the command that begins with the characters of
+ * `command`. You can specify exclusion by setting `exclude` to 1.
+ *
+ * You can call this function multiple times to add more search conditions.
+ *
+ * \since API version 1
+ */
+enum lsof_error lsof_select_process(struct lsof_context *ctx, char *command,
+                                    int exclude);
+
 #endif