blob: 0b887681efdd1e8a126dd8eecdfb7bd2eb0a7aa9 [file] [log] [blame]
Kevin O'Connor202024a2009-01-17 10:41:28 -05001#!/usr/bin/env python
Kevin O'Connor5b8f8092009-09-20 19:47:45 -04002# Script to analyze code and arrange ld sections.
Kevin O'Connor202024a2009-01-17 10:41:28 -05003#
Kevin O'Connor1a4885e2010-09-15 21:28:31 -04004# Copyright (C) 2008-2010 Kevin O'Connor <kevin@koconnor.net>
Kevin O'Connor202024a2009-01-17 10:41:28 -05005#
6# This file may be distributed under the terms of the GNU GPLv3 license.
7
Johannes Krampf0a82fc72014-01-12 11:39:57 -05008import operator
Kevin O'Connor202024a2009-01-17 10:41:28 -05009import sys
10
Kevin O'Connor5b8f8092009-09-20 19:47:45 -040011# LD script headers/trailers
12COMMONHEADER = """
13/* DO NOT EDIT! This is an autogenerated file. See tools/layoutrom.py. */
14OUTPUT_FORMAT("elf32-i386")
15OUTPUT_ARCH("i386")
16SECTIONS
17{
18"""
19COMMONTRAILER = """
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040020
21 /* Discard regular data sections to force a link error if
22 * code attempts to access data not marked with VAR16 (or other
23 * appropriate macro)
24 */
25 /DISCARD/ : {
26 *(.text*) *(.data*) *(.bss*) *(.rodata*)
Kevin O'Connor90ebed42012-06-21 20:54:53 -040027 *(COMMON) *(.discard*) *(.eh_frame) *(.note*)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040028 }
Kevin O'Connor5b8f8092009-09-20 19:47:45 -040029}
30"""
31
Kevin O'Connorc0693942009-06-10 21:56:01 -040032
33######################################################################
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040034# Determine section locations
Kevin O'Connorc0693942009-06-10 21:56:01 -040035######################################################################
36
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040037# Align 'pos' to 'alignbytes' offset
38def alignpos(pos, alignbytes):
39 mask = alignbytes - 1
40 return (pos + mask) & ~mask
41
42# Determine the final addresses for a list of sections that end at an
Kevin O'Connor5b8f8092009-09-20 19:47:45 -040043# address.
Kevin O'Connor46b82622012-05-13 12:10:30 -040044def setSectionsStart(sections, endaddr, minalign=1, segoffset=0):
Kevin O'Connor5b8f8092009-09-20 19:47:45 -040045 totspace = 0
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040046 for section in sections:
47 if section.align > minalign:
48 minalign = section.align
49 totspace = alignpos(totspace, section.align) + section.size
Johannes Krampf9d7d0442014-01-12 11:19:22 -050050 startaddr = int((endaddr - totspace) / minalign) * minalign
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040051 curaddr = startaddr
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040052 for section in sections:
53 curaddr = alignpos(curaddr, section.align)
54 section.finalloc = curaddr
Kevin O'Connor46b82622012-05-13 12:10:30 -040055 section.finalsegloc = curaddr - segoffset
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040056 curaddr += section.size
Kevin O'Connor46b82622012-05-13 12:10:30 -040057 return startaddr, minalign
Kevin O'Connorc0693942009-06-10 21:56:01 -040058
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040059# The 16bit code can't exceed 64K of space.
60BUILD_BIOS_ADDR = 0xf0000
61BUILD_BIOS_SIZE = 0x10000
Kevin O'Connor46b82622012-05-13 12:10:30 -040062BUILD_ROM_START = 0xc0000
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -040063BUILD_LOWRAM_END = 0xa0000
Kevin O'Connor6d152642013-02-19 21:35:20 -050064# Space to reserve in f-segment for dynamic allocations
65BUILD_MIN_BIOSTABLE = 2048
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040066
67# Layout the 16bit code. This ensures sections with fixed offset
68# requirements are placed in the correct location. It also places the
69# 16bit code as high as possible in the f-segment.
70def fitSections(sections, fillsections):
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040071 # fixedsections = [(addr, section), ...]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040072 fixedsections = []
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040073 for section in sections:
74 if section.name.startswith('.fixedaddr.'):
75 addr = int(section.name[11:], 16)
Kevin O'Connor46b82622012-05-13 12:10:30 -040076 section.finalloc = addr + BUILD_BIOS_ADDR
77 section.finalsegloc = addr
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040078 fixedsections.append((addr, section))
79 if section.align != 1:
Johannes Krampf064fd062014-01-12 11:14:54 -050080 print("Error: Fixed section %s has non-zero alignment (%d)" % (
81 section.name, section.align))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040082 sys.exit(1)
Johannes Krampf0a82fc72014-01-12 11:39:57 -050083 fixedsections.sort(key=operator.itemgetter(0))
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040084 firstfixed = fixedsections[0][0]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040085
86 # Find freespace in fixed address area
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040087 # fixedAddr = [(freespace, section), ...]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040088 fixedAddr = []
89 for i in range(len(fixedsections)):
90 fixedsectioninfo = fixedsections[i]
91 addr, section = fixedsectioninfo
92 if i == len(fixedsections) - 1:
93 nextaddr = BUILD_BIOS_SIZE
94 else:
95 nextaddr = fixedsections[i+1][0]
Kevin O'Connor1a4885e2010-09-15 21:28:31 -040096 avail = nextaddr - addr - section.size
97 fixedAddr.append((avail, section))
Johannes Krampf0a82fc72014-01-12 11:39:57 -050098 fixedAddr.sort(key=operator.itemgetter(0))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -040099
100 # Attempt to fit other sections into fixed area
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400101 canrelocate = [(section.size, section.align, section.name, section)
102 for section in fillsections]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400103 canrelocate.sort()
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400104 canrelocate = [section for size, align, name, section in canrelocate]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400105 totalused = 0
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400106 for freespace, fixedsection in fixedAddr:
Kevin O'Connor46b82622012-05-13 12:10:30 -0400107 addpos = fixedsection.finalsegloc + fixedsection.size
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400108 totalused += fixedsection.size
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400109 nextfixedaddr = addpos + freespace
Johannes Krampf064fd062014-01-12 11:14:54 -0500110# print("Filling section %x uses %d, next=%x, available=%d" % (
111# fixedsection.finalloc, fixedsection.size, nextfixedaddr, freespace))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400112 while 1:
113 canfit = None
114 for fitsection in canrelocate:
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400115 if addpos + fitsection.size > nextfixedaddr:
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400116 # Can't fit and nothing else will fit.
117 break
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400118 fitnextaddr = alignpos(addpos, fitsection.align) + fitsection.size
Johannes Krampf064fd062014-01-12 11:14:54 -0500119# print("Test %s - %x vs %x" % (
120# fitsection.name, fitnextaddr, nextfixedaddr))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400121 if fitnextaddr > nextfixedaddr:
122 # This item can't fit.
123 continue
124 canfit = (fitnextaddr, fitsection)
125 if canfit is None:
126 break
127 # Found a section that can fit.
128 fitnextaddr, fitsection = canfit
129 canrelocate.remove(fitsection)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400130 fitsection.finalloc = addpos + BUILD_BIOS_ADDR
131 fitsection.finalsegloc = addpos
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400132 addpos = fitnextaddr
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400133 totalused += fitsection.size
Johannes Krampf064fd062014-01-12 11:14:54 -0500134# print(" Adding %s (size %d align %d) pos=%x avail=%d" % (
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400135# fitsection[2], fitsection[0], fitsection[1]
Johannes Krampf064fd062014-01-12 11:14:54 -0500136# , fitnextaddr, nextfixedaddr - fitnextaddr))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400137
138 # Report stats
139 total = BUILD_BIOS_SIZE-firstfixed
140 slack = total - totalused
141 print ("Fixed space: 0x%x-0x%x total: %d slack: %d"
142 " Percent slack: %.1f%%" % (
143 firstfixed, BUILD_BIOS_SIZE, total, slack,
144 (float(slack) / total) * 100.0))
145
Kevin O'Connor46b82622012-05-13 12:10:30 -0400146 return firstfixed + BUILD_BIOS_ADDR
147
148# Return the subset of sections with a given category
149def getSectionsCategory(sections, category):
150 return [section for section in sections if section.category == category]
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400151
Kevin O'Connor8216a472014-06-10 17:59:53 -0400152# Return the subset of sections with a given fileid
153def getSectionsFileid(sections, fileid):
154 return [section for section in sections if section.fileid == fileid]
155
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400156# Return the subset of sections with a given name prefix
Kevin O'Connor46b82622012-05-13 12:10:30 -0400157def getSectionsPrefix(sections, prefix):
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400158 return [section for section in sections
Kevin O'Connor46b82622012-05-13 12:10:30 -0400159 if section.name.startswith(prefix)]
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400160
Kevin O'Connor46b82622012-05-13 12:10:30 -0400161# The sections (and associated information) to be placed in output rom
162class LayoutInfo:
Kevin O'Connor8216a472014-06-10 17:59:53 -0400163 sections = None
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500164 genreloc = None
Kevin O'Connor46b82622012-05-13 12:10:30 -0400165 sections16 = sec16_start = sec16_align = None
166 sections32seg = sec32seg_start = sec32seg_align = None
167 sections32flat = sec32flat_start = sec32flat_align = None
168 sections32init = sec32init_start = sec32init_align = None
169 sections32low = sec32low_start = sec32low_align = None
Kevin O'Connor41953492013-02-18 23:09:01 -0500170 sections32fseg = sec32fseg_start = sec32fseg_align = None
Kevin O'Connor6d152642013-02-19 21:35:20 -0500171 zonefseg_start = zonefseg_end = None
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500172 final_readonly_start = None
Kevin O'Connorc9243442013-02-17 13:58:28 -0500173 zonelow_base = final_sec32low_start = None
Kevin O'Connoree952532014-06-09 14:37:23 -0400174 varlowsyms = entrysym = None
Kevin O'Connor46b82622012-05-13 12:10:30 -0400175
176# Determine final memory addresses for sections
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500177def doLayout(sections, config, genreloc):
Kevin O'Connor46b82622012-05-13 12:10:30 -0400178 li = LayoutInfo()
Kevin O'Connor8216a472014-06-10 17:59:53 -0400179 li.sections = sections
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500180 li.genreloc = genreloc
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400181 # Determine 16bit positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400182 li.sections16 = getSectionsCategory(sections, '16')
183 textsections = getSectionsPrefix(li.sections16, '.text.')
Kevin O'Connore5749972014-06-07 15:55:00 -0400184 rodatasections = getSectionsPrefix(li.sections16, '.rodata')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400185 datasections = getSectionsPrefix(li.sections16, '.data16.')
186 fixedsections = getSectionsPrefix(li.sections16, '.fixedaddr.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400187
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400188 firstfixed = fitSections(fixedsections, textsections)
189 remsections = [s for s in textsections+rodatasections+datasections
190 if s.finalloc is None]
Kevin O'Connor46b82622012-05-13 12:10:30 -0400191 li.sec16_start, li.sec16_align = setSectionsStart(
192 remsections, firstfixed, segoffset=BUILD_BIOS_ADDR)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400193
194 # Determine 32seg positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400195 li.sections32seg = getSectionsCategory(sections, '32seg')
196 textsections = getSectionsPrefix(li.sections32seg, '.text.')
Kevin O'Connore5749972014-06-07 15:55:00 -0400197 rodatasections = getSectionsPrefix(li.sections32seg, '.rodata')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400198 datasections = getSectionsPrefix(li.sections32seg, '.data32seg.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400199
Kevin O'Connor46b82622012-05-13 12:10:30 -0400200 li.sec32seg_start, li.sec32seg_align = setSectionsStart(
201 textsections + rodatasections + datasections, li.sec16_start
202 , segoffset=BUILD_BIOS_ADDR)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400203
Kevin O'Connor41953492013-02-18 23:09:01 -0500204 # Determine "fseg memory" data positions
205 li.sections32fseg = getSectionsCategory(sections, '32fseg')
206
207 li.sec32fseg_start, li.sec32fseg_align = setSectionsStart(
208 li.sections32fseg, li.sec32seg_start, 16
209 , segoffset=BUILD_BIOS_ADDR)
210
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400211 # Determine 32flat runtime positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400212 li.sections32flat = getSectionsCategory(sections, '32flat')
213 textsections = getSectionsPrefix(li.sections32flat, '.text.')
214 rodatasections = getSectionsPrefix(li.sections32flat, '.rodata')
215 datasections = getSectionsPrefix(li.sections32flat, '.data.')
216 bsssections = getSectionsPrefix(li.sections32flat, '.bss.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400217
Kevin O'Connor46b82622012-05-13 12:10:30 -0400218 li.sec32flat_start, li.sec32flat_align = setSectionsStart(
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400219 textsections + rodatasections + datasections + bsssections
Kevin O'Connor41953492013-02-18 23:09:01 -0500220 , li.sec32fseg_start, 16)
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500221
222 # Determine 32flat init positions
223 li.sections32init = getSectionsCategory(sections, '32init')
224 init32_textsections = getSectionsPrefix(li.sections32init, '.text.')
225 init32_rodatasections = getSectionsPrefix(li.sections32init, '.rodata')
226 init32_datasections = getSectionsPrefix(li.sections32init, '.data.')
227 init32_bsssections = getSectionsPrefix(li.sections32init, '.bss.')
228
229 li.sec32init_start, li.sec32init_align = setSectionsStart(
230 init32_textsections + init32_rodatasections
231 + init32_datasections + init32_bsssections
232 , li.sec32flat_start, 16)
233
234 # Determine location of ZoneFSeg memory.
Kevin O'Connor6d152642013-02-19 21:35:20 -0500235 li.zonefseg_end = li.sec32flat_start
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500236 if not genreloc:
237 li.zonefseg_end = li.sec32init_start
Kevin O'Connor6d152642013-02-19 21:35:20 -0500238 li.zonefseg_start = BUILD_BIOS_ADDR
239 if li.zonefseg_start + BUILD_MIN_BIOSTABLE > li.zonefseg_end:
240 # Not enough ZoneFSeg space - force a minimum space.
241 li.zonefseg_end = li.sec32fseg_start
242 li.zonefseg_start = li.zonefseg_end - BUILD_MIN_BIOSTABLE
243 li.sec32flat_start, li.sec32flat_align = setSectionsStart(
244 textsections + rodatasections + datasections + bsssections
245 , li.zonefseg_start, 16)
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500246 li.sec32init_start, li.sec32init_align = setSectionsStart(
247 init32_textsections + init32_rodatasections
248 + init32_datasections + init32_bsssections
249 , li.sec32flat_start, 16)
250 li.final_readonly_start = min(BUILD_BIOS_ADDR, li.sec32flat_start)
251 if not genreloc:
252 li.final_readonly_start = min(BUILD_BIOS_ADDR, li.sec32init_start)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400253
254 # Determine "low memory" data positions
255 li.sections32low = getSectionsCategory(sections, '32low')
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500256 sec32low_end = li.sec32init_start
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400257 if config.get('CONFIG_MALLOC_UPPERMEMORY'):
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500258 final_sec32low_end = li.final_readonly_start
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400259 zonelow_base = final_sec32low_end - 64*1024
260 li.zonelow_base = max(BUILD_ROM_START, alignpos(zonelow_base, 2*1024))
261 else:
262 final_sec32low_end = BUILD_LOWRAM_END
263 li.zonelow_base = final_sec32low_end - 64*1024
Kevin O'Connor3be89a12013-02-23 16:07:00 -0500264 relocdelta = final_sec32low_end - sec32low_end
Kevin O'Connor46b82622012-05-13 12:10:30 -0400265 li.sec32low_start, li.sec32low_align = setSectionsStart(
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500266 li.sections32low, sec32low_end, 16
Kevin O'Connorc9243442013-02-17 13:58:28 -0500267 , segoffset=li.zonelow_base - relocdelta)
Kevin O'Connorc91da7a2012-06-08 21:14:19 -0400268 li.final_sec32low_start = li.sec32low_start + relocdelta
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400269
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400270 # Print statistics
Kevin O'Connor46b82622012-05-13 12:10:30 -0400271 size16 = BUILD_BIOS_ADDR + BUILD_BIOS_SIZE - li.sec16_start
272 size32seg = li.sec16_start - li.sec32seg_start
Kevin O'Connor41953492013-02-18 23:09:01 -0500273 size32fseg = li.sec32seg_start - li.sec32fseg_start
274 size32flat = li.sec32fseg_start - li.sec32flat_start
Kevin O'Connor46b82622012-05-13 12:10:30 -0400275 size32init = li.sec32flat_start - li.sec32init_start
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500276 sizelow = sec32low_end - li.sec32low_start
Johannes Krampf064fd062014-01-12 11:14:54 -0500277 print("16bit size: %d" % size16)
278 print("32bit segmented size: %d" % size32seg)
279 print("32bit flat size: %d" % size32flat)
280 print("32bit flat init size: %d" % size32init)
281 print("Lowmem size: %d" % sizelow)
282 print("f-segment var size: %d" % size32fseg)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400283 return li
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400284
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400285
286######################################################################
287# Linker script output
288######################################################################
289
290# Write LD script includes for the given cross references
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500291def outXRefs(sections, useseg=0, exportsyms=[], forcedelta=0):
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500292 xrefs = dict([(symbol.name, symbol) for symbol in exportsyms])
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400293 out = ""
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400294 for section in sections:
295 for reloc in section.relocs:
296 symbol = reloc.symbol
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500297 if (symbol.section is not None
298 and (symbol.section.fileid != section.fileid
299 or symbol.name != reloc.symbolname)):
300 xrefs[reloc.symbolname] = symbol
301 for symbolname, symbol in xrefs.items():
302 loc = symbol.section.finalloc
303 if useseg:
304 loc = symbol.section.finalsegloc
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500305 out += "%s = 0x%x ;\n" % (symbolname, loc + forcedelta + symbol.offset)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400306 return out
307
Kevin O'Connore5749972014-06-07 15:55:00 -0400308# Write LD script includes for the given sections
309def outSections(sections, useseg=0):
310 out = ""
311 for section in sections:
312 loc = section.finalloc
313 if useseg:
314 loc = section.finalsegloc
315 out += "%s 0x%x : { *(%s) }\n" % (section.name, loc, section.name)
316 return out
317
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400318# Write LD script includes for the given sections using relative offsets
Kevin O'Connor46b82622012-05-13 12:10:30 -0400319def outRelSections(sections, startsym, useseg=0):
320 sections = [(section.finalloc, section) for section in sections
321 if section.finalloc is not None]
Johannes Krampf0a82fc72014-01-12 11:39:57 -0500322 sections.sort(key=operator.itemgetter(0))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400323 out = ""
Kevin O'Connor46b82622012-05-13 12:10:30 -0400324 for addr, section in sections:
325 loc = section.finalloc
326 if useseg:
327 loc = section.finalsegloc
328 out += ". = ( 0x%x - %s ) ;\n" % (loc, startsym)
Kevin O'Connore5749972014-06-07 15:55:00 -0400329 if section.name in ('.rodata.str1.1', '.rodata'):
330 out += "_rodata%s = . ;\n" % (section.fileid,)
331 out += "*%s.*(%s)\n" % (section.fileid, section.name)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400332 return out
333
Kevin O'Connor46b82622012-05-13 12:10:30 -0400334# Build linker script output for a list of relocations.
335def strRelocs(outname, outrel, relocs):
336 relocs.sort()
337 return (" %s_start = ABSOLUTE(.) ;\n" % (outname,)
338 + "".join(["LONG(0x%x - %s)\n" % (pos, outrel)
339 for pos in relocs])
340 + " %s_end = ABSOLUTE(.) ;\n" % (outname,))
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500341
Kevin O'Connorb40016f2014-06-11 14:40:45 -0400342# Find relocations to the given sections
343def getRelocs(sections, tosection, type=None):
344 return [section.finalloc + reloc.offset
345 for section in sections
346 for reloc in section.relocs
347 if (reloc.symbol.section in tosection
348 and (type is None or reloc.type == type))]
Kevin O'Connor46b82622012-05-13 12:10:30 -0400349
Kevin O'Connor46b82622012-05-13 12:10:30 -0400350# Output the linker scripts for all required sections.
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500351def writeLinkerScripts(li, out16, out32seg, out32flat):
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400352 # Write 16bit linker script
Kevin O'Connor8216a472014-06-10 17:59:53 -0400353 filesections16 = getSectionsFileid(li.sections, '16')
354 out = outXRefs(filesections16, useseg=1) + """
Kevin O'Connorc9243442013-02-17 13:58:28 -0500355 zonelow_base = 0x%x ;
356 _zonelow_seg = 0x%x ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400357
Kevin O'Connor46b82622012-05-13 12:10:30 -0400358%s
Kevin O'Connorc9243442013-02-17 13:58:28 -0500359""" % (li.zonelow_base,
Johannes Krampf9d7d0442014-01-12 11:19:22 -0500360 int(li.zonelow_base / 16),
Kevin O'Connor8216a472014-06-10 17:59:53 -0400361 outSections(filesections16, useseg=1))
Johannes Krampf19f789b2014-01-19 16:03:49 +0100362 outfile = open(out16, 'w')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400363 outfile.write(COMMONHEADER + out + COMMONTRAILER)
364 outfile.close()
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500365
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400366 # Write 32seg linker script
Kevin O'Connor8216a472014-06-10 17:59:53 -0400367 filesections32seg = getSectionsFileid(li.sections, '32seg')
368 out = (outXRefs(filesections32seg, useseg=1)
369 + outSections(filesections32seg, useseg=1))
Johannes Krampf19f789b2014-01-19 16:03:49 +0100370 outfile = open(out32seg, 'w')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400371 outfile.write(COMMONHEADER + out + COMMONTRAILER)
372 outfile.close()
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500373
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400374 # Write 32flat linker script
Kevin O'Connor46b82622012-05-13 12:10:30 -0400375 sec32all_start = li.sec32low_start
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400376 relocstr = ""
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500377 if li.genreloc:
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400378 # Generate relocations
Kevin O'Connor8216a472014-06-10 17:59:53 -0400379 initsections = dict([
380 (s, 1) for s in getSectionsCategory(li.sections, '32init')])
381 noninitsections = dict([(s, 1) for s in li.sections
382 if s not in initsections])
Kevin O'Connorb40016f2014-06-11 14:40:45 -0400383 absrelocs = getRelocs(initsections, initsections, type='R_386_32')
384 relrelocs = getRelocs(initsections, noninitsections, type='R_386_PC32')
385 initrelocs = getRelocs(noninitsections, initsections)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400386 relocstr = (strRelocs("_reloc_abs", "code32init_start", absrelocs)
387 + strRelocs("_reloc_rel", "code32init_start", relrelocs)
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500388 + strRelocs("_reloc_init", "code32flat_start", initrelocs))
389 numrelocs = len(absrelocs + relrelocs + initrelocs)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400390 sec32all_start -= numrelocs * 4
Kevin O'Connor8216a472014-06-10 17:59:53 -0400391 filesections32flat = getSectionsFileid(li.sections, '32flat')
392 out = outXRefs([], exportsyms=li.varlowsyms
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500393 , forcedelta=li.final_sec32low_start-li.sec32low_start)
Kevin O'Connor8216a472014-06-10 17:59:53 -0400394 out += outXRefs(filesections32flat, exportsyms=[li.entrysym]) + """
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400395 _reloc_min_align = 0x%x ;
Kevin O'Connor6d152642013-02-19 21:35:20 -0500396 zonefseg_start = 0x%x ;
397 zonefseg_end = 0x%x ;
Kevin O'Connorc9243442013-02-17 13:58:28 -0500398 zonelow_base = 0x%x ;
399 final_varlow_start = 0x%x ;
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500400 final_readonly_start = 0x%x ;
Kevin O'Connor8216a472014-06-10 17:59:53 -0400401 varlow_start = 0x%x ;
402 varlow_end = 0x%x ;
403 code32init_start = 0x%x ;
404 code32init_end = 0x%x ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400405
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400406 code32flat_start = 0x%x ;
407 .text code32flat_start : {
Kevin O'Connor46b82622012-05-13 12:10:30 -0400408%s
Kevin O'Connor46b82622012-05-13 12:10:30 -0400409%s
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400410 code32flat_end = ABSOLUTE(.) ;
411 } :text
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500412""" % (li.sec32init_align,
Kevin O'Connor6d152642013-02-19 21:35:20 -0500413 li.zonefseg_start,
414 li.zonefseg_end,
Kevin O'Connorc9243442013-02-17 13:58:28 -0500415 li.zonelow_base,
Kevin O'Connorc91da7a2012-06-08 21:14:19 -0400416 li.final_sec32low_start,
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500417 li.final_readonly_start,
Kevin O'Connor8216a472014-06-10 17:59:53 -0400418 li.sec32low_start,
419 li.sec32init_start,
420 li.sec32init_start,
421 li.sec32flat_start,
Kevin O'Connor46b82622012-05-13 12:10:30 -0400422 sec32all_start,
423 relocstr,
Kevin O'Connor8216a472014-06-10 17:59:53 -0400424 outRelSections(li.sections, 'code32flat_start'))
Kevin O'Connor46b82622012-05-13 12:10:30 -0400425 out = COMMONHEADER + out + COMMONTRAILER + """
Kevin O'Connoree952532014-06-09 14:37:23 -0400426ENTRY(%s)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400427PHDRS
428{
429 text PT_LOAD AT ( code32flat_start ) ;
430}
Kevin O'Connoree952532014-06-09 14:37:23 -0400431""" % (li.entrysym.name,)
Johannes Krampf19f789b2014-01-19 16:03:49 +0100432 outfile = open(out32flat, 'w')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400433 outfile.write(out)
434 outfile.close()
Kevin O'Connorc0693942009-06-10 21:56:01 -0400435
436
437######################################################################
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400438# Detection of unused sections and init sections
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400439######################################################################
440
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400441# Visit all sections reachable from a given set of start sections
442def findReachable(anchorsections, checkreloc, data):
443 anchorsections = dict([(section, []) for section in anchorsections])
444 pending = list(anchorsections)
445 while pending:
446 section = pending.pop()
447 for reloc in section.relocs:
448 chain = anchorsections[section] + [section.name]
449 if not checkreloc(reloc, section, data, chain):
450 continue
451 nextsection = reloc.symbol.section
452 if nextsection not in anchorsections:
453 anchorsections[nextsection] = chain
454 pending.append(nextsection)
455 return anchorsections
456
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400457# Find "runtime" sections (ie, not init only sections).
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400458def checkRuntime(reloc, rsection, data, chain):
459 section = reloc.symbol.section
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400460 if section is None or '.init.' in section.name:
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400461 return 0
Kevin O'Connor2af52da2013-03-08 19:36:28 -0500462 if '.data.varinit.' in section.name:
Johannes Krampf064fd062014-01-12 11:14:54 -0500463 print("ERROR: %s is VARVERIFY32INIT but used from %s" % (
464 section.name, chain))
Kevin O'Connor2af52da2013-03-08 19:36:28 -0500465 sys.exit(1)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400466 return 1
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400467
Kevin O'Connorfdca4182010-01-01 12:46:54 -0500468# Find and keep the section associated with a symbol (if available).
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400469def checkKeepSym(reloc, syms, fileid, isxref):
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500470 symbolname = reloc.symbolname
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400471 mustbecfunc = symbolname.startswith('_cfunc')
472 if mustbecfunc:
473 symprefix = '_cfunc' + fileid + '_'
474 if not symbolname.startswith(symprefix):
475 return 0
476 symbolname = symbolname[len(symprefix):]
477 symbol = syms.get(symbolname)
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400478 if (symbol is None or symbol.section is None
479 or symbol.section.name.startswith('.discard.')):
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400480 return 0
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500481 isdestcfunc = (symbol.section.name.startswith('.text.')
482 and not symbol.section.name.startswith('.text.asm.'))
483 if ((mustbecfunc and not isdestcfunc)
484 or (not mustbecfunc and isdestcfunc and isxref)):
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400485 return 0
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500486
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400487 reloc.symbol = symbol
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400488 return 1
Kevin O'Connorfdca4182010-01-01 12:46:54 -0500489
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400490# Resolve a relocation and check if it should be kept in the final binary.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400491def checkKeep(reloc, section, symbols, chain):
492 ret = checkKeepSym(reloc, symbols[section.fileid], section.fileid, 0)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400493 if ret:
494 return ret
495 # Not in primary sections - it may be a cross 16/32 reference
496 for fileid in ('16', '32seg', '32flat'):
497 if fileid != section.fileid:
Kevin O'Connorc228d702014-06-09 14:59:25 -0400498 ret = checkKeepSym(reloc, symbols[fileid], fileid, 1)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400499 if ret:
500 return ret
501 return 0
Kevin O'Connorc0693942009-06-10 21:56:01 -0400502
Kevin O'Connorc0693942009-06-10 21:56:01 -0400503
504######################################################################
505# Startup and input parsing
506######################################################################
507
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400508class Section:
509 name = size = alignment = fileid = relocs = None
Kevin O'Connorc228d702014-06-09 14:59:25 -0400510 finalloc = finalsegloc = category = None
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400511class Reloc:
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500512 offset = type = symbolname = symbol = None
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400513class Symbol:
514 name = offset = section = None
515
Kevin O'Connorc0693942009-06-10 21:56:01 -0400516# Read in output from objdump
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400517def parseObjDump(file, fileid):
518 # sections = [section, ...]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400519 sections = []
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400520 sectionmap = {}
521 # symbols[symbolname] = symbol
Kevin O'Connorc0693942009-06-10 21:56:01 -0400522 symbols = {}
Kevin O'Connorc0693942009-06-10 21:56:01 -0400523
524 state = None
525 for line in file.readlines():
526 line = line.rstrip()
527 if line == 'Sections:':
528 state = 'section'
529 continue
530 if line == 'SYMBOL TABLE:':
531 state = 'symbol'
532 continue
Kevin O'Connor6c2e7812010-09-13 18:04:02 -0400533 if line.startswith('RELOCATION RECORDS FOR ['):
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400534 sectionname = line[24:-2]
535 if sectionname.startswith('.debug_'):
536 # Skip debugging sections (to reduce parsing time)
537 state = None
538 continue
Kevin O'Connorc0693942009-06-10 21:56:01 -0400539 state = 'reloc'
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400540 relocsection = sectionmap[sectionname]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400541 continue
542
543 if state == 'section':
544 try:
545 idx, name, size, vma, lma, fileoff, align = line.split()
546 if align[:3] != '2**':
547 continue
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400548 section = Section()
549 section.name = name
550 section.size = int(size, 16)
551 section.align = 2**int(align[3:])
552 section.fileid = fileid
553 section.relocs = []
554 sections.append(section)
555 sectionmap[name] = section
556 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400557 pass
558 continue
559 if state == 'symbol':
560 try:
Kevin O'Connor90ebed42012-06-21 20:54:53 -0400561 parts = line[17:].split()
562 if len(parts) == 3:
563 sectionname, size, name = parts
564 elif len(parts) == 4 and parts[2] == '.hidden':
565 sectionname, size, hidden, name = parts
566 else:
567 continue
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400568 symbol = Symbol()
569 symbol.size = int(size, 16)
570 symbol.offset = int(line[:8], 16)
571 symbol.name = name
572 symbol.section = sectionmap.get(sectionname)
573 symbols[name] = symbol
574 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400575 pass
576 continue
577 if state == 'reloc':
578 try:
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400579 off, type, symbolname = line.split()
580 reloc = Reloc()
581 reloc.offset = int(off, 16)
582 reloc.type = type
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500583 reloc.symbolname = symbolname
Kevin O'Connor67863be2010-12-24 10:23:10 -0500584 reloc.symbol = symbols.get(symbolname)
585 if reloc.symbol is None:
586 # Some binutils (2.20.1) give section name instead
587 # of a symbol - create a dummy symbol.
588 reloc.symbol = symbol = Symbol()
589 symbol.size = 0
590 symbol.offset = 0
591 symbol.name = symbolname
592 symbol.section = sectionmap.get(symbolname)
593 symbols[symbolname] = symbol
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400594 relocsection.relocs.append(reloc)
595 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400596 pass
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400597 return sections, symbols
Kevin O'Connorc0693942009-06-10 21:56:01 -0400598
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400599# Parser for constants in simple C header files.
600def scanconfig(file):
Johannes Krampf19f789b2014-01-19 16:03:49 +0100601 f = open(file, 'r')
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400602 opts = {}
603 for l in f.readlines():
604 parts = l.split()
605 if len(parts) != 3:
606 continue
607 if parts[0] != '#define':
608 continue
609 value = parts[2]
610 if value.isdigit() or (value.startswith('0x') and value[2:].isdigit()):
611 value = int(value, 0)
612 opts[parts[1]] = value
613 return opts
614
Kevin O'Connorc0693942009-06-10 21:56:01 -0400615def main():
616 # Get output name
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400617 in16, in32seg, in32flat, cfgfile, out16, out32seg, out32flat = sys.argv[1:]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400618
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400619 # Read in the objdump information
Johannes Krampf19f789b2014-01-19 16:03:49 +0100620 infile16 = open(in16, 'r')
621 infile32seg = open(in32seg, 'r')
622 infile32flat = open(in32flat, 'r')
Kevin O'Connorc0693942009-06-10 21:56:01 -0400623
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400624 # infoX = (sections, symbols)
625 info16 = parseObjDump(infile16, '16')
626 info32seg = parseObjDump(infile32seg, '32seg')
627 info32flat = parseObjDump(infile32flat, '32flat')
Kevin O'Connorc0693942009-06-10 21:56:01 -0400628
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400629 # Read kconfig config file
630 config = scanconfig(cfgfile)
631
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400632 # Figure out which sections to keep.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400633 allsections = info16[0] + info32seg[0] + info32flat[0]
634 symbols = {'16': info16[1], '32seg': info32seg[1], '32flat': info32flat[1]}
Kevin O'Connoree952532014-06-09 14:37:23 -0400635 if config.get('CONFIG_COREBOOT'):
636 entrysym = symbols['16'].get('entry_elf')
637 elif config.get('CONFIG_CSM'):
638 entrysym = symbols['16'].get('entry_csm')
639 else:
640 entrysym = symbols['16'].get('reset_vector')
641 anchorsections = [entrysym.section] + [
642 section for section in info16[0]
643 if section.name.startswith('.fixedaddr.')]
Kevin O'Connorc228d702014-06-09 14:59:25 -0400644 keepsections = findReachable(anchorsections, checkKeep, symbols)
645 sections = [section for section in allsections if section in keepsections]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400646
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400647 # Separate 32bit flat into runtime, init, and special variable parts
648 anchorsections = [
649 section for section in sections
650 if ('.data.varlow.' in section.name or '.data.varfseg.' in section.name
651 or '.runtime.' in section.name)]
652 runtimesections = findReachable(anchorsections, checkRuntime, None)
653 for section in sections:
654 if section.name.startswith('.data.varlow.'):
655 section.category = '32low'
656 elif section.name.startswith('.data.varfseg.'):
657 section.category = '32fseg'
658 elif section.fileid == '32flat' and section not in runtimesections:
659 section.category = '32init'
660 else:
661 section.category = section.fileid
Kevin O'Connor46b82622012-05-13 12:10:30 -0400662
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400663 # Determine the final memory locations of each kept section.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400664 genreloc = '_reloc_abs_start' in symbols['32flat']
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500665 li = doLayout(sections, config, genreloc)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400666
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500667 # Exported symbols
Kevin O'Connorc228d702014-06-09 14:59:25 -0400668 li.varlowsyms = [symbol for symbol in symbols['32flat'].values()
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500669 if (symbol.section is not None
670 and symbol.section.finalloc is not None
671 and '.data.varlow.' in symbol.section.name
672 and symbol.name != symbol.section.name)]
Kevin O'Connoree952532014-06-09 14:37:23 -0400673 li.entrysym = entrysym
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500674
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400675 # Write out linker script files.
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500676 writeLinkerScripts(li, out16, out32seg, out32flat)
Kevin O'Connorc0693942009-06-10 21:56:01 -0400677
Kevin O'Connor202024a2009-01-17 10:41:28 -0500678if __name__ == '__main__':
679 main()