Source code for pykickstart.commands.nvdimm

# Radek Vykydal <>
# Copyright 2018 Red Hat, Inc.
# This copyrighted material is made available to anyone wishing to use, modify,
# copy, or redistribute it subject to the terms and conditions of the GNU
# General Public License v.2.  This program is distributed in the hope that it
# will be useful, but WITHOUT ANY WARRANTY expressed or implied, including the
# 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, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  Any Red Hat
# trademarks that are incorporated in the source code or documentation are not
# subject to the GNU General Public License and may only be used or replicated
# with the express permission of Red Hat, Inc.

import warnings
from pykickstart.base import BaseData, KickstartCommand
from pykickstart.errors import KickstartParseError, KickstartParseWarning
from pykickstart.options import KSOptionParser, commaSplit
from pykickstart.constants import NVDIMM_MODE_SECTOR, NVDIMM_ACTION_RECONFIGURE, \
from pykickstart.version import F28

from pykickstart.i18n import _

[docs]class F28_NvdimmData(BaseData): removedKeywords = BaseData.removedKeywords removedAttrs = BaseData.removedAttrs def __init__(self, *args, **kwargs): BaseData.__init__(self, *args, **kwargs) self.action = kwargs.get("action", None) self.namespace = kwargs.get("namespace", "") self.mode = kwargs.get("mode", None) self.sectorsize = kwargs.get("sectorsize", None) self.blockdevs = kwargs.get("blockdevs", []) def __eq__(self, y): if not y: return False return (self.action == y.action and self.namespace == y.namespace and self.blockdevs == y.blockdevs) def __ne__(self, y): return not self == y def _getArgsAsStr(self): retval = "%s" % self.action if self.action == NVDIMM_ACTION_RECONFIGURE: if self.namespace: retval += " --namespace=%s" % self.namespace if self.mode == NVDIMM_MODE_SECTOR: retval += " --mode=%s" % NVDIMM_MODE_SECTOR if self.sectorsize: retval += " --sectorsize=%d" % self.sectorsize elif self.action == NVDIMM_ACTION_USE: if self.namespace: retval += " --namespace=%s" % self.namespace if self.blockdevs: retval += " --blockdevs=%s" % ",".join(self.blockdevs) return retval def __str__(self): retval = BaseData.__str__(self) retval += "nvdimm %s" % self._getArgsAsStr() return retval.strip() + "\n"
[docs]class F28_Nvdimm(KickstartCommand): removedKeywords = KickstartCommand.removedKeywords removedAttrs = KickstartCommand.removedAttrs def __init__(self, writePriority=80, *args, **kwargs): KickstartCommand.__init__(self, writePriority, *args, **kwargs) self.actionList = kwargs.get("actionList", []) self.validActions = [NVDIMM_ACTION_RECONFIGURE, NVDIMM_ACTION_USE] self.validModes = [NVDIMM_MODE_SECTOR] self.op = self._getParser() def __str__(self): retval = "" for action in self.actionList: retval += action.__str__() if retval != "": retval = "# NVDIMM devices setup\n" + retval + "\n" return retval def _getParser(self): op = KSOptionParser(prog="nvdimm", version=F28, description=""" Perform an action on an nvdimm device.""") op.add_argument("action", choices=self.validActions, nargs=1, default=NVDIMM_ACTION_RECONFIGURE, version=F28, help=""" The action to be performed on the device specified by further options. The device can be specified by ``--namespace`` or ``--blockdevs`` options, depending on the action. Valid actions: - ``reconfigure``: Reconfigures the device specified by ``--namespace`` into the mode specified by ``--mode`` and (depending on the mode) ``--sectorsize`` options. The device reconfigured into sector mode will be allowed to be used for storage configuration. - ``use``: Allow the device to be used for storage configuration. By default nvdimm devices are ignored. Only devices in sector mode can be used. """) op.add_argument("--namespace", metavar="<namespace>", version=F28, help="""The device specification by namespace.""") op.add_argument("--blockdevs", metavar="<devspec1>,<devspec2>,...,<devspecN>", type=commaSplit, version=F28, help="""Specification of devices by comma separated list of block device names.""") op.add_argument("--mode", choices=self.validModes, default=NVDIMM_MODE_SECTOR, version=F28, help="""The mode specification.""") op.add_argument("--sectorsize", type=int, version=F28, help="""Size of a sector for sector mode.""") return op
[docs] def parse(self, args): (ns, extra) = self.op.parse_known_args(args=args, lineno=self.lineno) if extra: raise KickstartParseError(_("Unexpected arguments to nvdimm command: %(arguments)s") % {"arguments": extra}, lineno=self.lineno) nvdimm_data = self.dataClass() # pylint: disable=not-callable self.set_to_obj(ns, nvdimm_data) nvdimm_data.lineno = self.lineno action = ns.action[0] nvdimm_data.action = action if nvdimm_data.namespace and nvdimm_data.blockdevs: raise KickstartParseError(_("Only one of --namespace and --blockdevs device specifications can be used")) # Check for duplicates in the data list. if nvdimm_data in self.dataList(): if nvdimm_data.namespace: warnings.warn(_("An action %(action)s on namespace %(namespace)s has already been defined.") % {"action": action, "namespace": nvdimm_data.namespace}, KickstartParseWarning) if nvdimm_data.blockdevs: warnings.warn(_("An action %(action)s on devices %(blockdevs)s has already been defined.") % {"action": action, "blockdevs": nvdimm_data.blockdevs}, KickstartParseWarning) if action == NVDIMM_ACTION_RECONFIGURE: if not nvdimm_data.namespace: raise KickstartParseError(_("Action %(action)s requires --namespace argument to be set") % {"action": action}) if nvdimm_data.mode == NVDIMM_MODE_SECTOR and not nvdimm_data.sectorsize: raise KickstartParseError(_("Action %(action)s with mode %(mode)s requires --sectorsize argument to be set") % {"action": action, "mode": nvdimm_data.mode}) elif action == NVDIMM_ACTION_USE: if not nvdimm_data.namespace and not nvdimm_data.blockdevs: raise KickstartParseError(_("Action %(action)s requires --namespace or --blockdevs argument to be set") % {"action": action}) return nvdimm_data
[docs] def dataList(self): return self.actionList
@property def dataClass(self): return self.handler.NvdimmData