]> git.ozlabs.org Git - petitboot/blobdiff - discover/parser.h
lib/efi: Cleanup read/write routines
[petitboot] / discover / parser.h
index 03ba8d4d704134b3a9a239c9da9f6657ff449505..e7d52fe5d2ae671e96e78c6ec6270396e4bb82a3 100644 (file)
@@ -2,6 +2,12 @@
 #define _PARSER_H
 
 #include <stdbool.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <dirent.h>
+
+#include "device-handler.h"
 
 struct discover_context;
 struct device_handler;
@@ -25,9 +31,7 @@ struct resource;
  */
 struct parser {
        char                    *name;
-       const char * const      *filenames;
-       int                     (*parse)(struct discover_context *ctx,
-                                               char *buf, int len);
+       int                     (*parse)(struct discover_context *ctx);
        bool                    (*resolve_resource)(
                                                struct device_handler *handler,
                                                struct resource *res);
@@ -41,6 +45,12 @@ enum generic_icon_type {
        ICON_TYPE_UNKNOWN
 };
 
+struct parser_found_file {
+       const char *filename;
+       unsigned ino;
+       struct list_item list;
+};
+
 #define streq(a,b) (!strcasecmp((a),(b)))
 
 void parser_init(void);
@@ -48,4 +58,45 @@ void parser_init(void);
 void iterate_parsers(struct discover_context *ctx);
 int parse_user_event(struct discover_context *ctx, struct event *event);
 
+/* File IO functions for parsers; these should be the only interface that
+ * parsers use to access a device's filesystem.
+ *
+ * These are intended for small amounts of data, typically text
+ * configuration and state files.  Note that parser_request_file,
+ * and parser_replace_file work only on non-directories.
+ */
+int parser_request_file(struct discover_context *ctx,
+               struct discover_device *dev, const char *filename,
+               char **buf, int *len);
+int parser_replace_file(struct discover_context *ctx,
+               struct discover_device *dev, const char *filename,
+               char *buf, int len);
+int parser_request_url(struct discover_context *ctx, struct pb_url *url,
+               char **buf, int *len);
+/* parser_stat_path returns 0 if path can be stated on dev by the
+ * running user.  Note that this function follows symlinks, like the
+ * stat system call.  When the function returns 0, also fills in
+ * statbuf for the path.  Returns non-zero on error.  This function
+ * does not have the limitations on file size that the functions above
+ * do.  Unlike some of the functions above, this function also works
+ * on directories. */
+int parser_stat_path(struct discover_context *ctx,
+               struct discover_device *dev, const char *path,
+               struct stat *statbuf);
+/* Function used to list the files on a directory. The dirname should
+ * be relative to the discover context device mount path. It returns
+ * the number of files returned in files or a negative value on error.
+ */
+int parser_scandir(struct discover_context *ctx, const char *dirname,
+                  struct dirent ***files, int (*filter)(const struct dirent *),
+                  int (*comp)(const struct dirent **, const struct dirent **));
+
+/* parser_is_unique - Test a file against a list of known files.
+ * If the file @filename exists and the file is not in @found_list add the
+ * file to @found_list and return true.  Use when searching case-insensitive
+ * filesystems.
+ */
+bool parser_is_unique(struct discover_context *ctx, struct discover_device *dev, const char *filename,
+               struct list *found_list);
+
 #endif /* _PARSER_H */