tools/binman/control.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2016 Google, Inc
   3 # Written by Simon Glass <sjg@chromium.org>
   4 #
   5 # Creates binary images from input files controlled by a description
   6 #
   7
   8 from __future__ import print_function
   9
  10 from collections import OrderedDict
  11 import os
  12 import sys
  13 import tools
  14
  15 import cbfs_util
  16 import command
  17 import elf
  18 from image import Image
  19 import state
  20 import tout
  21
  22 # List of images we plan to create
  23 # Make this global so that it can be referenced from tests
  24 images = OrderedDict()
  25
  26 def _ReadImageDesc(binman_node):
  27     """Read the image descriptions from the /binman node
  28
  29     This normally produces a single Image object called 'image'. But if
  30     multiple images are present, they will all be returned.
  31
  32     Args:
  33         binman_node: Node object of the /binman node
  34     Returns:
  35         OrderedDict of Image objects, each of which describes an image
  36     """
  37     images = OrderedDict()
  38     if 'multiple-images' in binman_node.props:
  39         for node in binman_node.subnodes:
  40             images[node.name] = Image(node.name, node)
  41     else:
  42         images['image'] = Image('image', binman_node)
  43     return images
  44
  45 def _FindBinmanNode(dtb):
  46     """Find the 'binman' node in the device tree
  47
  48     Args:
  49         dtb: Fdt object to scan
  50     Returns:
  51         Node object of /binman node, or None if not found
  52     """
  53     for node in dtb.GetRoot().subnodes:
  54         if node.name == 'binman':
  55             return node
  56     return None
  57
  58 def WriteEntryDocs(modules, test_missing=None):
  59     """Write out documentation for all entries
  60
  61     Args:
  62         modules: List of Module objects to get docs for
  63         test_missing: Used for testing only, to force an entry's documeentation
  64             to show as missing even if it is present. Should be set to None in
  65             normal use.
  66     """
  67     from entry import Entry
  68     Entry.WriteDocs(modules, test_missing)
  69
  70
  71 def ListEntries(image_fname, entry_paths):
  72     """List the entries in an image
  73
  74     This decodes the supplied image and displays a table of entries from that
  75     image, preceded by a header.
  76
  77     Args:
  78         image_fname: Image filename to process
  79         entry_paths: List of wildcarded paths (e.g. ['*dtb*', 'u-boot*',
  80                                                      'section/u-boot'])
  81     """
  82     image = Image.FromFile(image_fname)
  83
  84     entries, lines, widths = image.GetListEntries(entry_paths)
  85
  86     num_columns = len(widths)
  87     for linenum, line in enumerate(lines):
  88         if linenum == 1:
  89             # Print header line
  90             print('-' * (sum(widths) + num_columns * 2))
  91         out = ''
  92         for i, item in enumerate(line):
  93             width = -widths[i]
  94             if item.startswith('>'):
  95                 width = -width
  96                 item = item[1:]
  97             txt = '%*s  ' % (width, item)
  98             out += txt
  99         print(out.rstrip())
 100
 101
 102 def ReadEntry(image_fname, entry_path, decomp=True):
 103     """Extract an entry from an image
 104
 105     This extracts the data from a particular entry in an image
 106
 107     Args:
 108         image_fname: Image filename to process
 109         entry_path: Path to entry to extract
 110         decomp: True to return uncompressed data, if the data is compress
 111             False to return the raw data
 112
 113     Returns:
 114         data extracted from the entry
 115     """
 116     image = Image.FromFile(image_fname)
 117     entry = image.FindEntryPath(entry_path)
 118     return entry.ReadData(decomp)
 119
 120
 121 def ExtractEntries(image_fname, output_fname, outdir, entry_paths,
 122                    decomp=True):
 123     """Extract the data from one or more entries and write it to files
 124
 125     Args:
 126         image_fname: Image filename to process
 127         output_fname: Single output filename to use if extracting one file, None
 128             otherwise
 129         outdir: Output directory to use (for any number of files), else None
 130         entry_paths: List of entry paths to extract
 131         decomp: True to compress the entry data
 132
 133     Returns:
 134         List of EntryInfo records that were written
 135     """
 136     image = Image.FromFile(image_fname)
 137
 138     # Output an entry to a single file, as a special case
 139     if output_fname:
 140         if not entry_paths:
 141             raise ValueError('Must specify an entry path to write with -o')
 142         if len(entry_paths) != 1:
 143             raise ValueError('Must specify exactly one entry path to write with -o')
 144         entry = image.FindEntryPath(entry_paths[0])
 145         data = entry.ReadData(decomp)
 146         tools.WriteFile(output_fname, data)
 147         tout.Notice("Wrote %#x bytes to file '%s'" % (len(data), output_fname))
 148         return
 149
 150     # Otherwise we will output to a path given by the entry path of each entry.
 151     # This means that entries will appear in subdirectories if they are part of
 152     # a sub-section.
 153     einfos = image.GetListEntries(entry_paths)[0]
 154     tout.Notice('%d entries match and will be written' % len(einfos))
 155     for einfo in einfos:
 156         entry = einfo.entry
 157         data = entry.ReadData(decomp)
 158         path = entry.GetPath()[1:]
 159         fname = os.path.join(outdir, path)
 160
 161         # If this entry has children, create a directory for it and put its
 162         # data in a file called 'root' in that directory
 163         if entry.GetEntries():
 164             if not os.path.exists(fname):
 165                 os.makedirs(fname)
 166             fname = os.path.join(fname, 'root')
 167         tout.Notice("Write entry '%s' to '%s'" % (entry.GetPath(), fname))
 168         tools.WriteFile(fname, data)
 169     return einfos
 170
 171
 172 def PrepareImagesAndDtbs(dtb_fname, select_images, update_fdt):
 173     """Prepare the images to be processed and select the device tree
 174
 175     This function:
 176     - reads in the device tree
 177     - finds and scans the binman node to create all entries
 178     - selects which images to build
 179     - Updates the device tress with placeholder properties for offset,
 180         image-pos, etc.
 181
 182     Args:
 183         dtb_fname: Filename of the device tree file to use (.dts or .dtb)
 184         selected_images: List of images to output, or None for all
 185         update_fdt: True to update the FDT wth entry offsets, etc.
 186     """
 187     # Import these here in case libfdt.py is not available, in which case
 188     # the above help option still works.
 189     import fdt
 190     import fdt_util
 191     global images
 192
 193     # Get the device tree ready by compiling it and copying the compiled
 194     # output into a file in our output directly. Then scan it for use
 195     # in binman.
 196     dtb_fname = fdt_util.EnsureCompiled(dtb_fname)
 197     fname = tools.GetOutputFilename('u-boot.dtb.out')
 198     tools.WriteFile(fname, tools.ReadFile(dtb_fname))
 199     dtb = fdt.FdtScan(fname)
 200
 201     node = _FindBinmanNode(dtb)
 202     if not node:
 203         raise ValueError("Device tree '%s' does not have a 'binman' "
 204                             "node" % dtb_fname)
 205
 206     images = _ReadImageDesc(node)
 207
 208     if select_images:
 209         skip = []
 210         new_images = OrderedDict()
 211         for name, image in images.items():
 212             if name in select_images:
 213                 new_images[name] = image
 214             else:
 215                 skip.append(name)
 216         images = new_images
 217         tout.Notice('Skipping images: %s' % ', '.join(skip))
 218
 219     state.Prepare(images, dtb)
 220
 221     # Prepare the device tree by making sure that any missing
 222     # properties are added (e.g. 'pos' and 'size'). The values of these
 223     # may not be correct yet, but we add placeholders so that the
 224     # size of the device tree is correct. Later, in
 225     # SetCalculatedProperties() we will insert the correct values
 226     # without changing the device-tree size, thus ensuring that our
 227     # entry offsets remain the same.
 228     for image in images.values():
 229         image.ExpandEntries()
 230         if update_fdt:
 231             image.AddMissingProperties()
 232         image.ProcessFdt(dtb)
 233
 234     for dtb_item in state.GetAllFdts():
 235         dtb_item.Sync(auto_resize=True)
 236         dtb_item.Pack()
 237         dtb_item.Flush()
 238     return images
 239
 240
 241 def ProcessImage(image, update_fdt, write_map):
 242     """Perform all steps for this image, including checking and # writing it.
 243
 244     This means that errors found with a later image will be reported after
 245     earlier images are already completed and written, but that does not seem
 246     important.
 247
 248     Args:
 249         image: Image to process
 250         update_fdt: True to update the FDT wth entry offsets, etc.
 251         write_map: True to write a map file
 252     """
 253     image.GetEntryContents()
 254     image.GetEntryOffsets()
 255
 256     # We need to pack the entries to figure out where everything
 257     # should be placed. This sets the offset/size of each entry.
 258     # However, after packing we call ProcessEntryContents() which
 259     # may result in an entry changing size. In that case we need to
 260     # do another pass. Since the device tree often contains the
 261     # final offset/size information we try to make space for this in
 262     # AddMissingProperties() above. However, if the device is
 263     # compressed we cannot know this compressed size in advance,
 264     # since changing an offset from 0x100 to 0x104 (for example) can
 265     # alter the compressed size of the device tree. So we need a
 266     # third pass for this.
 267     passes = 3
 268     for pack_pass in range(passes):
 269         try:
 270             image.PackEntries()
 271             image.CheckSize()
 272             image.CheckEntries()
 273         except Exception as e:
 274             if write_map:
 275                 fname = image.WriteMap()
 276                 print("Wrote map file '%s' to show errors"  % fname)
 277             raise
 278         image.SetImagePos()
 279         if update_fdt:
 280             image.SetCalculatedProperties()
 281             for dtb_item in state.GetAllFdts():
 282                 dtb_item.Sync()
 283         sizes_ok = image.ProcessEntryContents()
 284         if sizes_ok:
 285             break
 286         image.ResetForPack()
 287     if not sizes_ok:
 288         image.Raise('Entries expanded after packing (tried %s passes)' %
 289                     passes)
 290
 291     image.WriteSymbols()
 292     image.BuildImage()
 293     if write_map:
 294         image.WriteMap()
 295
 296
 297 def Binman(args):
 298     """The main control code for binman
 299
 300     This assumes that help and test options have already been dealt with. It
 301     deals with the core task of building images.
 302
 303     Args:
 304         args: Command line arguments Namespace object
 305     """
 306     if args.full_help:
 307         pager = os.getenv('PAGER')
 308         if not pager:
 309             pager = 'more'
 310         fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
 311                             'README')
 312         command.Run(pager, fname)
 313         return 0
 314
 315     if args.cmd == 'ls':
 316         ListEntries(args.image, args.paths)
 317         return 0
 318
 319     if args.cmd == 'extract':
 320         try:
 321             tools.PrepareOutputDir(None)
 322             ExtractEntries(args.image, args.filename, args.outdir, args.paths,
 323                            not args.uncompressed)
 324         finally:
 325             tools.FinaliseOutputDir()
 326         return 0
 327
 328     # Try to figure out which device tree contains our image description
 329     if args.dt:
 330         dtb_fname = args.dt
 331     else:
 332         board = args.board
 333         if not board:
 334             raise ValueError('Must provide a board to process (use -b <board>)')
 335         board_pathname = os.path.join(args.build_dir, board)
 336         dtb_fname = os.path.join(board_pathname, 'u-boot.dtb')
 337         if not args.indir:
 338             args.indir = ['.']
 339         args.indir.append(board_pathname)
 340
 341     try:
 342         tout.Init(args.verbosity)
 343         elf.debug = args.debug
 344         cbfs_util.VERBOSE = args.verbosity > 2
 345         state.use_fake_dtb = args.fake_dtb
 346         try:
 347             tools.SetInputDirs(args.indir)
 348             tools.PrepareOutputDir(args.outdir, args.preserve)
 349             tools.SetToolPaths(args.toolpath)
 350             state.SetEntryArgs(args.entry_arg)
 351
 352             images = PrepareImagesAndDtbs(dtb_fname, args.image,
 353                                           args.update_fdt)
 354             for image in images.values():
 355                 ProcessImage(image, args.update_fdt, args.map)
 356
 357             # Write the updated FDTs to our output files
 358             for dtb_item in state.GetAllFdts():
 359                 tools.WriteFile(dtb_item._fname, dtb_item.GetContents())
 360
 361         finally:
 362             tools.FinaliseOutputDir()
 363     finally:
 364         tout.Uninit()
 365
 366     return 0