src/basic/os-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include "forward.h"
   5
   6 typedef enum ImageClass {
   7         IMAGE_MACHINE,
   8         IMAGE_PORTABLE,
   9         IMAGE_SYSEXT,
  10         _IMAGE_CLASS_EXTENSION_FIRST = IMAGE_SYSEXT,  /* First "extension" image type, so that we can easily generically iterate through them */
  11         IMAGE_CONFEXT,
  12         _IMAGE_CLASS_EXTENSION_LAST = IMAGE_CONFEXT,  /* Last "extension image type */
  13         _IMAGE_CLASS_MAX,
  14         _IMAGE_CLASS_INVALID = -EINVAL,
  15 } ImageClass;
  16
  17 const char* image_class_to_string(ImageClass cl) _const_;
  18 ImageClass image_class_from_string(const char *s) _pure_;
  19
  20 /* The *_extension_release flavours will look for /usr/lib/extension-release/extension-release.NAME
  21  * for sysext images and for /etc/extension-release.d/extension-release.NAME for confext images
  22  * in accordance with the OS extension specification, rather than for /usr/lib/ or /etc/os-release. */
  23
  24 bool image_name_is_valid(const char *s) _pure_;
  25 int path_extract_image_name(const char *path, char **ret);
  26
  27 int path_is_extension_tree(ImageClass image_class, const char *path, const char *extension, bool relax_extension_release_check);
  28 static inline int path_is_os_tree(const char *path) {
  29         return path_is_extension_tree(_IMAGE_CLASS_INVALID, path, NULL, false);
  30 }
  31
  32 int open_extension_release(const char *root, ImageClass image_class, const char *extension, bool relax_extension_release_check, char **ret_path, int *ret_fd);
  33 int open_extension_release_at(int rfd, ImageClass image_class, const char *extension, bool relax_extension_release_check, char **ret_path, int *ret_fd);
  34 int open_os_release(const char *root, char **ret_path, int *ret_fd);
  35 int open_os_release_at(int rfd, char **ret_path, int *ret_fd);
  36
  37 int parse_extension_release_sentinel(const char *root, ImageClass image_class, bool relax_extension_release_check, const char *extension, ...) _sentinel_;
  38 #define parse_extension_release(root, image_class, extension, relax_extension_release_check, ...) \
  39         parse_extension_release_sentinel(root, image_class, relax_extension_release_check, extension, __VA_ARGS__, NULL)
  40 #define parse_os_release(root, ...)                                     \
  41         parse_extension_release_sentinel(root, _IMAGE_CLASS_INVALID, false, NULL, __VA_ARGS__, NULL)
  42
  43 int parse_extension_release_at_sentinel(int rfd, ImageClass image_class, bool relax_extension_release_check, const char *extension, ...) _sentinel_;
  44 #define parse_extension_release_at(rfd, image_class, extension, relax_extension_release_check, ...) \
  45         parse_extension_release_at_sentinel(rfd, image_class, relax_extension_release_check, extension, __VA_ARGS__, NULL)
  46 #define parse_os_release_at(rfd, ...)                                     \
  47         parse_extension_release_at_sentinel(rfd, _IMAGE_CLASS_INVALID, false, NULL, __VA_ARGS__, NULL)
  48
  49 int load_extension_release_pairs(const char *root, ImageClass image_class, const char *extension, bool relax_extension_release_check, char ***ret);
  50 static inline int load_os_release_pairs(const char *root, char ***ret) {
  51         return load_extension_release_pairs(root, _IMAGE_CLASS_INVALID, NULL, false, ret);
  52 }
  53 int load_os_release_pairs_with_prefix(const char *root, const char *prefix, char ***ret);
  54
  55 int os_release_support_ended(const char *support_end, bool quiet, usec_t *ret_eol);
  56
  57 const char* os_release_pretty_name(const char *pretty_name, const char *name);