|
| 1 | +#!/usr/bin/python3 |
| 2 | +"""XAPI plugin to manage Kalray DPU.""" |
| 3 | + |
| 4 | +import json |
| 5 | +import XenAPIPlugin # pylint: disable=import-error |
| 6 | + |
| 7 | +from kalray.acs.spdk import rpc # pylint: disable=import-error |
| 8 | +from xcpngutils import error_wrapped |
| 9 | + |
| 10 | +class KalrayCmd: |
| 11 | + """Describe a command to be ran on the Kalray DPU.""" |
| 12 | + |
| 13 | + def __init__(self, rpc_name: str, updates: dict): |
| 14 | + self.server = 'localhost' |
| 15 | + self.port = 8080 |
| 16 | + self.username = None |
| 17 | + self.password = None |
| 18 | + self.timeout = 60.0 |
| 19 | + self.rpc_name = rpc_name |
| 20 | + self.rpc_params = {} # will be updated using add_rpc_params |
| 21 | + |
| 22 | + for k, v in updates.items(): |
| 23 | + if hasattr(self, k): |
| 24 | + setattr(self, k, v) |
| 25 | + |
| 26 | + # Check that username & password are well set |
| 27 | + if self.username is None: |
| 28 | + raise XenAPIPlugin.Failure("-1", ["'username' is required"]) |
| 29 | + if self.password is None: |
| 30 | + raise XenAPIPlugin.Failure("-1", ["'password' is required"]) |
| 31 | + |
| 32 | + def add_rpc_params(self, key, value): |
| 33 | + """Adds a parameter that will be passed to the RPC.""" |
| 34 | + self.rpc_params[key] = value |
| 35 | + |
| 36 | + def call_rpc(self): |
| 37 | + """Do the RPC call.""" |
| 38 | + try: |
| 39 | + client = rpc.client.HTTPJSONRPCClient( |
| 40 | + self.server, |
| 41 | + self.port, |
| 42 | + self.timeout, |
| 43 | + self.username, |
| 44 | + self.password, |
| 45 | + log_level="ERROR") |
| 46 | + message = client.call(self.rpc_name, self.rpc_params) |
| 47 | + except rpc.client.JSONRPCException as exc: |
| 48 | + raise XenAPIPlugin.Failure("-1", [exc.message]) |
| 49 | + |
| 50 | + return json.dumps(message) |
| 51 | + |
| 52 | +@error_wrapped |
| 53 | +def get_devices(_session, args): |
| 54 | + """Get the list of devices available on the Kalray DPU.""" |
| 55 | + kc = KalrayCmd("bdev_get_bdevs", args) |
| 56 | + return kc.call_rpc() |
| 57 | + |
| 58 | +@error_wrapped |
| 59 | +def get_raids(_session, args): |
| 60 | + """Get the list of raids available on the Kalray DPU.""" |
| 61 | + kc = KalrayCmd("bdev_raid_get_bdevs", args) |
| 62 | + kc.add_rpc_params("category", "all") |
| 63 | + return kc.call_rpc() |
| 64 | + |
| 65 | +@error_wrapped |
| 66 | +def get_lvs(_session, args): |
| 67 | + """Get the list of logical volume stores available on the Kalray DPU.""" |
| 68 | + kc = KalrayCmd("bdev_lvol_get_lvstores", args) |
| 69 | + return kc.call_rpc() |
| 70 | + |
| 71 | +@error_wrapped |
| 72 | +def raid_create(_session, args): |
| 73 | + """Create a raid.""" |
| 74 | + kc = KalrayCmd("bdev_raid_create", args) |
| 75 | + try: |
| 76 | + raid_name = args["raid_name"] |
| 77 | + raid_level = args["raid_level"] |
| 78 | + base_bdevs = args["base_bdevs"].split(',') |
| 79 | + except KeyError as msg: |
| 80 | + raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) |
| 81 | + |
| 82 | + # == Sanity checks == |
| 83 | + # Check supported raids |
| 84 | + if raid_level not in ["raid0", "raid1", "raid10"]: |
| 85 | + raise XenAPIPlugin.Failure("-1", ["Only raid0, raid1 and raid10 are supported"]) |
| 86 | + # Check that bdevs are "NVMe disk" |
| 87 | + devices = json.loads(get_devices(_session, args)) |
| 88 | + for bdev_name in base_bdevs: |
| 89 | + bdev_type = [dev['product_name'] for dev in devices if dev['name'] == bdev_name] |
| 90 | + if len(bdev_type) == 0 or bdev_type[0] != 'NVMe disk': |
| 91 | + raise XenAPIPlugin.Failure("-1", |
| 92 | + [f"Device ${bdev_name} is not an NVMe disk"]) |
| 93 | + |
| 94 | + kc.add_rpc_params("name", raid_name) |
| 95 | + kc.add_rpc_params("raid_level", raid_level) |
| 96 | + kc.add_rpc_params("base_bdevs", base_bdevs) |
| 97 | + kc.add_rpc_params("strip_size_kb", 128) |
| 98 | + kc.add_rpc_params("persist", True) |
| 99 | + kc.add_rpc_params("split_dp", True) |
| 100 | + return kc.call_rpc() |
| 101 | + |
| 102 | +@error_wrapped |
| 103 | +def lvs_create(_session, args): |
| 104 | + """Create a logical volume store.""" |
| 105 | + kc = KalrayCmd("bdev_lvol_lvs_createtore", args) |
| 106 | + try: |
| 107 | + lvs_name = args["lvs_name"] |
| 108 | + bdev_name = args["bdev_name"] |
| 109 | + except KeyError as msg: |
| 110 | + raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) |
| 111 | + |
| 112 | + kc.add_rpc_params("lvs_name", lvs_name) |
| 113 | + kc.add_rpc_params("bdev_name", bdev_name) |
| 114 | + |
| 115 | + return kc.call_rpc() |
| 116 | + |
| 117 | +@error_wrapped |
| 118 | +def lvol_create(_session, args): |
| 119 | + """Create a new lvol on the Kalray DPU.""" |
| 120 | + kc = KalrayCmd("bdev_lvol_create", args) |
| 121 | + |
| 122 | + try: |
| 123 | + lvol_name = args["lvol_name"] |
| 124 | + lvol_size = int(args["lvol_size_mb"]) |
| 125 | + lvs_name = args["lvs_name"] |
| 126 | + except KeyError as msg: |
| 127 | + raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) |
| 128 | + except ValueError as msg: |
| 129 | + raise XenAPIPlugin.Failure("-1", [f"Wrong size: {msg}"]) |
| 130 | + |
| 131 | + kc.add_rpc_params("lvol_name", lvol_name) |
| 132 | + kc.add_rpc_params("size", lvol_size) |
| 133 | + kc.add_rpc_params("lvs_name", lvs_name) |
| 134 | + return kc.call_rpc() |
| 135 | + |
| 136 | +@error_wrapped |
| 137 | +def lvol_delete(_session, args): |
| 138 | + """Delete the lvol passed as parameter on the Kalray DPU if exists.""" |
| 139 | + kc = KalrayCmd("bdev_lvol_delete", args) |
| 140 | + |
| 141 | + try: |
| 142 | + lvol_name = args["lvol_name"] |
| 143 | + except KeyError as msg: |
| 144 | + raise XenAPIPlugin.Failure("-1", [f"Key {msg} is missing"]) |
| 145 | + |
| 146 | + kc.add_rpc_params("name", lvol_name) |
| 147 | + return kc.call_rpc() |
| 148 | + |
| 149 | +def test(_session, args): |
| 150 | + devices = json.loads(get_devices(_session, args)) |
| 151 | + dev_name = args["name"] |
| 152 | + for dev in devices: |
| 153 | + if dev['name'] == dev_name and dev['product_name'] == 'NVMe disk': |
| 154 | + return json.dumps(True) |
| 155 | + |
| 156 | + return json.dumps(False) |
| 157 | + |
| 158 | +if __name__ == "__main__": |
| 159 | + XenAPIPlugin.dispatch({ |
| 160 | + "get_devices": get_devices, |
| 161 | + "get_raids": get_raids, |
| 162 | + "get_lvs": get_lvs, |
| 163 | + "raid_create": raid_create, |
| 164 | + "lvs_create": lvs_create, |
| 165 | + "lvol_create": lvol_create, |
| 166 | + "lvol_delete": lvol_delete, |
| 167 | + "test": test, |
| 168 | + }) |
0 commit comments