src/basic/unit-name.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8 ***/
   9
  10 #include <stdbool.h>
  11
  12 #include "macro.h"
  13 #include "unit-def.h"
  14
  15 #define UNIT_NAME_MAX 256
  16
  17 typedef enum UnitNameFlags {
  18         UNIT_NAME_PLAIN = 1,      /* Allow foo.service */
  19         UNIT_NAME_INSTANCE = 2,   /* Allow foo@bar.service */
  20         UNIT_NAME_TEMPLATE = 4,   /* Allow foo@.service */
  21         UNIT_NAME_ANY = UNIT_NAME_PLAIN|UNIT_NAME_INSTANCE|UNIT_NAME_TEMPLATE,
  22 } UnitNameFlags;
  23
  24 bool unit_name_is_valid(const char *n, UnitNameFlags flags) _pure_;
  25 bool unit_prefix_is_valid(const char *p) _pure_;
  26 bool unit_instance_is_valid(const char *i) _pure_;
  27 bool unit_suffix_is_valid(const char *s) _pure_;
  28
  29 static inline int unit_prefix_and_instance_is_valid(const char *p) {
  30         /* For prefix+instance and instance the same rules apply */
  31         return unit_instance_is_valid(p);
  32 }
  33
  34 int unit_name_to_prefix(const char *n, char **prefix);
  35 int unit_name_to_instance(const char *n, char **instance);
  36 int unit_name_to_prefix_and_instance(const char *n, char **ret);
  37
  38 UnitType unit_name_to_type(const char *n) _pure_;
  39
  40 int unit_name_change_suffix(const char *n, const char *suffix, char **ret);
  41
  42 int unit_name_build(const char *prefix, const char *instance, const char *suffix, char **ret);
  43 int unit_name_build_from_type(const char *prefix, const char *instance, UnitType, char **ret);
  44
  45 char *unit_name_escape(const char *f);
  46 int unit_name_unescape(const char *f, char **ret);
  47 int unit_name_path_escape(const char *f, char **ret);
  48 int unit_name_path_unescape(const char *f, char **ret);
  49
  50 int unit_name_replace_instance(const char *f, const char *i, char **ret);
  51
  52 int unit_name_template(const char *f, char **ret);
  53
  54 int unit_name_from_path(const char *path, const char *suffix, char **ret);
  55 int unit_name_from_path_instance(const char *prefix, const char *path, const char *suffix, char **ret);
  56 int unit_name_to_path(const char *name, char **ret);
  57
  58 typedef enum UnitNameMangle {
  59         UNIT_NAME_MANGLE_GLOB = 1,
  60         UNIT_NAME_MANGLE_WARN = 2,
  61 } UnitNameMangle;
  62
  63 int unit_name_mangle_with_suffix(const char *name, UnitNameMangle flags, const char *suffix, char **ret);
  64
  65 static inline int unit_name_mangle(const char *name, UnitNameMangle flags, char **ret) {
  66         return unit_name_mangle_with_suffix(name, flags, ".service", ret);
  67 }
  68
  69 int slice_build_parent_slice(const char *slice, char **ret);
  70 int slice_build_subslice(const char *slice, const char*name, char **subslice);
  71 bool slice_name_is_valid(const char *name);