tools/mkarray.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2011 Martin Decky
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 #
  10 # - Redistributions of source code must retain the above copyright
  11 #   notice, this list of conditions and the following disclaimer.
  12 # - Redistributions in binary form must reproduce the above copyright
  13 #   notice, this list of conditions and the following disclaimer in the
  14 #   documentation and/or other materials provided with the distribution.
  15 # - The name of the author may not be used to endorse or promote products
  16 #   derived from this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 """
  30 Binary inline data packer
  31 """
  32
  33 import sys
  34 import os
  35 import zlib
  36 import zipfile
  37 import binascii
  38
  39 def usage(prname):
  40         "Print usage syntax"
  41         print("%s [--deflate] <DESTINATION> <TYPENAME> <LABEL> <AS_PROLOG> <SECTION> [SOURCE ...]" % prname)
  42
  43 def arg_check():
  44         if (len(sys.argv) < 6):
  45                 usage(sys.argv[0])
  46                 sys.exit()
  47
  48 def deflate(data):
  49         "Compress using deflate algorithm (without any headers)"
  50         return zlib.compress(data, 9)[2:-4]
  51
  52 def chunks(string, length):
  53         "Produce string chunks"
  54         for start in range(0, len(string), length):
  55                 yield string[start:start + length]
  56
  57 def main():
  58         arg_check()
  59
  60         if sys.argv[1] == "--deflate":
  61                 sys.argv.pop(1)
  62                 arg_check()
  63                 compress = True
  64         else:
  65                 compress = False
  66
  67         dest = sys.argv[1]
  68         typename = sys.argv[2]
  69         label = sys.argv[3]
  70         as_prolog = sys.argv[4]
  71         section = sys.argv[5]
  72
  73         timestamp = (1980, 1, 1, 0, 0, 0)
  74
  75         header_ctx = []
  76         desc_ctx = []
  77         size_ctx = []
  78         data_ctx = []
  79
  80         src_cnt = 0
  81
  82         archive = zipfile.ZipFile("%s.zip" % dest, "w", zipfile.ZIP_STORED)
  83
  84         for src in sys.argv[6:]:
  85                 basename = os.path.basename(src)
  86                 plainname = os.path.splitext(basename)[0]
  87                 symbol = basename.replace(".", "_")
  88
  89                 print("%s -> %s" % (src, symbol))
  90
  91                 src_in = open(src, "rb")
  92                 src_data = src_in.read()
  93                 src_in.close()
  94
  95                 length = len(src_data)
  96
  97                 if compress:
  98                         src_data = deflate(src_data)
  99                         src_fname = os.path.basename("%s.deflate" % src)
 100                         zipinfo = zipfile.ZipInfo(src_fname, timestamp)
 101                         archive.writestr(zipinfo, src_data)
 102                 else:
 103                         src_fname = src
 104
 105                 if sys.version_info < (3,):
 106                         src_data = bytearray(src_data)
 107
 108                 length_out = len(src_data)
 109
 110                 header_ctx.append("extern uint8_t %s[];" % symbol)
 111                 header_ctx.append("extern size_t %s_size;" % symbol)
 112
 113                 data_ctx.append(".globl %s" % symbol)
 114                 data_ctx.append(".balign 8")
 115                 data_ctx.append(".size %s, %u" % (symbol, length_out))
 116                 data_ctx.append("%s:" % symbol)
 117                 data_ctx.append("\t.incbin \"%s\"\n" % src_fname)
 118
 119                 desc_field = []
 120                 desc_field.append("\t{")
 121                 desc_field.append("\t\t.name = \"%s\"," % plainname)
 122                 desc_field.append("\t\t.addr = (void *) %s," % symbol)
 123                 desc_field.append("\t\t.size = %u," % length_out)
 124                 desc_field.append("\t\t.inflated = %u," % length)
 125
 126                 if compress:
 127                         desc_field.append("\t\t.compressed = true")
 128                 else:
 129                         desc_field.append("\t\t.compressed = false")
 130
 131                 desc_field.append("\t}")
 132
 133                 desc_ctx.append("\n".join(desc_field))
 134
 135                 size_ctx.append("size_t %s_size = %u;" % (symbol, length_out))
 136
 137                 src_cnt += 1
 138
 139         data = ''
 140         data += '/*\n'
 141         data += ' * AUTO-GENERATED FILE, DO NOT EDIT!!!\n'
 142         data += ' * Generated by: tools/mkarray.py\n'
 143         data += ' */\n\n'
 144         data += "#ifndef %sS_H_\n" % label.upper()
 145         data += "#define %sS_H_\n\n" % label.upper()
 146         data += "#include <stddef.h>\n"
 147         data += "#include <stdint.h>\n"
 148         data += "#include <stdbool.h>\n\n"
 149         data += "#define %sS  %u\n\n" % (label.upper(), src_cnt)
 150         data += "#ifndef %sS_T_\n" % typename.upper()
 151         data += "#define %sS_T_\n\n" % typename.upper()
 152         data += "typedef struct {\n"
 153         data += "\tconst char *name;\n"
 154         data += "\tvoid *addr;\n"
 155         data += "\tsize_t size;\n"
 156         data += "\tsize_t inflated;\n"
 157         data += "\tbool compressed;\n"
 158         data += "} %s_t;\n\n" % typename
 159         data += "#endif\n"
 160         data += "extern %s_t %ss[];\n\n" % (typename, label)
 161         data += "\n".join(header_ctx)
 162         data += "\n\n"
 163         data += "#endif\n"
 164         zipinfo = zipfile.ZipInfo("%s.h" % dest, timestamp)
 165         archive.writestr(zipinfo, data)
 166
 167         data = ''
 168         data += '/*\n'
 169         data += ' * AUTO-GENERATED FILE, DO NOT EDIT!!!\n'
 170         data += ' * Generated by: tools/mkarray.py\n'
 171         data += ' */\n\n'
 172         data += as_prolog
 173         data += "%s\n\n" % section
 174         data += "\n".join(data_ctx)
 175         data += "\n"
 176         zipinfo = zipfile.ZipInfo("%s.s" % dest, timestamp)
 177         archive.writestr(zipinfo, data)
 178
 179         data = ''
 180         data += '/*\n'
 181         data += ' * AUTO-GENERATED FILE, DO NOT EDIT!!!\n'
 182         data += ' * Generated by: tools/mkarray.py\n'
 183         data += ' */\n\n'
 184         data += "#include \"%s.h\"\n\n" % dest
 185         data += "%s_t %ss[] = {\n" % (typename, label)
 186         data += ",\n".join(desc_ctx)
 187         data += "\n"
 188         data += "};\n\n"
 189         data += "\n".join(size_ctx)
 190         data += "\n"
 191         zipinfo = zipfile.ZipInfo("%s_desc.c" % dest, timestamp)
 192         archive.writestr(zipinfo, data)
 193
 194         archive.close()
 195
 196 if __name__ == '__main__':
 197         main()