summaryrefslogtreecommitdiff
path: root/kvmd/plugins/ugpio/ipmi.py
blob: 7b1622f90de56451fb37f4e488dba184a2d5ad76 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# ========================================================================== #
#                                                                            #
#    KVMD - The main Pi-KVM daemon.                                          #
#                                                                            #
#    Copyright (C) 2018-2021  Maxim Devaev <[email protected]>               #
#                                                                            #
#    This program is free software: you can redistribute it and/or modify    #
#    it under the terms of the GNU General Public License as published by    #
#    the Free Software Foundation, either version 3 of the License, or       #
#    (at your option) any later version.                                     #
#                                                                            #
#    This program is distributed in the hope that it will be useful,         #
#    but WITHOUT ANY WARRANTY; without even the implied warranty of          #
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           #
#    GNU General Public License for more details.                            #
#                                                                            #
#    You should have received a copy of the GNU General Public License       #
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
#                                                                            #
# ========================================================================== #


import asyncio

from typing import Dict
from typing import Optional

from pyghmi.ipmi.command import Command as IpmiCommand

from ...logging import get_logger

from ... import aiotools

from ...yamlconf import Option

from ...validators.basic import valid_float_f01
from ...validators.net import valid_ip_or_host
from ...validators.net import valid_port

from . import GpioDriverOfflineError
from . import BaseUserGpioDriver


# =====
_OUTPUTS = {
    1: "on",
    2: "off",
    3: "shutdown",
    4: "reset",
    5: "boot",
}


# =====
class Plugin(BaseUserGpioDriver):
    def __init__(  # pylint: disable=super-init-not-called
        self,
        instance_name: str,
        notifier: aiotools.AioNotifier,

        host: str,
        port: int,
        user: str,
        passwd: str,
        state_poll: float,
    ) -> None:

        super().__init__(instance_name, notifier)

        self.__host = host
        self.__port = port
        self.__user = user
        self.__passwd = passwd
        self.__state_poll = state_poll

        self.__online = False
        self.__power = False

    @classmethod
    def get_plugin_options(cls) -> Dict:
        return {
            "host":       Option("",  type=valid_ip_or_host),
            "port":       Option(623, type=valid_port),
            "user":       Option(""),
            "passwd":     Option(""),
            "state_poll": Option(1.0, type=valid_float_f01),
        }

    def register_input(self, pin: int, debounce: float) -> None:
        _ = debounce
        if pin != 0:
            raise RuntimeError(f"Unsupported mode 'input' for pin={pin} on {self}")

    def register_output(self, pin: int, initial: Optional[bool]) -> None:
        _ = initial
        if pin not in _OUTPUTS:
            raise RuntimeError(f"Unsupported mode 'output' for pin={pin} on {self}")

    def prepare(self) -> None:
        get_logger(0).info("Probing driver %s on %s:%d ...", self, self.__host, self.__port)

    async def run(self) -> None:
        prev = (False, False)
        while True:
            await aiotools.run_async(self.__update_power)
            new = (self.__online, self.__power)
            if new != prev:
                await self._notifier.notify()
                prev = new
            await asyncio.sleep(self.__state_poll)

    def cleanup(self) -> None:
        pass

    def read(self, pin: int) -> bool:
        if not self.__online:
            raise GpioDriverOfflineError(self)
        if pin == 0:
            return self.__power
        return False

    def write(self, pin: int, state: bool) -> None:
        if not self.__online:
            raise GpioDriverOfflineError(self)
        request = _OUTPUTS[pin]
        try:
            self.__make_command().set_power(request)
        except Exception:
            get_logger(0).exception("Can't send IPMI power-%s request to %s:%d", request, self.__host, self.__port)
            raise GpioDriverOfflineError(self)

    # =====

    def __update_power(self) -> None:
        try:
            self.__power = (self.__make_command().get_power()["powerstate"] == "on")
            self.__online = True
        except Exception:
            self.__online = self.__power = False
            get_logger(0).exception("Can't fetch IPMI power status from %s:%d", self.__host, self.__port)

    def __make_command(self) -> IpmiCommand:
        return IpmiCommand(
            bmc=self.__host,
            port=self.__port,
            userid=(self.__user or None),
            password=(self.__passwd or None),
        )

    def __str__(self) -> str:
        return f"IPMI({self._instance_name})"

    __repr__ = __str__