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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2022 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
import functools
from typing import List
from typing import Dict
from typing import Callable
from typing import Optional
from typing import Any
from ...logging import get_logger
from ... import tools
from ... import aiotools
from ... import aioproc
from ...yamlconf import Option
from ...validators import check_string_in_list
from ...validators.basic import valid_float_f01
from ...validators.net import valid_ip_or_host
from ...validators.net import valid_port
from ...validators.os import valid_command
from . import GpioDriverOfflineError
from . import BaseUserGpioDriver
# =====
_OUTPUTS = {
"1": "on",
"2": "off",
"3": "cycle",
"4": "reset",
"5": "diag",
"6": "soft",
}
# =====
class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attributes
def __init__( # pylint: disable=super-init-not-called
self,
instance_name: str,
notifier: aiotools.AioNotifier,
host: str,
port: int,
user: str,
passwd: str,
passwd_env: str,
cmd: List[str],
state_poll: float,
) -> None:
super().__init__(instance_name, notifier)
self.__host = host
self.__port = port
self.__user = user
self.__passwd = passwd
self.__passwd_env = passwd_env
self.__cmd = cmd
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(""),
"passwd_env": Option("IPMI_PASSWORD"),
"cmd": Option([
"/usr/bin/ipmitool",
"-I", "lanplus",
"-U", "{user}", "-E",
"-H", "{host}", "-p", "{port}",
"power", "{action}",
], type=valid_command),
"state_poll": Option(1.0, type=valid_float_f01),
}
@classmethod
def get_pin_validator(cls) -> Callable[[Any], Any]:
actions = ["0", *_OUTPUTS, "status", *_OUTPUTS.values()]
return (lambda arg: check_string_in_list(arg, "IPMI action", actions))
def register_input(self, pin: str, debounce: float) -> None:
_ = debounce
if pin not in ["0", "status"]:
raise RuntimeError(f"Unsupported mode 'input' for pin={pin} on {self}")
def register_output(self, pin: str, initial: Optional[bool]) -> None:
_ = initial
if pin not in [*_OUTPUTS, *_OUTPUTS.values()]:
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 self.__update_power()
new = (self.__online, self.__power)
if new != prev:
self._notifier.notify()
prev = new
await asyncio.sleep(self.__state_poll)
async def read(self, pin: str) -> bool:
if not self.__online:
raise GpioDriverOfflineError(self)
if pin == "0":
return self.__power
return False
async def write(self, pin: str, state: bool) -> None:
if not self.__online:
raise GpioDriverOfflineError(self)
if not state:
return
action = (_OUTPUTS[pin] if pin.isdigit() else pin)
try:
proc = await aioproc.log_process(**self.__make_ipmitool_kwargs(action), logger=get_logger(0), prefix=str(self))
if proc.returncode != 0:
raise RuntimeError(f"Ipmitool error: retcode={proc.returncode}")
except Exception as err:
get_logger(0).error("Can't send IPMI power-%s request to %s:%d: %s",
action, self.__host, self.__port, tools.efmt(err))
raise GpioDriverOfflineError(self)
# =====
async def __update_power(self) -> None:
try:
(proc, text) = await aioproc.read_process(**self.__make_ipmitool_kwargs("status"))
if proc.returncode != 0:
raise RuntimeError(f"Ipmitool error: retcode={proc.returncode}")
stripped = text.strip()
if stripped.startswith("Chassis Power is "):
self.__power = (stripped != "Chassis Power is off")
self.__online = True
return
raise RuntimeError(f"Invalid ipmitool response: {text}")
except Exception as err:
get_logger(0).error("Can't fetch IPMI power status from %s:%d: %s",
self.__host, self.__port, tools.efmt(err))
self.__power = False
self.__online = False
@functools.lru_cache()
def __make_ipmitool_kwargs(self, action: str) -> Dict:
return {
"cmd": [
part.format(
host=self.__host,
port=self.__port,
user=self.__user,
passwd=self.__passwd,
action=action,
)
for part in self.__cmd
],
"env": (
{self.__passwd_env: self.__passwd}
if self.__passwd and self.__passwd_env
else None
),
}
def __str__(self) -> str:
return f"IPMI({self._instance_name})"
__repr__ = __str__
|
