src/core/swap.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   Copyright 2010 Maarten Lankhorst
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include "libudev.h"
  25
  26 typedef struct Swap Swap;
  27
  28 typedef enum SwapExecCommand {
  29         SWAP_EXEC_ACTIVATE,
  30         SWAP_EXEC_DEACTIVATE,
  31         _SWAP_EXEC_COMMAND_MAX,
  32         _SWAP_EXEC_COMMAND_INVALID = -1
  33 } SwapExecCommand;
  34
  35 typedef enum SwapResult {
  36         SWAP_SUCCESS,
  37         SWAP_FAILURE_RESOURCES,
  38         SWAP_FAILURE_TIMEOUT,
  39         SWAP_FAILURE_EXIT_CODE,
  40         SWAP_FAILURE_SIGNAL,
  41         SWAP_FAILURE_CORE_DUMP,
  42         SWAP_FAILURE_START_LIMIT_HIT,
  43         _SWAP_RESULT_MAX,
  44         _SWAP_RESULT_INVALID = -1
  45 } SwapResult;
  46
  47 typedef struct SwapParameters {
  48         char *what;
  49         char *options;
  50         int priority;
  51 } SwapParameters;
  52
  53 struct Swap {
  54         Unit meta;
  55
  56         char *what;
  57
  58         /* If the device has already shown up, this is the device
  59          * node, which might be different from what, due to
  60          * symlinks */
  61         char *devnode;
  62
  63         SwapParameters parameters_proc_swaps;
  64         SwapParameters parameters_fragment;
  65
  66         bool from_proc_swaps:1;
  67         bool from_fragment:1;
  68
  69         /* Used while looking for swaps that vanished or got added
  70          * from/to /proc/swaps */
  71         bool is_active:1;
  72         bool just_activated:1;
  73
  74         bool reset_accounting:1;
  75
  76         SwapResult result;
  77
  78         usec_t timeout_usec;
  79
  80         ExecCommand exec_command[_SWAP_EXEC_COMMAND_MAX];
  81         ExecContext exec_context;
  82         KillContext kill_context;
  83         CGroupContext cgroup_context;
  84
  85         ExecRuntime *exec_runtime;
  86         DynamicCreds dynamic_creds;
  87
  88         SwapState state, deserialized_state;
  89
  90         ExecCommand* control_command;
  91         SwapExecCommand control_command_id;
  92         pid_t control_pid;
  93
  94         sd_event_source *timer_event_source;
  95
  96         /* In order to be able to distinguish dependencies on
  97         different device nodes we might end up creating multiple
  98         devices for the same swap. We chain them up here. */
  99
 100         LIST_FIELDS(struct Swap, same_devnode);
 101 };
 102
 103 extern const UnitVTable swap_vtable;
 104
 105 int swap_process_device_new(Manager *m, struct udev_device *dev);
 106 int swap_process_device_remove(Manager *m, struct udev_device *dev);
 107
 108 const char* swap_exec_command_to_string(SwapExecCommand i) _const_;
 109 SwapExecCommand swap_exec_command_from_string(const char *s) _pure_;
 110
 111 const char* swap_result_to_string(SwapResult i) _const_;
 112 SwapResult swap_result_from_string(const char *s) _pure_;