X-Git-Url: http://git.ozlabs.org/?p=petitboot;a=blobdiff_plain;f=discover%2Fparser.h;h=fc165c5aeda494a9051b368a86f633d83dd4c0d8;hp=9c6fb352e84337b14ce647e538e7f23bb07bd6f2;hb=33a0f544151f44bb58924ad281aaca2dc58fe561;hpb=32e6a41f33e5576716b351bd473a27939fe94fa1 diff --git a/discover/parser.h b/discover/parser.h index 9c6fb35..fc165c5 100644 --- a/discover/parser.h +++ b/discover/parser.h @@ -1,15 +1,39 @@ +#ifndef _PARSER_H +#define _PARSER_H -#ifndef _PARSERS_H -#define _PARSERS_H +#include +#include +#include +#include -#include -#include "message.h" +#include "device-handler.h" +struct discover_context; +struct device_handler; +struct resource; + +/** + * Our config parser. + * + * Each parser is responsible for creating discover_boot_options from config + * files found on new devices. The boot items discovered during parse will have + * 'resources' attached (see @discover_boot_option), which may already be + * resolved (in the case of a device-local filename, or a URL), or unresolved + * (in the case of a filename on another device). + * + * If the boot option contains references to unresolved resources, the + * device handler will not inform clients about the boot options, as + * they're not properly "available" at this stage. The handler will attempt to + * resolve them whenever new devices are discovered, by calling the parser's + * resolve_resource function. Once a boot option's resources are full resolved, + * the option can be sent to clients. + */ struct parser { - char *name; - int priority; - int (*parse)(const char *device); - struct parser *next; + char *name; + int (*parse)(struct discover_context *ctx); + bool (*resolve_resource)( + struct device_handler *handler, + struct resource *res); }; enum generic_icon_type { @@ -22,25 +46,35 @@ enum generic_icon_type { #define streq(a,b) (!strcasecmp((a),(b))) -/* general functions provided by parsers.c */ -void iterate_parsers(const char *devpath, const char *mountpoint); - -void free_device(struct device *dev); -void free_boot_option(struct boot_option *opt); - -const char *generic_icon_file(enum generic_icon_type type); - -/* functions provided by udev-helper or the test wrapper */ -void pb_log(const char *fmt, ...); - -int mount_device(const char *dev_path); - -char *resolve_path(const char *path, const char *current_dev); -const char *mountpoint_for_device(const char *dev_path); +void parser_init(void); -enum generic_icon_type guess_device_type(void); +void iterate_parsers(struct discover_context *ctx); +int parse_user_event(struct discover_context *ctx, struct event *event); -int add_device(const struct device *dev); -int add_boot_option(const struct boot_option *opt); +/* 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); -#endif /* _PARSERS_H */ +#endif /* _PARSER_H */