blob: 20ffbe00de21d28a3cd9443f76826333ebc8aec6 [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'Connor1a4885e2010-09-15 21:28:31 -0400152# Return the subset of sections with a given name prefix
Kevin O'Connor46b82622012-05-13 12:10:30 -0400153def getSectionsPrefix(sections, prefix):
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400154 return [section for section in sections
Kevin O'Connor46b82622012-05-13 12:10:30 -0400155 if section.name.startswith(prefix)]
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400156
Kevin O'Connor46b82622012-05-13 12:10:30 -0400157# The sections (and associated information) to be placed in output rom
158class LayoutInfo:
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500159 genreloc = None
Kevin O'Connor46b82622012-05-13 12:10:30 -0400160 sections16 = sec16_start = sec16_align = None
161 sections32seg = sec32seg_start = sec32seg_align = None
162 sections32flat = sec32flat_start = sec32flat_align = None
163 sections32init = sec32init_start = sec32init_align = None
164 sections32low = sec32low_start = sec32low_align = None
Kevin O'Connor41953492013-02-18 23:09:01 -0500165 sections32fseg = sec32fseg_start = sec32fseg_align = None
Kevin O'Connor6d152642013-02-19 21:35:20 -0500166 zonefseg_start = zonefseg_end = None
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500167 final_readonly_start = None
Kevin O'Connorc9243442013-02-17 13:58:28 -0500168 zonelow_base = final_sec32low_start = None
Kevin O'Connoree952532014-06-09 14:37:23 -0400169 varlowsyms = entrysym = None
Kevin O'Connor46b82622012-05-13 12:10:30 -0400170
171# Determine final memory addresses for sections
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500172def doLayout(sections, config, genreloc):
Kevin O'Connor46b82622012-05-13 12:10:30 -0400173 li = LayoutInfo()
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500174 li.genreloc = genreloc
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400175 # Determine 16bit positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400176 li.sections16 = getSectionsCategory(sections, '16')
177 textsections = getSectionsPrefix(li.sections16, '.text.')
Kevin O'Connore5749972014-06-07 15:55:00 -0400178 rodatasections = getSectionsPrefix(li.sections16, '.rodata')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400179 datasections = getSectionsPrefix(li.sections16, '.data16.')
180 fixedsections = getSectionsPrefix(li.sections16, '.fixedaddr.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400181
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400182 firstfixed = fitSections(fixedsections, textsections)
183 remsections = [s for s in textsections+rodatasections+datasections
184 if s.finalloc is None]
Kevin O'Connor46b82622012-05-13 12:10:30 -0400185 li.sec16_start, li.sec16_align = setSectionsStart(
186 remsections, firstfixed, segoffset=BUILD_BIOS_ADDR)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400187
188 # Determine 32seg positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400189 li.sections32seg = getSectionsCategory(sections, '32seg')
190 textsections = getSectionsPrefix(li.sections32seg, '.text.')
Kevin O'Connore5749972014-06-07 15:55:00 -0400191 rodatasections = getSectionsPrefix(li.sections32seg, '.rodata')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400192 datasections = getSectionsPrefix(li.sections32seg, '.data32seg.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400193
Kevin O'Connor46b82622012-05-13 12:10:30 -0400194 li.sec32seg_start, li.sec32seg_align = setSectionsStart(
195 textsections + rodatasections + datasections, li.sec16_start
196 , segoffset=BUILD_BIOS_ADDR)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400197
Kevin O'Connor41953492013-02-18 23:09:01 -0500198 # Determine "fseg memory" data positions
199 li.sections32fseg = getSectionsCategory(sections, '32fseg')
200
201 li.sec32fseg_start, li.sec32fseg_align = setSectionsStart(
202 li.sections32fseg, li.sec32seg_start, 16
203 , segoffset=BUILD_BIOS_ADDR)
204
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400205 # Determine 32flat runtime positions
Kevin O'Connor46b82622012-05-13 12:10:30 -0400206 li.sections32flat = getSectionsCategory(sections, '32flat')
207 textsections = getSectionsPrefix(li.sections32flat, '.text.')
208 rodatasections = getSectionsPrefix(li.sections32flat, '.rodata')
209 datasections = getSectionsPrefix(li.sections32flat, '.data.')
210 bsssections = getSectionsPrefix(li.sections32flat, '.bss.')
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400211
Kevin O'Connor46b82622012-05-13 12:10:30 -0400212 li.sec32flat_start, li.sec32flat_align = setSectionsStart(
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400213 textsections + rodatasections + datasections + bsssections
Kevin O'Connor41953492013-02-18 23:09:01 -0500214 , li.sec32fseg_start, 16)
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500215
216 # Determine 32flat init positions
217 li.sections32init = getSectionsCategory(sections, '32init')
218 init32_textsections = getSectionsPrefix(li.sections32init, '.text.')
219 init32_rodatasections = getSectionsPrefix(li.sections32init, '.rodata')
220 init32_datasections = getSectionsPrefix(li.sections32init, '.data.')
221 init32_bsssections = getSectionsPrefix(li.sections32init, '.bss.')
222
223 li.sec32init_start, li.sec32init_align = setSectionsStart(
224 init32_textsections + init32_rodatasections
225 + init32_datasections + init32_bsssections
226 , li.sec32flat_start, 16)
227
228 # Determine location of ZoneFSeg memory.
Kevin O'Connor6d152642013-02-19 21:35:20 -0500229 li.zonefseg_end = li.sec32flat_start
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500230 if not genreloc:
231 li.zonefseg_end = li.sec32init_start
Kevin O'Connor6d152642013-02-19 21:35:20 -0500232 li.zonefseg_start = BUILD_BIOS_ADDR
233 if li.zonefseg_start + BUILD_MIN_BIOSTABLE > li.zonefseg_end:
234 # Not enough ZoneFSeg space - force a minimum space.
235 li.zonefseg_end = li.sec32fseg_start
236 li.zonefseg_start = li.zonefseg_end - BUILD_MIN_BIOSTABLE
237 li.sec32flat_start, li.sec32flat_align = setSectionsStart(
238 textsections + rodatasections + datasections + bsssections
239 , li.zonefseg_start, 16)
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500240 li.sec32init_start, li.sec32init_align = setSectionsStart(
241 init32_textsections + init32_rodatasections
242 + init32_datasections + init32_bsssections
243 , li.sec32flat_start, 16)
244 li.final_readonly_start = min(BUILD_BIOS_ADDR, li.sec32flat_start)
245 if not genreloc:
246 li.final_readonly_start = min(BUILD_BIOS_ADDR, li.sec32init_start)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400247
248 # Determine "low memory" data positions
249 li.sections32low = getSectionsCategory(sections, '32low')
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500250 sec32low_end = li.sec32init_start
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400251 if config.get('CONFIG_MALLOC_UPPERMEMORY'):
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500252 final_sec32low_end = li.final_readonly_start
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400253 zonelow_base = final_sec32low_end - 64*1024
254 li.zonelow_base = max(BUILD_ROM_START, alignpos(zonelow_base, 2*1024))
255 else:
256 final_sec32low_end = BUILD_LOWRAM_END
257 li.zonelow_base = final_sec32low_end - 64*1024
Kevin O'Connor3be89a12013-02-23 16:07:00 -0500258 relocdelta = final_sec32low_end - sec32low_end
Kevin O'Connor46b82622012-05-13 12:10:30 -0400259 li.sec32low_start, li.sec32low_align = setSectionsStart(
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500260 li.sections32low, sec32low_end, 16
Kevin O'Connorc9243442013-02-17 13:58:28 -0500261 , segoffset=li.zonelow_base - relocdelta)
Kevin O'Connorc91da7a2012-06-08 21:14:19 -0400262 li.final_sec32low_start = li.sec32low_start + relocdelta
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400263
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400264 # Print statistics
Kevin O'Connor46b82622012-05-13 12:10:30 -0400265 size16 = BUILD_BIOS_ADDR + BUILD_BIOS_SIZE - li.sec16_start
266 size32seg = li.sec16_start - li.sec32seg_start
Kevin O'Connor41953492013-02-18 23:09:01 -0500267 size32fseg = li.sec32seg_start - li.sec32fseg_start
268 size32flat = li.sec32fseg_start - li.sec32flat_start
Kevin O'Connor46b82622012-05-13 12:10:30 -0400269 size32init = li.sec32flat_start - li.sec32init_start
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500270 sizelow = sec32low_end - li.sec32low_start
Johannes Krampf064fd062014-01-12 11:14:54 -0500271 print("16bit size: %d" % size16)
272 print("32bit segmented size: %d" % size32seg)
273 print("32bit flat size: %d" % size32flat)
274 print("32bit flat init size: %d" % size32init)
275 print("Lowmem size: %d" % sizelow)
276 print("f-segment var size: %d" % size32fseg)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400277 return li
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400278
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400279
280######################################################################
281# Linker script output
282######################################################################
283
284# Write LD script includes for the given cross references
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500285def outXRefs(sections, useseg=0, exportsyms=[], forcedelta=0):
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500286 xrefs = dict([(symbol.name, symbol) for symbol in exportsyms])
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400287 out = ""
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400288 for section in sections:
289 for reloc in section.relocs:
290 symbol = reloc.symbol
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500291 if (symbol.section is not None
292 and (symbol.section.fileid != section.fileid
293 or symbol.name != reloc.symbolname)):
294 xrefs[reloc.symbolname] = symbol
295 for symbolname, symbol in xrefs.items():
296 loc = symbol.section.finalloc
297 if useseg:
298 loc = symbol.section.finalsegloc
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500299 out += "%s = 0x%x ;\n" % (symbolname, loc + forcedelta + symbol.offset)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400300 return out
301
Kevin O'Connore5749972014-06-07 15:55:00 -0400302# Write LD script includes for the given sections
303def outSections(sections, useseg=0):
304 out = ""
305 for section in sections:
306 loc = section.finalloc
307 if useseg:
308 loc = section.finalsegloc
309 out += "%s 0x%x : { *(%s) }\n" % (section.name, loc, section.name)
310 return out
311
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400312# Write LD script includes for the given sections using relative offsets
Kevin O'Connor46b82622012-05-13 12:10:30 -0400313def outRelSections(sections, startsym, useseg=0):
314 sections = [(section.finalloc, section) for section in sections
315 if section.finalloc is not None]
Johannes Krampf0a82fc72014-01-12 11:39:57 -0500316 sections.sort(key=operator.itemgetter(0))
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400317 out = ""
Kevin O'Connor46b82622012-05-13 12:10:30 -0400318 for addr, section in sections:
319 loc = section.finalloc
320 if useseg:
321 loc = section.finalsegloc
322 out += ". = ( 0x%x - %s ) ;\n" % (loc, startsym)
Kevin O'Connore5749972014-06-07 15:55:00 -0400323 if section.name in ('.rodata.str1.1', '.rodata'):
324 out += "_rodata%s = . ;\n" % (section.fileid,)
325 out += "*%s.*(%s)\n" % (section.fileid, section.name)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400326 return out
327
Kevin O'Connor46b82622012-05-13 12:10:30 -0400328# Build linker script output for a list of relocations.
329def strRelocs(outname, outrel, relocs):
330 relocs.sort()
331 return (" %s_start = ABSOLUTE(.) ;\n" % (outname,)
332 + "".join(["LONG(0x%x - %s)\n" % (pos, outrel)
333 for pos in relocs])
334 + " %s_end = ABSOLUTE(.) ;\n" % (outname,))
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500335
Kevin O'Connorb40016f2014-06-11 14:40:45 -0400336# Find relocations to the given sections
337def getRelocs(sections, tosection, type=None):
338 return [section.finalloc + reloc.offset
339 for section in sections
340 for reloc in section.relocs
341 if (reloc.symbol.section in tosection
342 and (type is None or reloc.type == type))]
Kevin O'Connor46b82622012-05-13 12:10:30 -0400343
Kevin O'Connor46b82622012-05-13 12:10:30 -0400344# Output the linker scripts for all required sections.
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500345def writeLinkerScripts(li, out16, out32seg, out32flat):
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400346 # Write 16bit linker script
Kevin O'Connor46b82622012-05-13 12:10:30 -0400347 out = outXRefs(li.sections16, useseg=1) + """
Kevin O'Connorc9243442013-02-17 13:58:28 -0500348 zonelow_base = 0x%x ;
349 _zonelow_seg = 0x%x ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400350
Kevin O'Connor46b82622012-05-13 12:10:30 -0400351%s
Kevin O'Connorc9243442013-02-17 13:58:28 -0500352""" % (li.zonelow_base,
Johannes Krampf9d7d0442014-01-12 11:19:22 -0500353 int(li.zonelow_base / 16),
Kevin O'Connore5749972014-06-07 15:55:00 -0400354 outSections(li.sections16, useseg=1))
Johannes Krampf19f789b2014-01-19 16:03:49 +0100355 outfile = open(out16, 'w')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400356 outfile.write(COMMONHEADER + out + COMMONTRAILER)
357 outfile.close()
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500358
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400359 # Write 32seg linker script
Kevin O'Connore5749972014-06-07 15:55:00 -0400360 out = (outXRefs(li.sections32seg, useseg=1)
361 + outSections(li.sections32seg, useseg=1))
Johannes Krampf19f789b2014-01-19 16:03:49 +0100362 outfile = open(out32seg, '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 32flat linker script
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500367 sections32all = (li.sections32flat + li.sections32init + li.sections32fseg)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400368 sec32all_start = li.sec32low_start
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400369 relocstr = ""
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500370 if li.genreloc:
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400371 # Generate relocations
Kevin O'Connorb40016f2014-06-11 14:40:45 -0400372 initsections = dict([(s, 1) for s in li.sections32init])
373 noninitsections = dict([(s, 1) for s in (
Kevin O'Connor46b82622012-05-13 12:10:30 -0400374 li.sections32flat + li.sections32low + li.sections16
Kevin O'Connorb40016f2014-06-11 14:40:45 -0400375 + li.sections32seg + li.sections32fseg)])
376 absrelocs = getRelocs(initsections, initsections, type='R_386_32')
377 relrelocs = getRelocs(initsections, noninitsections, type='R_386_PC32')
378 initrelocs = getRelocs(noninitsections, initsections)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400379 relocstr = (strRelocs("_reloc_abs", "code32init_start", absrelocs)
380 + strRelocs("_reloc_rel", "code32init_start", relrelocs)
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500381 + strRelocs("_reloc_init", "code32flat_start", initrelocs))
382 numrelocs = len(absrelocs + relrelocs + initrelocs)
Kevin O'Connor46b82622012-05-13 12:10:30 -0400383 sec32all_start -= numrelocs * 4
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500384 out = outXRefs(li.sections32low, exportsyms=li.varlowsyms
385 , forcedelta=li.final_sec32low_start-li.sec32low_start)
Kevin O'Connoree952532014-06-09 14:37:23 -0400386 out += outXRefs(sections32all, exportsyms=[li.entrysym]) + """
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400387 _reloc_min_align = 0x%x ;
Kevin O'Connor6d152642013-02-19 21:35:20 -0500388 zonefseg_start = 0x%x ;
389 zonefseg_end = 0x%x ;
Kevin O'Connorc9243442013-02-17 13:58:28 -0500390 zonelow_base = 0x%x ;
391 final_varlow_start = 0x%x ;
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500392 final_readonly_start = 0x%x ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400393
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400394 code32flat_start = 0x%x ;
395 .text code32flat_start : {
Kevin O'Connor46b82622012-05-13 12:10:30 -0400396%s
Kevin O'Connorc9243442013-02-17 13:58:28 -0500397 varlow_start = ABSOLUTE(.) ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400398%s
Kevin O'Connorc9243442013-02-17 13:58:28 -0500399 varlow_end = ABSOLUTE(.) ;
Kevin O'Connor402fd9c2010-09-15 00:26:19 -0400400 code32init_start = ABSOLUTE(.) ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400401%s
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400402 code32init_end = ABSOLUTE(.) ;
Kevin O'Connor46b82622012-05-13 12:10:30 -0400403%s
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400404 code32flat_end = ABSOLUTE(.) ;
405 } :text
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500406""" % (li.sec32init_align,
Kevin O'Connor6d152642013-02-19 21:35:20 -0500407 li.zonefseg_start,
408 li.zonefseg_end,
Kevin O'Connorc9243442013-02-17 13:58:28 -0500409 li.zonelow_base,
Kevin O'Connorc91da7a2012-06-08 21:14:19 -0400410 li.final_sec32low_start,
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500411 li.final_readonly_start,
Kevin O'Connor46b82622012-05-13 12:10:30 -0400412 sec32all_start,
413 relocstr,
414 outRelSections(li.sections32low, 'code32flat_start'),
415 outRelSections(li.sections32init, 'code32flat_start'),
Kevin O'Connore5749972014-06-07 15:55:00 -0400416 outRelSections(li.sections32flat + li.sections32fseg
417 + li.sections32seg + li.sections16, 'code32flat_start'))
Kevin O'Connor46b82622012-05-13 12:10:30 -0400418 out = COMMONHEADER + out + COMMONTRAILER + """
Kevin O'Connoree952532014-06-09 14:37:23 -0400419ENTRY(%s)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400420PHDRS
421{
422 text PT_LOAD AT ( code32flat_start ) ;
423}
Kevin O'Connoree952532014-06-09 14:37:23 -0400424""" % (li.entrysym.name,)
Johannes Krampf19f789b2014-01-19 16:03:49 +0100425 outfile = open(out32flat, 'w')
Kevin O'Connor46b82622012-05-13 12:10:30 -0400426 outfile.write(out)
427 outfile.close()
Kevin O'Connorc0693942009-06-10 21:56:01 -0400428
429
430######################################################################
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400431# Detection of unused sections and init sections
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400432######################################################################
433
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400434# Visit all sections reachable from a given set of start sections
435def findReachable(anchorsections, checkreloc, data):
436 anchorsections = dict([(section, []) for section in anchorsections])
437 pending = list(anchorsections)
438 while pending:
439 section = pending.pop()
440 for reloc in section.relocs:
441 chain = anchorsections[section] + [section.name]
442 if not checkreloc(reloc, section, data, chain):
443 continue
444 nextsection = reloc.symbol.section
445 if nextsection not in anchorsections:
446 anchorsections[nextsection] = chain
447 pending.append(nextsection)
448 return anchorsections
449
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400450# Find "runtime" sections (ie, not init only sections).
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400451def checkRuntime(reloc, rsection, data, chain):
452 section = reloc.symbol.section
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400453 if section is None or '.init.' in section.name:
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400454 return 0
Kevin O'Connor2af52da2013-03-08 19:36:28 -0500455 if '.data.varinit.' in section.name:
Johannes Krampf064fd062014-01-12 11:14:54 -0500456 print("ERROR: %s is VARVERIFY32INIT but used from %s" % (
457 section.name, chain))
Kevin O'Connor2af52da2013-03-08 19:36:28 -0500458 sys.exit(1)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400459 return 1
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400460
Kevin O'Connorfdca4182010-01-01 12:46:54 -0500461# Find and keep the section associated with a symbol (if available).
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400462def checkKeepSym(reloc, syms, fileid, isxref):
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500463 symbolname = reloc.symbolname
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400464 mustbecfunc = symbolname.startswith('_cfunc')
465 if mustbecfunc:
466 symprefix = '_cfunc' + fileid + '_'
467 if not symbolname.startswith(symprefix):
468 return 0
469 symbolname = symbolname[len(symprefix):]
470 symbol = syms.get(symbolname)
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400471 if (symbol is None or symbol.section is None
472 or symbol.section.name.startswith('.discard.')):
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400473 return 0
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500474 isdestcfunc = (symbol.section.name.startswith('.text.')
475 and not symbol.section.name.startswith('.text.asm.'))
476 if ((mustbecfunc and not isdestcfunc)
477 or (not mustbecfunc and isdestcfunc and isxref)):
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400478 return 0
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500479
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400480 reloc.symbol = symbol
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400481 return 1
Kevin O'Connorfdca4182010-01-01 12:46:54 -0500482
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400483# Resolve a relocation and check if it should be kept in the final binary.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400484def checkKeep(reloc, section, symbols, chain):
485 ret = checkKeepSym(reloc, symbols[section.fileid], section.fileid, 0)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400486 if ret:
487 return ret
488 # Not in primary sections - it may be a cross 16/32 reference
489 for fileid in ('16', '32seg', '32flat'):
490 if fileid != section.fileid:
Kevin O'Connorc228d702014-06-09 14:59:25 -0400491 ret = checkKeepSym(reloc, symbols[fileid], fileid, 1)
Kevin O'Connorcc132ab2014-06-09 12:48:13 -0400492 if ret:
493 return ret
494 return 0
Kevin O'Connorc0693942009-06-10 21:56:01 -0400495
Kevin O'Connorc0693942009-06-10 21:56:01 -0400496
497######################################################################
498# Startup and input parsing
499######################################################################
500
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400501class Section:
502 name = size = alignment = fileid = relocs = None
Kevin O'Connorc228d702014-06-09 14:59:25 -0400503 finalloc = finalsegloc = category = None
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400504class Reloc:
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500505 offset = type = symbolname = symbol = None
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400506class Symbol:
507 name = offset = section = None
508
Kevin O'Connorc0693942009-06-10 21:56:01 -0400509# Read in output from objdump
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400510def parseObjDump(file, fileid):
511 # sections = [section, ...]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400512 sections = []
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400513 sectionmap = {}
514 # symbols[symbolname] = symbol
Kevin O'Connorc0693942009-06-10 21:56:01 -0400515 symbols = {}
Kevin O'Connorc0693942009-06-10 21:56:01 -0400516
517 state = None
518 for line in file.readlines():
519 line = line.rstrip()
520 if line == 'Sections:':
521 state = 'section'
522 continue
523 if line == 'SYMBOL TABLE:':
524 state = 'symbol'
525 continue
Kevin O'Connor6c2e7812010-09-13 18:04:02 -0400526 if line.startswith('RELOCATION RECORDS FOR ['):
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400527 sectionname = line[24:-2]
528 if sectionname.startswith('.debug_'):
529 # Skip debugging sections (to reduce parsing time)
530 state = None
531 continue
Kevin O'Connorc0693942009-06-10 21:56:01 -0400532 state = 'reloc'
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400533 relocsection = sectionmap[sectionname]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400534 continue
535
536 if state == 'section':
537 try:
538 idx, name, size, vma, lma, fileoff, align = line.split()
539 if align[:3] != '2**':
540 continue
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400541 section = Section()
542 section.name = name
543 section.size = int(size, 16)
544 section.align = 2**int(align[3:])
545 section.fileid = fileid
546 section.relocs = []
547 sections.append(section)
548 sectionmap[name] = section
549 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400550 pass
551 continue
552 if state == 'symbol':
553 try:
Kevin O'Connor90ebed42012-06-21 20:54:53 -0400554 parts = line[17:].split()
555 if len(parts) == 3:
556 sectionname, size, name = parts
557 elif len(parts) == 4 and parts[2] == '.hidden':
558 sectionname, size, hidden, name = parts
559 else:
560 continue
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400561 symbol = Symbol()
562 symbol.size = int(size, 16)
563 symbol.offset = int(line[:8], 16)
564 symbol.name = name
565 symbol.section = sectionmap.get(sectionname)
566 symbols[name] = symbol
567 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400568 pass
569 continue
570 if state == 'reloc':
571 try:
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400572 off, type, symbolname = line.split()
573 reloc = Reloc()
574 reloc.offset = int(off, 16)
575 reloc.type = type
Kevin O'Connorf3fe3aa2010-12-05 12:38:33 -0500576 reloc.symbolname = symbolname
Kevin O'Connor67863be2010-12-24 10:23:10 -0500577 reloc.symbol = symbols.get(symbolname)
578 if reloc.symbol is None:
579 # Some binutils (2.20.1) give section name instead
580 # of a symbol - create a dummy symbol.
581 reloc.symbol = symbol = Symbol()
582 symbol.size = 0
583 symbol.offset = 0
584 symbol.name = symbolname
585 symbol.section = sectionmap.get(symbolname)
586 symbols[symbolname] = symbol
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400587 relocsection.relocs.append(reloc)
588 except ValueError:
Kevin O'Connorc0693942009-06-10 21:56:01 -0400589 pass
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400590 return sections, symbols
Kevin O'Connorc0693942009-06-10 21:56:01 -0400591
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400592# Parser for constants in simple C header files.
593def scanconfig(file):
Johannes Krampf19f789b2014-01-19 16:03:49 +0100594 f = open(file, 'r')
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400595 opts = {}
596 for l in f.readlines():
597 parts = l.split()
598 if len(parts) != 3:
599 continue
600 if parts[0] != '#define':
601 continue
602 value = parts[2]
603 if value.isdigit() or (value.startswith('0x') and value[2:].isdigit()):
604 value = int(value, 0)
605 opts[parts[1]] = value
606 return opts
607
Kevin O'Connorc0693942009-06-10 21:56:01 -0400608def main():
609 # Get output name
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400610 in16, in32seg, in32flat, cfgfile, out16, out32seg, out32flat = sys.argv[1:]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400611
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400612 # Read in the objdump information
Johannes Krampf19f789b2014-01-19 16:03:49 +0100613 infile16 = open(in16, 'r')
614 infile32seg = open(in32seg, 'r')
615 infile32flat = open(in32flat, 'r')
Kevin O'Connorc0693942009-06-10 21:56:01 -0400616
Kevin O'Connor1a4885e2010-09-15 21:28:31 -0400617 # infoX = (sections, symbols)
618 info16 = parseObjDump(infile16, '16')
619 info32seg = parseObjDump(infile32seg, '32seg')
620 info32flat = parseObjDump(infile32flat, '32flat')
Kevin O'Connorc0693942009-06-10 21:56:01 -0400621
Kevin O'Connor2b0fb8c2013-08-07 23:03:47 -0400622 # Read kconfig config file
623 config = scanconfig(cfgfile)
624
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400625 # Figure out which sections to keep.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400626 allsections = info16[0] + info32seg[0] + info32flat[0]
627 symbols = {'16': info16[1], '32seg': info32seg[1], '32flat': info32flat[1]}
Kevin O'Connoree952532014-06-09 14:37:23 -0400628 if config.get('CONFIG_COREBOOT'):
629 entrysym = symbols['16'].get('entry_elf')
630 elif config.get('CONFIG_CSM'):
631 entrysym = symbols['16'].get('entry_csm')
632 else:
633 entrysym = symbols['16'].get('reset_vector')
634 anchorsections = [entrysym.section] + [
635 section for section in info16[0]
636 if section.name.startswith('.fixedaddr.')]
Kevin O'Connorc228d702014-06-09 14:59:25 -0400637 keepsections = findReachable(anchorsections, checkKeep, symbols)
638 sections = [section for section in allsections if section in keepsections]
Kevin O'Connorc0693942009-06-10 21:56:01 -0400639
Kevin O'Connorbf70fbf2014-06-10 00:00:20 -0400640 # Separate 32bit flat into runtime, init, and special variable parts
641 anchorsections = [
642 section for section in sections
643 if ('.data.varlow.' in section.name or '.data.varfseg.' in section.name
644 or '.runtime.' in section.name)]
645 runtimesections = findReachable(anchorsections, checkRuntime, None)
646 for section in sections:
647 if section.name.startswith('.data.varlow.'):
648 section.category = '32low'
649 elif section.name.startswith('.data.varfseg.'):
650 section.category = '32fseg'
651 elif section.fileid == '32flat' and section not in runtimesections:
652 section.category = '32init'
653 else:
654 section.category = section.fileid
Kevin O'Connor46b82622012-05-13 12:10:30 -0400655
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400656 # Determine the final memory locations of each kept section.
Kevin O'Connorc228d702014-06-09 14:59:25 -0400657 genreloc = '_reloc_abs_start' in symbols['32flat']
Kevin O'Connorb94170c2013-12-06 13:52:16 -0500658 li = doLayout(sections, config, genreloc)
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400659
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500660 # Exported symbols
Kevin O'Connorc228d702014-06-09 14:59:25 -0400661 li.varlowsyms = [symbol for symbol in symbols['32flat'].values()
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500662 if (symbol.section is not None
663 and symbol.section.finalloc is not None
664 and '.data.varlow.' in symbol.section.name
665 and symbol.name != symbol.section.name)]
Kevin O'Connoree952532014-06-09 14:37:23 -0400666 li.entrysym = entrysym
Kevin O'Connora3c48f52013-02-05 22:36:13 -0500667
Kevin O'Connor9ba1dea2010-05-01 09:50:13 -0400668 # Write out linker script files.
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500669 writeLinkerScripts(li, out16, out32seg, out32flat)
Kevin O'Connorc0693942009-06-10 21:56:01 -0400670
Kevin O'Connor202024a2009-01-17 10:41:28 -0500671if __name__ == '__main__':
672 main()