1#!/usr/bin/env python3 2# 3# Copyright (c) 2016 Intel, Inc. 4# 5# SPDX-License-Identifier: GPL-2.0-only 6# 7# DESCRIPTION 8# This module provides parser for kickstart format 9# 10# AUTHORS 11# Ed Bartosh <ed.bartosh> (at] linux.intel.com> 12 13"""Kickstart parser module.""" 14 15import os 16import shlex 17import logging 18import re 19 20from argparse import ArgumentParser, ArgumentError, ArgumentTypeError 21 22from wic.engine import find_canned 23from wic.partition import Partition 24from wic.misc import get_bitbake_var 25 26logger = logging.getLogger('wic') 27 28__expand_var_regexp__ = re.compile(r"\${[^{}@\n\t :]+}") 29 30def expand_line(line): 31 while True: 32 m = __expand_var_regexp__.search(line) 33 if not m: 34 return line 35 key = m.group()[2:-1] 36 val = get_bitbake_var(key) 37 if val is None: 38 logger.warning("cannot expand variable %s" % key) 39 return line 40 line = line[:m.start()] + val + line[m.end():] 41 42class KickStartError(Exception): 43 """Custom exception.""" 44 pass 45 46class KickStartParser(ArgumentParser): 47 """ 48 This class overwrites error method to throw exception 49 instead of producing usage message(default argparse behavior). 50 """ 51 def error(self, message): 52 raise ArgumentError(None, message) 53 54def sizetype(default, size_in_bytes=False): 55 def f(arg): 56 """ 57 Custom type for ArgumentParser 58 Converts size string in <num>[S|s|K|k|M|G] format into the integer value 59 """ 60 try: 61 suffix = default 62 size = int(arg) 63 except ValueError: 64 try: 65 suffix = arg[-1:] 66 size = int(arg[:-1]) 67 except ValueError: 68 raise ArgumentTypeError("Invalid size: %r" % arg) 69 70 71 if size_in_bytes: 72 if suffix == 's' or suffix == 'S': 73 return size * 512 74 mult = 1024 75 else: 76 mult = 1 77 78 if suffix == "k" or suffix == "K": 79 return size * mult 80 if suffix == "M": 81 return size * mult * 1024 82 if suffix == "G": 83 return size * mult * 1024 * 1024 84 85 raise ArgumentTypeError("Invalid size: %r" % arg) 86 return f 87 88def overheadtype(arg): 89 """ 90 Custom type for ArgumentParser 91 Converts overhead string to float and checks if it's bigger than 1.0 92 """ 93 try: 94 result = float(arg) 95 except ValueError: 96 raise ArgumentTypeError("Invalid value: %r" % arg) 97 98 if result < 1.0: 99 raise ArgumentTypeError("Overhead factor should be > 1.0" % arg) 100 101 return result 102 103def cannedpathtype(arg): 104 """ 105 Custom type for ArgumentParser 106 Tries to find file in the list of canned wks paths 107 """ 108 scripts_path = os.path.abspath(os.path.dirname(__file__) + '../../..') 109 result = find_canned(scripts_path, arg) 110 if not result: 111 raise ArgumentTypeError("file not found: %s" % arg) 112 return result 113 114def systemidtype(arg): 115 """ 116 Custom type for ArgumentParser 117 Checks if the argument sutisfies system id requirements, 118 i.e. if it's one byte long integer > 0 119 """ 120 error = "Invalid system type: %s. must be hex "\ 121 "between 0x1 and 0xFF" % arg 122 try: 123 result = int(arg, 16) 124 except ValueError: 125 raise ArgumentTypeError(error) 126 127 if result <= 0 or result > 0xff: 128 raise ArgumentTypeError(error) 129 130 return arg 131 132class KickStart(): 133 """Kickstart parser implementation.""" 134 135 DEFAULT_EXTRA_SPACE = 10*1024 136 DEFAULT_OVERHEAD_FACTOR = 1.3 137 138 def __init__(self, confpath): 139 140 self.partitions = [] 141 self.bootloader = None 142 self.lineno = 0 143 self.partnum = 0 144 145 parser = KickStartParser() 146 subparsers = parser.add_subparsers() 147 148 part = subparsers.add_parser('part') 149 part.add_argument('mountpoint', nargs='?') 150 part.add_argument('--active', action='store_true') 151 part.add_argument('--align', type=int) 152 part.add_argument('--offset', type=sizetype("K", True)) 153 part.add_argument('--exclude-path', nargs='+') 154 part.add_argument('--include-path', nargs='+', action='append') 155 part.add_argument('--change-directory') 156 part.add_argument("--extra-space", type=sizetype("M")) 157 part.add_argument('--fsoptions', dest='fsopts') 158 part.add_argument('--fstype', default='vfat', 159 choices=('ext2', 'ext3', 'ext4', 'btrfs', 160 'squashfs', 'vfat', 'msdos', 'erofs', 161 'swap')) 162 part.add_argument('--mkfs-extraopts', default='') 163 part.add_argument('--label') 164 part.add_argument('--use-label', action='store_true') 165 part.add_argument('--no-table', action='store_true') 166 part.add_argument('--ondisk', '--ondrive', dest='disk', default='sda') 167 part.add_argument("--overhead-factor", type=overheadtype) 168 part.add_argument('--part-name') 169 part.add_argument('--part-type') 170 part.add_argument('--rootfs-dir') 171 part.add_argument('--type', default='primary', 172 choices = ('primary', 'logical')) 173 174 # --size and --fixed-size cannot be specified together; options 175 # ----extra-space and --overhead-factor should also raise a parser 176 # --error, but since nesting mutually exclusive groups does not work, 177 # ----extra-space/--overhead-factor are handled later 178 sizeexcl = part.add_mutually_exclusive_group() 179 sizeexcl.add_argument('--size', type=sizetype("M"), default=0) 180 sizeexcl.add_argument('--fixed-size', type=sizetype("M"), default=0) 181 182 part.add_argument('--source') 183 part.add_argument('--sourceparams') 184 part.add_argument('--system-id', type=systemidtype) 185 part.add_argument('--use-uuid', action='store_true') 186 part.add_argument('--uuid') 187 part.add_argument('--fsuuid') 188 part.add_argument('--no-fstab-update', action='store_true') 189 190 bootloader = subparsers.add_parser('bootloader') 191 bootloader.add_argument('--append') 192 bootloader.add_argument('--configfile') 193 bootloader.add_argument('--ptable', choices=('msdos', 'gpt'), 194 default='msdos') 195 bootloader.add_argument('--timeout', type=int) 196 bootloader.add_argument('--source') 197 198 include = subparsers.add_parser('include') 199 include.add_argument('path', type=cannedpathtype) 200 201 self._parse(parser, confpath) 202 if not self.bootloader: 203 logger.warning('bootloader config not specified, using defaults\n') 204 self.bootloader = bootloader.parse_args([]) 205 206 def _parse(self, parser, confpath): 207 """ 208 Parse file in .wks format using provided parser. 209 """ 210 with open(confpath) as conf: 211 lineno = 0 212 for line in conf: 213 line = line.strip() 214 lineno += 1 215 if line and line[0] != '#': 216 line = expand_line(line) 217 try: 218 line_args = shlex.split(line) 219 parsed = parser.parse_args(line_args) 220 except ArgumentError as err: 221 raise KickStartError('%s:%d: %s' % \ 222 (confpath, lineno, err)) 223 if line.startswith('part'): 224 # SquashFS does not support filesystem UUID 225 if parsed.fstype == 'squashfs': 226 if parsed.fsuuid: 227 err = "%s:%d: SquashFS does not support UUID" \ 228 % (confpath, lineno) 229 raise KickStartError(err) 230 if parsed.label: 231 err = "%s:%d: SquashFS does not support LABEL" \ 232 % (confpath, lineno) 233 raise KickStartError(err) 234 # erofs does not support filesystem labels 235 if parsed.fstype == 'erofs' and parsed.label: 236 err = "%s:%d: erofs does not support LABEL" % (confpath, lineno) 237 raise KickStartError(err) 238 if parsed.fstype == 'msdos' or parsed.fstype == 'vfat': 239 if parsed.fsuuid: 240 if parsed.fsuuid.upper().startswith('0X'): 241 if len(parsed.fsuuid) > 10: 242 err = "%s:%d: fsuuid %s given in wks kickstart file " \ 243 "exceeds the length limit for %s filesystem. " \ 244 "It should be in the form of a 32 bit hexadecimal" \ 245 "number (for example, 0xABCD1234)." \ 246 % (confpath, lineno, parsed.fsuuid, parsed.fstype) 247 raise KickStartError(err) 248 elif len(parsed.fsuuid) > 8: 249 err = "%s:%d: fsuuid %s given in wks kickstart file " \ 250 "exceeds the length limit for %s filesystem. " \ 251 "It should be in the form of a 32 bit hexadecimal" \ 252 "number (for example, 0xABCD1234)." \ 253 % (confpath, lineno, parsed.fsuuid, parsed.fstype) 254 raise KickStartError(err) 255 if parsed.use_label and not parsed.label: 256 err = "%s:%d: Must set the label with --label" \ 257 % (confpath, lineno) 258 raise KickStartError(err) 259 # using ArgumentParser one cannot easily tell if option 260 # was passed as argument, if said option has a default 261 # value; --overhead-factor/--extra-space cannot be used 262 # with --fixed-size, so at least detect when these were 263 # passed with non-0 values ... 264 if parsed.fixed_size: 265 if parsed.overhead_factor or parsed.extra_space: 266 err = "%s:%d: arguments --overhead-factor and --extra-space not "\ 267 "allowed with argument --fixed-size" \ 268 % (confpath, lineno) 269 raise KickStartError(err) 270 else: 271 # ... and provide defaults if not using 272 # --fixed-size iff given option was not used 273 # (again, one cannot tell if option was passed but 274 # with value equal to 0) 275 if '--overhead-factor' not in line_args: 276 parsed.overhead_factor = self.DEFAULT_OVERHEAD_FACTOR 277 if '--extra-space' not in line_args: 278 parsed.extra_space = self.DEFAULT_EXTRA_SPACE 279 280 self.partnum += 1 281 self.partitions.append(Partition(parsed, self.partnum)) 282 elif line.startswith('include'): 283 self._parse(parser, parsed.path) 284 elif line.startswith('bootloader'): 285 if not self.bootloader: 286 self.bootloader = parsed 287 # Concatenate the strings set in APPEND 288 append_var = get_bitbake_var("APPEND") 289 if append_var: 290 self.bootloader.append = ' '.join(filter(None, \ 291 (self.bootloader.append, append_var))) 292 else: 293 err = "%s:%d: more than one bootloader specified" \ 294 % (confpath, lineno) 295 raise KickStartError(err) 296