coreboot-gerrit May 2015

coreboot-gerrit@coreboot.org

1 participants
1299 discussions

New patch to review for coreboot: 7b53ed3 northbridge/intel/fsp_rangeley: Correct MMIO size setting
by Dave Frodin 01 May '15

01 May '15

Dave Frodin (dave.frodin(a)se-eng.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/10047 -gerrit commit 7b53ed37cb90ae4a160f37d1abc2439212a50f67 Author: Dave Frodin <dave.frodin(a)se-eng.com> Date: Fri May 1 09:17:43 2015 -0600 northbridge/intel/fsp_rangeley: Correct MMIO size setting The Rangeley chipset has the MMIO PCI config space feature enabled at 0xe0000000-0xefffffff. This is a 256MB space which covers all of config space. The ACPI table for this space only defines it as being 64MB. This change fixes that setting. Change-Id: I8205a9b89ea6633ac6c4b0d5a282cd2745595b2e Signed-off-by: Dave Frodin <dave.frodin(a)se-eng.com> --- src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl b/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl index 6a8c2e0..08dba89 100644 --- a/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl +++ b/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl @@ -30,7 +30,7 @@ Device (PDRC) Name (_UID, 1) Name (PDRS, ResourceTemplate() { - Memory32Fixed(ReadWrite, DEFAULT_ECBASE, 0x04000000) + Memory32Fixed(ReadWrite, DEFAULT_ECBASE, 0x10000000) }) // Current Resource Settings

1 0

Patch set updated for coreboot: a5f0d1a intel: Correct MMIO related ACPI table settings
by Dave Frodin 01 May '15

01 May '15

Dave Frodin (dave.frodin(a)se-eng.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9972 -gerrit commit a5f0d1a90cc6d0f465050d3ce0a4699cc59917ca Author: Dave Frodin <dave.frodin(a)se-eng.com> Date: Thu Apr 23 06:04:46 2015 -0600 intel: Correct MMIO related ACPI table settings Several of the intel platforms define the region reserved for PCI memory resources in a location where it overlaps with the MMIO (MCFG) region. Using the memory map from mohon_peak as an example: 0. 0000000000000000-0000000000000fff: CONFIGURATION TABLES 1. 0000000000001000-000000000009ffff: RAM 2. 00000000000a0000-00000000000fffff: RESERVED 3. 0000000000100000-000000007fbcffff: RAM 4. 000000007fbd0000-000000007fbfffff: CONFIGURATION TABLES 5. 000000007fc00000-000000007fdfffff: RESERVED 6. 00000000e0000000-00000000efffffff: RESERVED 7. 00000000fee00000-00000000fee00fff: RESERVED 8. 0000000100000000-000000017fffffff: RAM The ACPI table describing the space set aside for PCI memory (not to be confused with the MMIO config space) is defined as the region from BMBOUND (the top of DRAM below 4GB) to a hardcoded value of 0xfebfffff. That region would overlap the MMIO region at 0xe0000000-0xefffffff. For rangeley the upper bound of the PCI memory space should be set to 0xe0000000 - 1. The MCFG regions for several of the affected chipsets are: rangeley 0xe0000000-0xefffffff baytrail 0xe0000000-0xefffffff haswell 0xf0000000-0xf3ffffff sandybridge 0xf8000000-0xfbffffff TEST = intel/mohonpeak and intel/bayleybay. Change-Id: Ic188a4f575494f04930dea4d0aaaeaad95df9f90 Signed-off-by: Dave Frodin <dave.frodin(a)se-eng.com> --- src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl | 10 ++++++---- src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl | 7 ++++--- src/northbridge/intel/haswell/acpi/hostbridge.asl | 7 ++++--- src/northbridge/intel/sandybridge/acpi/hostbridge.asl | 7 ++++--- src/soc/intel/baytrail/acpi/southcluster.asl | 7 ++++--- src/soc/intel/broadwell/acpi/systemagent.asl | 7 ++++--- src/soc/intel/fsp_baytrail/acpi/southcluster.asl | 7 ++++--- 7 files changed, 30 insertions(+), 22 deletions(-) diff --git a/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl b/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl index 5cefaeb..4410815 100644 --- a/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl +++ b/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl @@ -111,11 +111,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0, 0x00000000, + 0,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -131,7 +131,9 @@ Method (_CRS, 0, Serialized) // Fix up PCI memory region // Start with Top of Lower Usable DRAM - Store (BMBD, PMIN) // Memory goes from BMBOUND to 0xfebfffff (PM01 above) + // Memory goes from BMBOUND to CONFIG_MMCONF_BASE_ADDRESS (PM01 above) + Store (BMBD, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) // Store Memory Size Return (MCRS) diff --git a/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl b/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl index e82758c..ea09679 100644 --- a/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl +++ b/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl @@ -320,11 +320,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -350,6 +350,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/northbridge/intel/haswell/acpi/hostbridge.asl b/src/northbridge/intel/haswell/acpi/hostbridge.asl index 9bc5549..4474367 100644 --- a/src/northbridge/intel/haswell/acpi/hostbridge.asl +++ b/src/northbridge/intel/haswell/acpi/hostbridge.asl @@ -426,11 +426,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -456,6 +456,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/northbridge/intel/sandybridge/acpi/hostbridge.asl b/src/northbridge/intel/sandybridge/acpi/hostbridge.asl index 26f7514..f2720cf 100644 --- a/src/northbridge/intel/sandybridge/acpi/hostbridge.asl +++ b/src/northbridge/intel/sandybridge/acpi/hostbridge.asl @@ -344,11 +344,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -374,6 +374,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/baytrail/acpi/southcluster.asl b/src/soc/intel/baytrail/acpi/southcluster.asl index 47151a3..9092562 100644 --- a/src/soc/intel/baytrail/acpi/southcluster.asl +++ b/src/soc/intel/baytrail/acpi/southcluster.asl @@ -158,11 +158,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfeafffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0xfea00000, 0xfeafffff, 0x00000000, - 0x00100000,,, PMEM) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PMEM) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -178,6 +178,7 @@ Method (_CRS, 0, Serialized) // TOLM is BMBOUND accessible from IOSF so is saved in NVS Store (\TOLM, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add (Subtract (PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/broadwell/acpi/systemagent.asl b/src/soc/intel/broadwell/acpi/systemagent.asl index 8fcd0b7..c2049ea 100644 --- a/src/soc/intel/broadwell/acpi/systemagent.asl +++ b/src/soc/intel/broadwell/acpi/systemagent.asl @@ -147,11 +147,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -177,6 +177,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/fsp_baytrail/acpi/southcluster.asl b/src/soc/intel/fsp_baytrail/acpi/southcluster.asl index 3ee9ee0..ed82124 100644 --- a/src/soc/intel/fsp_baytrail/acpi/southcluster.asl +++ b/src/soc/intel/fsp_baytrail/acpi/southcluster.asl @@ -157,11 +157,11 @@ Name (MCRS, ResourceTemplate() 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfeafffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0xfea00000, 0xfeafffff, 0x00000000, - 0x00100000,,, PMEM) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PMEM) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -179,6 +179,7 @@ Method (_CRS, 0, Serialized) // TOLM is BMBOUND accessible from IOSF so is saved in NVS Store (\TOLM, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add (Subtract (PMAX, PMIN), 1, PLEN) Return (MCRS)

1 0

Patch set updated for coreboot: 8d20b0c intel: Correct several MMIO related ACPI table settings
by Dave Frodin 01 May '15

01 May '15

Dave Frodin (dave.frodin(a)se-eng.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9972 -gerrit commit 8d20b0c3604928e3863d9883dea9f3e0e5d61160 Author: Dave Frodin <dave.frodin(a)se-eng.com> Date: Thu Apr 23 06:04:46 2015 -0600 intel: Correct several MMIO related ACPI table settings 1) The Rangeley chipset has the MMIO PCI config space feature enabled at 0xe0000000-0xefffffff. This is a 256MB space which covers all of config space. The ACPI table for this space only defines it as being 64MB. This table setting has been corrected in the rangeley.asl file. 2) Several of the intel platforms define the region reserved for PCI memory resources in a location where it overlaps with the MMIO (MCFG) region. Using the memory map from mohon_peak as an example: 0. 0000000000000000-0000000000000fff: CONFIGURATION TABLES 1. 0000000000001000-000000000009ffff: RAM 2. 00000000000a0000-00000000000fffff: RESERVED 3. 0000000000100000-000000007fbcffff: RAM 4. 000000007fbd0000-000000007fbfffff: CONFIGURATION TABLES 5. 000000007fc00000-000000007fdfffff: RESERVED 6. 00000000e0000000-00000000efffffff: RESERVED 7. 00000000fee00000-00000000fee00fff: RESERVED 8. 0000000100000000-000000017fffffff: RAM The ACPI table describing the space set aside for PCI memory (not to be confused with the MMIO config space) is defined as the region from BMBOUND (the top of DRAM below 4GB) to a hardcoded value of 0xfebfffff. That region would overlap the MMIO region at 0xe0000000-0xefffffff. For rangeley the upper bound of the PCI memory space should be set to 0xe0000000 - 1. The MCFG regions for several of the affected chipsets are: rangeley 0xe0000000-0xefffffff baytrail 0xe0000000-0xefffffff haswell 0xf0000000-0xf3ffffff sandybridge 0xf8000000-0xfbffffff TEST = intel/mohonpeak and intel/bayleybay. Change-Id: Ic188a4f575494f04930dea4d0aaaeaad95df9f90 Signed-off-by: Dave Frodin <dave.frodin(a)se-eng.com> --- src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl | 10 ++++++---- src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl | 2 +- src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl | 7 ++++--- src/northbridge/intel/haswell/acpi/hostbridge.asl | 7 ++++--- src/northbridge/intel/sandybridge/acpi/hostbridge.asl | 7 ++++--- src/soc/intel/baytrail/acpi/southcluster.asl | 7 ++++--- src/soc/intel/broadwell/acpi/systemagent.asl | 7 ++++--- src/soc/intel/fsp_baytrail/acpi/southcluster.asl | 7 ++++--- 8 files changed, 31 insertions(+), 23 deletions(-) diff --git a/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl b/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl index 5cefaeb..4410815 100644 --- a/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl +++ b/src/northbridge/intel/fsp_rangeley/acpi/hostbridge.asl @@ -111,11 +111,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0, 0x00000000, + 0,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -131,7 +131,9 @@ Method (_CRS, 0, Serialized) // Fix up PCI memory region // Start with Top of Lower Usable DRAM - Store (BMBD, PMIN) // Memory goes from BMBOUND to 0xfebfffff (PM01 above) + // Memory goes from BMBOUND to CONFIG_MMCONF_BASE_ADDRESS (PM01 above) + Store (BMBD, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) // Store Memory Size Return (MCRS) diff --git a/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl b/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl index 6a8c2e0..08dba89 100644 --- a/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl +++ b/src/northbridge/intel/fsp_rangeley/acpi/rangeley.asl @@ -30,7 +30,7 @@ Device (PDRC) Name (_UID, 1) Name (PDRS, ResourceTemplate() { - Memory32Fixed(ReadWrite, DEFAULT_ECBASE, 0x04000000) + Memory32Fixed(ReadWrite, DEFAULT_ECBASE, 0x10000000) }) // Current Resource Settings diff --git a/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl b/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl index e82758c..ea09679 100644 --- a/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl +++ b/src/northbridge/intel/fsp_sandybridge/acpi/hostbridge.asl @@ -320,11 +320,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -350,6 +350,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/northbridge/intel/haswell/acpi/hostbridge.asl b/src/northbridge/intel/haswell/acpi/hostbridge.asl index 9bc5549..4474367 100644 --- a/src/northbridge/intel/haswell/acpi/hostbridge.asl +++ b/src/northbridge/intel/haswell/acpi/hostbridge.asl @@ -426,11 +426,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -456,6 +456,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/northbridge/intel/sandybridge/acpi/hostbridge.asl b/src/northbridge/intel/sandybridge/acpi/hostbridge.asl index 26f7514..f2720cf 100644 --- a/src/northbridge/intel/sandybridge/acpi/hostbridge.asl +++ b/src/northbridge/intel/sandybridge/acpi/hostbridge.asl @@ -344,11 +344,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -374,6 +374,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/baytrail/acpi/southcluster.asl b/src/soc/intel/baytrail/acpi/southcluster.asl index 47151a3..9092562 100644 --- a/src/soc/intel/baytrail/acpi/southcluster.asl +++ b/src/soc/intel/baytrail/acpi/southcluster.asl @@ -158,11 +158,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfeafffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0xfea00000, 0xfeafffff, 0x00000000, - 0x00100000,,, PMEM) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PMEM) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -178,6 +178,7 @@ Method (_CRS, 0, Serialized) // TOLM is BMBOUND accessible from IOSF so is saved in NVS Store (\TOLM, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add (Subtract (PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/broadwell/acpi/systemagent.asl b/src/soc/intel/broadwell/acpi/systemagent.asl index 8fcd0b7..c2049ea 100644 --- a/src/soc/intel/broadwell/acpi/systemagent.asl +++ b/src/soc/intel/broadwell/acpi/systemagent.asl @@ -147,11 +147,11 @@ Method (_CRS, 0, Serialized) 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfebfffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0x00000000, 0xfebfffff, 0x00000000, - 0xfec00000,,, PM01) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PM01) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -177,6 +177,7 @@ Method (_CRS, 0, Serialized) } Store (Local0, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add(Subtract(PMAX, PMIN), 1, PLEN) Return (MCRS) diff --git a/src/soc/intel/fsp_baytrail/acpi/southcluster.asl b/src/soc/intel/fsp_baytrail/acpi/southcluster.asl index 3ee9ee0..ed82124 100644 --- a/src/soc/intel/fsp_baytrail/acpi/southcluster.asl +++ b/src/soc/intel/fsp_baytrail/acpi/southcluster.asl @@ -157,11 +157,11 @@ Name (MCRS, ResourceTemplate() 0x00000000, 0x000f0000, 0x000fffff, 0x00000000, 0x00010000,,, FSEG) - // PCI Memory Region (Top of memory-0xfeafffff) + // PCI Memory Region (Top of memory-CONFIG_MMCONF_BASE_ADDRESS) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, Cacheable, ReadWrite, - 0x00000000, 0xfea00000, 0xfeafffff, 0x00000000, - 0x00100000,,, PMEM) + 0x00000000, 0x00000000, 0x00000000, 0x00000000, + 0x00000000,,, PMEM) // TPM Area (0xfed40000-0xfed44fff) DWordMemory (ResourceProducer, PosDecode, MinFixed, MaxFixed, @@ -179,6 +179,7 @@ Method (_CRS, 0, Serialized) // TOLM is BMBOUND accessible from IOSF so is saved in NVS Store (\TOLM, PMIN) + Store (Subtract(CONFIG_MMCONF_BASE_ADDRESS, 1), PMAX) Add (Subtract (PMAX, PMIN), 1, PLEN) Return (MCRS)

1 0

Patch set updated for coreboot: 269fa00 haswell: Link stage_cache_external_region into ramstage, too
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/10046 -gerrit commit 269fa00a33fefb3db9fe3e4e095cbd32abbec0fe Author: Sol Boucher <solb(a)chromium.org> Date: Thu Apr 30 18:02:08 2015 -0700 haswell: Link stage_cache_external_region into ramstage, too When CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM is set, this function is now linked into the ramstage as well as the romstage, since the former makes calls to it in panther builds. After this commit, it's possible to build panther using the config file from the Chromium OS project[1] if you supply the appropriate Intel descriptor and ME binary blobs and manually set CONFIG_VBOOT_VERIFY_FIRMWARE=n, CONFIG_BUILD_WITH_FAKE_IFD=n, and CONFIG_HAVE_ME_BIN=y. The resulting image is at least able to load a payload, although I only tested with depthcharge, which immediately complained, "vboot handoff pointer is NULL" and gave up the ghost. [1] https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/… Change-Id: Id3bb510fa60129a4d36a0117dc33e7aa62d6c742 Signed-off-by: Sol Boucher <solb(a)chromium.org> --- src/cpu/intel/haswell/Makefile.inc | 3 +++ src/cpu/intel/haswell/romstage.c | 10 ---------- src/cpu/intel/haswell/stage_cache.c | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 10 deletions(-) diff --git a/src/cpu/intel/haswell/Makefile.inc b/src/cpu/intel/haswell/Makefile.inc index 0db0475..57f9120 100644 --- a/src/cpu/intel/haswell/Makefile.inc +++ b/src/cpu/intel/haswell/Makefile.inc @@ -4,9 +4,12 @@ romstage-y += romstage.c romstage-y += tsc_freq.c ramstage-y += acpi.c +ramstage-$(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) += stage_cache.c ramstage-$(CONFIG_HAVE_SMI_HANDLER) += smmrelocate.c ramstage-$(CONFIG_MONOTONIC_TIMER_MSR) += monotonic_timer.c +romstage-$(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) += stage_cache.c + cpu_microcode-$(CONFIG_CPU_MICROCODE_CBFS_GENERATE) += microcode_blob.c smm-$(CONFIG_HAVE_SMI_HANDLER) += finalize.c diff --git a/src/cpu/intel/haswell/romstage.c b/src/cpu/intel/haswell/romstage.c index b8c455b..8e4335f 100644 --- a/src/cpu/intel/haswell/romstage.c +++ b/src/cpu/intel/haswell/romstage.c @@ -20,7 +20,6 @@ #include <stdint.h> #include <string.h> #include <cbfs.h> -#include <cbmem.h> #include <console/console.h> #include <arch/cpu.h> #include <cpu/x86/bist.h> @@ -313,15 +312,6 @@ void romstage_after_car(void) #if IS_ENABLED(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) - -void stage_cache_external_region(void **base, size_t *size) -{ - /* The ramstage cache lives in the TSEG region at RESERVED_SMM_OFFSET. - * The top of ram is defined to be the TSEG base address. */ - *size = RESERVED_SMM_SIZE; - *base = (void *)((uint32_t)cbmem_top() + RESERVED_SMM_OFFSET); -} - void ramstage_cache_invalid(void) { #if CONFIG_RESET_ON_INVALID_RAMSTAGE_CACHE diff --git a/src/cpu/intel/haswell/stage_cache.c b/src/cpu/intel/haswell/stage_cache.c new file mode 100644 index 0000000..e84eb82 --- /dev/null +++ b/src/cpu/intel/haswell/stage_cache.c @@ -0,0 +1,32 @@ +/* + * This file is part of the coreboot project. + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include <stddef.h> +#include <stdint.h> +#include <cbmem.h> +#include <stage_cache.h> +#include "haswell.h" + +void stage_cache_external_region(void **base, size_t *size) +{ + /* The ramstage cache lives in the TSEG region at RESERVED_SMM_OFFSET. + * The top of ram is defined to be the TSEG base address. */ + *size = RESERVED_SMM_SIZE; + *base = (void *)((uint32_t)cbmem_top() + RESERVED_SMM_OFFSET); +}

1 0

New patch to review for coreboot: 130ac76 haswell: Link stage_cache_external_region into ramstage, too
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/10046 -gerrit commit 130ac761521b62a36c681a8160997e63ecc78da6 Author: Sol Boucher <solb(a)chromium.org> Date: Thu Apr 30 18:02:08 2015 -0700 haswell: Link stage_cache_external_region into ramstage, too When CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM is set, this function is now linked into the ramstage as well as the romstage, since the former makes calls to it in panther builds. After this commit, it's possible to build panther using the config file from the Chromium OS project[1] if you supply the appropriate Intel descriptor and ME binary blobs and manually set CONFIG_VBOOT_VERIFY_FIRMWARE=n, CONFIG_BUILD_WITH_FAKE_IFD=n, and CONFIG_HAVE_ME_BIN=y. The resulting image is at least able to load a payload, although I only tested with depthcharge, which immediately complained, "vboot handoff pointer is NULL" and gave up the ghost. [1] https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay/+/… Change-Id: Id3bb510fa60129a4d36a0117dc33e7aa62d6c742 Signed-off-by: Sol Boucher <solb(a)chromium.org> --- src/cpu/intel/haswell/Makefile.inc | 3 +++ src/cpu/intel/haswell/romstage.c | 10 ---------- src/cpu/intel/haswell/stage_cache.c | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 10 deletions(-) diff --git a/src/cpu/intel/haswell/Makefile.inc b/src/cpu/intel/haswell/Makefile.inc index 0db0475..57f9120 100644 --- a/src/cpu/intel/haswell/Makefile.inc +++ b/src/cpu/intel/haswell/Makefile.inc @@ -4,9 +4,12 @@ romstage-y += romstage.c romstage-y += tsc_freq.c ramstage-y += acpi.c +ramstage-$(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) += stage_cache.c ramstage-$(CONFIG_HAVE_SMI_HANDLER) += smmrelocate.c ramstage-$(CONFIG_MONOTONIC_TIMER_MSR) += monotonic_timer.c +romstage-$(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) += stage_cache.c + cpu_microcode-$(CONFIG_CPU_MICROCODE_CBFS_GENERATE) += microcode_blob.c smm-$(CONFIG_HAVE_SMI_HANDLER) += finalize.c diff --git a/src/cpu/intel/haswell/romstage.c b/src/cpu/intel/haswell/romstage.c index b8c455b..8e4335f 100644 --- a/src/cpu/intel/haswell/romstage.c +++ b/src/cpu/intel/haswell/romstage.c @@ -20,7 +20,6 @@ #include <stdint.h> #include <string.h> #include <cbfs.h> -#include <cbmem.h> #include <console/console.h> #include <arch/cpu.h> #include <cpu/x86/bist.h> @@ -313,15 +312,6 @@ void romstage_after_car(void) #if IS_ENABLED(CONFIG_CACHE_RELOCATED_RAMSTAGE_OUTSIDE_CBMEM) - -void stage_cache_external_region(void **base, size_t *size) -{ - /* The ramstage cache lives in the TSEG region at RESERVED_SMM_OFFSET. - * The top of ram is defined to be the TSEG base address. */ - *size = RESERVED_SMM_SIZE; - *base = (void *)((uint32_t)cbmem_top() + RESERVED_SMM_OFFSET); -} - void ramstage_cache_invalid(void) { #if CONFIG_RESET_ON_INVALID_RAMSTAGE_CACHE diff --git a/src/cpu/intel/haswell/stage_cache.c b/src/cpu/intel/haswell/stage_cache.c new file mode 100644 index 0000000..e84eb82 --- /dev/null +++ b/src/cpu/intel/haswell/stage_cache.c @@ -0,0 +1,32 @@ +/* + * This file is part of the coreboot project. + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include <stddef.h> +#include <stdint.h> +#include <cbmem.h> +#include <stage_cache.h> +#include "haswell.h" + +void stage_cache_external_region(void **base, size_t *size) +{ + /* The ramstage cache lives in the TSEG region at RESERVED_SMM_OFFSET. + * The top of ram is defined to be the TSEG base address. */ + *size = RESERVED_SMM_SIZE; + *base = (void *)((uint32_t)cbmem_top() + RESERVED_SMM_OFFSET); +}

1 0

Patch set updated for coreboot: 1f6a46a fmaptool: Add listing of annotated CBFS sections and generate header
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9967 -gerrit commit 1f6a46a106b16699f2d83c5cfa9f30525082174a Author: Sol Boucher <solb(a)chromium.org> Date: Wed Mar 18 10:13:48 2015 -0700 fmaptool: Add listing of annotated CBFS sections and generate header The fmd compiler now processes "(CBFS)" annotations, distilling them into a comma-separated list of the names of sections containing CBFSes. This list is the only thing printed to standard output to enable easy capture and machine consumption by other tools. Additionally, the ability to generate a tiny header with a define for the primary CBFS's size is implemented and can be requested via a new command-line switch. BUG=chromium:470407 TEST=Verify that fmd files without a "COREBOOT" section or with one that isn't annotated as "(CBFS)" are not accepted. Ensure that the list of CBFS sections matches the descriptor file's annotations and is led by the "COREBOOT" section. Invoke with the header generation switch and check that output file for reasonableness. BRANCH=None Change-Id: I496dd937f69467bfd9233c28df59c7608e89538f Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Commit-Id: 9227698adecf675770b2983380eb570676c2b5d2 Original-Change-Id: I8b32f6ef19cabe2f6760106e676683c4565bbaad Original-Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Reviewed-on: https://chromium-review.googlesource.com/262956 Original-Reviewed-by: Duncan Laurie <dlaurie(a)chromium.org> Original-Reviewed-by: Julius Werner <jwerner(a)chromium.org> --- util/cbfstool/Makefile | 3 +- util/cbfstool/Makefile.inc | 1 + util/cbfstool/cbfs_sections.c | 122 ++++++++++++++++++++++++++++ util/cbfstool/cbfs_sections.h | 59 ++++++++++++++ util/cbfstool/fmap_from_fmd.c | 15 ++-- util/cbfstool/fmaptool.c | 181 +++++++++++++++++++++++++++++++++++------- util/cbfstool/fmd.c | 27 +++---- util/cbfstool/fmd_parser.c | 85 ++++++++++---------- util/cbfstool/fmd_parser.h | 4 +- util/cbfstool/fmd_parser.y | 13 +-- 10 files changed, 405 insertions(+), 105 deletions(-) diff --git a/util/cbfstool/Makefile b/util/cbfstool/Makefile index abacfaa..e97e7a3 100644 --- a/util/cbfstool/Makefile +++ b/util/cbfstool/Makefile @@ -22,7 +22,8 @@ CBFSTOOL_COMMON+=lzma/C/LzFind.o lzma/C/LzmaDec.o lzma/C/LzmaEnc.o CBFSTOOL_COMMON:=$(addprefix $(obj)/,$(CBFSTOOL_COMMON)) FMAPTOOL_BINARY:=$(obj)/fmaptool -FMAPTOOL_COMMON:=fmap_from_fmd.o fmd.o fmd_parser.o fmd_scanner.o +FMAPTOOL_COMMON:=cbfs_sections.o fmap_from_fmd.o +FMAPTOOL_COMMON+=fmd.o fmd_parser.o fmd_scanner.o # FMAP FMAPTOOL_COMMON+=flashmap/fmap.o FMAPTOOL_COMMON+=flashmap/kv_pair.o flashmap/valstr.o diff --git a/util/cbfstool/Makefile.inc b/util/cbfstool/Makefile.inc index b5eed70..b3377e6 100644 --- a/util/cbfstool/Makefile.inc +++ b/util/cbfstool/Makefile.inc @@ -19,6 +19,7 @@ cbfsobj += cbfs-payload-linux.o fmapobj := fmapobj += fmaptool.o +fmapobj += cbfs_sections.o fmapobj += fmap_from_fmd.o fmapobj += fmd.o fmapobj += fmd_parser.o diff --git a/util/cbfstool/cbfs_sections.c b/util/cbfstool/cbfs_sections.c new file mode 100644 index 0000000..81912d5 --- /dev/null +++ b/util/cbfstool/cbfs_sections.c @@ -0,0 +1,122 @@ +/* + * fmap_sections.c, track which sections of the image will contain CBFSes + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#include "cbfs_sections.h" + +#include <assert.h> +#include <stdlib.h> +#include <string.h> + +struct descriptor_node { + const struct flashmap_descriptor *val; + struct descriptor_node *next; +}; + +static struct descriptor_list { + struct descriptor_node *head; + struct descriptor_node *tail; +} cbfs_sections; + +static bool seen_primary_section = false; + +static void descriptor_list_prepend(struct descriptor_list *list, + struct descriptor_node *new_head) +{ + assert(list); + assert(new_head); + + new_head->next = list->head; + list->head = new_head; + if (!list->tail) + list->tail = new_head; +} + +static void descriptor_list_append(struct descriptor_list *list, + struct descriptor_node *new_tail) +{ + assert(list); + assert(new_tail); + + if (list->tail) + list->tail->next = new_tail; + list->tail = new_tail; + if (!list->head) + list->head = new_tail; +} + +/* Implementation of cbfs module's callback; invoked during fmd file parsing */ +bool fmd_process_annotation_impl(const struct flashmap_descriptor *node, + const char *annotation) +{ + if (strcmp(annotation, SECTION_ANNOTATION_CBFS) == 0 && + node->list_len == 0) { + struct descriptor_node *list_node = malloc(sizeof(*list_node)); + list_node->val = node; + list_node->next = NULL; + + if (strcmp(node->name, SECTION_NAME_PRIMARY_CBFS) == 0) { + descriptor_list_prepend(&cbfs_sections, list_node); + seen_primary_section = true; + } else { + descriptor_list_append(&cbfs_sections, list_node); + } + + return true; + } + + return false; +} + +cbfs_section_iterator_t cbfs_sections_iterator(void) +{ + return cbfs_sections.head; +} + +bool cbfs_sections_iterator_advance(cbfs_section_iterator_t *it) +{ + assert(it); + if (!*it) + return false; + + *it = (*it)->next; + return true; +} + +const struct flashmap_descriptor *cbfs_sections_iterator_deref( + cbfs_section_iterator_t it) +{ + assert(it); + return it->val; +} + +bool cbfs_sections_primary_cbfs_accounted_for(void) +{ + return seen_primary_section; +} + +void cbfs_sections_cleanup(void) +{ + for (struct descriptor_node *cur = cbfs_sections.head, *next = NULL; + cur; cur = next) { + next = cur->next; + free(cur); + } + cbfs_sections.head = NULL; + cbfs_sections.tail = NULL; +} diff --git a/util/cbfstool/cbfs_sections.h b/util/cbfstool/cbfs_sections.h new file mode 100644 index 0000000..5a23899 --- /dev/null +++ b/util/cbfstool/cbfs_sections.h @@ -0,0 +1,59 @@ +/* + * fmap_sections.h, track which sections of the image will contain CBFSes + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#ifndef CBFS_SECTIONS_H_ +#define CBFS_SECTIONS_H_ + +#include "fmd.h" + +#include <stdbool.h> + +#define SECTION_NAME_FMAP "FMAP" +#define SECTION_NAME_PRIMARY_CBFS "COREBOOT" + +#define SECTION_ANNOTATION_CBFS "CBFS" + +typedef const struct descriptor_node *cbfs_section_iterator_t; + +/** @return Iterator pointing to first CBFS section, or NULL if none exist */ +cbfs_section_iterator_t cbfs_sections_iterator(void); + +/** + * Advance iterator to point to the next CBFS section. + * If it was already pointing to the last such section, it will be set to NULL. + * + * @param it (Non-NULL) pointer to (possibly NULL) iterator to be updated + * @return Whether it was successfully advanced (wasn't already NULL) + */ +bool cbfs_sections_iterator_advance(cbfs_section_iterator_t *it); + +/** + * @param it Iterator, which must currently be non-NULL + * @return Section to which it points + */ +const struct flashmap_descriptor *cbfs_sections_iterator_deref( + cbfs_section_iterator_t it); + +/** @return Whether a section named SECTION_NAME_PRIMARY_CBFS is in the list. */ +bool cbfs_sections_primary_cbfs_accounted_for(void); + +/** Reclaim the space used to store knowledge of which sections are CBFSes. */ +void cbfs_sections_cleanup(void); + +#endif diff --git a/util/cbfstool/fmap_from_fmd.c b/util/cbfstool/fmap_from_fmd.c index fa1024b..2671743 100644 --- a/util/cbfstool/fmap_from_fmd.c +++ b/util/cbfstool/fmap_from_fmd.c @@ -28,9 +28,8 @@ static bool fmap_append_fmd_node(struct fmap **flashmap, const struct flashmap_descriptor *section, unsigned absolute_watermark) { if (strlen(section->name) >= FMAP_STRLEN) { - fprintf(stderr, - "ERROR: Section name ('%s') exceeds %d character FMAP format limit\n", - section->name, FMAP_STRLEN - 1); + ERROR("Section name ('%s') exceeds %d character FMAP format limit\n", + section->name, FMAP_STRLEN - 1); return false; } @@ -38,9 +37,8 @@ static bool fmap_append_fmd_node(struct fmap **flashmap, if (fmap_append_area(flashmap, absolute_watermark, section->size, (uint8_t *)section->name, 0) < 0) { - fprintf(stderr, - "ERROR: Failed to insert section '%s' into FMAP\n", - section->name); + ERROR("Failed to insert section '%s' into FMAP\n", + section->name); return false; } @@ -59,8 +57,7 @@ struct fmap *fmap_from_fmd(const struct flashmap_descriptor *desc) assert(desc->size_known); if (strlen(desc->name) >= FMAP_STRLEN) { - fprintf(stderr, - "ERROR: Image name ('%s') exceeds %d character FMAP header limit\n", + ERROR("Image name ('%s') exceeds %d character FMAP header limit\n", desc->name, FMAP_STRLEN - 1); return NULL; } @@ -68,7 +65,7 @@ struct fmap *fmap_from_fmd(const struct flashmap_descriptor *desc) struct fmap *fmap = fmap_create(desc->offset_known ? desc->offset : 0, desc->size, (uint8_t *)desc->name); if (!fmap) { - fputs("ERROR: Failed to allocate FMAP header\n", stderr); + ERROR("Failed to allocate FMAP header\n"); return fmap; } diff --git a/util/cbfstool/fmaptool.c b/util/cbfstool/fmaptool.c index 961e9dc..09b68d2 100644 --- a/util/cbfstool/fmaptool.c +++ b/util/cbfstool/fmaptool.c @@ -18,53 +18,149 @@ */ #include "common.h" +#include "cbfs_sections.h" #include "fmap_from_fmd.h" #include <stdio.h> #include <string.h> +#include <unistd.h> #define STDIN_FILENAME_SENTINEL "-" +#define HEADER_FMAP_OFFSET "FMAP_OFFSET" + enum fmaptool_return { FMAPTOOL_EXIT_SUCCESS = 0, FMAPTOOL_EXIT_BAD_ARGS, FMAPTOOL_EXIT_BAD_INPUT_PATH, FMAPTOOL_EXIT_BAD_OUTPUT_PATH, FMAPTOOL_EXIT_FAILED_DESCRIPTOR, + FMAPTOOL_EXIT_MISSING_FMAP_SECTION, + FMAPTOOL_EXIT_MISSING_PRIMARY_CBFS, FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION, FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE, - FMAPTOOL_EXIT_FAILED_WRITING_FILE, + FMAPTOOL_EXIT_FAILED_WRITING_OUTPUT, + FMAPTOOL_EXIT_FAILED_WRITING_HEADER, }; -bool fmd_process_annotation_impl(unused const struct flashmap_descriptor *node, - unused const char *annotation) +static void usage(const char *invoked_as) { - // We always accept annotations, but never act on them. + fputs("fmaptool: Compiler for fmd (flashmap descriptor) files\n", + stderr); + fputs("\nUSAGE:\n", stderr); + fprintf(stderr, + "\t%s [-h <header output file>] <fmd input file> <binary output file>\n", + invoked_as); + fputs("\nMANDATORY ARGUMENTS:\n", stderr); + fprintf(stderr, + "<fmd input file> may be '%s' to read from standard input\n", + STDIN_FILENAME_SENTINEL); + fputs("<binary output file> must be a regular file\n", stderr); + fputs("\nOPTIONAL SWITCHES:\n", stderr); + fprintf(stderr, + "-h\tAlso produce a C header defining %s to the FMAP section's flash offset.\n", + HEADER_FMAP_OFFSET); + fputs("\nOUTPUT:\n", stderr); + fputs("A successful invocation prints a summary of work done to standard error, and a comma-separated list\n", + stderr); + fputs("of those sections that contain CBFSes, starting with the primary such section, to standard output.\n", + stderr); +} + +static void list_cbfs_section_names(void) +{ + cbfs_section_iterator_t cbfs_it = cbfs_sections_iterator(); + assert(cbfs_it); + + bool subsequent = false; + while (cbfs_it) { + const char *cur_name = + cbfs_sections_iterator_deref(cbfs_it)->name; + if (cbfs_sections_iterator_advance(&cbfs_it) && subsequent) + putchar(','); + fputs(cur_name, stdout); + subsequent = true; + } + putchar('\n'); +} + +static bool write_header(const char *out_fname, + const struct flashmap_descriptor *root) +{ + assert(out_fname); + + FILE *header = fopen(out_fname, "w"); + if (!header) { + fprintf(stderr, "FATAL: Unable to open file '%s' for writing\n", + out_fname); + return false; + } + + unsigned fmap_offset = + fmd_calc_absolute_offset(root, SECTION_NAME_FMAP); + assert(fmap_offset != FMD_NOTFOUND); + + fputs("#ifndef FMAPTOOL_GENERATED_HEADER_H_\n", header); + fputs("#define FMAPTOOL_GENERATED_HEADER_H_\n\n", header); + fprintf(header, "#define %s %#x\n\n", HEADER_FMAP_OFFSET, fmap_offset); + fputs("#endif\n", header); + + fclose(header); return true; } +static void full_fmd_cleanup(struct flashmap_descriptor **victim) +{ + assert(victim); + + cbfs_sections_cleanup(); + fmd_cleanup(*victim); + *victim = NULL; +} + int main(int argc, char **argv) { - if (argc != 3) { - fputs("Convert a human-readable flashmap descriptor (fmd) file into the binary FMAP format for use in firmware images\n", - stderr); - fprintf(stderr, - "USAGE: %s <fmd input file> <binary output file>\n", - argv[0]); - fprintf(stderr, - "To read from standard input, provide '%s' as the input filename.\n", - STDIN_FILENAME_SENTINEL); + struct { + // Mandatory + const char *fmd_filename; + const char *fmap_filename; + + // Optional + const char *header_filename; + } args = {NULL, NULL, NULL}; + + bool show_usage = false; + int each_arg; + while (!show_usage && (each_arg = getopt(argc, argv, ":h:")) != -1) { + switch (each_arg) { + case 'h': + args.header_filename = optarg; + break; + case ':': + fprintf(stderr, "-%c: Expected an accompanying value\n", + optopt); + show_usage = true; + break; + default: + fprintf(stderr, "-%c: Unexpected command-line switch\n", + optopt); + show_usage = true; + } + } + + if (show_usage || argc - optind != 2) { + usage(argv[0]); return FMAPTOOL_EXIT_BAD_ARGS; } - const char *fmd_filename = argv[1]; - const char *fmap_filename = argv[2]; + args.fmd_filename = argv[optind]; + args.fmap_filename = argv[optind + 1]; FILE *fmd_file = stdin; - if (strcmp(fmd_filename, STDIN_FILENAME_SENTINEL) != 0) { - fmd_file = fopen(fmd_filename, "r"); + if (strcmp(args.fmd_filename, STDIN_FILENAME_SENTINEL) != 0) { + fmd_file = fopen(args.fmd_filename, "r"); if (!fmd_file) { fprintf(stderr, "FATAL: Unable to open file '%s'\n", - fmd_filename); + args.fmd_filename); return FMAPTOOL_EXIT_BAD_INPUT_PATH; } } @@ -74,14 +170,32 @@ int main(int argc, char **argv) if (!descriptor) { fputs("FATAL: Failed while processing provided descriptor\n", stderr); + full_fmd_cleanup(&descriptor); return FMAPTOOL_EXIT_FAILED_DESCRIPTOR; } + if (!fmd_find_node(descriptor, SECTION_NAME_FMAP)) { + fprintf(stderr, + "FATAL: Flashmap descriptor must have an '%s' section\n", + SECTION_NAME_FMAP); + full_fmd_cleanup(&descriptor); + return FMAPTOOL_EXIT_MISSING_FMAP_SECTION; + } + + if (!cbfs_sections_primary_cbfs_accounted_for()) { + fprintf(stderr, + "FATAL: Flashmap descriptor must have a '%s' section that is annotated with '(%s)'\n", + SECTION_NAME_PRIMARY_CBFS, + SECTION_ANNOTATION_CBFS); + full_fmd_cleanup(&descriptor); + return FMAPTOOL_EXIT_MISSING_PRIMARY_CBFS; + } + struct fmap *flashmap = fmap_from_fmd(descriptor); if (!flashmap) { fputs("FATAL: Failed while constructing FMAP section\n", stderr); - fmd_cleanup(descriptor); + full_fmd_cleanup(&descriptor); return FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION; } @@ -90,16 +204,16 @@ int main(int argc, char **argv) fputs("FATAL: Failed to determine FMAP section size\n", stderr); fmap_destroy(flashmap); - fmd_cleanup(descriptor); + full_fmd_cleanup(&descriptor); return FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE; } - FILE *fmap_file = fopen(fmap_filename, "wb"); + FILE *fmap_file = fopen(args.fmap_filename, "wb"); if (!fmap_file) { fprintf(stderr, "FATAL: Unable to open file '%s' for writing\n", - fmap_filename); + args.fmap_filename); fmap_destroy(flashmap); - fmd_cleanup(descriptor); + full_fmd_cleanup(&descriptor); return FMAPTOOL_EXIT_BAD_OUTPUT_PATH; } @@ -107,13 +221,24 @@ int main(int argc, char **argv) fputs("FATAL: Failed to write final FMAP to file\n", stderr); fclose(fmap_file); fmap_destroy(flashmap); - fmd_cleanup(descriptor); - return FMAPTOOL_EXIT_FAILED_WRITING_FILE; + full_fmd_cleanup(&descriptor); + return FMAPTOOL_EXIT_FAILED_WRITING_OUTPUT; } fclose(fmap_file); - printf("SUCCESS: Wrote %d bytes to file '%s'\n", size, fmap_filename); - fmap_destroy(flashmap); - fmd_cleanup(descriptor); + + if (args.header_filename && + !write_header(args.header_filename, descriptor)) { + full_fmd_cleanup(&descriptor); + return FMAPTOOL_EXIT_FAILED_WRITING_HEADER; + } + + fprintf(stderr, "SUCCESS: Wrote %d bytes to file '%s'%s\n", size, + args.fmap_filename, + args.header_filename ? " (and generated header)" : ""); + fputs("The sections containing CBFSes are: ", stderr); + list_cbfs_section_names(); + + full_fmd_cleanup(&descriptor); return FMAPTOOL_EXIT_SUCCESS; } diff --git a/util/cbfstool/fmd.c b/util/cbfstool/fmd.c index bfce049..a4430be 100644 --- a/util/cbfstool/fmd.c +++ b/util/cbfstool/fmd.c @@ -19,6 +19,7 @@ #include "fmd.h" +#include "common.h" #include "fmd_parser.h" #include "fmd_scanner.h" #include "option.h" @@ -56,8 +57,7 @@ static bool validate_descriptor_node(const struct flashmap_descriptor *node, ENTRY search_key = {node->name, NULL}; if (hsearch(search_key, FIND)) { - fprintf(stderr, "ERROR: Multiple sections with name '%s'\n", - node->name); + ERROR("Multiple sections with name '%s'\n", node->name); return false; } if (!hsearch(search_key, ENTER)) @@ -65,26 +65,22 @@ static bool validate_descriptor_node(const struct flashmap_descriptor *node, if (node->offset_known) { if (start.val_known && node->offset < start.val) { - fprintf(stderr, "ERROR: Section '%s' starts too low\n", - node->name); + ERROR("Section '%s' starts too low\n", node->name); return false; } else if (end.val_known && node->offset > end.val) { - fprintf(stderr, "ERROR: Section '%s' starts too high\n", - node->name); + ERROR("Section '%s' starts too high\n", node->name); return false; } } if (node->size_known) { if (node->size == 0) { - fprintf(stderr, "ERROR: Section '%s' given no space\n", - node->name); + ERROR("Section '%s' given no space\n", node->name); return false; } else if (node->offset_known) { unsigned node_end = node->offset + node->size; if (end.val_known && node_end > end.val) { - fprintf(stderr, "ERROR: Section '%s' too big\n", - node->name); + ERROR("Section '%s' too big\n", node->name); return false; } } @@ -120,16 +116,14 @@ static bool complete_missing_info_backward( assert(cur->offset_known || cur->size_known); if (!cur->offset_known) { if (cur->size > end_watermark) { - fprintf(stderr, "ERROR: Section '%s' too big\n", - cur->name); + ERROR("Section '%s' too big\n", cur->name); return false; } cur->offset_known = true; cur->offset = end_watermark -= cur->size; } else if (!cur->size_known) { if (cur->offset > end_watermark) { - fprintf(stderr, - "ERROR: Section '%s' starts too high\n", + ERROR("Section '%s' starts too high\n", cur->name); return false; } @@ -230,8 +224,7 @@ static bool validate_and_complete_info(struct flashmap_descriptor *cur_level) if (!cur_section->size_known) { if (!cur_section->offset_known) { - fprintf(stderr, - "ERROR: Cannot determine either offset or size of section '%s'\n", + ERROR("Cannot determine either offset or size of section '%s'\n", cur_section->name); return false; } else if (!first_incomplete_it) { @@ -315,7 +308,7 @@ struct flashmap_descriptor *fmd_create(FILE *stream) // This hash table is used to store the declared name of each // section and ensure that each is globally unique. if (!hcreate(fmd_count_nodes(ret))) { - perror("ERROR: While initializing hashtable"); + perror("E: While initializing hashtable"); fmd_cleanup(ret); return NULL; } diff --git a/util/cbfstool/fmd_parser.c b/util/cbfstool/fmd_parser.c index d97e743..d463393 100644 --- a/util/cbfstool/fmd_parser.c +++ b/util/cbfstool/fmd_parser.c @@ -65,12 +65,13 @@ #line 20 "fmd_parser.y" /* yacc.c:339 */ #include "fmd_scanner.h" +#include "common.h" #include <stdlib.h> struct flashmap_descriptor *res = NULL; -#line 74 "y.tab.c" /* yacc.c:339 */ +#line 75 "y.tab.c" /* yacc.c:339 */ # ifndef YY_NULLPTR # if defined __cplusplus && 201103L <= __cplusplus @@ -100,7 +101,7 @@ struct flashmap_descriptor *res = NULL; extern int yydebug; #endif /* "%code requires" blocks. */ -#line 36 "fmd_parser.y" /* yacc.c:355 */ +#line 37 "fmd_parser.y" /* yacc.c:355 */ #include "fmd.h" #include "option.h" @@ -125,7 +126,7 @@ struct flashmap_descriptor *parse_descriptor(char *name, struct descriptor_list children); void yyerror(const char *s); -#line 129 "y.tab.c" /* yacc.c:355 */ +#line 130 "y.tab.c" /* yacc.c:355 */ /* Token type. */ #ifndef YYTOKENTYPE @@ -147,7 +148,7 @@ void yyerror(const char *s); typedef union YYSTYPE YYSTYPE; union YYSTYPE { -#line 28 "fmd_parser.y" /* yacc.c:355 */ +#line 29 "fmd_parser.y" /* yacc.c:355 */ unsigned intval; char *strval; @@ -155,7 +156,7 @@ union YYSTYPE struct flashmap_descriptor *region_ptr; struct descriptor_list region_listhdr; -#line 159 "y.tab.c" /* yacc.c:355 */ +#line 160 "y.tab.c" /* yacc.c:355 */ }; # define YYSTYPE_IS_TRIVIAL 1 # define YYSTYPE_IS_DECLARED 1 @@ -170,7 +171,7 @@ int yyparse (void); /* Copy the second part of user declarations. */ -#line 174 "y.tab.c" /* yacc.c:358 */ +#line 175 "y.tab.c" /* yacc.c:358 */ #ifdef short # undef short @@ -468,8 +469,8 @@ static const yytype_uint8 yytranslate[] = /* YYRLINE[YYN] -- Source line where rule number YYN was defined. */ static const yytype_uint8 yyrline[] = { - 0, 79, 79, 84, 101, 108, 109, 110, 111, 112, - 113, 114, 115, 116, 118, 122, 123, 124, 135 + 0, 80, 80, 85, 102, 109, 110, 111, 112, 113, + 114, 115, 116, 117, 119, 123, 124, 125, 136 }; #endif @@ -1251,16 +1252,16 @@ yyreduce: switch (yyn) { case 2: -#line 80 "fmd_parser.y" /* yacc.c:1646 */ +#line 81 "fmd_parser.y" /* yacc.c:1646 */ { if (!(res = parse_descriptor((yyvsp[-3].strval), (yyvsp[-2].maybe_intval), (yyvsp[-1].maybe_intval), (yyvsp[0].region_listhdr)))) YYABORT; } -#line 1260 "y.tab.c" /* yacc.c:1646 */ +#line 1261 "y.tab.c" /* yacc.c:1646 */ break; case 3: -#line 86 "fmd_parser.y" /* yacc.c:1646 */ +#line 87 "fmd_parser.y" /* yacc.c:1646 */ { struct flashmap_descriptor *node = parse_descriptor((yyvsp[-4].strval), (yyvsp[-2].maybe_intval), (yyvsp[-1].maybe_intval), (yyvsp[0].region_listhdr)); if (!node) @@ -1268,7 +1269,7 @@ yyreduce: char *annotation = (yyvsp[-3].strval); if (annotation && !fmd_process_annotation_impl(node, annotation)) { - fprintf(stderr, "ERROR: Section '%s' has unexpected annotation '(%s)'\n", + ERROR("Section '%s' has unexpected annotation '(%s)'\n", node->name, annotation); YYABORT; } @@ -1276,92 +1277,92 @@ yyreduce: (yyval.region_ptr) = node; } -#line 1280 "y.tab.c" /* yacc.c:1646 */ +#line 1281 "y.tab.c" /* yacc.c:1646 */ break; case 4: -#line 102 "fmd_parser.y" /* yacc.c:1646 */ +#line 103 "fmd_parser.y" /* yacc.c:1646 */ { if (!(yyvsp[0].strval)) { - perror("ERROR: While allocating section name"); + perror("E: While allocating section name"); YYABORT; } } -#line 1291 "y.tab.c" /* yacc.c:1646 */ +#line 1292 "y.tab.c" /* yacc.c:1646 */ break; case 5: -#line 108 "fmd_parser.y" /* yacc.c:1646 */ +#line 109 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.strval) = NULL; } -#line 1297 "y.tab.c" /* yacc.c:1646 */ +#line 1298 "y.tab.c" /* yacc.c:1646 */ break; case 7: -#line 110 "fmd_parser.y" /* yacc.c:1646 */ +#line 111 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.strval) = (yyvsp[-1].strval); } -#line 1303 "y.tab.c" /* yacc.c:1646 */ +#line 1304 "y.tab.c" /* yacc.c:1646 */ break; case 8: -#line 111 "fmd_parser.y" /* yacc.c:1646 */ +#line 112 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.maybe_intval) = (struct unsigned_option){false, 0}; } -#line 1309 "y.tab.c" /* yacc.c:1646 */ +#line 1310 "y.tab.c" /* yacc.c:1646 */ break; case 10: -#line 113 "fmd_parser.y" /* yacc.c:1646 */ +#line 114 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.maybe_intval) = (struct unsigned_option){true, (yyvsp[0].intval)}; } -#line 1315 "y.tab.c" /* yacc.c:1646 */ +#line 1316 "y.tab.c" /* yacc.c:1646 */ break; case 11: -#line 114 "fmd_parser.y" /* yacc.c:1646 */ +#line 115 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.maybe_intval) = (struct unsigned_option){false, 0}; } -#line 1321 "y.tab.c" /* yacc.c:1646 */ +#line 1322 "y.tab.c" /* yacc.c:1646 */ break; case 13: -#line 116 "fmd_parser.y" /* yacc.c:1646 */ +#line 117 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.maybe_intval) = (struct unsigned_option){true, (yyvsp[0].intval)}; } -#line 1327 "y.tab.c" /* yacc.c:1646 */ +#line 1328 "y.tab.c" /* yacc.c:1646 */ break; case 14: -#line 118 "fmd_parser.y" /* yacc.c:1646 */ +#line 119 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.region_listhdr) = (struct descriptor_list) {.len = 0, .head = NULL, .tail = NULL}; } -#line 1336 "y.tab.c" /* yacc.c:1646 */ +#line 1337 "y.tab.c" /* yacc.c:1646 */ break; case 16: -#line 123 "fmd_parser.y" /* yacc.c:1646 */ +#line 124 "fmd_parser.y" /* yacc.c:1646 */ { (yyval.region_listhdr) = (yyvsp[-1].region_listhdr); } -#line 1342 "y.tab.c" /* yacc.c:1646 */ +#line 1343 "y.tab.c" /* yacc.c:1646 */ break; case 17: -#line 125 "fmd_parser.y" /* yacc.c:1646 */ +#line 126 "fmd_parser.y" /* yacc.c:1646 */ { struct descriptor_node *node = malloc(sizeof(*node)); if (!node) { - perror("ERROR: While allocating linked list node"); + perror("E: While allocating linked list node"); YYABORT; } node->val = (yyvsp[0].region_ptr); node->next = NULL; (yyval.region_listhdr) = (struct descriptor_list){.len = 1, .head = node, .tail = node}; } -#line 1357 "y.tab.c" /* yacc.c:1646 */ +#line 1358 "y.tab.c" /* yacc.c:1646 */ break; case 18: -#line 136 "fmd_parser.y" /* yacc.c:1646 */ +#line 137 "fmd_parser.y" /* yacc.c:1646 */ { struct descriptor_node *node = malloc(sizeof(*node)); if (!node) { - perror("ERROR: While allocating linked list node"); + perror("E: While allocating linked list node"); YYABORT; } node->val = (yyvsp[0].region_ptr); @@ -1371,11 +1372,11 @@ yyreduce: (yyval.region_listhdr) = (struct descriptor_list) {.len = (yyvsp[-1].region_listhdr).len + 1, .head = (yyvsp[-1].region_listhdr).head, .tail = node}; } -#line 1375 "y.tab.c" /* yacc.c:1646 */ +#line 1376 "y.tab.c" /* yacc.c:1646 */ break; -#line 1379 "y.tab.c" /* yacc.c:1646 */ +#line 1380 "y.tab.c" /* yacc.c:1646 */ default: break; } /* User semantic actions sometimes alter yychar, and that requires @@ -1603,7 +1604,7 @@ yyreturn: #endif return yyresult; } -#line 150 "fmd_parser.y" /* yacc.c:1906 */ +#line 151 "fmd_parser.y" /* yacc.c:1906 */ struct flashmap_descriptor *parse_descriptor(char *name, @@ -1612,7 +1613,7 @@ struct flashmap_descriptor *parse_descriptor(char *name, { struct flashmap_descriptor *region = malloc(sizeof(*region)); if (!region) { - perror("ERROR: While allocating descriptor section"); + perror("E: While allocating descriptor section"); return NULL; } region->name = name; @@ -1624,7 +1625,7 @@ struct flashmap_descriptor *parse_descriptor(char *name, if (region->list_len) { region->list = malloc(region->list_len * sizeof(*region->list)); if (!region->list) { - perror("ERROR: While allocating node children array"); + perror("E: While allocating node children array"); return NULL; } struct descriptor_node *cur_node = children.head; diff --git a/util/cbfstool/fmd_parser.h b/util/cbfstool/fmd_parser.h index 393a8ff..dc6301d 100644 --- a/util/cbfstool/fmd_parser.h +++ b/util/cbfstool/fmd_parser.h @@ -40,7 +40,7 @@ extern int yydebug; #endif /* "%code requires" blocks. */ -#line 36 "fmd_parser.y" /* yacc.c:1909 */ +#line 37 "fmd_parser.y" /* yacc.c:1909 */ #include "fmd.h" #include "option.h" @@ -87,7 +87,7 @@ void yyerror(const char *s); typedef union YYSTYPE YYSTYPE; union YYSTYPE { -#line 28 "fmd_parser.y" /* yacc.c:1909 */ +#line 29 "fmd_parser.y" /* yacc.c:1909 */ unsigned intval; char *strval; diff --git a/util/cbfstool/fmd_parser.y b/util/cbfstool/fmd_parser.y index 292fba3..2327ae4 100644 --- a/util/cbfstool/fmd_parser.y +++ b/util/cbfstool/fmd_parser.y @@ -19,6 +19,7 @@ %{ #include "fmd_scanner.h" +#include "common.h" #include <stdlib.h> @@ -90,7 +91,7 @@ flash_region: region_name region_annotation_opt region_offset_opt char *annotation = $2; if (annotation && !fmd_process_annotation_impl(node, annotation)) { - fprintf(stderr, "ERROR: Section '%s' has unexpected annotation '(%s)'\n", + ERROR("Section '%s' has unexpected annotation '(%s)'\n", node->name, annotation); YYABORT; } @@ -101,7 +102,7 @@ flash_region: region_name region_annotation_opt region_offset_opt region_name: STRING { if (!$1) { - perror("ERROR: While allocating section name"); + perror("E: While allocating section name"); YYABORT; } }; @@ -125,7 +126,7 @@ region_list_entries: flash_region { struct descriptor_node *node = malloc(sizeof(*node)); if (!node) { - perror("ERROR: While allocating linked list node"); + perror("E: While allocating linked list node"); YYABORT; } node->val = $1; @@ -136,7 +137,7 @@ region_list_entries: flash_region { struct descriptor_node *node = malloc(sizeof(*node)); if (!node) { - perror("ERROR: While allocating linked list node"); + perror("E: While allocating linked list node"); YYABORT; } node->val = $2; @@ -155,7 +156,7 @@ struct flashmap_descriptor *parse_descriptor(char *name, { struct flashmap_descriptor *region = malloc(sizeof(*region)); if (!region) { - perror("ERROR: While allocating descriptor section"); + perror("E: While allocating descriptor section"); return NULL; } region->name = name; @@ -167,7 +168,7 @@ struct flashmap_descriptor *parse_descriptor(char *name, if (region->list_len) { region->list = malloc(region->list_len * sizeof(*region->list)); if (!region->list) { - perror("ERROR: While allocating node children array"); + perror("E: While allocating node children array"); return NULL; } struct descriptor_node *cur_node = children.head;

1 0

Patch set updated for coreboot: 614b7e5 cbfstool: Import minimal set of files from flashmap
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9940 -gerrit commit 614b7e52877ede099e9637aa926ab16e60b5e41d Author: Sol Boucher <solb(a)chromium.org> Date: Fri Feb 27 17:07:30 2015 -0800 cbfstool: Import minimal set of files from flashmap flashmap was developed in a separate repository until now. Import the files from the 2012 version of the project [1]. [1] https://code.google.com/p/flashmap BUG=chromium:461875 TEST=None BRANCH=None Change-Id: Ida33f81509abc1cf2e532435adbbf31919d96bd8 Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Commit-Id: f44e1d1864babe244f07ca49655f0b80b84e890d Original-Change-Id: Ibf191d34df738449c9b9d7ebccca3d7f4150d4d3 Original-Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Reviewed-on: https://chromium-review.googlesource.com/254801 Original-Reviewed-by: Julius Werner <jwerner(a)chromium.org> --- util/cbfstool/flashmap/fmap.c | 727 +++++++++++++++++++++++++++++++++++++++ util/cbfstool/flashmap/fmap.h | 192 +++++++++++ util/cbfstool/flashmap/kv_pair.c | 242 +++++++++++++ util/cbfstool/flashmap/kv_pair.h | 153 ++++++++ util/cbfstool/flashmap/valstr.c | 65 ++++ util/cbfstool/flashmap/valstr.h | 78 +++++ 6 files changed, 1457 insertions(+) diff --git a/util/cbfstool/flashmap/fmap.c b/util/cbfstool/flashmap/fmap.c new file mode 100644 index 0000000..8850a92 --- /dev/null +++ b/util/cbfstool/flashmap/fmap.c @@ -0,0 +1,727 @@ +/* Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Alternatively, this software may be distributed under the terms of the + * GNU General Public License ("GPL") version 2 as published by the Free + * Software Foundation. + */ + +#include <stdlib.h> +#include <stdio.h> +#include <string.h> +#include <fcntl.h> +#include <unistd.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <sys/mman.h> +#include <errno.h> +#include <inttypes.h> +#include <limits.h> +#include <assert.h> + +#include <fmap.h> +#include <valstr.h> + +#include "kv_pair.h" +#include "mincrypt/sha.h" + +#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) + +const struct valstr flag_lut[] = { + { FMAP_AREA_STATIC, "static" }, + { FMAP_AREA_COMPRESSED, "compressed" }, + { FMAP_AREA_RO, "ro" }, +}; + +/* returns size of fmap data structure if successful, <0 to indicate error */ +int fmap_size(struct fmap *fmap) +{ + if (!fmap) + return -1; + + return sizeof(*fmap) + (fmap->nareas * sizeof(struct fmap_area)); +} + +/* brute force linear search */ +static long int fmap_lsearch(const uint8_t *image, size_t len) +{ + long int offset; + int fmap_found = 0; + + for (offset = 0; offset < len - strlen(FMAP_SIGNATURE); offset++) { + if (!memcmp(&image[offset], + FMAP_SIGNATURE, + strlen(FMAP_SIGNATURE))) { + fmap_found = 1; + break; + } + } + + if (!fmap_found) + return -1; + + if (offset + fmap_size((struct fmap *)&image[offset]) > len) + return -1; + + return offset; +} + +/* if image length is a power of 2, use binary search */ +static long int fmap_bsearch(const uint8_t *image, size_t len) +{ + long int offset = -1; + int fmap_found = 0, stride; + + /* + * For efficient operation, we start with the largest stride possible + * and then decrease the stride on each iteration. Also, check for a + * remainder when modding the offset with the previous stride. This + * makes it so that each offset is only checked once. + */ + for (stride = len / 2; stride >= 1; stride /= 2) { + if (fmap_found) + break; + + for (offset = 0; + offset < len - strlen(FMAP_SIGNATURE); + offset += stride) { + if ((offset % (stride * 2) == 0) && (offset != 0)) + continue; + if (!memcmp(&image[offset], + FMAP_SIGNATURE, + strlen(FMAP_SIGNATURE))) { + fmap_found = 1; + break; + } + } + } + + if (!fmap_found) + return -1; + + if (offset + fmap_size((struct fmap *)&image[offset]) > len) + return -1; + + return offset; +} + +static int popcnt(unsigned int u) +{ + int count; + + /* K&R method */ + for (count = 0; u; count++) + u &= (u - 1); + + return count; +} + +long int fmap_find(const uint8_t *image, unsigned int image_len) +{ + long int ret = -1; + + if ((image == NULL) || (image_len == 0)) + return -1; + + if (popcnt(image_len) == 1) + ret = fmap_bsearch(image, image_len); + else + ret = fmap_lsearch(image, image_len); + + return ret; +} + +int fmap_print(const struct fmap *fmap) +{ + int i; + struct kv_pair *kv = NULL; + const uint8_t *tmp; + + kv = kv_pair_new(); + if (!kv) + return -1; + + tmp = fmap->signature; + kv_pair_fmt(kv, "fmap_signature", + "0x%02x%02x%02x%02x%02x%02x%02x%02x", + tmp[0], tmp[1], tmp[2], tmp[3], + tmp[4], tmp[5], tmp[6], tmp[7]); + kv_pair_fmt(kv, "fmap_ver_major", "%d", fmap->ver_major); + kv_pair_fmt(kv, "fmap_ver_minor","%d", fmap->ver_minor); + kv_pair_fmt(kv, "fmap_base", "0x%016llx", + (unsigned long long)fmap->base); + kv_pair_fmt(kv, "fmap_size", "0x%04x", fmap->size); + kv_pair_fmt(kv, "fmap_name", "%s", fmap->name); + kv_pair_fmt(kv, "fmap_nareas", "%d", fmap->nareas); + kv_pair_print(kv); + kv_pair_free(kv); + + for (i = 0; i < fmap->nareas; i++) { + struct kv_pair *kv; + uint16_t flags; + char *str; + + kv = kv_pair_new(); + if (!kv) + return -1; + + kv_pair_fmt(kv, "area_offset", "0x%08x", + fmap->areas[i].offset); + kv_pair_fmt(kv, "area_size", "0x%08x", + fmap->areas[i].size); + kv_pair_fmt(kv, "area_name", "%s", + fmap->areas[i].name); + kv_pair_fmt(kv, "area_flags_raw", "0x%02x", + fmap->areas[i].flags); + + /* Print descriptive strings for flags rather than the field */ + flags = fmap->areas[i].flags; + if ((str = fmap_flags_to_string(flags)) == NULL) + return -1; + kv_pair_fmt(kv, "area_flags", "%s", str ); + free(str); + + kv_pair_print(kv); + kv_pair_free(kv); + } + + return 0; +} + +/* get SHA1 sum of all static regions described by the flashmap and copy into + *digest (which will be allocated and must be freed by the caller), */ +int fmap_get_csum(const uint8_t *image, unsigned int image_len, uint8_t **digest) +{ + int i; + struct fmap *fmap; + int fmap_offset; + SHA_CTX ctx; + + if ((image == NULL)) + return -1; + + if ((fmap_offset = fmap_find(image, image_len)) < 0) + return -1; + fmap = (struct fmap *)(image + fmap_offset); + + SHA_init(&ctx); + + /* Iterate through flash map and calculate the checksum piece-wise. */ + for (i = 0; i < fmap->nareas; i++) { + /* skip non-static areas */ + if (!(fmap->areas[i].flags & FMAP_AREA_STATIC)) + continue; + + /* sanity check the offset */ + if (fmap->areas[i].size + fmap->areas[i].offset > image_len) { + fprintf(stderr, + "(%s) invalid parameter detected in area %d\n", + __func__, i); + return -1; + } + + SHA_update(&ctx, + image + fmap->areas[i].offset, + fmap->areas[i].size); + } + + SHA_final(&ctx); + *digest = malloc(SHA_DIGEST_SIZE); + memcpy(*digest, ctx.buf, SHA_DIGEST_SIZE); + + return SHA_DIGEST_SIZE; +} + +/* convert raw flags field to user-friendly string */ +char *fmap_flags_to_string(uint16_t flags) +{ + char *str = NULL; + int i, total_size; + + str = malloc(1); + str[0] = '\0'; + total_size = 1; + + for (i = 0; i < sizeof(flags) * CHAR_BIT; i++) { + if (!flags) + break; + + if (flags & (1 << i)) { + const char *tmp = val2str(1 << i, flag_lut); + + total_size += strlen(tmp); + str = realloc(str, total_size); + strcat(str, tmp); + + flags &= ~(1 << i); + if (flags) { + total_size++; + str = realloc(str, total_size); + strcat(str, ","); + } + } + } + + return str; +} + +/* allocate and initialize a new fmap structure */ +struct fmap *fmap_create(uint64_t base, uint32_t size, uint8_t *name) +{ + struct fmap *fmap; + + fmap = malloc(sizeof(*fmap)); + if (!fmap) + return NULL; + + memset(fmap, 0, sizeof(*fmap)); + memcpy(&fmap->signature, FMAP_SIGNATURE, strlen(FMAP_SIGNATURE)); + fmap->ver_major = VERSION_MAJOR; + fmap->ver_minor = VERSION_MINOR; + fmap->base = base; + fmap->size = size; + memccpy(&fmap->name, name, '\0', FMAP_STRLEN); + + return fmap; +} + +/* free memory used by an fmap structure */ +void fmap_destroy(struct fmap *fmap) { + free(fmap); +} + +/* append area to existing structure, return new total size if successful */ +int fmap_append_area(struct fmap **fmap, + uint32_t offset, uint32_t size, + const uint8_t *name, uint16_t flags) +{ + struct fmap_area *area; + int orig_size, new_size; + + if ((fmap == NULL || *fmap == NULL) || (name == NULL)) + return -1; + + /* too many areas */ + if ((*fmap)->nareas >= 0xffff) + return -1; + + orig_size = fmap_size(*fmap); + new_size = orig_size + sizeof(*area); + + *fmap = realloc(*fmap, new_size); + if (*fmap == NULL) + return -1; + + area = (struct fmap_area *)((uint8_t *)*fmap + orig_size); + memset(area, 0, sizeof(*area)); + memcpy(&area->offset, &offset, sizeof(area->offset)); + memcpy(&area->size, &size, sizeof(area->size)); + memccpy(&area->name, name, '\0', FMAP_STRLEN); + memcpy(&area->flags, &flags, sizeof(area->flags)); + + (*fmap)->nareas++; + return new_size; +} + +struct fmap_area *fmap_find_area(struct fmap *fmap, const char *name) +{ + int i; + struct fmap_area *area = NULL; + + if (!fmap || !name) + return NULL; + + for (i = 0; i < fmap->nareas; i++) { + if (!strcmp((const char *)fmap->areas[i].name, name)) { + area = &fmap->areas[i]; + break; + } + } + + return area; +} + +/* + * LCOV_EXCL_START + * Unit testing stuff done here so we do not need to expose static functions. + */ +static enum test_status { pass = EXIT_SUCCESS, fail = EXIT_FAILURE } status; +static struct fmap *fmap_create_test(void) +{ + struct fmap *fmap; + uint64_t base = 0; + uint32_t size = 0x100000; + char name[] = "test_fmap"; + + status = fail; + + fmap = fmap_create(base, size, (uint8_t *)name); + if (!fmap) + return NULL; + + if (memcmp(&fmap->signature, FMAP_SIGNATURE, strlen(FMAP_SIGNATURE))) { + printf("FAILURE: signature is incorrect\n"); + goto fmap_create_test_exit; + } + + if ((fmap->ver_major != VERSION_MAJOR) || + (fmap->ver_minor != VERSION_MINOR)) { + printf("FAILURE: version is incorrect\n"); + goto fmap_create_test_exit; + } + + if (fmap->base != base) { + printf("FAILURE: base is incorrect\n"); + goto fmap_create_test_exit; + } + + if (fmap->size != 0x100000) { + printf("FAILURE: size is incorrect\n"); + goto fmap_create_test_exit; + } + + if (strcmp((char *)fmap->name, "test_fmap")) { + printf("FAILURE: name is incorrect\n"); + goto fmap_create_test_exit; + } + + if (fmap->nareas != 0) { + printf("FAILURE: number of areas is incorrect\n"); + goto fmap_create_test_exit; + } + + status = pass; +fmap_create_test_exit: + /* preserve fmap if all went well */ + if (status == fail) { + fmap_destroy(fmap); + fmap = NULL; + } + return fmap; +} + +static int fmap_print_test(struct fmap *fmap) +{ + return fmap_print(fmap); +} + +static int fmap_get_csum_test(struct fmap *fmap) +{ + uint8_t *digest = NULL, *image = NULL; + /* assume 0x100-0x10100 is marked "static" and is filled with 0x00 */ + int image_size = 0x20000; + uint8_t csum[SHA_DIGEST_SIZE] = { + 0x1a, 0xdc, 0x95, 0xbe, 0xbe, 0x9e, 0xea, 0x8c, + 0x11, 0x2d, 0x40, 0xcd, 0x04, 0xab, 0x7a, 0x8d, + 0x75, 0xc4, 0xf9, 0x61 }; + + status = fail; + + if ((fmap_get_csum(NULL, image_size, &digest) >= 0) || + (fmap_get_csum(image, image_size, NULL) >= 0)) { + printf("failed to abort on NULL pointer input\n"); + goto fmap_get_csum_test_exit; + } + + image = calloc(image_size, 1); + memcpy(image, fmap, fmap_size(fmap)); + + if (fmap_get_csum(image, image_size, &digest) != SHA_DIGEST_SIZE) { + printf("FAILURE: failed to calculate checksum\n"); + goto fmap_get_csum_test_exit; + } + if (memcmp(digest, csum, SHA_DIGEST_SIZE)) { + printf("FAILURE: checksum is incorrect\n"); + goto fmap_get_csum_test_exit; + } + + status = pass; +fmap_get_csum_test_exit: + free(image); + free(digest); + return status; +} + +static int fmap_size_test(struct fmap *fmap) +{ + status = fail; + + if (fmap_size(NULL) >= 0) { + printf("FAILURE: failed to abort on NULL pointer input\n"); + goto fmap_size_test_exit; + } + + status = pass; +fmap_size_test_exit: + return status; +} + +/* this test re-allocates the fmap, so it gets a double-pointer */ +static int fmap_append_area_test(struct fmap **fmap) +{ + int total_size; + uint16_t nareas_orig; + /* test_area will be used by fmap_csum_test and find_area_test */ + struct fmap_area test_area = { + .offset = 0x400, + .size = 0x10000, + .name = "test_area_1", + .flags = FMAP_AREA_STATIC, + }; + + status = fail; + + if ((fmap_append_area(NULL, 0, 0, test_area.name, 0) >= 0) || + (fmap_append_area(fmap, 0, 0, NULL, 0) >= 0)) { + printf("FAILURE: failed to abort on NULL pointer input\n"); + goto fmap_append_area_test_exit; + } + + nareas_orig = (*fmap)->nareas; + (*fmap)->nareas = ~(0); + if (fmap_append_area(fmap, 0, 0, (const uint8_t *)"foo", 0) >= 0) { + printf("FAILURE: failed to abort with too many areas\n"); + goto fmap_append_area_test_exit; + } + (*fmap)->nareas = nareas_orig; + + total_size = sizeof(**fmap) + sizeof(test_area); + if (fmap_append_area(fmap, + test_area.offset, + test_area.size, + test_area.name, + test_area.flags + ) != total_size) { + printf("failed to append area\n"); + goto fmap_append_area_test_exit; + } + + if ((*fmap)->nareas != 1) { + printf("FAILURE: failed to increment number of areas\n"); + goto fmap_append_area_test_exit; + } + + status = pass; +fmap_append_area_test_exit: + return status; +} + +static int fmap_find_area_test(struct fmap *fmap) +{ + status = fail; + char area_name[] = "test_area_1"; + + if (fmap_find_area(NULL, area_name) || + fmap_find_area(fmap, NULL)) { + printf("FAILURE: failed to abort on NULL pointer input\n"); + goto fmap_find_area_test_exit; + } + + if (fmap_find_area(fmap, area_name) == NULL) { + printf("FAILURE: failed to find \"%s\"\n", area_name); + goto fmap_find_area_test_exit; + } + + status = pass; +fmap_find_area_test_exit: + return status; +} + +static int fmap_flags_to_string_test() +{ + char *str, *my_str; + int i; + uint16_t flags; + + status = fail; + + /* no area flag */ + str = fmap_flags_to_string(0); + if (!str || strcmp(str, "")) { + printf("FAILURE: failed to return empty string when no flag" + "are set"); + goto fmap_flags_to_string_test_exit; + } + free(str); + + /* single area flags */ + for (i = 0; i < ARRAY_SIZE(flag_lut); i++) { + if (!flag_lut[i].str) + continue; + + if ((str = fmap_flags_to_string(flag_lut[i].val)) == NULL) { + printf("FAILURE: failed to translate flag to string"); + goto fmap_flags_to_string_test_exit; + } + free(str); + } + + /* construct our own flags field and string using all available flags + * and compare output with fmap_flags_to_string() */ + my_str = calloc(256, 1); + flags = 0; + for (i = 0; i < ARRAY_SIZE(flag_lut); i++) { + if (!flag_lut[i].str) + continue; + else if (i > 0) + strcat(my_str, ","); + + flags |= flag_lut[i].val; + strcat(my_str, flag_lut[i].str); + } + + str = fmap_flags_to_string(flags); + if (strcmp(str, my_str)) { + printf("FAILURE: bad result from fmap_flags_to_string\n"); + goto fmap_flags_to_string_test_exit; + } + free(my_str); + free(str); + + status = pass; +fmap_flags_to_string_test_exit: + return status; + +} + +static int fmap_find_test(struct fmap *fmap) +{ + uint8_t *buf; + size_t total_size, offset; + + status = fail; + + /* + * Note: In these tests, we'll use fmap_find() and control usage of + * lsearch and bsearch by using a power-of-2 total_size. For lsearch, + * use total_size - 1. For bsearch, use total_size. + */ + + total_size = 0x100000; + buf = calloc(total_size, 1); + + /* test if image length is zero */ + if (fmap_find(buf, 0) >= 0) { + printf("FAILURE: failed to abort on zero-length image\n"); + goto fmap_find_test_exit; + } + + /* test if no fmap exists */ + if (fmap_find(buf, total_size - 1) >= 0) { + printf("FAILURE: lsearch returned false positive\n"); + goto fmap_find_test_exit; + } + if (fmap_find(buf, total_size) >= 0) { + printf("FAILURE: bsearch returned false positive\n"); + goto fmap_find_test_exit; + } + + /* simple test case: fmap at (total_size / 2) + 1 */ + offset = (total_size / 2) + 1; + memcpy(&buf[offset], fmap, fmap_size(fmap)); + + if (fmap_find(buf, total_size - 1) != offset) { + printf("FAILURE: lsearch failed to find fmap\n"); + goto fmap_find_test_exit; + } + if (fmap_find(buf, total_size) != offset) { + printf("FAILURE: bsearch failed to find fmap\n"); + goto fmap_find_test_exit; + } + + /* test bsearch if offset is at 0 */ + offset = 0; + memset(buf, 0, total_size); + memcpy(buf, fmap, fmap_size(fmap)); + if (fmap_find(buf, total_size) != offset) { + printf("FAILURE: bsearch failed to find fmap at offset 0\n"); + goto fmap_find_test_exit; + } + + /* test overrun detection */ + memset(buf, 0, total_size); + memcpy(&buf[total_size - fmap_size(fmap) + 1], + fmap, + fmap_size(fmap) + 1); + if (fmap_find(buf, total_size - 1) >= 0) { + printf("FAILURE: lsearch failed to catch overrun\n"); + goto fmap_find_test_exit; + } + if (fmap_find(buf, total_size) >= 0) { + printf("FAILURE: bsearch failed to catch overrun\n"); + goto fmap_find_test_exit; + } + + status = pass; +fmap_find_test_exit: + free(buf); + return status; +} + +int fmap_test() +{ + int rc = EXIT_SUCCESS; + struct fmap *my_fmap; + + /* + * This test has two parts: Creation of an fmap with one or more + * area(s), and other stuff. Since a valid fmap is required to run + * many tests, we abort if fmap creation fails in any way. + * + * Also, fmap_csum_test() makes some assumptions based on the areas + * appended. See fmap_append_area_test() for details. + */ + if ((my_fmap = fmap_create_test()) == NULL) { + rc = EXIT_FAILURE; + goto fmap_test_exit; + } + + if (fmap_find_test(my_fmap)) { + rc = EXIT_FAILURE; + goto fmap_test_exit; + } + + if (fmap_append_area_test(&my_fmap)) { + rc = EXIT_FAILURE; + goto fmap_test_exit; + } + + rc |= fmap_find_area_test(my_fmap); + rc |= fmap_get_csum_test(my_fmap); + rc |= fmap_size_test(my_fmap); + rc |= fmap_flags_to_string_test(); + rc |= fmap_print_test(my_fmap); + +fmap_test_exit: + fmap_destroy(my_fmap); + if (rc) + printf("FAILED\n"); + return rc; +} +/* LCOV_EXCL_STOP */ diff --git a/util/cbfstool/flashmap/fmap.h b/util/cbfstool/flashmap/fmap.h new file mode 100644 index 0000000..9cea22d --- /dev/null +++ b/util/cbfstool/flashmap/fmap.h @@ -0,0 +1,192 @@ +/* + * Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Alternatively, this software may be distributed under the terms of the + * GNU General Public License ("GPL") version 2 as published by the Free + * Software Foundation. + */ + +#ifndef FLASHMAP_LIB_FMAP_H__ +#define FLASHMAP_LIB_FMAP_H__ + +#include <inttypes.h> + +#include <valstr.h> + +#define FMAP_SIGNATURE "__FMAP__" +#define FMAP_VER_MAJOR 1 /* this header's FMAP minor version */ +#define FMAP_VER_MINOR 1 /* this header's FMAP minor version */ +#define FMAP_STRLEN 32 /* maximum length for strings, */ + /* including null-terminator */ +extern const struct valstr flag_lut[16]; +enum fmap_flags { + FMAP_AREA_STATIC = 1 << 0, + FMAP_AREA_COMPRESSED = 1 << 1, + FMAP_AREA_RO = 1 << 2, +}; + +/* Mapping of volatile and static regions in firmware binary */ +struct fmap_area { + uint32_t offset; /* offset relative to base */ + uint32_t size; /* size in bytes */ + uint8_t name[FMAP_STRLEN]; /* descriptive name */ + uint16_t flags; /* flags for this area */ +} __attribute__((packed)); + +struct fmap { + uint8_t signature[8]; /* "__FMAP__" (0x5F5F464D41505F5F) */ + uint8_t ver_major; /* major version */ + uint8_t ver_minor; /* minor version */ + uint64_t base; /* address of the firmware binary */ + uint32_t size; /* size of firmware binary in bytes */ + uint8_t name[FMAP_STRLEN]; /* name of this firmware binary */ + uint16_t nareas; /* number of areas described by + fmap_areas[] below */ + struct fmap_area areas[]; +} __attribute__((packed)); + +/* + * fmap_find - find FMAP signature in a binary image + * + * @image: binary image + * @len: length of binary image + * + * This function does no error checking. The caller is responsible for + * verifying that the contents are sane. + * + * returns offset of FMAP signature to indicate success + * returns <0 to indicate failure + */ +extern long int fmap_find(const uint8_t *image, unsigned int len); + +/* + * fmap_print - Print contents of flash map data structure + * + * @map: raw map data + * + * returns 0 to indiciate success + * returns <0 to indicate failure + */ +extern int fmap_print(const struct fmap *map); + +/* + * fmap_get_csum - get the checksum of static regions of an image + * + * @image: image to checksum + * @len: length of image + * @digest: double-pointer to store location of first byte of digest + * + * fmap_get_csum() will reset, write, and finalize the digest. + * The location of the final digest will start at the location pointed to + * by digest, which will be allocated and must be freed by the caller. + * + * returns digest length if successful + * returns <0 to indicate error + */ +extern int fmap_get_csum(const uint8_t *image, + unsigned int image_len, uint8_t **digest); + + +/* + * fmap_flags_to_string - convert raw flags field into user-friendly string + * + * @flags: raw flags + * + * This function returns a user-friendly comma-separated list of fmap area + * flags. If there are no flags (flags == 0), the string will contain only + * a terminating character ('\0') + * + * This function allocates memory which the caller must free. + * + * returns pointer to an allocated string if successful + * returns NULL to indicate failure + */ +char *fmap_flags_to_string(uint16_t flags); + +/* + * fmap_create - allocate and initialize a new fmap structure + * + * @base: base address of firmware within address space + * @size: size of the firmware (bytes) + * @name: name of firmware + * + * This function will allocate a flashmap header. Members of the structure + * which are not passed in are automatically initialized. + * + * returns pointer to newly allocated flashmap header if successful + * returns NULL to indicate failure + */ +extern struct fmap *fmap_create(uint64_t base, + uint32_t size, uint8_t *name); + +/* free memory used by an fmap structure */ +extern void fmap_destroy(struct fmap *fmap); + +/* + * fmap_size - returns size of fmap data structure (including areas) + * + * @fmap: fmap + * + * returns size of fmap structure if successful + * returns <0 to indicate failure + */ +extern int fmap_size(struct fmap *fmap); + +/* + * fmap_append_area - realloc an existing flashmap and append an area + * + * @fmap: double pointer to existing flashmap + * @offset: offset of area + * @size: size of area + * @name: name of area + * @flags: area flags + * + * returns total size of reallocated flashmap structure if successful + * returns <0 to indicate failure + */ +extern int fmap_append_area(struct fmap **fmap, + uint32_t offset, uint32_t size, + const uint8_t *name, uint16_t flags); + +/* + * fmap_find_area - find an fmap_area entry (by name) and return pointer to it + * + * @fmap: fmap structure to parse + * @name: name of area to find + * + * returns a pointer to the entry in the fmap structure if successful + * returns NULL to indicate failure or if no matching area entry is found + */ +extern struct fmap_area *fmap_find_area(struct fmap *fmap, const char *name); + +/* unit testing stuff */ +extern int fmap_test(); + +#endif /* FLASHMAP_LIB_FMAP_H__*/ diff --git a/util/cbfstool/flashmap/kv_pair.c b/util/cbfstool/flashmap/kv_pair.c new file mode 100644 index 0000000..2572c64 --- /dev/null +++ b/util/cbfstool/flashmap/kv_pair.c @@ -0,0 +1,242 @@ +/* + * Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Alternatively, this software may be distributed under the terms of the + * GNU General Public License ("GPL") version 2 as published by the Free + * Software Foundation. + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdarg.h> + +#include "kv_pair.h" + +/* Internal variable for output style. Use accessors to get/set style. */ +static enum kv_pair_style _style; + +void kv_pair_set_style(enum kv_pair_style style) +{ + _style = style; +} + +enum kv_pair_style kv_pair_get_style() +{ + return _style; +} + +struct kv_pair *kv_pair_new(void) +{ + struct kv_pair *kv; + + kv = calloc(0, sizeof(*kv)); + if (!kv) + return NULL; + + return kv; +} + +struct kv_pair **kv_pair_new_array(size_t size) +{ + struct kv_pair **kv; + size_t i; + + kv = (struct kv_pair **) calloc(0, sizeof(kv) * size); + for (i = 0; i < size; ++i) { + kv[i] = kv_pair_new(); + } + return kv; +} + +struct kv_pair *kv_pair_add(struct kv_pair *kv_list, + const char *key, const char *value) +{ + struct kv_pair *kv_new; + struct kv_pair *kv_ptr; + + kv_new = kv_pair_new(); + if (!kv_new) + return NULL; + + /* save key=value strings if provided */ + if (key) { + kv_new->key = strdup(key); + if (!kv_new->key) + goto kv_pair_add_failed; + } + if (value) { + kv_new->value = strdup(value); + if (!kv_new->value) + goto kv_pair_add_failed; + } + + /* first in the list if no list provided */ + if (kv_list) { + /* find the end of list */ + for (kv_ptr = kv_list; kv_ptr->next != NULL; + kv_ptr = kv_ptr->next) + ; + + /* link in the new pair at the end */ + kv_ptr->next = kv_new; + } + + /* return pointer to the new pair */ + return kv_new; + +kv_pair_add_failed: + kv_pair_free(kv_new); + return NULL; +} + +struct kv_pair *kv_pair_add_bool(struct kv_pair *kv_list, + const char *key, int value) +{ + const char *str; + + if (value) { + str = "yes"; + } else { + str = "no"; + } + return kv_pair_add(kv_list, key, str); +} + +struct kv_pair *kv_pair_fmt(struct kv_pair *kv_list, + const char *kv_key, const char *format, ...) +{ + char kv_value[KV_PAIR_MAX_VALUE_LEN]; + va_list vptr; + + memset(kv_value, 0, sizeof(kv_value)); + + va_start(vptr, format); + vsnprintf(kv_value, sizeof(kv_value), format, vptr); + va_end(vptr); + + return kv_pair_add(kv_list, kv_key, kv_value); +} + +void kv_pair_free(struct kv_pair *kv_list) +{ + struct kv_pair *kv_ptr = kv_list; + struct kv_pair *kv_next; + + while (kv_ptr != NULL) { + /* free key/value strings */ + if (kv_ptr->key) + free(kv_ptr->key); + if (kv_ptr->value) + free(kv_ptr->value); + + /* free current pair move to next */ + kv_next = kv_ptr->next; + free(kv_ptr); + kv_ptr = kv_next; + } +} + +void kv_pair_free_array(struct kv_pair **kv_array, size_t size) +{ + size_t i; + for (i = 0; i < size; ++i) { + kv_pair_free(kv_array[i]); + } + free(kv_array); +} + +void kv_pair_print_to_file(FILE* fp, struct kv_pair *kv_list, + enum kv_pair_style style) +{ + struct kv_pair *kv_ptr; + + switch (style) { + case KV_STYLE_PAIR: + for (kv_ptr = kv_list; kv_ptr != NULL; kv_ptr = kv_ptr->next) { + if (kv_ptr->key && kv_ptr->value) { + fprintf(fp, "%s=\"%s\" ", + kv_ptr->key, kv_ptr->value); + } + } + break; + + case KV_STYLE_VALUE: + for (kv_ptr = kv_list; kv_ptr != NULL; kv_ptr = kv_ptr->next) { + if (kv_ptr->value) { + fprintf(fp, "%s", kv_ptr->value); + if (kv_ptr->next) + fprintf(fp, " | "); + } + } + break; + + case KV_STYLE_LONG: + for (kv_ptr = kv_list; kv_ptr != NULL; kv_ptr = kv_ptr->next) { + if (kv_ptr->key && kv_ptr->value) + fprintf(fp, "%-20s | %s\n", + kv_ptr->key, kv_ptr->value); + } + break; + } + + fprintf(fp, "\n"); +} + +void kv_pair_print(struct kv_pair *kv_list) +{ + kv_pair_print_to_file(stdout, kv_list, kv_pair_get_style()); +} + +const char *kv_pair_get_value(struct kv_pair *kv_list, const char *kv_key) +{ + const char *kv_value = NULL; + struct kv_pair *kv_ptr; + + for (kv_ptr = kv_list; kv_ptr != NULL; kv_ptr = kv_ptr->next) { + if (kv_ptr->key && strcmp(kv_ptr->key, kv_key) == 0) { + kv_value = kv_ptr->value; + break; + } + } + return kv_value; +} + +int kv_pair_size(struct kv_pair *kv_list) { + struct kv_pair *kv_ptr; + int count; + + count = 0; + for (kv_ptr = kv_list; kv_ptr != NULL; kv_ptr = kv_ptr->next) { + if (kv_ptr->key) { + count++; + } + } + return count; +} diff --git a/util/cbfstool/flashmap/kv_pair.h b/util/cbfstool/flashmap/kv_pair.h new file mode 100644 index 0000000..b573530 --- /dev/null +++ b/util/cbfstool/flashmap/kv_pair.h @@ -0,0 +1,153 @@ +/* + * Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Alternatively, this software may be distributed under the terms of the + * GNU General Public License ("GPL") version 2 as published by the Free + * Software Foundation. + */ + +#ifndef FLASHMAP_LIB_KV_PAIR_H__ +#define FLASHMAP_LIB_KV_PAIR_H__ + +#include <stdio.h> +#include <inttypes.h> +#include <string.h> + +/* key=value string pair list */ +#define KV_PAIR_MAX_VALUE_LEN 1024 + +enum kv_pair_style { + KV_STYLE_PAIR, /* key1="value1" key2="value2" */ + KV_STYLE_VALUE, /* | value1 | value2 | */ + KV_STYLE_LONG, /* key1 | value1 */ + /* key2 | value2 */ +}; + +struct kv_pair { + char *key; + char *value; + struct kv_pair *next; +}; + +extern enum kv_pair_style kv_pair_get_style(); + +extern void kv_pair_set_style(enum kv_pair_style style); + +/* + * kv_pair_new - create new key=value pair + * + * returns pointer to new key=value pair + * returns NULL to indicate error + */ +extern struct kv_pair *kv_pair_new(void); + +/* + * kv_pair_add - add new key=value pair to list + * + * @kv_list: key=value pair list + * @key: key string + * @value: value string + * + * returns pointer to new key=value pair + * returns NULL to indicate error + */ +extern struct kv_pair *kv_pair_add(struct kv_pair *kv_list, + const char *key, const char *value); + +/* + * kv_pair_add_bool - add new boolean kvpair to list + * + * @kv_list: key=value pair list + * @key: key string + * @value: value + * + * returns pointer to new key=value pair + * returns NULL to indicate error + */ +extern struct kv_pair *kv_pair_add_bool(struct kv_pair *kv_list, + const char *key, int value); + +/* + * kv_pair_fmt - add key=value pair based on printf format + * NOTE: uses variable argument list + * + * @kv_list: list of key=value pairs + * @kv_key: key string + * @format: printf-style format for value input + * @...: arguments to format + * + * returns pointer to new key=value pair + * returns NULL to indicate error + */ +extern struct kv_pair *kv_pair_fmt(struct kv_pair *kv_list, + const char *kv_key, const char *format, ...) + __attribute__((format(printf, 3, 4))); + +/* + * kv_pair_free - clean a key=value pair list + * + * @kv_list: pointer to key=value list + */ +extern void kv_pair_free(struct kv_pair *kv_list); + +/* + * kv_pair_print - print a key=value pair list + * + * @kv_list: pointer to key=value list + * @style: print style + */ +extern void kv_pair_print_to_file(FILE* fp, struct kv_pair *kv_list, + enum kv_pair_style style); + +/* + * kv_pair_print - print a key=value pair list to gsys output + * + * @kv_list: pointer to key=value list + */ +extern void kv_pair_print(struct kv_pair *kv_list); + + +/* + * kv_pair_get_value - return first value with key match + * + * @kv_list: pointer to key=value list + * @kv_key: key string + */ +extern const char *kv_pair_get_value(struct kv_pair *kv_list, + const char *kv_key); + +/* + * kv_pair_size - return number of kv pairs in the chain + * + * @kv_list: pointer to key=value list + */ +extern int kv_pair_size(struct kv_pair *kv_list); + +#endif /* FLASHMAP_LIB_KV_PAIR_H__ */ diff --git a/util/cbfstool/flashmap/valstr.c b/util/cbfstool/flashmap/valstr.c new file mode 100644 index 0000000..fa9ed82 --- /dev/null +++ b/util/cbfstool/flashmap/valstr.c @@ -0,0 +1,65 @@ +/* + * Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include <inttypes.h> +#include <string.h> + +#include <valstr.h> + +const char *val2str_default(uint32_t val, const struct valstr *vs, + const char *def_str) +{ + int i; + + for (i = 0; vs[i].str; i++) { + if (vs[i].val == val) + return vs[i].str; + } + + return def_str; +} + +const char *val2str(uint32_t val, const struct valstr *vs) +{ + return val2str_default(val, vs, "Unknown"); +} + +uint32_t str2val(const char *str, const struct valstr *vs) +{ + int i; + + for (i = 0; vs[i].str; i++) { + if (strcasecmp(vs[i].str, str) == 0) + return vs[i].val; + } + + return vs[i].val; +} diff --git a/util/cbfstool/flashmap/valstr.h b/util/cbfstool/flashmap/valstr.h new file mode 100644 index 0000000..3885ef7 --- /dev/null +++ b/util/cbfstool/flashmap/valstr.h @@ -0,0 +1,78 @@ +/* + * Copyright 2010, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef FLASHMAP_LIB_VALSTR_H__ +#define FLASHMAP_LIB_VALSTR_H__ + +#include <inttypes.h> + +/* value + string structure for common conversions */ +struct valstr { + uint32_t val; /* field value */ + const char *str; /* field description */ +}; + +/* + * val2str_default - convert value to string + * + * @val: value to convert + * @vs: value-string data + * @def_str: default string to return if no matching value found + * + * returns pointer to string + * returns def_str if no matching value found + */ +const char *val2str_default(uint32_t val, const struct valstr *vs, + const char *def_str); + +/* + * val2str - convert value to string + * + * @val: value to convert + * @vs: value-string data + * + * returns pointer to string + * returns pointer to "unknown" static string if not found + */ +const char *val2str(uint32_t val, const struct valstr *vs); + +/* + * str2val - convert string to value + * + * @str: string to convert + * @vs: value-string data + * + * returns value for string + * returns value for last entry in value-string data if not found + */ +uint32_t str2val(const char *str, const struct valstr *vs); + +#endif /* FLASHMAP_LIB_VALSTR_H__ */

1 0

Patch set updated for coreboot: 9dab149 fmaptool: Introduce the fmd ("flashmap descriptor") language and compiler
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9942 -gerrit commit 9dab14993616ebeebc0ab10ba3bfd149e475104c Author: Sol Boucher <solb(a)chromium.org> Date: Thu Feb 26 11:47:19 2015 -0800 fmaptool: Introduce the fmd ("flashmap descriptor") language and compiler This adds a compiler for a language whose textual representation of flashmap regions will be used to describe the layout of flash chips that contain more than just a single CBFS. Direct integration with cbfstool (via a new command-line switch for the create action) is forthcoming but will be added separately. BUG=chromium:461875 TEST=Use Chromium OS's cros_bundle_firmware script on the fmap.dts file for panther. Using the latter file as a reference, write a corresponding fmap.fmd file and feed it through fmaptool. Run both binary output files though the flashmap project's own flashmap_decode utility. Observe only the expected differences. BRANCH=None Change-Id: I06b32d138dbef0a4e5ed43c81bd31c796fd5d669 Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Commit-Id: 005ab67eb594e21489cf31036aedaea87e0c7142 Original-Change-Id: Ia08f28688efdbbfc70c255916b8eb7eb0eb07fb2 Original-Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Reviewed-on: https://chromium-review.googlesource.com/255031 Original-Reviewed-by: Julius Werner <jwerner(a)chromium.org> Original-Reviewed-by: Stefan Reinauer <reinauer(a)chromium.org> --- .gitignore | 1 + Makefile.inc | 6 +- src/Kconfig | 14 +- util/cbfstool/Makefile | 42 +- util/cbfstool/Makefile.inc | 43 + util/cbfstool/README.fmaptool | 67 ++ util/cbfstool/common.h | 1 + util/cbfstool/flashmap/fmap.c | 143 +-- util/cbfstool/flashmap/fmap.h | 24 +- util/cbfstool/flashmap/kv_pair.c | 23 +- util/cbfstool/flashmap/kv_pair.h | 2 +- util/cbfstool/flashmap/valstr.c | 1 + util/cbfstool/flashmap_tests.c | 37 + util/cbfstool/fmap_from_fmd.c | 83 ++ util/cbfstool/fmap_from_fmd.h | 33 + util/cbfstool/fmaptool.c | 119 +++ util/cbfstool/fmd.c | 401 +++++++++ util/cbfstool/fmd.h | 143 +++ util/cbfstool/fmd_parser.c | 1647 +++++++++++++++++++++++++++++++++ util/cbfstool/fmd_parser.h | 109 +++ util/cbfstool/fmd_parser.y | 190 ++++ util/cbfstool/fmd_scanner.c | 1852 ++++++++++++++++++++++++++++++++++++++ util/cbfstool/fmd_scanner.h | 333 +++++++ util/cbfstool/fmd_scanner.l | 78 ++ util/cbfstool/option.h | 29 + 25 files changed, 5258 insertions(+), 163 deletions(-) diff --git a/.gitignore b/.gitignore index 678982d..0398b15 100644 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,7 @@ util/*/.dependencies util/*/.test util/board_status/board-status util/cbfstool/cbfstool +util/cbfstool/fmaptool util/cbfstool/rmodtool util/cbmem/.dependencies util/cbmem/cbmem diff --git a/Makefile.inc b/Makefile.inc index 6403977..269ffef 100644 --- a/Makefile.inc +++ b/Makefile.inc @@ -285,11 +285,15 @@ build-dirs: ####################################################################### # Build the tools CBFSTOOL:=$(objutil)/cbfstool/cbfstool +FMAPTOOL:=$(objutil)/cbfstool/fmaptool RMODTOOL:=$(objutil)/cbfstool/rmodtool $(obj)/cbfstool: $(CBFSTOOL) cp $< $@ +$(obj)/fmaptool: $(FMAPTOOL) + cp $< $@ + $(obj)/rmodtool: $(RMODTOOL) cp $< $@ @@ -544,7 +548,7 @@ prebuild-files = \ $(cbfs-add-cmd) $(if $(call extract_nth,5,$(file)),-b $(call extract_nth,5,$(file))) &&)) prebuilt-files = $(foreach file,$(cbfs-files), $(call extract_nth,1,$(file))) -$(obj)/coreboot.pre1: $(objcbfs)/bootblock.bin $$(prebuilt-files) $(CBFSTOOL) $$(cpu_ucode_cbfs_file) +$(obj)/coreboot.pre1: $(objcbfs)/bootblock.bin $$(prebuilt-files) $(FMAPTOOL) $(CBFSTOOL) $$(cpu_ucode_cbfs_file) $(CBFSTOOL) $@.tmp create \ -B $(objcbfs)/bootblock.bin -a 64 \ $(CBFSTOOL_PRE1_OPTS) diff --git a/src/Kconfig b/src/Kconfig index df4e320..480b8e9 100644 --- a/src/Kconfig +++ b/src/Kconfig @@ -108,15 +108,25 @@ config CCACHE For details see https://ccache.samba.org. +config FMD_GENPARSER + bool "Generate flashmap descriptor parser using flex and bison" + default n + depends on EXPERT + help + Enable this option if you are working on the flashmap descriptor + parser and made changes to fmd_scanner.l or fmd_parser.y. + + Otherwise, say N to use the provided pregenerated scanner/parser. + config SCONFIG_GENPARSER bool "Generate SCONFIG parser using flex and bison" default n depends on EXPERT help Enable this option if you are working on the sconfig device tree - parser and made changes to sconfig.l and sconfig.y. + parser and made changes to sconfig.l or sconfig.y. - Otherwise, say N. + Otherwise, say N to use the provided pregenerated scanner/parser. config USE_OPTION_TABLE bool "Use CMOS for configuration values" diff --git a/util/cbfstool/Makefile b/util/cbfstool/Makefile index 9595773..abacfaa 100644 --- a/util/cbfstool/Makefile +++ b/util/cbfstool/Makefile @@ -7,6 +7,8 @@ CFLAGS += -std=c99 -Werror -Wall -Wextra CFLAGS += -Wcast-qual -Wmissing-prototypes -Wredundant-decls -Wshadow CFLAGS += -Wstrict-prototypes -Wwrite-strings CPPFLAGS += -D_POSIX_C_SOURCE=200809L # strdup() from string.h +CPPFLAGS += -D_SVID_SOURCE # memccpy() from string.h +CPPFLAGS += -Iflashmap LINKFLAGS += -g3 CBFSTOOL_BINARY:=$(obj)/cbfstool @@ -19,14 +21,28 @@ CBFSTOOL_COMMON+=lzma/C/LzFind.o lzma/C/LzmaDec.o lzma/C/LzmaEnc.o CBFSTOOL_COMMON:=$(addprefix $(obj)/,$(CBFSTOOL_COMMON)) +FMAPTOOL_BINARY:=$(obj)/fmaptool +FMAPTOOL_COMMON:=fmap_from_fmd.o fmd.o fmd_parser.o fmd_scanner.o +# FMAP +FMAPTOOL_COMMON+=flashmap/fmap.o +FMAPTOOL_COMMON+=flashmap/kv_pair.o flashmap/valstr.o + +FMAPTOOL_COMMON:=$(addprefix $(obj)/,$(FMAPTOOL_COMMON)) RMODTOOL_BINARY:=$(obj)/rmodtool RMODTOOL_COMMON:=rmodule.o common.o elfheaders.o xdr.o RMODTOOL_COMMON:=$(addprefix $(obj)/,$(RMODTOOL_COMMON)) +FMAPTESTS_BINARY:=$(obj)/flashmap_tests +FMAPTESTS_COMMON:=flashmap/fmap.o flashmap/valstr.o flashmap/kv_pair.o + +FMAPTESTS_COMMON:=$(addprefix $(obj)/,$(FMAPTESTS_COMMON)) + +GENERATED:=fmd_parser.c fmd_parser.h fmd_scanner.c fmd_scanner.h + .PHONY: all -all: .dependencies $(CBFSTOOL_BINARY) $(RMODTOOL_BINARY) +all: .dependencies $(CBFSTOOL_BINARY) $(FMAPTOOL_BINARY) $(RMODTOOL_BINARY) $(obj)/%: $(obj)/%.o mkdir -p $(dir $@) @@ -34,27 +50,47 @@ $(obj)/%: $(obj)/%.o $(obj)/%.o: %.c mkdir -p $(dir $@) $(HOSTCC) $(CPPFLAGS) $(CFLAGS) -c -o $@ $< +%.c %.h: %.l + $(LEX) $(LFLAGS) -t --header-file=$*.h $< >$*.c +%.c %.h: %.y + $(YACC) $(YFLAGS) -d $< + mv -f y.tab.c $*.c + mv -f y.tab.h $*.h .PHONY: clean clean: $(RM) $(CBFSTOOL_COMMON) $(CBFSTOOL_BINARY).o $(CBFSTOOL_BINARY) + $(RM) $(FMAPTOOL_COMMON) $(FMAPTOOL_BINARY).o $(FMAPTOOL_BINARY) $(RM) $(RMODTOOL_COMMON) $(RMODTOOL_BINARY).o $(RMODTOOL_BINARY) + $(RM) $(FMAPTESTS_COMMON) $(FMAPTESTS_BINARY).o $(FMAPTESTS_BINARY) .PHONY: distclean distclean: clean $(RM) .dependencies +.PHONY: maintainer-clean +maintainer-clean: distclean + $(RM) $(GENERATED) -tags: +tags: $(GENERATED) ctags *.[ch] -.dependencies: +.dependencies: $(GENERATED) @$(HOSTCC) $(CPPFLAGS) $(CFLAGS) -MM -MG *.c > $@ + @$(HOSTCC) $(CPPFLAGS) $(CFLAGS) -MM flashmap/*.c >> $@ @$(HOSTCC) $(CPPFLAGS) $(CFLAGS) -MM lzma/*.c >> $@ @$(HOSTCC) $(CPPFLAGS) $(CFLAGS) -MM lzma/C/*.c >> $@ @sed -i 's|.*:.*|$$(obj)/&|' $@ $(CBFSTOOL_BINARY): $(CBFSTOOL_COMMON) +$(FMAPTOOL_BINARY): $(FMAPTOOL_COMMON) $(RMODTOOL_BINARY): $(RMODTOOL_COMMON) +# This target must be built manually +$(FMAPTESTS_BINARY): $(FMAPTESTS_COMMON) + +# Yacc source is superset of header +$(obj)/fmd_parser.o: CFLAGS += -Wno-redundant-decls +# Lex generates unneeded functions +$(obj)/fmd_scanner.o: CFLAGS += -Wno-unused-function # Tolerate lzma sdk warnings $(obj)/lzma/C/LzmaEnc.o: CFLAGS += -Wno-sign-compare -Wno-cast-qual diff --git a/util/cbfstool/Makefile.inc b/util/cbfstool/Makefile.inc index a846e99..b5eed70 100644 --- a/util/cbfstool/Makefile.inc +++ b/util/cbfstool/Makefile.inc @@ -17,6 +17,17 @@ cbfsobj += LzmaEnc.o cbfsobj += linux_trampoline.o cbfsobj += cbfs-payload-linux.o +fmapobj := +fmapobj += fmaptool.o +fmapobj += fmap_from_fmd.o +fmapobj += fmd.o +fmapobj += fmd_parser.o +fmapobj += fmd_scanner.o +# FMAP +fmapobj += fmap.o +fmapobj += kv_pair.o +fmapobj += valstr.o + rmodobj := rmodobj += rmodtool.o rmodobj += rmodule.o @@ -28,6 +39,8 @@ TOOLCFLAGS ?= -std=c99 -Werror -Wall -Wextra TOOLCFLAGS += -Wcast-qual -Wmissing-prototypes -Wredundant-decls -Wshadow TOOLCFLAGS += -Wstrict-prototypes -Wwrite-strings TOOLCPPFLAGS ?= -D_POSIX_C_SOURCE=200809L # strdup() from string.h +TOOLCPPFLAGS += -D_SVID_SOURCE # memccpy() from string.h +TOOLCPPFLAGS += -I$(top)/util/cbfstool/flashmap TOOLLINKFLAGS ?= ifeq ($(shell uname -s | cut -c-7 2>/dev/null), MINGW32) @@ -38,6 +51,10 @@ $(objutil)/cbfstool/%.o: $(top)/util/cbfstool/%.c printf " HOSTCC $(subst $(objutil)/,,$(@))\n" $(HOSTCC) $(TOOLCPPFLAGS) $(TOOLCFLAGS) $(HOSTCFLAGS) -c -o $@ $< +$(objutil)/cbfstool/%.o: $(top)/util/cbfstool/flashmap/%.c + printf " HOSTCC $(subst $(objutil)/,,$(@))\n" + $(HOSTCC) $(TOOLCPPFLAGS) $(TOOLCFLAGS) $(HOSTCFLAGS) -c -o $@ $< + $(objutil)/cbfstool/%.o: $(top)/util/cbfstool/lzma/%.c printf " HOSTCC $(subst $(objutil)/,,$(@))\n" $(HOSTCC) $(TOOLCPPFLAGS) $(TOOLCFLAGS) $(HOSTCFLAGS) -c -o $@ $< @@ -50,9 +67,35 @@ $(objutil)/cbfstool/cbfstool: $(addprefix $(objutil)/cbfstool/,$(cbfsobj)) printf " HOSTCC $(subst $(objutil)/,,$(@)) (link)\n" $(HOSTCC) $(TOOLLINKFLAGS) -o $@ $(addprefix $(objutil)/cbfstool/,$(cbfsobj)) +$(objutil)/cbfstool/fmaptool: $(addprefix $(objutil)/cbfstool/,$(fmapobj)) + printf " HOSTCC $(subst $(objutil)/,,$(@)) (link)\n" + $(HOSTCC) $(TOOLLINKFLAGS) -o $@ $(addprefix $(objutil)/cbfstool/,$(fmapobj)) + $(objutil)/cbfstool/rmodtool: $(addprefix $(objutil)/cbfstool/,$(rmodobj)) printf " HOSTCC $(subst $(objutil)/,,$(@)) (link)\n" $(HOSTCC) $(TOOLLINKFLAGS) -o $@ $(addprefix $(objutil)/cbfstool/,$(rmodobj)) +# Yacc source is superset of header +$(objutil)/cbfstool/fmd_parser.o: TOOLCFLAGS += -Wno-redundant-decls +# Lex generates unneeded functions +$(objutil)/cbfstool/fmd_scanner.o: TOOLCFLAGS += -Wno-unused-function # Tolerate lzma sdk warnings $(objutil)/cbfstool/LzmaEnc.o: TOOLCFLAGS += -Wno-sign-compare -Wno-cast-qual + +ifeq ($(CONFIG_FMD_GENPARSER),y) +TOOLLEX := lex +TOOLYACC := yacc + +$(objutil)/cbfstool/fmd.o: $(top)/util/cbfstool/fmd_parser.c +$(objutil)/cbfstool/fmd.o: $(top)/util/cbfstool/fmd_scanner.c +$(objutil)/cbfstool/fmd_parser.o: $(objutil)/cbfstool/fmd.o +$(objutil)/cbfstool/fmd_scanner.o: $(objutil)/cbfstool/fmd.o +$(top)/util/cbfstool/fmd_scanner.c $(top)/util/cbfstool/fmd_scanner.h: $(top)/util/cbfstool/fmd_scanner.l + echo " LEX util/cbfstool/fmd_scanner.[ch]" + $(TOOLLEX) -t --header-file=$(top)/util/cbfstool/fmd_scanner.h $< >$(top)/util/cbfstool/fmd_scanner.c +$(top)/util/cbfstool/fmd_parser.c $(top)/util/cbfstool/fmd_parser.h: $(top)/util/cbfstool/fmd_parser.y + echo " YACC util/cbfstool/fmd_parser.[ch]" + $(TOOLYACC) -d $< + mv -f y.tab.c $(top)/util/cbfstool/fmd_parser.c + mv -f y.tab.h $(top)/util/cbfstool/fmd_parser.h +endif diff --git a/util/cbfstool/README.fmaptool b/util/cbfstool/README.fmaptool new file mode 100644 index 0000000..f806c43 --- /dev/null +++ b/util/cbfstool/README.fmaptool @@ -0,0 +1,67 @@ +Flashmap descriptors in coreboot +================================ +Flashmap (https://code.google.com/p/flashmap) is a binary format for representing the layout of +flash chips. Since coreboot is starting to use a "partition" of this format to describe the flash +chip layout---both at runtime and when flashing a new image onto a chip---, the project needed a +reasonably expressive plaintext format for representing such sections in the source tree. Our +solution is the fmd ("flashmap descriptor") language, and the files in this directory contain a +scanner, parser, semantic analyser, and flashmap converter. Here's an informal language description: + +# <line comment> +<image name>[@<memory-mapped address>] <image size> { + <section name>[@<offset from start of image>] [<section size>] [{ + <subsection name>[@<offset from start of parent section>] [<subsection size>] [{ + # Sections can be nested as deeply as desired + <subsubsection name>[(CBFS)][@...] [...] [{...}] + }] + [<subsection name>[(CBFS)][@...] [...] [{...}]] + # There can be many subsections at each level of nesting: they will be inserted + # sequentially, and although gaps are allowed, any provided offsets are always + # relative to the closest parent node's and must be strictly increasing with neither + # overlapping nor degenerate-size sections. + }] +} + +Note that the above example contains a few symbols that are actually metasyntax, and therefore have +neither meaning nor place in a real file. The <.*> s indicate placeholders for parameters: + - The names are strings, which are provided as single-word---no whitespace---groups of + syntactically unimportant symbols (i.e. everything except @, {, and }): they are not surrounded + by quotes or any other form of delimiter. + - The other fields are nonnegative integers, which may be given as decimal or hexadecimal; in + either case, a K, M, or G may be appended---without intermediate whitespace---as a multiplier. + - Comments consist of anything one manages to enter, provided it doesn't start a new line. +The [.*] s indicate that a portion of the file could be omitted altogether: + - Just because something is noted as optional doesn't mean it is in every case: the answer might + actually depend on which other information is---or isn't---provided. + - In particular, it is only legal to place a (CBFS) annotation on a leaf section; that is, choosing + to add child sections excludes the possibility of putting a CBFS in their parent. Such + annotations are only used to decide where CBFS empty file headers should be created, and do not + result in the storage of any additional metadata in the resulting FMAP section. +Additionally, it's important to note these properties of the overall file and its values: + - Other than within would-be strings and numbers, whitespace is ignored. It goes without saying + that such power comes with responsibility, which is why this sentence is here. + - Although the .*section names must be globally unique, one of them may---but is not required to--- + match the image name. + - It is a syntax error to supply a number---besides 0---that begins with the character 0, as there + is no intention of adding octals to the mix. + - The image's memory address should be present on---and only on---layouts for memory-mapped chips. + - Although it may be evident from above, all .*section offsets are relative only to the immediate + parent. There is no way to include an absolute offset (i.e. from the beginning of flash), which + means that it is "safe" to reorder the .*section s within a particular level of nesting, as long + as the change doesn't cause their positions and sizes to necessitate overlap or zero sizes. + - A .*section with omitted offset is assumed to start at as low a position as possible---with no + consideration of alignment---and one with omitted size is assumed to fill the remaining space + until the next sibling or before the end of its parent. + - It's fine to omit any .*section 's offset, size, or both, provided its position and size are + still unambiguous in the context of its *sibling* sections and its parent's *size*. In + particular, knowledge of one .*section 's children or the .*section s' common parent's siblings + will not be used for this purpose. + - Although .*section s are not required to have children, the flash chip as a whole must have at + least one. + - Though the braces after .*section s may be omitted for those that have no children, if they are + present, they must contain at least one child. + +PL people and sympathizers may wish to examine the formal abstract syntax and context-free grammar, +which are located in fmd_scanner.l and fmd_scanner.y, respectively. Those interested in the +algorithm used to infer omitted values will feel at home in fmd.c, particularly near the definition +of validate_and_complete_info(). diff --git a/util/cbfstool/common.h b/util/cbfstool/common.h index 80d5789..f364ea1 100644 --- a/util/cbfstool/common.h +++ b/util/cbfstool/common.h @@ -20,6 +20,7 @@ #ifndef __CBFSTOOL_COMMON_H #define __CBFSTOOL_COMMON_H +#include <stddef.h> #include <stdint.h> #include <assert.h> diff --git a/util/cbfstool/flashmap/fmap.c b/util/cbfstool/flashmap/fmap.c index 8850a92..bb18ceb 100644 --- a/util/cbfstool/flashmap/fmap.c +++ b/util/cbfstool/flashmap/fmap.c @@ -1,4 +1,4 @@ -/* Copyright 2010, Google Inc. +/* Copyright 2015, Google Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -49,7 +49,6 @@ #include <valstr.h> #include "kv_pair.h" -#include "mincrypt/sha.h" #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) @@ -60,7 +59,7 @@ const struct valstr flag_lut[] = { }; /* returns size of fmap data structure if successful, <0 to indicate error */ -int fmap_size(struct fmap *fmap) +int fmap_size(const struct fmap *fmap) { if (!fmap) return -1; @@ -71,7 +70,7 @@ int fmap_size(struct fmap *fmap) /* brute force linear search */ static long int fmap_lsearch(const uint8_t *image, size_t len) { - long int offset; + unsigned long int offset; int fmap_found = 0; for (offset = 0; offset < len - strlen(FMAP_SIGNATURE); offset++) { @@ -86,7 +85,7 @@ static long int fmap_lsearch(const uint8_t *image, size_t len) if (!fmap_found) return -1; - if (offset + fmap_size((struct fmap *)&image[offset]) > len) + if (offset + fmap_size((const struct fmap *)&image[offset]) > len) return -1; return offset; @@ -95,7 +94,7 @@ static long int fmap_lsearch(const uint8_t *image, size_t len) /* if image length is a power of 2, use binary search */ static long int fmap_bsearch(const uint8_t *image, size_t len) { - long int offset = -1; + unsigned long int offset = -1; int fmap_found = 0, stride; /* @@ -125,7 +124,7 @@ static long int fmap_bsearch(const uint8_t *image, size_t len) if (!fmap_found) return -1; - if (offset + fmap_size((struct fmap *)&image[offset]) > len) + if (offset + fmap_size((const struct fmap *)&image[offset]) > len) return -1; return offset; @@ -183,86 +182,42 @@ int fmap_print(const struct fmap *fmap) kv_pair_free(kv); for (i = 0; i < fmap->nareas; i++) { - struct kv_pair *kv; + struct kv_pair *pair; uint16_t flags; char *str; - kv = kv_pair_new(); - if (!kv) + pair = kv_pair_new(); + if (!pair) return -1; - kv_pair_fmt(kv, "area_offset", "0x%08x", + kv_pair_fmt(pair, "area_offset", "0x%08x", fmap->areas[i].offset); - kv_pair_fmt(kv, "area_size", "0x%08x", + kv_pair_fmt(pair, "area_size", "0x%08x", fmap->areas[i].size); - kv_pair_fmt(kv, "area_name", "%s", + kv_pair_fmt(pair, "area_name", "%s", fmap->areas[i].name); - kv_pair_fmt(kv, "area_flags_raw", "0x%02x", + kv_pair_fmt(pair, "area_flags_raw", "0x%02x", fmap->areas[i].flags); /* Print descriptive strings for flags rather than the field */ flags = fmap->areas[i].flags; if ((str = fmap_flags_to_string(flags)) == NULL) return -1; - kv_pair_fmt(kv, "area_flags", "%s", str ); + kv_pair_fmt(pair, "area_flags", "%s", str); free(str); - kv_pair_print(kv); - kv_pair_free(kv); + kv_pair_print(pair); + kv_pair_free(pair); } return 0; } -/* get SHA1 sum of all static regions described by the flashmap and copy into - *digest (which will be allocated and must be freed by the caller), */ -int fmap_get_csum(const uint8_t *image, unsigned int image_len, uint8_t **digest) -{ - int i; - struct fmap *fmap; - int fmap_offset; - SHA_CTX ctx; - - if ((image == NULL)) - return -1; - - if ((fmap_offset = fmap_find(image, image_len)) < 0) - return -1; - fmap = (struct fmap *)(image + fmap_offset); - - SHA_init(&ctx); - - /* Iterate through flash map and calculate the checksum piece-wise. */ - for (i = 0; i < fmap->nareas; i++) { - /* skip non-static areas */ - if (!(fmap->areas[i].flags & FMAP_AREA_STATIC)) - continue; - - /* sanity check the offset */ - if (fmap->areas[i].size + fmap->areas[i].offset > image_len) { - fprintf(stderr, - "(%s) invalid parameter detected in area %d\n", - __func__, i); - return -1; - } - - SHA_update(&ctx, - image + fmap->areas[i].offset, - fmap->areas[i].size); - } - - SHA_final(&ctx); - *digest = malloc(SHA_DIGEST_SIZE); - memcpy(*digest, ctx.buf, SHA_DIGEST_SIZE); - - return SHA_DIGEST_SIZE; -} - /* convert raw flags field to user-friendly string */ char *fmap_flags_to_string(uint16_t flags) { char *str = NULL; - int i, total_size; + unsigned int i, total_size; str = malloc(1); str[0] = '\0'; @@ -278,7 +233,7 @@ char *fmap_flags_to_string(uint16_t flags) total_size += strlen(tmp); str = realloc(str, total_size); strcat(str, tmp); - + flags &= ~(1 << i); if (flags) { total_size++; @@ -302,8 +257,8 @@ struct fmap *fmap_create(uint64_t base, uint32_t size, uint8_t *name) memset(fmap, 0, sizeof(*fmap)); memcpy(&fmap->signature, FMAP_SIGNATURE, strlen(FMAP_SIGNATURE)); - fmap->ver_major = VERSION_MAJOR; - fmap->ver_minor = VERSION_MINOR; + fmap->ver_major = FMAP_VER_MAJOR; + fmap->ver_minor = FMAP_VER_MINOR; fmap->base = base; fmap->size = size; memccpy(&fmap->name, name, '\0', FMAP_STRLEN); @@ -390,8 +345,8 @@ static struct fmap *fmap_create_test(void) goto fmap_create_test_exit; } - if ((fmap->ver_major != VERSION_MAJOR) || - (fmap->ver_minor != VERSION_MINOR)) { + if ((fmap->ver_major != FMAP_VER_MAJOR) || + (fmap->ver_minor != FMAP_VER_MINOR)) { printf("FAILURE: version is incorrect\n"); goto fmap_create_test_exit; } @@ -431,44 +386,7 @@ static int fmap_print_test(struct fmap *fmap) return fmap_print(fmap); } -static int fmap_get_csum_test(struct fmap *fmap) -{ - uint8_t *digest = NULL, *image = NULL; - /* assume 0x100-0x10100 is marked "static" and is filled with 0x00 */ - int image_size = 0x20000; - uint8_t csum[SHA_DIGEST_SIZE] = { - 0x1a, 0xdc, 0x95, 0xbe, 0xbe, 0x9e, 0xea, 0x8c, - 0x11, 0x2d, 0x40, 0xcd, 0x04, 0xab, 0x7a, 0x8d, - 0x75, 0xc4, 0xf9, 0x61 }; - - status = fail; - - if ((fmap_get_csum(NULL, image_size, &digest) >= 0) || - (fmap_get_csum(image, image_size, NULL) >= 0)) { - printf("failed to abort on NULL pointer input\n"); - goto fmap_get_csum_test_exit; - } - - image = calloc(image_size, 1); - memcpy(image, fmap, fmap_size(fmap)); - - if (fmap_get_csum(image, image_size, &digest) != SHA_DIGEST_SIZE) { - printf("FAILURE: failed to calculate checksum\n"); - goto fmap_get_csum_test_exit; - } - if (memcmp(digest, csum, SHA_DIGEST_SIZE)) { - printf("FAILURE: checksum is incorrect\n"); - goto fmap_get_csum_test_exit; - } - - status = pass; -fmap_get_csum_test_exit: - free(image); - free(digest); - return status; -} - -static int fmap_size_test(struct fmap *fmap) +static int fmap_size_test(void) { status = fail; @@ -553,10 +471,10 @@ fmap_find_area_test_exit: return status; } -static int fmap_flags_to_string_test() +static int fmap_flags_to_string_test(void) { char *str, *my_str; - int i; + unsigned int i; uint16_t flags; status = fail; @@ -646,11 +564,11 @@ static int fmap_find_test(struct fmap *fmap) offset = (total_size / 2) + 1; memcpy(&buf[offset], fmap, fmap_size(fmap)); - if (fmap_find(buf, total_size - 1) != offset) { + if ((unsigned)fmap_find(buf, total_size - 1) != offset) { printf("FAILURE: lsearch failed to find fmap\n"); goto fmap_find_test_exit; } - if (fmap_find(buf, total_size) != offset) { + if ((unsigned)fmap_find(buf, total_size) != offset) { printf("FAILURE: bsearch failed to find fmap\n"); goto fmap_find_test_exit; } @@ -659,7 +577,7 @@ static int fmap_find_test(struct fmap *fmap) offset = 0; memset(buf, 0, total_size); memcpy(buf, fmap, fmap_size(fmap)); - if (fmap_find(buf, total_size) != offset) { + if ((unsigned)fmap_find(buf, total_size) != offset) { printf("FAILURE: bsearch failed to find fmap at offset 0\n"); goto fmap_find_test_exit; } @@ -684,7 +602,7 @@ fmap_find_test_exit: return status; } -int fmap_test() +int fmap_test(void) { int rc = EXIT_SUCCESS; struct fmap *my_fmap; @@ -713,8 +631,7 @@ int fmap_test() } rc |= fmap_find_area_test(my_fmap); - rc |= fmap_get_csum_test(my_fmap); - rc |= fmap_size_test(my_fmap); + rc |= fmap_size_test(); rc |= fmap_flags_to_string_test(); rc |= fmap_print_test(my_fmap); diff --git a/util/cbfstool/flashmap/fmap.h b/util/cbfstool/flashmap/fmap.h index 9cea22d..bfc9253 100644 --- a/util/cbfstool/flashmap/fmap.h +++ b/util/cbfstool/flashmap/fmap.h @@ -1,5 +1,5 @@ /* - * Copyright 2010, Google Inc. + * Copyright 2015, Google Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -97,24 +97,6 @@ extern long int fmap_find(const uint8_t *image, unsigned int len); extern int fmap_print(const struct fmap *map); /* - * fmap_get_csum - get the checksum of static regions of an image - * - * @image: image to checksum - * @len: length of image - * @digest: double-pointer to store location of first byte of digest - * - * fmap_get_csum() will reset, write, and finalize the digest. - * The location of the final digest will start at the location pointed to - * by digest, which will be allocated and must be freed by the caller. - * - * returns digest length if successful - * returns <0 to indicate error - */ -extern int fmap_get_csum(const uint8_t *image, - unsigned int image_len, uint8_t **digest); - - -/* * fmap_flags_to_string - convert raw flags field into user-friendly string * * @flags: raw flags @@ -157,7 +139,7 @@ extern void fmap_destroy(struct fmap *fmap); * returns size of fmap structure if successful * returns <0 to indicate failure */ -extern int fmap_size(struct fmap *fmap); +extern int fmap_size(const struct fmap *fmap); /* * fmap_append_area - realloc an existing flashmap and append an area @@ -187,6 +169,6 @@ extern int fmap_append_area(struct fmap **fmap, extern struct fmap_area *fmap_find_area(struct fmap *fmap, const char *name); /* unit testing stuff */ -extern int fmap_test(); +extern int fmap_test(void); #endif /* FLASHMAP_LIB_FMAP_H__*/ diff --git a/util/cbfstool/flashmap/kv_pair.c b/util/cbfstool/flashmap/kv_pair.c index 2572c64..c5903b6 100644 --- a/util/cbfstool/flashmap/kv_pair.c +++ b/util/cbfstool/flashmap/kv_pair.c @@ -47,7 +47,7 @@ void kv_pair_set_style(enum kv_pair_style style) _style = style; } -enum kv_pair_style kv_pair_get_style() +enum kv_pair_style kv_pair_get_style(void) { return _style; } @@ -63,18 +63,6 @@ struct kv_pair *kv_pair_new(void) return kv; } -struct kv_pair **kv_pair_new_array(size_t size) -{ - struct kv_pair **kv; - size_t i; - - kv = (struct kv_pair **) calloc(0, sizeof(kv) * size); - for (i = 0; i < size; ++i) { - kv[i] = kv_pair_new(); - } - return kv; -} - struct kv_pair *kv_pair_add(struct kv_pair *kv_list, const char *key, const char *value) { @@ -163,15 +151,6 @@ void kv_pair_free(struct kv_pair *kv_list) } } -void kv_pair_free_array(struct kv_pair **kv_array, size_t size) -{ - size_t i; - for (i = 0; i < size; ++i) { - kv_pair_free(kv_array[i]); - } - free(kv_array); -} - void kv_pair_print_to_file(FILE* fp, struct kv_pair *kv_list, enum kv_pair_style style) { diff --git a/util/cbfstool/flashmap/kv_pair.h b/util/cbfstool/flashmap/kv_pair.h index b573530..1fb1e0d 100644 --- a/util/cbfstool/flashmap/kv_pair.h +++ b/util/cbfstool/flashmap/kv_pair.h @@ -56,7 +56,7 @@ struct kv_pair { struct kv_pair *next; }; -extern enum kv_pair_style kv_pair_get_style(); +extern enum kv_pair_style kv_pair_get_style(void); extern void kv_pair_set_style(enum kv_pair_style style); diff --git a/util/cbfstool/flashmap/valstr.c b/util/cbfstool/flashmap/valstr.c index fa9ed82..1e5c5d4 100644 --- a/util/cbfstool/flashmap/valstr.c +++ b/util/cbfstool/flashmap/valstr.c @@ -31,6 +31,7 @@ #include <inttypes.h> #include <string.h> +#include <strings.h> #include <valstr.h> diff --git a/util/cbfstool/flashmap_tests.c b/util/cbfstool/flashmap_tests.c new file mode 100644 index 0000000..c545285 --- /dev/null +++ b/util/cbfstool/flashmap_tests.c @@ -0,0 +1,37 @@ +/* + * fmap_from_fmd.c, simple launcher for fmap library unit test suite + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#include "flashmap/fmap.h" + +#include <stdio.h> + +int main(void) +{ + int result = fmap_test(); + + puts(""); + puts("==="); + puts(""); + if (!result) + puts("RESULT: All unit tests PASSED."); + else + puts("RESULT: One or more tests FAILED!"); + + return result; +} diff --git a/util/cbfstool/fmap_from_fmd.c b/util/cbfstool/fmap_from_fmd.c new file mode 100644 index 0000000..fa1024b --- /dev/null +++ b/util/cbfstool/fmap_from_fmd.c @@ -0,0 +1,83 @@ +/* + * fmap_from_fmd.c, tool to distill flashmap descriptors into raw FMAP sections + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#include "fmap_from_fmd.h" + +#include "common.h" + +#include <assert.h> +#include <string.h> + +static bool fmap_append_fmd_node(struct fmap **flashmap, + const struct flashmap_descriptor *section, + unsigned absolute_watermark) { + if (strlen(section->name) >= FMAP_STRLEN) { + fprintf(stderr, + "ERROR: Section name ('%s') exceeds %d character FMAP format limit\n", + section->name, FMAP_STRLEN - 1); + return false; + } + + absolute_watermark += section->offset; + + if (fmap_append_area(flashmap, absolute_watermark, section->size, + (uint8_t *)section->name, 0) < 0) { + fprintf(stderr, + "ERROR: Failed to insert section '%s' into FMAP\n", + section->name); + return false; + } + + fmd_foreach_child(subsection, section) { + if (!fmap_append_fmd_node(flashmap, subsection, + absolute_watermark)) + return false; + } + + return true; +} + +struct fmap *fmap_from_fmd(const struct flashmap_descriptor *desc) +{ + assert(desc); + assert(desc->size_known); + + if (strlen(desc->name) >= FMAP_STRLEN) { + fprintf(stderr, + "ERROR: Image name ('%s') exceeds %d character FMAP header limit\n", + desc->name, FMAP_STRLEN - 1); + return NULL; + } + + struct fmap *fmap = fmap_create(desc->offset_known ? desc->offset : 0, + desc->size, (uint8_t *)desc->name); + if (!fmap) { + fputs("ERROR: Failed to allocate FMAP header\n", stderr); + return fmap; + } + + fmd_foreach_child(real_section, desc) { + if (!fmap_append_fmd_node(&fmap, real_section, 0)) { + fmap_destroy(fmap); + return NULL; + } + } + + return fmap; +} diff --git a/util/cbfstool/fmap_from_fmd.h b/util/cbfstool/fmap_from_fmd.h new file mode 100644 index 0000000..689c859 --- /dev/null +++ b/util/cbfstool/fmap_from_fmd.h @@ -0,0 +1,33 @@ +/* + * fmap_from_fmd.h, tool to distill flashmap descriptors into raw FMAP sections + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#ifndef FMAP_FROM_FMD_H_ +#define FMAP_FROM_FMD_H_ + +#include "flashmap/fmap.h" +#include "fmd.h" + +/** + * @param desc The descriptor tree serving as a data source + * @return The FMAP section, which is also owned by the caller and must + * later be released with a call to fmap_destroy() + */ +struct fmap *fmap_from_fmd(const struct flashmap_descriptor *desc); + +#endif diff --git a/util/cbfstool/fmaptool.c b/util/cbfstool/fmaptool.c new file mode 100644 index 0000000..961e9dc --- /dev/null +++ b/util/cbfstool/fmaptool.c @@ -0,0 +1,119 @@ +/* + * fmaptool, CLI utility for converting plaintext fmd files into fmap blobs + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#include "common.h" +#include "fmap_from_fmd.h" + +#include <stdio.h> +#include <string.h> + +#define STDIN_FILENAME_SENTINEL "-" + +enum fmaptool_return { + FMAPTOOL_EXIT_SUCCESS = 0, + FMAPTOOL_EXIT_BAD_ARGS, + FMAPTOOL_EXIT_BAD_INPUT_PATH, + FMAPTOOL_EXIT_BAD_OUTPUT_PATH, + FMAPTOOL_EXIT_FAILED_DESCRIPTOR, + FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION, + FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE, + FMAPTOOL_EXIT_FAILED_WRITING_FILE, +}; + +bool fmd_process_annotation_impl(unused const struct flashmap_descriptor *node, + unused const char *annotation) +{ + // We always accept annotations, but never act on them. + return true; +} + +int main(int argc, char **argv) +{ + if (argc != 3) { + fputs("Convert a human-readable flashmap descriptor (fmd) file into the binary FMAP format for use in firmware images\n", + stderr); + fprintf(stderr, + "USAGE: %s <fmd input file> <binary output file>\n", + argv[0]); + fprintf(stderr, + "To read from standard input, provide '%s' as the input filename.\n", + STDIN_FILENAME_SENTINEL); + return FMAPTOOL_EXIT_BAD_ARGS; + } + const char *fmd_filename = argv[1]; + const char *fmap_filename = argv[2]; + + FILE *fmd_file = stdin; + if (strcmp(fmd_filename, STDIN_FILENAME_SENTINEL) != 0) { + fmd_file = fopen(fmd_filename, "r"); + if (!fmd_file) { + fprintf(stderr, "FATAL: Unable to open file '%s'\n", + fmd_filename); + return FMAPTOOL_EXIT_BAD_INPUT_PATH; + } + } + + struct flashmap_descriptor *descriptor = fmd_create(fmd_file); + fclose(fmd_file); + if (!descriptor) { + fputs("FATAL: Failed while processing provided descriptor\n", + stderr); + return FMAPTOOL_EXIT_FAILED_DESCRIPTOR; + } + + struct fmap *flashmap = fmap_from_fmd(descriptor); + if (!flashmap) { + fputs("FATAL: Failed while constructing FMAP section\n", + stderr); + fmd_cleanup(descriptor); + return FMAPTOOL_EXIT_FAILED_FMAP_CONVERSION; + } + + int size = fmap_size(flashmap); + if (size < 0) { + fputs("FATAL: Failed to determine FMAP section size\n", + stderr); + fmap_destroy(flashmap); + fmd_cleanup(descriptor); + return FMAPTOOL_EXIT_UNKNOWN_FMAP_SIZE; + } + + FILE *fmap_file = fopen(fmap_filename, "wb"); + if (!fmap_file) { + fprintf(stderr, "FATAL: Unable to open file '%s' for writing\n", + fmap_filename); + fmap_destroy(flashmap); + fmd_cleanup(descriptor); + return FMAPTOOL_EXIT_BAD_OUTPUT_PATH; + } + + if (!fwrite(flashmap, size, 1, fmap_file)) { + fputs("FATAL: Failed to write final FMAP to file\n", stderr); + fclose(fmap_file); + fmap_destroy(flashmap); + fmd_cleanup(descriptor); + return FMAPTOOL_EXIT_FAILED_WRITING_FILE; + } + fclose(fmap_file); + printf("SUCCESS: Wrote %d bytes to file '%s'\n", size, fmap_filename); + + fmap_destroy(flashmap); + fmd_cleanup(descriptor); + return FMAPTOOL_EXIT_SUCCESS; +} diff --git a/util/cbfstool/fmd.c b/util/cbfstool/fmd.c new file mode 100644 index 0000000..bfce049 --- /dev/null +++ b/util/cbfstool/fmd.c @@ -0,0 +1,401 @@ +/* + * fmd.c, parser frontend and utility functions for flashmap descriptor language + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#include "fmd.h" + +#include "fmd_parser.h" +#include "fmd_scanner.h" +#include "option.h" + +#include <assert.h> +#include <search.h> +#include <string.h> + +/* + * Validate the given flashmap descriptor node's properties. In particular: + * - Ensure its name is globally unique. + * - Ensure its offset, if known, isn't located before the end of the previous + * section, if this can be determined. + * - Ensure its offset, if known, isn't located after the beginning of the next + * section or off the end of its parent section, if this can be determined. + * - Ensure its size is nonzero. + * - Ensure that the combination of its size and offset, if they are both + * known, doesn't place its end after the beginning of the next section or + * off the end of its parent section, if this can be determined. + * In the case of a validation error, the particular problem is reported to + * standard error and this function returns false. It should be noted that this + * function makes no claim that the members of the node's child list are valid: + * under no circumstances is any recursive validation performed. + * + * @param node The flashmap descriptor node to be validated + * @param start Optional minimum permissible base of the section to be + * validated, to be provided if known + * @param end Optional maximum permissible offset to the end of the section to + * be validated, to be provided if known + * @return Whether the node is valid + */ +static bool validate_descriptor_node(const struct flashmap_descriptor *node, + struct unsigned_option start, struct unsigned_option end) { + assert(node); + + ENTRY search_key = {node->name, NULL}; + if (hsearch(search_key, FIND)) { + fprintf(stderr, "ERROR: Multiple sections with name '%s'\n", + node->name); + return false; + } + if (!hsearch(search_key, ENTER)) + assert(false); + + if (node->offset_known) { + if (start.val_known && node->offset < start.val) { + fprintf(stderr, "ERROR: Section '%s' starts too low\n", + node->name); + return false; + } else if (end.val_known && node->offset > end.val) { + fprintf(stderr, "ERROR: Section '%s' starts too high\n", + node->name); + return false; + } + } + + if (node->size_known) { + if (node->size == 0) { + fprintf(stderr, "ERROR: Section '%s' given no space\n", + node->name); + return false; + } else if (node->offset_known) { + unsigned node_end = node->offset + node->size; + if (end.val_known && node_end > end.val) { + fprintf(stderr, "ERROR: Section '%s' too big\n", + node->name); + return false; + } + } + } + + return true; +} + +/* + * Performs reverse lateral processing of sibling nodes, as described by the + * documentation of its caller, validate_and_complete_info(). If it encounters + * a node that is invalid in a way that couldn't have been discovered earlier, + * it explains the problem to standard output and returns false. + * + * @param first_incomplete_it First node whose offset or size couldn't be + * determined during forward processing + * @param cur_incomplete_it Last node whose offset or size is unknown + * @param end_watermark Offset to the end of the unresolved region + * @return Whether all completed nodes were still valid + */ +static bool complete_missing_info_backward( + flashmap_descriptor_iterator_t first_incomplete_it, + flashmap_descriptor_iterator_t cur_incomplete_it, + unsigned end_watermark) +{ + assert(first_incomplete_it); + assert(cur_incomplete_it); + assert(cur_incomplete_it >= first_incomplete_it); + + do { + struct flashmap_descriptor *cur = *cur_incomplete_it; + + assert(cur->offset_known || cur->size_known); + if (!cur->offset_known) { + if (cur->size > end_watermark) { + fprintf(stderr, "ERROR: Section '%s' too big\n", + cur->name); + return false; + } + cur->offset_known = true; + cur->offset = end_watermark -= cur->size; + } else if (!cur->size_known) { + if (cur->offset > end_watermark) { + fprintf(stderr, + "ERROR: Section '%s' starts too high\n", + cur->name); + return false; + } + cur->size_known = true; + cur->size = end_watermark - cur->offset; + end_watermark = cur->offset; + } + } while (--cur_incomplete_it >= first_incomplete_it); + + return true; +} + +/* + * Recursively examine each descendant of the provided flashmap descriptor node + * to ensure its position and size are known, attempt to infer them otherwise, + * and validate their values once they've been populated. + * This processes nodes according to the following algorithm: + * - At each level of the tree, it moves laterally between siblings, keeping + * a watermark of its current offset relative to the previous section, which + * it uses to fill in any unknown offsets it encounters along the way. + * - The first time it encounters a sibling with unknown size, it loses track + * of the watermark, and is therefore unable to complete further offsets; + * instead, if the watermark was known before, it marks the current node as + * the first that couldn't be completed in the initial pass. + * - If the current watermark is unknown (i.e. a node has been marked as the + * first incomplete one) and one with a fixed offset is encountered, a + * reverse lateral traversal is dispatched that uses that provided offset as + * a reverse watermark to complete all unknown fields until it finishes with + * the node marked as the first incomplete one: at this point, that flag is + * cleared, the watermark is updated, and forward processing resumes from + * where it left off. + * - If the watermark is unknown (i.e. node(s) are incomplete) after traversing + * all children of a particular parent node, reverse processing is employed + * as described above, except that the reverse watermark is initialized to + * the parent node's size instead of the (nonexistent) next node's offset. + * - Once all of a node's children have been processed, the algorithm applies + * itself recursively to each of the child nodes; thus, lower levels of the + * tree are processed only after their containing levels are finished. + * This approach can fail in two possible ways (in which case the problem is + * reported to standard output and this function returns false): + * - Processing reveals that some node's provided value is invalid in some way. + * - Processing determines that one or more provided values require an omitted + * field to take a nonsensical value. + * - Processing determines that it is impossible to determine a group of + * omitted values. This state is detected when a node whose offset *and* + * value are omitted is encountered during forward processing and while the + * current watermark is unknown: in such a case, neither can be known without + * being provided with either the other or more context. + * The function notably performs neither validation nor completion on the parent + * node it is passed; thus, it is important to ensure that that node is valid. + * (At the very least, it must have a valid size field in order for the + * algorithm to work on its children.) + * + * @param cur_level Parent node, which must minimally already have a valid size + * @return Whether completing and validating the children succeeded + */ +static bool validate_and_complete_info(struct flashmap_descriptor *cur_level) +{ + assert(cur_level); + assert(cur_level->size_known); + + // Our watermark is only known when first_incomplete_it is NULL. + flashmap_descriptor_iterator_t first_incomplete_it = NULL; + unsigned watermark = 0; + + fmd_foreach_child_iterator(cur_it, cur_level) { + struct flashmap_descriptor *cur_section = *cur_it; + + if (first_incomplete_it) { + if (cur_section->offset_known) { + if (complete_missing_info_backward( + first_incomplete_it, cur_it - 1, + cur_section->offset)) { + first_incomplete_it = NULL; + watermark = cur_section->offset; + } else { + return false; + } + } + // Otherwise, we can't go back until a provided offset. + } else if (!cur_section->offset_known) { + cur_section->offset_known = true; + cur_section->offset = watermark; + } + + assert(cur_level->size_known); + struct unsigned_option max_endpoint = {true, cur_level->size}; + if (cur_it != cur_level->list + cur_level->list_len - 1) { + struct flashmap_descriptor *next_section = cur_it[1]; + max_endpoint.val_known = next_section->offset_known; + max_endpoint.val = next_section->offset; + } + if (!validate_descriptor_node(cur_section, + (struct unsigned_option) + {!first_incomplete_it, watermark}, + max_endpoint)) + return false; + + if (!cur_section->size_known) { + if (!cur_section->offset_known) { + fprintf(stderr, + "ERROR: Cannot determine either offset or size of section '%s'\n", + cur_section->name); + return false; + } else if (!first_incomplete_it) { + first_incomplete_it = cur_it; + } else { + // We shouldn't find an unknown size within an + // incomplete region because the backward + // traversal at the beginning of this node's + // processing should have concluded said region. + assert(!first_incomplete_it); + } + } else if (!first_incomplete_it) { + watermark = cur_section->offset + cur_section->size; + } + } + + if (first_incomplete_it && + !complete_missing_info_backward(first_incomplete_it, + cur_level->list + cur_level->list_len - 1, + cur_level->size)) + return false; + + fmd_foreach_child(cur_section, cur_level) { + assert(cur_section->offset_known); + assert(cur_section->size_known); + + if (!validate_and_complete_info(cur_section)) + return false; + } + + return true; +} + +static void print_with_prefix(const struct flashmap_descriptor *tree, + const char *pre) +{ + assert(tree); + assert(pre); + + printf("%ssection '%s' has ", pre, tree->name); + + if (tree->offset_known) + printf("offset %uB, ", tree->offset); + else + fputs("unknown offset, ", stdout); + + if (tree->size_known) + printf("size %uB, ", tree->size); + else + fputs("unknown size, ", stdout); + + printf("and %zu subsections", tree->list_len); + if (tree->list_len) { + puts(":"); + + char child_prefix[strlen(pre) + 1]; + strcpy(child_prefix, pre); + strcat(child_prefix, "\t"); + fmd_foreach_child(each, tree) + print_with_prefix(each, child_prefix); + } else { + puts(""); + } +} + +struct flashmap_descriptor *fmd_create(FILE *stream) +{ + assert(stream); + + yyin = stream; + + struct flashmap_descriptor *ret = NULL; + if (yyparse() == 0) + ret = res; + + yylex_destroy(); + yyin = NULL; + res = NULL; + + if (ret) { + // This hash table is used to store the declared name of each + // section and ensure that each is globally unique. + if (!hcreate(fmd_count_nodes(ret))) { + perror("ERROR: While initializing hashtable"); + fmd_cleanup(ret); + return NULL; + } + + // Even though we haven't checked that the root node (ret) has + // a size field as required by this function, the parser + // warrants that it does because the grammar requires it. + if (!validate_and_complete_info(ret)) { + hdestroy(); + fmd_cleanup(ret); + return NULL; + } + + hdestroy(); + } + + return ret; +} + +void fmd_cleanup(struct flashmap_descriptor *victim) +{ + if (!victim) + return; + + free(victim->name); + for (unsigned idx = 0; idx < victim->list_len; ++idx) + fmd_cleanup(victim->list[idx]); + free(victim->list); + free(victim); +} + +size_t fmd_count_nodes(const struct flashmap_descriptor *tree) +{ + assert(tree); + + if (!tree->list_len) + return 1; + + unsigned count = 1; + fmd_foreach_child(lower, tree) + count += fmd_count_nodes(lower); + return count; +} + +const struct flashmap_descriptor *fmd_find_node( + const struct flashmap_descriptor *root, const char *name) +{ + assert(root); + assert(name); + + if (strcmp(root->name, name) == 0) + return root; + + fmd_foreach_child(descendant, root) { + const struct flashmap_descriptor *match = + fmd_find_node(descendant, name); + if (match) + return match; + } + return NULL; +} + +unsigned fmd_calc_absolute_offset(const struct flashmap_descriptor *root, + const char *name) +{ + assert(root); + assert(name); + + if (strcmp(root->name, name) == 0) + return 0; + + fmd_foreach_child(descendant, root) { + unsigned subtotal = fmd_calc_absolute_offset(descendant, name); + if (subtotal != FMD_NOTFOUND) + return descendant->offset + subtotal; + } + return FMD_NOTFOUND; +} + +void fmd_print(const struct flashmap_descriptor *tree) +{ + print_with_prefix(tree, ""); +} diff --git a/util/cbfstool/fmd.h b/util/cbfstool/fmd.h new file mode 100644 index 0000000..ff54cbf --- /dev/null +++ b/util/cbfstool/fmd.h @@ -0,0 +1,143 @@ +/* + * fmd.h, parser frontend and utility functions for flashmap descriptor language + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#ifndef FMD_H_ +#define FMD_H_ + +#include <limits.h> +#include <stdbool.h> +#include <stddef.h> +#include <stdio.h> + +#define FMD_NOTFOUND UINT_MAX + +struct flashmap_descriptor { + char *name; + bool offset_known; + /** + * Offset relative to that of the parent node. + * Exception: for the root node in the descriptor tree, it is optional. + * In this case, if absent, it indicates that the flash chip will not be + * memory mapped at runtime; otherwise, its value indicates the base + * address of the flash chip in the virtual address space rather than + * representing an offset into the flash image itself. + * It is an error to read this field unless offset_known is set. + */ + unsigned offset; + bool size_known; + /** It is an error to read this field unless size_known is set. */ + unsigned size; + size_t list_len; + /** It is an error to dereference this array if list_len is 0. */ + struct flashmap_descriptor **list; +}; + +/** + * **Client-defined** callback. + * This call is used to notify client code that the user has annotated the given + * section node by accompanying it with a string enclosed in parentheses. It is + * only invoked for nodes that have annotations, and then only once per node. + * The annotations' syntactic validity and semantic meaning are not determined + * by the compiler; rather, implementations of this function should use their + * return type to tell the compiler whether the annotation was valid syntax, as + * well as perform whatever actions are necessary given the particular + * annotation. It's worth reiterating that this is only called on section nodes, + * and will never be called with the final, complete flashmap_descriptor because + * it is impossible to annotate the image as a whole. Note that, although the + * node received by this function will be preserved in memory as part of the + * ultimate flashmap_descriptor, the annotation string will only persist during + * this function call: if the implementation needs it longer, it must copy it. + * + * @param flashmap_descriptor The section node carrying the annotation + * @param annotation What the user wrote (only valid during callback) + * @return Whether this annotation represented valid syntax + */ +bool fmd_process_annotation_impl(const struct flashmap_descriptor *node, + const char *annotation); + +/** + * Parse and validate a flashmap descriptor from the specified stream. + * As part of this process, any fields that were omitted in the input are + * inferred from whatever information is known, if possible. The result is a + * tree with all its offset and size fields filled, except possibly the former + * part of the root node in the case of non--memory mapped flash. If a syntax + * error causes the parser to fail, or if there is not enough information given + * in the input file to determine any single missing value, the specific error + * is reported to standard error and this function returns NULL. + * + * @param stream File from which to read the (partial) flashmap descriptor + * @return Populated flashmap descriptor tree, or NULL on failure + */ +struct flashmap_descriptor *fmd_create(FILE *stream); + +/** @param victim Valid descriptor tree to be cleaned up, or NULL for no-op */ +void fmd_cleanup(struct flashmap_descriptor *victim); + +/** + * @param tree Must be non-NULL + * @return The number of nodes in the tree, including the root + */ +size_t fmd_count_nodes(const struct flashmap_descriptor *tree); + +/** + * @param root The flashmap descriptor to search + * @param name The name of the sought-after section + * @return The desired section node, or NULL if none was found + */ +const struct flashmap_descriptor *fmd_find_node( + const struct flashmap_descriptor *root, const char *name); + +/** + * @param root Parent node to whose start the "absolute" offset will be relative + * @param name The name of the node whose offset to determine + * @return The "absolute" offset, or FMD_NOTFOUND if the node wasn't found + */ +unsigned fmd_calc_absolute_offset(const struct flashmap_descriptor *root, + const char *name); + +/** @param tree Must be non-NULL */ +void fmd_print(const struct flashmap_descriptor *tree); + +typedef struct flashmap_descriptor **flashmap_descriptor_iterator_t; + +/* + * Run the subsequent statement once on each descendant of the specified node. + * + * @param iterator A flashmap_descriptor_iterator_t (automatically declared) + * @param parent The parent node of those over which the loop should iterate + */ +#define fmd_foreach_child_iterator(iterator, parent) \ + for (flashmap_descriptor_iterator_t iterator = parent->list; \ + iterator < parent->list + parent->list_len; ++iterator) + +/* + * Run the subsequent statement once on each descendant of the specified node. + * + * @param child A struct flashmap_descriptor * (automatically declared) + * @param parent The parent node of those over which the loop should iterate + */ +#define fmd_foreach_child(child, parent) \ + for (struct flashmap_descriptor **fmd_foreach_child_iterator_ = \ + parent->list, *child = NULL; \ + fmd_foreach_child_iterator_ < \ + parent->list + parent->list_len && \ + (child = *fmd_foreach_child_iterator_); \ + ++fmd_foreach_child_iterator_) + +#endif diff --git a/util/cbfstool/fmd_parser.c b/util/cbfstool/fmd_parser.c new file mode 100644 index 0000000..d97e743 --- /dev/null +++ b/util/cbfstool/fmd_parser.c @@ -0,0 +1,1647 @@ +/* A Bison parser, made by GNU Bison 3.0.2. */ + +/* Bison implementation for Yacc-like parsers in C + + Copyright (C) 1984, 1989-1990, 2000-2013 Free Software Foundation, Inc. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. */ + +/* As a special exception, you may create a larger work that contains + part or all of the Bison parser skeleton and distribute that work + under terms of your choice, so long as that work isn't itself a + parser generator using the skeleton or a modified version thereof + as a parser skeleton. Alternatively, if you modify or redistribute + the parser skeleton itself, you may (at your option) remove this + special exception, which will cause the skeleton and the resulting + Bison output files to be licensed under the GNU General Public + License without this special exception. + + This special exception was added by the Free Software Foundation in + version 2.2 of Bison. */ + +/* C LALR(1) parser skeleton written by Richard Stallman, by + simplifying the original so-called "semantic" parser. */ + +/* All symbols defined below should begin with yy or YY, to avoid + infringing on user name space. This should be done even for local + variables, as they might otherwise be expanded by user macros. + There are some unavoidable exceptions within include files to + define necessary library symbols; they are noted "INFRINGES ON + USER NAME SPACE" below. */ + +/* Identify Bison output. */ +#define YYBISON 1 + +/* Bison version. */ +#define YYBISON_VERSION "3.0.2" + +/* Skeleton name. */ +#define YYSKELETON_NAME "yacc.c" + +/* Pure parsers. */ +#define YYPURE 0 + +/* Push parsers. */ +#define YYPUSH 0 + +/* Pull parsers. */ +#define YYPULL 1 + + + + +/* Copy the first part of user declarations. */ +#line 20 "fmd_parser.y" /* yacc.c:339 */ + +#include "fmd_scanner.h" + +#include <stdlib.h> + +struct flashmap_descriptor *res = NULL; + +#line 74 "y.tab.c" /* yacc.c:339 */ + +# ifndef YY_NULLPTR +# if defined __cplusplus && 201103L <= __cplusplus +# define YY_NULLPTR nullptr +# else +# define YY_NULLPTR 0 +# endif +# endif + +/* Enabling verbose error messages. */ +#ifdef YYERROR_VERBOSE +# undef YYERROR_VERBOSE +# define YYERROR_VERBOSE 1 +#else +# define YYERROR_VERBOSE 0 +#endif + +/* In a future release of Bison, this section will be replaced + by #include "y.tab.h". */ +#ifndef YY_YY_Y_TAB_H_INCLUDED +# define YY_YY_Y_TAB_H_INCLUDED +/* Debug traces. */ +#ifndef YYDEBUG +# define YYDEBUG 0 +#endif +#if YYDEBUG +extern int yydebug; +#endif +/* "%code requires" blocks. */ +#line 36 "fmd_parser.y" /* yacc.c:355 */ + +#include "fmd.h" +#include "option.h" + +#include <stdbool.h> + +struct descriptor_node { + struct flashmap_descriptor *val; + struct descriptor_node *next; +}; + +struct descriptor_list { + size_t len; + struct descriptor_node *head; + struct descriptor_node *tail; +}; + +extern struct flashmap_descriptor *res; + +struct flashmap_descriptor *parse_descriptor(char *name, + struct unsigned_option offset, struct unsigned_option size, + struct descriptor_list children); +void yyerror(const char *s); + +#line 129 "y.tab.c" /* yacc.c:355 */ + +/* Token type. */ +#ifndef YYTOKENTYPE +# define YYTOKENTYPE + enum yytokentype + { + INTEGER = 258, + OCTAL = 259, + STRING = 260 + }; +#endif +/* Tokens. */ +#define INTEGER 258 +#define OCTAL 259 +#define STRING 260 + +/* Value type. */ +#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED +typedef union YYSTYPE YYSTYPE; +union YYSTYPE +{ +#line 28 "fmd_parser.y" /* yacc.c:355 */ + + unsigned intval; + char *strval; + struct unsigned_option maybe_intval; + struct flashmap_descriptor *region_ptr; + struct descriptor_list region_listhdr; + +#line 159 "y.tab.c" /* yacc.c:355 */ +}; +# define YYSTYPE_IS_TRIVIAL 1 +# define YYSTYPE_IS_DECLARED 1 +#endif + + +extern YYSTYPE yylval; + +int yyparse (void); + +#endif /* !YY_YY_Y_TAB_H_INCLUDED */ + +/* Copy the second part of user declarations. */ + +#line 174 "y.tab.c" /* yacc.c:358 */ + +#ifdef short +# undef short +#endif + +#ifdef YYTYPE_UINT8 +typedef YYTYPE_UINT8 yytype_uint8; +#else +typedef unsigned char yytype_uint8; +#endif + +#ifdef YYTYPE_INT8 +typedef YYTYPE_INT8 yytype_int8; +#else +typedef signed char yytype_int8; +#endif + +#ifdef YYTYPE_UINT16 +typedef YYTYPE_UINT16 yytype_uint16; +#else +typedef unsigned short int yytype_uint16; +#endif + +#ifdef YYTYPE_INT16 +typedef YYTYPE_INT16 yytype_int16; +#else +typedef short int yytype_int16; +#endif + +#ifndef YYSIZE_T +# ifdef __SIZE_TYPE__ +# define YYSIZE_T __SIZE_TYPE__ +# elif defined size_t +# define YYSIZE_T size_t +# elif ! defined YYSIZE_T +# include <stddef.h> /* INFRINGES ON USER NAME SPACE */ +# define YYSIZE_T size_t +# else +# define YYSIZE_T unsigned int +# endif +#endif + +#define YYSIZE_MAXIMUM ((YYSIZE_T) -1) + +#ifndef YY_ +# if defined YYENABLE_NLS && YYENABLE_NLS +# if ENABLE_NLS +# include <libintl.h> /* INFRINGES ON USER NAME SPACE */ +# define YY_(Msgid) dgettext ("bison-runtime", Msgid) +# endif +# endif +# ifndef YY_ +# define YY_(Msgid) Msgid +# endif +#endif + +#ifndef YY_ATTRIBUTE +# if (defined __GNUC__ \ + && (2 < __GNUC__ || (__GNUC__ == 2 && 96 <= __GNUC_MINOR__))) \ + || defined __SUNPRO_C && 0x5110 <= __SUNPRO_C +# define YY_ATTRIBUTE(Spec) __attribute__(Spec) +# else +# define YY_ATTRIBUTE(Spec) /* empty */ +# endif +#endif + +#ifndef YY_ATTRIBUTE_PURE +# define YY_ATTRIBUTE_PURE YY_ATTRIBUTE ((__pure__)) +#endif + +#ifndef YY_ATTRIBUTE_UNUSED +# define YY_ATTRIBUTE_UNUSED YY_ATTRIBUTE ((__unused__)) +#endif + +#if !defined _Noreturn \ + && (!defined __STDC_VERSION__ || __STDC_VERSION__ < 201112) +# if defined _MSC_VER && 1200 <= _MSC_VER +# define _Noreturn __declspec (noreturn) +# else +# define _Noreturn YY_ATTRIBUTE ((__noreturn__)) +# endif +#endif + +/* Suppress unused-variable warnings by "using" E. */ +#if ! defined lint || defined __GNUC__ +# define YYUSE(E) ((void) (E)) +#else +# define YYUSE(E) /* empty */ +#endif + +#if defined __GNUC__ && 407 <= __GNUC__ * 100 + __GNUC_MINOR__ +/* Suppress an incorrect diagnostic about yylval being uninitialized. */ +# define YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN \ + _Pragma ("GCC diagnostic push") \ + _Pragma ("GCC diagnostic ignored \"-Wuninitialized\"")\ + _Pragma ("GCC diagnostic ignored \"-Wmaybe-uninitialized\"") +# define YY_IGNORE_MAYBE_UNINITIALIZED_END \ + _Pragma ("GCC diagnostic pop") +#else +# define YY_INITIAL_VALUE(Value) Value +#endif +#ifndef YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN +# define YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN +# define YY_IGNORE_MAYBE_UNINITIALIZED_END +#endif +#ifndef YY_INITIAL_VALUE +# define YY_INITIAL_VALUE(Value) /* Nothing. */ +#endif + + +#if ! defined yyoverflow || YYERROR_VERBOSE + +/* The parser invokes alloca or malloc; define the necessary symbols. */ + +# ifdef YYSTACK_USE_ALLOCA +# if YYSTACK_USE_ALLOCA +# ifdef __GNUC__ +# define YYSTACK_ALLOC __builtin_alloca +# elif defined __BUILTIN_VA_ARG_INCR +# include <alloca.h> /* INFRINGES ON USER NAME SPACE */ +# elif defined _AIX +# define YYSTACK_ALLOC __alloca +# elif defined _MSC_VER +# include <malloc.h> /* INFRINGES ON USER NAME SPACE */ +# define alloca _alloca +# else +# define YYSTACK_ALLOC alloca +# if ! defined _ALLOCA_H && ! defined EXIT_SUCCESS +# include <stdlib.h> /* INFRINGES ON USER NAME SPACE */ + /* Use EXIT_SUCCESS as a witness for stdlib.h. */ +# ifndef EXIT_SUCCESS +# define EXIT_SUCCESS 0 +# endif +# endif +# endif +# endif +# endif + +# ifdef YYSTACK_ALLOC + /* Pacify GCC's 'empty if-body' warning. */ +# define YYSTACK_FREE(Ptr) do { /* empty */; } while (0) +# ifndef YYSTACK_ALLOC_MAXIMUM + /* The OS might guarantee only one guard page at the bottom of the stack, + and a page size can be as small as 4096 bytes. So we cannot safely + invoke alloca (N) if N exceeds 4096. Use a slightly smaller number + to allow for a few compiler-allocated temporary stack slots. */ +# define YYSTACK_ALLOC_MAXIMUM 4032 /* reasonable circa 2006 */ +# endif +# else +# define YYSTACK_ALLOC YYMALLOC +# define YYSTACK_FREE YYFREE +# ifndef YYSTACK_ALLOC_MAXIMUM +# define YYSTACK_ALLOC_MAXIMUM YYSIZE_MAXIMUM +# endif +# if (defined __cplusplus && ! defined EXIT_SUCCESS \ + && ! ((defined YYMALLOC || defined malloc) \ + && (defined YYFREE || defined free))) +# include <stdlib.h> /* INFRINGES ON USER NAME SPACE */ +# ifndef EXIT_SUCCESS +# define EXIT_SUCCESS 0 +# endif +# endif +# ifndef YYMALLOC +# define YYMALLOC malloc +# if ! defined malloc && ! defined EXIT_SUCCESS +void *malloc (YYSIZE_T); /* INFRINGES ON USER NAME SPACE */ +# endif +# endif +# ifndef YYFREE +# define YYFREE free +# if ! defined free && ! defined EXIT_SUCCESS +void free (void *); /* INFRINGES ON USER NAME SPACE */ +# endif +# endif +# endif +#endif /* ! defined yyoverflow || YYERROR_VERBOSE */ + + +#if (! defined yyoverflow \ + && (! defined __cplusplus \ + || (defined YYSTYPE_IS_TRIVIAL && YYSTYPE_IS_TRIVIAL))) + +/* A type that is properly aligned for any stack member. */ +union yyalloc +{ + yytype_int16 yyss_alloc; + YYSTYPE yyvs_alloc; +}; + +/* The size of the maximum gap between one aligned stack and the next. */ +# define YYSTACK_GAP_MAXIMUM (sizeof (union yyalloc) - 1) + +/* The size of an array large to enough to hold all stacks, each with + N elements. */ +# define YYSTACK_BYTES(N) \ + ((N) * (sizeof (yytype_int16) + sizeof (YYSTYPE)) \ + + YYSTACK_GAP_MAXIMUM) + +# define YYCOPY_NEEDED 1 + +/* Relocate STACK from its old location to the new one. The + local variables YYSIZE and YYSTACKSIZE give the old and new number of + elements in the stack, and YYPTR gives the new location of the + stack. Advance YYPTR to a properly aligned location for the next + stack. */ +# define YYSTACK_RELOCATE(Stack_alloc, Stack) \ + do \ + { \ + YYSIZE_T yynewbytes; \ + YYCOPY (&yyptr->Stack_alloc, Stack, yysize); \ + Stack = &yyptr->Stack_alloc; \ + yynewbytes = yystacksize * sizeof (*Stack) + YYSTACK_GAP_MAXIMUM; \ + yyptr += yynewbytes / sizeof (*yyptr); \ + } \ + while (0) + +#endif + +#if defined YYCOPY_NEEDED && YYCOPY_NEEDED +/* Copy COUNT objects from SRC to DST. The source and destination do + not overlap. */ +# ifndef YYCOPY +# if defined __GNUC__ && 1 < __GNUC__ +# define YYCOPY(Dst, Src, Count) \ + __builtin_memcpy (Dst, Src, (Count) * sizeof (*(Src))) +# else +# define YYCOPY(Dst, Src, Count) \ + do \ + { \ + YYSIZE_T yyi; \ + for (yyi = 0; yyi < (Count); yyi++) \ + (Dst)[yyi] = (Src)[yyi]; \ + } \ + while (0) +# endif +# endif +#endif /* !YYCOPY_NEEDED */ + +/* YYFINAL -- State number of the termination state. */ +#define YYFINAL 4 +/* YYLAST -- Last index in YYTABLE. */ +#define YYLAST 17 + +/* YYNTOKENS -- Number of terminals. */ +#define YYNTOKENS 11 +/* YYNNTS -- Number of nonterminals. */ +#define YYNNTS 13 +/* YYNRULES -- Number of rules. */ +#define YYNRULES 18 +/* YYNSTATES -- Number of states. */ +#define YYNSTATES 28 + +/* YYTRANSLATE[YYX] -- Symbol number corresponding to YYX as returned + by yylex, with out-of-bounds checking. */ +#define YYUNDEFTOK 2 +#define YYMAXUTOK 260 + +#define YYTRANSLATE(YYX) \ + ((unsigned int) (YYX) <= YYMAXUTOK ? yytranslate[YYX] : YYUNDEFTOK) + +/* YYTRANSLATE[TOKEN-NUM] -- Symbol number corresponding to TOKEN-NUM + as returned by yylex, without out-of-bounds checking. */ +static const yytype_uint8 yytranslate[] = +{ + 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 6, 7, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 8, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 9, 2, 10, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 1, 2, 3, 4, + 5 +}; + +#if YYDEBUG + /* YYRLINE[YYN] -- Source line where rule number YYN was defined. */ +static const yytype_uint8 yyrline[] = +{ + 0, 79, 79, 84, 101, 108, 109, 110, 111, 112, + 113, 114, 115, 116, 118, 122, 123, 124, 135 +}; +#endif + +#if YYDEBUG || YYERROR_VERBOSE || 0 +/* YYTNAME[SYMBOL-NUM] -- String name of the symbol SYMBOL-NUM. + First, the terminals, then, starting at YYNTOKENS, nonterminals. */ +static const char *const yytname[] = +{ + "$end", "error", "$undefined", "INTEGER", "OCTAL", "STRING", "'('", + "')'", "'@'", "'{'", "'}'", "$accept", "flash_chip", "flash_region", + "region_name", "region_annotation_opt", "region_annotation", + "region_offset_opt", "region_offset", "region_size_opt", "region_size", + "region_list_opt", "region_list", "region_list_entries", YY_NULLPTR +}; +#endif + +# ifdef YYPRINT +/* YYTOKNUM[NUM] -- (External) token number corresponding to the + (internal) symbol number NUM (which must be that of a token). */ +static const yytype_uint16 yytoknum[] = +{ + 0, 256, 257, 258, 259, 260, 40, 41, 64, 123, + 125 +}; +# endif + +#define YYPACT_NINF -10 + +#define yypact_value_is_default(Yystate) \ + (!!((Yystate) == (-10))) + +#define YYTABLE_NINF -1 + +#define yytable_value_is_error(Yytable_value) \ + 0 + + /* YYPACT[STATE-NUM] -- Index in YYTABLE of the portion describing + STATE-NUM. */ +static const yytype_int8 yypact[] = +{ + -4, -10, 2, -2, -10, 0, 1, -10, -10, -10, + -1, -4, -10, -10, 3, -5, 5, -2, -10, -10, + -10, 4, 1, -10, -1, -10, -10, -10 +}; + + /* YYDEFACT[STATE-NUM] -- Default reduction number in state STATE-NUM. + Performed when YYTABLE does not specify something else to do. Zero + means the default is an error. */ +static const yytype_uint8 yydefact[] = +{ + 0, 4, 0, 8, 1, 0, 0, 9, 10, 13, + 0, 0, 2, 17, 5, 0, 0, 8, 6, 16, + 18, 0, 11, 7, 14, 12, 3, 15 +}; + + /* YYPGOTO[NTERM-NUM]. */ +static const yytype_int8 yypgoto[] = +{ + -10, -10, -8, 12, -10, -10, -3, -10, -10, -9, + -10, -7, -10 +}; + + /* YYDEFGOTO[NTERM-NUM]. */ +static const yytype_int8 yydefgoto[] = +{ + -1, 2, 13, 14, 17, 18, 6, 7, 24, 10, + 26, 12, 15 +}; + + /* YYTABLE[YYPACT[STATE-NUM]] -- What to do in state STATE-NUM. If + positive, shift that token. If negative, reduce the rule whose + number is the opposite. If YYTABLE_NINF, syntax error. */ +static const yytype_uint8 yytable[] = +{ + 1, 1, 4, 8, 9, 19, 5, 20, 11, 16, + 21, 23, 3, 25, 22, 0, 0, 27 +}; + +static const yytype_int8 yycheck[] = +{ + 5, 5, 0, 3, 3, 10, 8, 15, 9, 6, + 5, 7, 0, 22, 17, -1, -1, 24 +}; + + /* YYSTOS[STATE-NUM] -- The (internal number of the) accessing + symbol of state STATE-NUM. */ +static const yytype_uint8 yystos[] = +{ + 0, 5, 12, 14, 0, 8, 17, 18, 3, 3, + 20, 9, 22, 13, 14, 23, 6, 15, 16, 10, + 13, 5, 17, 7, 19, 20, 21, 22 +}; + + /* YYR1[YYN] -- Symbol number of symbol that rule YYN derives. */ +static const yytype_uint8 yyr1[] = +{ + 0, 11, 12, 13, 14, 15, 15, 16, 17, 17, + 18, 19, 19, 20, 21, 21, 22, 23, 23 +}; + + /* YYR2[YYN] -- Number of symbols on the right hand side of rule YYN. */ +static const yytype_uint8 yyr2[] = +{ + 0, 2, 4, 5, 1, 0, 1, 3, 0, 1, + 2, 0, 1, 1, 0, 1, 3, 1, 2 +}; + + +#define yyerrok (yyerrstatus = 0) +#define yyclearin (yychar = YYEMPTY) +#define YYEMPTY (-2) +#define YYEOF 0 + +#define YYACCEPT goto yyacceptlab +#define YYABORT goto yyabortlab +#define YYERROR goto yyerrorlab + + +#define YYRECOVERING() (!!yyerrstatus) + +#define YYBACKUP(Token, Value) \ +do \ + if (yychar == YYEMPTY) \ + { \ + yychar = (Token); \ + yylval = (Value); \ + YYPOPSTACK (yylen); \ + yystate = *yyssp; \ + goto yybackup; \ + } \ + else \ + { \ + yyerror (YY_("syntax error: cannot back up")); \ + YYERROR; \ + } \ +while (0) + +/* Error token number */ +#define YYTERROR 1 +#define YYERRCODE 256 + + + +/* Enable debugging if requested. */ +#if YYDEBUG + +# ifndef YYFPRINTF +# include <stdio.h> /* INFRINGES ON USER NAME SPACE */ +# define YYFPRINTF fprintf +# endif + +# define YYDPRINTF(Args) \ +do { \ + if (yydebug) \ + YYFPRINTF Args; \ +} while (0) + +/* This macro is provided for backward compatibility. */ +#ifndef YY_LOCATION_PRINT +# define YY_LOCATION_PRINT(File, Loc) ((void) 0) +#endif + + +# define YY_SYMBOL_PRINT(Title, Type, Value, Location) \ +do { \ + if (yydebug) \ + { \ + YYFPRINTF (stderr, "%s ", Title); \ + yy_symbol_print (stderr, \ + Type, Value); \ + YYFPRINTF (stderr, "\n"); \ + } \ +} while (0) + + +/*----------------------------------------. +| Print this symbol's value on YYOUTPUT. | +`----------------------------------------*/ + +static void +yy_symbol_value_print (FILE *yyoutput, int yytype, YYSTYPE const * const yyvaluep) +{ + FILE *yyo = yyoutput; + YYUSE (yyo); + if (!yyvaluep) + return; +# ifdef YYPRINT + if (yytype < YYNTOKENS) + YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep); +# endif + YYUSE (yytype); +} + + +/*--------------------------------. +| Print this symbol on YYOUTPUT. | +`--------------------------------*/ + +static void +yy_symbol_print (FILE *yyoutput, int yytype, YYSTYPE const * const yyvaluep) +{ + YYFPRINTF (yyoutput, "%s %s (", + yytype < YYNTOKENS ? "token" : "nterm", yytname[yytype]); + + yy_symbol_value_print (yyoutput, yytype, yyvaluep); + YYFPRINTF (yyoutput, ")"); +} + +/*------------------------------------------------------------------. +| yy_stack_print -- Print the state stack from its BOTTOM up to its | +| TOP (included). | +`------------------------------------------------------------------*/ + +static void +yy_stack_print (yytype_int16 *yybottom, yytype_int16 *yytop) +{ + YYFPRINTF (stderr, "Stack now"); + for (; yybottom <= yytop; yybottom++) + { + int yybot = *yybottom; + YYFPRINTF (stderr, " %d", yybot); + } + YYFPRINTF (stderr, "\n"); +} + +# define YY_STACK_PRINT(Bottom, Top) \ +do { \ + if (yydebug) \ + yy_stack_print ((Bottom), (Top)); \ +} while (0) + + +/*------------------------------------------------. +| Report that the YYRULE is going to be reduced. | +`------------------------------------------------*/ + +static void +yy_reduce_print (yytype_int16 *yyssp, YYSTYPE *yyvsp, int yyrule) +{ + unsigned long int yylno = yyrline[yyrule]; + int yynrhs = yyr2[yyrule]; + int yyi; + YYFPRINTF (stderr, "Reducing stack by rule %d (line %lu):\n", + yyrule - 1, yylno); + /* The symbols being reduced. */ + for (yyi = 0; yyi < yynrhs; yyi++) + { + YYFPRINTF (stderr, " $%d = ", yyi + 1); + yy_symbol_print (stderr, + yystos[yyssp[yyi + 1 - yynrhs]], + &(yyvsp[(yyi + 1) - (yynrhs)]) + ); + YYFPRINTF (stderr, "\n"); + } +} + +# define YY_REDUCE_PRINT(Rule) \ +do { \ + if (yydebug) \ + yy_reduce_print (yyssp, yyvsp, Rule); \ +} while (0) + +/* Nonzero means print parse trace. It is left uninitialized so that + multiple parsers can coexist. */ +int yydebug; +#else /* !YYDEBUG */ +# define YYDPRINTF(Args) +# define YY_SYMBOL_PRINT(Title, Type, Value, Location) +# define YY_STACK_PRINT(Bottom, Top) +# define YY_REDUCE_PRINT(Rule) +#endif /* !YYDEBUG */ + + +/* YYINITDEPTH -- initial size of the parser's stacks. */ +#ifndef YYINITDEPTH +# define YYINITDEPTH 200 +#endif + +/* YYMAXDEPTH -- maximum size the stacks can grow to (effective only + if the built-in stack extension method is used). + + Do not make this value too large; the results are undefined if + YYSTACK_ALLOC_MAXIMUM < YYSTACK_BYTES (YYMAXDEPTH) + evaluated with infinite-precision integer arithmetic. */ + +#ifndef YYMAXDEPTH +# define YYMAXDEPTH 10000 +#endif + + +#if YYERROR_VERBOSE + +# ifndef yystrlen +# if defined __GLIBC__ && defined _STRING_H +# define yystrlen strlen +# else +/* Return the length of YYSTR. */ +static YYSIZE_T +yystrlen (const char *yystr) +{ + YYSIZE_T yylen; + for (yylen = 0; yystr[yylen]; yylen++) + continue; + return yylen; +} +# endif +# endif + +# ifndef yystpcpy +# if defined __GLIBC__ && defined _STRING_H && defined _GNU_SOURCE +# define yystpcpy stpcpy +# else +/* Copy YYSRC to YYDEST, returning the address of the terminating '\0' in + YYDEST. */ +static char * +yystpcpy (char *yydest, const char *yysrc) +{ + char *yyd = yydest; + const char *yys = yysrc; + + while ((*yyd++ = *yys++) != '\0') + continue; + + return yyd - 1; +} +# endif +# endif + +# ifndef yytnamerr +/* Copy to YYRES the contents of YYSTR after stripping away unnecessary + quotes and backslashes, so that it's suitable for yyerror. The + heuristic is that double-quoting is unnecessary unless the string + contains an apostrophe, a comma, or backslash (other than + backslash-backslash). YYSTR is taken from yytname. If YYRES is + null, do not copy; instead, return the length of what the result + would have been. */ +static YYSIZE_T +yytnamerr (char *yyres, const char *yystr) +{ + if (*yystr == '"') + { + YYSIZE_T yyn = 0; + char const *yyp = yystr; + + for (;;) + switch (*++yyp) + { + case '\'': + case ',': + goto do_not_strip_quotes; + + case '\\': + if (*++yyp != '\\') + goto do_not_strip_quotes; + /* Fall through. */ + default: + if (yyres) + yyres[yyn] = *yyp; + yyn++; + break; + + case '"': + if (yyres) + yyres[yyn] = '\0'; + return yyn; + } + do_not_strip_quotes: ; + } + + if (! yyres) + return yystrlen (yystr); + + return yystpcpy (yyres, yystr) - yyres; +} +# endif + +/* Copy into *YYMSG, which is of size *YYMSG_ALLOC, an error message + about the unexpected token YYTOKEN for the state stack whose top is + YYSSP. + + Return 0 if *YYMSG was successfully written. Return 1 if *YYMSG is + not large enough to hold the message. In that case, also set + *YYMSG_ALLOC to the required number of bytes. Return 2 if the + required number of bytes is too large to store. */ +static int +yysyntax_error (YYSIZE_T *yymsg_alloc, char **yymsg, + yytype_int16 *yyssp, int yytoken) +{ + YYSIZE_T yysize0 = yytnamerr (YY_NULLPTR, yytname[yytoken]); + YYSIZE_T yysize = yysize0; + enum { YYERROR_VERBOSE_ARGS_MAXIMUM = 5 }; + /* Internationalized format string. */ + const char *yyformat = YY_NULLPTR; + /* Arguments of yyformat. */ + char const *yyarg[YYERROR_VERBOSE_ARGS_MAXIMUM]; + /* Number of reported tokens (one for the "unexpected", one per + "expected"). */ + int yycount = 0; + + /* There are many possibilities here to consider: + - If this state is a consistent state with a default action, then + the only way this function was invoked is if the default action + is an error action. In that case, don't check for expected + tokens because there are none. + - The only way there can be no lookahead present (in yychar) is if + this state is a consistent state with a default action. Thus, + detecting the absence of a lookahead is sufficient to determine + that there is no unexpected or expected token to report. In that + case, just report a simple "syntax error". + - Don't assume there isn't a lookahead just because this state is a + consistent state with a default action. There might have been a + previous inconsistent state, consistent state with a non-default + action, or user semantic action that manipulated yychar. + - Of course, the expected token list depends on states to have + correct lookahead information, and it depends on the parser not + to perform extra reductions after fetching a lookahead from the + scanner and before detecting a syntax error. Thus, state merging + (from LALR or IELR) and default reductions corrupt the expected + token list. However, the list is correct for canonical LR with + one exception: it will still contain any token that will not be + accepted due to an error action in a later state. + */ + if (yytoken != YYEMPTY) + { + int yyn = yypact[*yyssp]; + yyarg[yycount++] = yytname[yytoken]; + if (!yypact_value_is_default (yyn)) + { + /* Start YYX at -YYN if negative to avoid negative indexes in + YYCHECK. In other words, skip the first -YYN actions for + this state because they are default actions. */ + int yyxbegin = yyn < 0 ? -yyn : 0; + /* Stay within bounds of both yycheck and yytname. */ + int yychecklim = YYLAST - yyn + 1; + int yyxend = yychecklim < YYNTOKENS ? yychecklim : YYNTOKENS; + int yyx; + + for (yyx = yyxbegin; yyx < yyxend; ++yyx) + if (yycheck[yyx + yyn] == yyx && yyx != YYTERROR + && !yytable_value_is_error (yytable[yyx + yyn])) + { + if (yycount == YYERROR_VERBOSE_ARGS_MAXIMUM) + { + yycount = 1; + yysize = yysize0; + break; + } + yyarg[yycount++] = yytname[yyx]; + { + YYSIZE_T yysize1 = yysize + yytnamerr (YY_NULLPTR, yytname[yyx]); + if (! (yysize <= yysize1 + && yysize1 <= YYSTACK_ALLOC_MAXIMUM)) + return 2; + yysize = yysize1; + } + } + } + } + + switch (yycount) + { +# define YYCASE_(N, S) \ + case N: \ + yyformat = S; \ + break + YYCASE_(0, YY_("syntax error")); + YYCASE_(1, YY_("syntax error, unexpected %s")); + YYCASE_(2, YY_("syntax error, unexpected %s, expecting %s")); + YYCASE_(3, YY_("syntax error, unexpected %s, expecting %s or %s")); + YYCASE_(4, YY_("syntax error, unexpected %s, expecting %s or %s or %s")); + YYCASE_(5, YY_("syntax error, unexpected %s, expecting %s or %s or %s or %s")); +# undef YYCASE_ + } + + { + YYSIZE_T yysize1 = yysize + yystrlen (yyformat); + if (! (yysize <= yysize1 && yysize1 <= YYSTACK_ALLOC_MAXIMUM)) + return 2; + yysize = yysize1; + } + + if (*yymsg_alloc < yysize) + { + *yymsg_alloc = 2 * yysize; + if (! (yysize <= *yymsg_alloc + && *yymsg_alloc <= YYSTACK_ALLOC_MAXIMUM)) + *yymsg_alloc = YYSTACK_ALLOC_MAXIMUM; + return 1; + } + + /* Avoid sprintf, as that infringes on the user's name space. + Don't have undefined behavior even if the translation + produced a string with the wrong number of "%s"s. */ + { + char *yyp = *yymsg; + int yyi = 0; + while ((*yyp = *yyformat) != '\0') + if (*yyp == '%' && yyformat[1] == 's' && yyi < yycount) + { + yyp += yytnamerr (yyp, yyarg[yyi++]); + yyformat += 2; + } + else + { + yyp++; + yyformat++; + } + } + return 0; +} +#endif /* YYERROR_VERBOSE */ + +/*-----------------------------------------------. +| Release the memory associated to this symbol. | +`-----------------------------------------------*/ + +static void +yydestruct (const char *yymsg, int yytype, YYSTYPE *yyvaluep) +{ + YYUSE (yyvaluep); + if (!yymsg) + yymsg = "Deleting"; + YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp); + + YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN + YYUSE (yytype); + YY_IGNORE_MAYBE_UNINITIALIZED_END +} + + + + +/* The lookahead symbol. */ +int yychar; + +/* The semantic value of the lookahead symbol. */ +YYSTYPE yylval; +/* Number of syntax errors so far. */ +int yynerrs; + + +/*----------. +| yyparse. | +`----------*/ + +int +yyparse (void) +{ + int yystate; + /* Number of tokens to shift before error messages enabled. */ + int yyerrstatus; + + /* The stacks and their tools: + 'yyss': related to states. + 'yyvs': related to semantic values. + + Refer to the stacks through separate pointers, to allow yyoverflow + to reallocate them elsewhere. */ + + /* The state stack. */ + yytype_int16 yyssa[YYINITDEPTH]; + yytype_int16 *yyss; + yytype_int16 *yyssp; + + /* The semantic value stack. */ + YYSTYPE yyvsa[YYINITDEPTH]; + YYSTYPE *yyvs; + YYSTYPE *yyvsp; + + YYSIZE_T yystacksize; + + int yyn; + int yyresult; + /* Lookahead token as an internal (translated) token number. */ + int yytoken = 0; + /* The variables used to return semantic value and location from the + action routines. */ + YYSTYPE yyval; + +#if YYERROR_VERBOSE + /* Buffer for error messages, and its allocated size. */ + char yymsgbuf[128]; + char *yymsg = yymsgbuf; + YYSIZE_T yymsg_alloc = sizeof yymsgbuf; +#endif + +#define YYPOPSTACK(N) (yyvsp -= (N), yyssp -= (N)) + + /* The number of symbols on the RHS of the reduced rule. + Keep to zero when no symbol should be popped. */ + int yylen = 0; + + yyssp = yyss = yyssa; + yyvsp = yyvs = yyvsa; + yystacksize = YYINITDEPTH; + + YYDPRINTF ((stderr, "Starting parse\n")); + + yystate = 0; + yyerrstatus = 0; + yynerrs = 0; + yychar = YYEMPTY; /* Cause a token to be read. */ + goto yysetstate; + +/*------------------------------------------------------------. +| yynewstate -- Push a new state, which is found in yystate. | +`------------------------------------------------------------*/ + yynewstate: + /* In all cases, when you get here, the value and location stacks + have just been pushed. So pushing a state here evens the stacks. */ + yyssp++; + + yysetstate: + *yyssp = yystate; + + if (yyss + yystacksize - 1 <= yyssp) + { + /* Get the current used size of the three stacks, in elements. */ + YYSIZE_T yysize = yyssp - yyss + 1; + +#ifdef yyoverflow + { + /* Give user a chance to reallocate the stack. Use copies of + these so that the &'s don't force the real ones into + memory. */ + YYSTYPE *yyvs1 = yyvs; + yytype_int16 *yyss1 = yyss; + + /* Each stack pointer address is followed by the size of the + data in use in that stack, in bytes. This used to be a + conditional around just the two extra args, but that might + be undefined if yyoverflow is a macro. */ + yyoverflow (YY_("memory exhausted"), + &yyss1, yysize * sizeof (*yyssp), + &yyvs1, yysize * sizeof (*yyvsp), + &yystacksize); + + yyss = yyss1; + yyvs = yyvs1; + } +#else /* no yyoverflow */ +# ifndef YYSTACK_RELOCATE + goto yyexhaustedlab; +# else + /* Extend the stack our own way. */ + if (YYMAXDEPTH <= yystacksize) + goto yyexhaustedlab; + yystacksize *= 2; + if (YYMAXDEPTH < yystacksize) + yystacksize = YYMAXDEPTH; + + { + yytype_int16 *yyss1 = yyss; + union yyalloc *yyptr = + (union yyalloc *) YYSTACK_ALLOC (YYSTACK_BYTES (yystacksize)); + if (! yyptr) + goto yyexhaustedlab; + YYSTACK_RELOCATE (yyss_alloc, yyss); + YYSTACK_RELOCATE (yyvs_alloc, yyvs); +# undef YYSTACK_RELOCATE + if (yyss1 != yyssa) + YYSTACK_FREE (yyss1); + } +# endif +#endif /* no yyoverflow */ + + yyssp = yyss + yysize - 1; + yyvsp = yyvs + yysize - 1; + + YYDPRINTF ((stderr, "Stack size increased to %lu\n", + (unsigned long int) yystacksize)); + + if (yyss + yystacksize - 1 <= yyssp) + YYABORT; + } + + YYDPRINTF ((stderr, "Entering state %d\n", yystate)); + + if (yystate == YYFINAL) + YYACCEPT; + + goto yybackup; + +/*-----------. +| yybackup. | +`-----------*/ +yybackup: + + /* Do appropriate processing given the current state. Read a + lookahead token if we need one and don't already have one. */ + + /* First try to decide what to do without reference to lookahead token. */ + yyn = yypact[yystate]; + if (yypact_value_is_default (yyn)) + goto yydefault; + + /* Not known => get a lookahead token if don't already have one. */ + + /* YYCHAR is either YYEMPTY or YYEOF or a valid lookahead symbol. */ + if (yychar == YYEMPTY) + { + YYDPRINTF ((stderr, "Reading a token: ")); + yychar = yylex (); + } + + if (yychar <= YYEOF) + { + yychar = yytoken = YYEOF; + YYDPRINTF ((stderr, "Now at end of input.\n")); + } + else + { + yytoken = YYTRANSLATE (yychar); + YY_SYMBOL_PRINT ("Next token is", yytoken, &yylval, &yylloc); + } + + /* If the proper action on seeing token YYTOKEN is to reduce or to + detect an error, take that action. */ + yyn += yytoken; + if (yyn < 0 || YYLAST < yyn || yycheck[yyn] != yytoken) + goto yydefault; + yyn = yytable[yyn]; + if (yyn <= 0) + { + if (yytable_value_is_error (yyn)) + goto yyerrlab; + yyn = -yyn; + goto yyreduce; + } + + /* Count tokens shifted since error; after three, turn off error + status. */ + if (yyerrstatus) + yyerrstatus--; + + /* Shift the lookahead token. */ + YY_SYMBOL_PRINT ("Shifting", yytoken, &yylval, &yylloc); + + /* Discard the shifted token. */ + yychar = YYEMPTY; + + yystate = yyn; + YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN + *++yyvsp = yylval; + YY_IGNORE_MAYBE_UNINITIALIZED_END + + goto yynewstate; + + +/*-----------------------------------------------------------. +| yydefault -- do the default action for the current state. | +`-----------------------------------------------------------*/ +yydefault: + yyn = yydefact[yystate]; + if (yyn == 0) + goto yyerrlab; + goto yyreduce; + + +/*-----------------------------. +| yyreduce -- Do a reduction. | +`-----------------------------*/ +yyreduce: + /* yyn is the number of a rule to reduce with. */ + yylen = yyr2[yyn]; + + /* If YYLEN is nonzero, implement the default value of the action: + '$$ = $1'. + + Otherwise, the following line sets YYVAL to garbage. + This behavior is undocumented and Bison + users should not rely upon it. Assigning to YYVAL + unconditionally makes the parser a bit smaller, and it avoids a + GCC warning that YYVAL may be used uninitialized. */ + yyval = yyvsp[1-yylen]; + + + YY_REDUCE_PRINT (yyn); + switch (yyn) + { + case 2: +#line 80 "fmd_parser.y" /* yacc.c:1646 */ + { + if (!(res = parse_descriptor((yyvsp[-3].strval), (yyvsp[-2].maybe_intval), (yyvsp[-1].maybe_intval), (yyvsp[0].region_listhdr)))) + YYABORT; +} +#line 1260 "y.tab.c" /* yacc.c:1646 */ + break; + + case 3: +#line 86 "fmd_parser.y" /* yacc.c:1646 */ + { + struct flashmap_descriptor *node = parse_descriptor((yyvsp[-4].strval), (yyvsp[-2].maybe_intval), (yyvsp[-1].maybe_intval), (yyvsp[0].region_listhdr)); + if (!node) + YYABORT; + + char *annotation = (yyvsp[-3].strval); + if (annotation && !fmd_process_annotation_impl(node, annotation)) { + fprintf(stderr, "ERROR: Section '%s' has unexpected annotation '(%s)'\n", + node->name, annotation); + YYABORT; + } + free(annotation); + + (yyval.region_ptr) = node; +} +#line 1280 "y.tab.c" /* yacc.c:1646 */ + break; + + case 4: +#line 102 "fmd_parser.y" /* yacc.c:1646 */ + { + if (!(yyvsp[0].strval)) { + perror("ERROR: While allocating section name"); + YYABORT; + } +} +#line 1291 "y.tab.c" /* yacc.c:1646 */ + break; + + case 5: +#line 108 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.strval) = NULL; } +#line 1297 "y.tab.c" /* yacc.c:1646 */ + break; + + case 7: +#line 110 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.strval) = (yyvsp[-1].strval); } +#line 1303 "y.tab.c" /* yacc.c:1646 */ + break; + + case 8: +#line 111 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.maybe_intval) = (struct unsigned_option){false, 0}; } +#line 1309 "y.tab.c" /* yacc.c:1646 */ + break; + + case 10: +#line 113 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.maybe_intval) = (struct unsigned_option){true, (yyvsp[0].intval)}; } +#line 1315 "y.tab.c" /* yacc.c:1646 */ + break; + + case 11: +#line 114 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.maybe_intval) = (struct unsigned_option){false, 0}; } +#line 1321 "y.tab.c" /* yacc.c:1646 */ + break; + + case 13: +#line 116 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.maybe_intval) = (struct unsigned_option){true, (yyvsp[0].intval)}; } +#line 1327 "y.tab.c" /* yacc.c:1646 */ + break; + + case 14: +#line 118 "fmd_parser.y" /* yacc.c:1646 */ + { + (yyval.region_listhdr) = (struct descriptor_list) + {.len = 0, .head = NULL, .tail = NULL}; +} +#line 1336 "y.tab.c" /* yacc.c:1646 */ + break; + + case 16: +#line 123 "fmd_parser.y" /* yacc.c:1646 */ + { (yyval.region_listhdr) = (yyvsp[-1].region_listhdr); } +#line 1342 "y.tab.c" /* yacc.c:1646 */ + break; + + case 17: +#line 125 "fmd_parser.y" /* yacc.c:1646 */ + { + struct descriptor_node *node = malloc(sizeof(*node)); + if (!node) { + perror("ERROR: While allocating linked list node"); + YYABORT; + } + node->val = (yyvsp[0].region_ptr); + node->next = NULL; + (yyval.region_listhdr) = (struct descriptor_list){.len = 1, .head = node, .tail = node}; +} +#line 1357 "y.tab.c" /* yacc.c:1646 */ + break; + + case 18: +#line 136 "fmd_parser.y" /* yacc.c:1646 */ + { + struct descriptor_node *node = malloc(sizeof(*node)); + if (!node) { + perror("ERROR: While allocating linked list node"); + YYABORT; + } + node->val = (yyvsp[0].region_ptr); + node->next = NULL; + + (yyvsp[-1].region_listhdr).tail->next = node; + (yyval.region_listhdr) = (struct descriptor_list) + {.len = (yyvsp[-1].region_listhdr).len + 1, .head = (yyvsp[-1].region_listhdr).head, .tail = node}; +} +#line 1375 "y.tab.c" /* yacc.c:1646 */ + break; + + +#line 1379 "y.tab.c" /* yacc.c:1646 */ + default: break; + } + /* User semantic actions sometimes alter yychar, and that requires + that yytoken be updated with the new translation. We take the + approach of translating immediately before every use of yytoken. + One alternative is translating here after every semantic action, + but that translation would be missed if the semantic action invokes + YYABORT, YYACCEPT, or YYERROR immediately after altering yychar or + if it invokes YYBACKUP. In the case of YYABORT or YYACCEPT, an + incorrect destructor might then be invoked immediately. In the + case of YYERROR or YYBACKUP, subsequent parser actions might lead + to an incorrect destructor call or verbose syntax error message + before the lookahead is translated. */ + YY_SYMBOL_PRINT ("-> $$ =", yyr1[yyn], &yyval, &yyloc); + + YYPOPSTACK (yylen); + yylen = 0; + YY_STACK_PRINT (yyss, yyssp); + + *++yyvsp = yyval; + + /* Now 'shift' the result of the reduction. Determine what state + that goes to, based on the state we popped back to and the rule + number reduced by. */ + + yyn = yyr1[yyn]; + + yystate = yypgoto[yyn - YYNTOKENS] + *yyssp; + if (0 <= yystate && yystate <= YYLAST && yycheck[yystate] == *yyssp) + yystate = yytable[yystate]; + else + yystate = yydefgoto[yyn - YYNTOKENS]; + + goto yynewstate; + + +/*--------------------------------------. +| yyerrlab -- here on detecting error. | +`--------------------------------------*/ +yyerrlab: + /* Make sure we have latest lookahead translation. See comments at + user semantic actions for why this is necessary. */ + yytoken = yychar == YYEMPTY ? YYEMPTY : YYTRANSLATE (yychar); + + /* If not already recovering from an error, report this error. */ + if (!yyerrstatus) + { + ++yynerrs; +#if ! YYERROR_VERBOSE + yyerror (YY_("syntax error")); +#else +# define YYSYNTAX_ERROR yysyntax_error (&yymsg_alloc, &yymsg, \ + yyssp, yytoken) + { + char const *yymsgp = YY_("syntax error"); + int yysyntax_error_status; + yysyntax_error_status = YYSYNTAX_ERROR; + if (yysyntax_error_status == 0) + yymsgp = yymsg; + else if (yysyntax_error_status == 1) + { + if (yymsg != yymsgbuf) + YYSTACK_FREE (yymsg); + yymsg = (char *) YYSTACK_ALLOC (yymsg_alloc); + if (!yymsg) + { + yymsg = yymsgbuf; + yymsg_alloc = sizeof yymsgbuf; + yysyntax_error_status = 2; + } + else + { + yysyntax_error_status = YYSYNTAX_ERROR; + yymsgp = yymsg; + } + } + yyerror (yymsgp); + if (yysyntax_error_status == 2) + goto yyexhaustedlab; + } +# undef YYSYNTAX_ERROR +#endif + } + + + + if (yyerrstatus == 3) + { + /* If just tried and failed to reuse lookahead token after an + error, discard it. */ + + if (yychar <= YYEOF) + { + /* Return failure if at end of input. */ + if (yychar == YYEOF) + YYABORT; + } + else + { + yydestruct ("Error: discarding", + yytoken, &yylval); + yychar = YYEMPTY; + } + } + + /* Else will try to reuse lookahead token after shifting the error + token. */ + goto yyerrlab1; + + +/*---------------------------------------------------. +| yyerrorlab -- error raised explicitly by YYERROR. | +`---------------------------------------------------*/ +yyerrorlab: + + /* Pacify compilers like GCC when the user code never invokes + YYERROR and the label yyerrorlab therefore never appears in user + code. */ + if (/*CONSTCOND*/ 0) + goto yyerrorlab; + + /* Do not reclaim the symbols of the rule whose action triggered + this YYERROR. */ + YYPOPSTACK (yylen); + yylen = 0; + YY_STACK_PRINT (yyss, yyssp); + yystate = *yyssp; + goto yyerrlab1; + + +/*-------------------------------------------------------------. +| yyerrlab1 -- common code for both syntax error and YYERROR. | +`-------------------------------------------------------------*/ +yyerrlab1: + yyerrstatus = 3; /* Each real token shifted decrements this. */ + + for (;;) + { + yyn = yypact[yystate]; + if (!yypact_value_is_default (yyn)) + { + yyn += YYTERROR; + if (0 <= yyn && yyn <= YYLAST && yycheck[yyn] == YYTERROR) + { + yyn = yytable[yyn]; + if (0 < yyn) + break; + } + } + + /* Pop the current state because it cannot handle the error token. */ + if (yyssp == yyss) + YYABORT; + + + yydestruct ("Error: popping", + yystos[yystate], yyvsp); + YYPOPSTACK (1); + yystate = *yyssp; + YY_STACK_PRINT (yyss, yyssp); + } + + YY_IGNORE_MAYBE_UNINITIALIZED_BEGIN + *++yyvsp = yylval; + YY_IGNORE_MAYBE_UNINITIALIZED_END + + + /* Shift the error token. */ + YY_SYMBOL_PRINT ("Shifting", yystos[yyn], yyvsp, yylsp); + + yystate = yyn; + goto yynewstate; + + +/*-------------------------------------. +| yyacceptlab -- YYACCEPT comes here. | +`-------------------------------------*/ +yyacceptlab: + yyresult = 0; + goto yyreturn; + +/*-----------------------------------. +| yyabortlab -- YYABORT comes here. | +`-----------------------------------*/ +yyabortlab: + yyresult = 1; + goto yyreturn; + +#if !defined yyoverflow || YYERROR_VERBOSE +/*-------------------------------------------------. +| yyexhaustedlab -- memory exhaustion comes here. | +`-------------------------------------------------*/ +yyexhaustedlab: + yyerror (YY_("memory exhausted")); + yyresult = 2; + /* Fall through. */ +#endif + +yyreturn: + if (yychar != YYEMPTY) + { + /* Make sure we have latest lookahead translation. See comments at + user semantic actions for why this is necessary. */ + yytoken = YYTRANSLATE (yychar); + yydestruct ("Cleanup: discarding lookahead", + yytoken, &yylval); + } + /* Do not reclaim the symbols of the rule whose action triggered + this YYABORT or YYACCEPT. */ + YYPOPSTACK (yylen); + YY_STACK_PRINT (yyss, yyssp); + while (yyssp != yyss) + { + yydestruct ("Cleanup: popping", + yystos[*yyssp], yyvsp); + YYPOPSTACK (1); + } +#ifndef yyoverflow + if (yyss != yyssa) + YYSTACK_FREE (yyss); +#endif +#if YYERROR_VERBOSE + if (yymsg != yymsgbuf) + YYSTACK_FREE (yymsg); +#endif + return yyresult; +} +#line 150 "fmd_parser.y" /* yacc.c:1906 */ + + +struct flashmap_descriptor *parse_descriptor(char *name, + struct unsigned_option offset, struct unsigned_option size, + struct descriptor_list children) +{ + struct flashmap_descriptor *region = malloc(sizeof(*region)); + if (!region) { + perror("ERROR: While allocating descriptor section"); + return NULL; + } + region->name = name; + region->offset_known = offset.val_known; + region->offset = offset.val; + region->size_known = size.val_known; + region->size = size.val; + region->list_len = children.len; + if (region->list_len) { + region->list = malloc(region->list_len * sizeof(*region->list)); + if (!region->list) { + perror("ERROR: While allocating node children array"); + return NULL; + } + struct descriptor_node *cur_node = children.head; + for (unsigned idx = 0; idx < region->list_len; ++idx) { + region->list[idx] = cur_node->val; + + struct descriptor_node *next_node = cur_node->next; + free(cur_node); + cur_node = next_node; + } + } else { + region->list = NULL; + } + return region; +} + +void yyerror(const char *s) +{ + fprintf(stderr, "%s\n", s); +} diff --git a/util/cbfstool/fmd_parser.h b/util/cbfstool/fmd_parser.h new file mode 100644 index 0000000..393a8ff --- /dev/null +++ b/util/cbfstool/fmd_parser.h @@ -0,0 +1,109 @@ +/* A Bison parser, made by GNU Bison 3.0.2. */ + +/* Bison interface for Yacc-like parsers in C + + Copyright (C) 1984, 1989-1990, 2000-2013 Free Software Foundation, Inc. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. */ + +/* As a special exception, you may create a larger work that contains + part or all of the Bison parser skeleton and distribute that work + under terms of your choice, so long as that work isn't itself a + parser generator using the skeleton or a modified version thereof + as a parser skeleton. Alternatively, if you modify or redistribute + the parser skeleton itself, you may (at your option) remove this + special exception, which will cause the skeleton and the resulting + Bison output files to be licensed under the GNU General Public + License without this special exception. + + This special exception was added by the Free Software Foundation in + version 2.2 of Bison. */ + +#ifndef YY_YY_Y_TAB_H_INCLUDED +# define YY_YY_Y_TAB_H_INCLUDED +/* Debug traces. */ +#ifndef YYDEBUG +# define YYDEBUG 0 +#endif +#if YYDEBUG +extern int yydebug; +#endif +/* "%code requires" blocks. */ +#line 36 "fmd_parser.y" /* yacc.c:1909 */ + +#include "fmd.h" +#include "option.h" + +#include <stdbool.h> + +struct descriptor_node { + struct flashmap_descriptor *val; + struct descriptor_node *next; +}; + +struct descriptor_list { + size_t len; + struct descriptor_node *head; + struct descriptor_node *tail; +}; + +extern struct flashmap_descriptor *res; + +struct flashmap_descriptor *parse_descriptor(char *name, + struct unsigned_option offset, struct unsigned_option size, + struct descriptor_list children); +void yyerror(const char *s); + +#line 69 "y.tab.h" /* yacc.c:1909 */ + +/* Token type. */ +#ifndef YYTOKENTYPE +# define YYTOKENTYPE + enum yytokentype + { + INTEGER = 258, + OCTAL = 259, + STRING = 260 + }; +#endif +/* Tokens. */ +#define INTEGER 258 +#define OCTAL 259 +#define STRING 260 + +/* Value type. */ +#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED +typedef union YYSTYPE YYSTYPE; +union YYSTYPE +{ +#line 28 "fmd_parser.y" /* yacc.c:1909 */ + + unsigned intval; + char *strval; + struct unsigned_option maybe_intval; + struct flashmap_descriptor *region_ptr; + struct descriptor_list region_listhdr; + +#line 99 "y.tab.h" /* yacc.c:1909 */ +}; +# define YYSTYPE_IS_TRIVIAL 1 +# define YYSTYPE_IS_DECLARED 1 +#endif + + +extern YYSTYPE yylval; + +int yyparse (void); + +#endif /* !YY_YY_Y_TAB_H_INCLUDED */ diff --git a/util/cbfstool/fmd_parser.y b/util/cbfstool/fmd_parser.y new file mode 100644 index 0000000..292fba3 --- /dev/null +++ b/util/cbfstool/fmd_parser.y @@ -0,0 +1,190 @@ +/* + * fmd_parser.y, parser generator for flashmap descriptor language + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +%{ +#include "fmd_scanner.h" + +#include <stdlib.h> + +struct flashmap_descriptor *res = NULL; +%} + +%union { + unsigned intval; + char *strval; + struct unsigned_option maybe_intval; + struct flashmap_descriptor *region_ptr; + struct descriptor_list region_listhdr; +} + +%code requires { +#include "fmd.h" +#include "option.h" + +#include <stdbool.h> + +struct descriptor_node { + struct flashmap_descriptor *val; + struct descriptor_node *next; +}; + +struct descriptor_list { + size_t len; + struct descriptor_node *head; + struct descriptor_node *tail; +}; + +extern struct flashmap_descriptor *res; + +struct flashmap_descriptor *parse_descriptor(char *name, + struct unsigned_option offset, struct unsigned_option size, + struct descriptor_list children); +void yyerror(const char *s); +} + +%token <intval> INTEGER +%token OCTAL +%token <strval> STRING + +%type <region_ptr> flash_region +%type <strval> region_name +%type <strval> region_annotation_opt +%type <strval> region_annotation +%type <maybe_intval> region_offset_opt +%type <maybe_intval> region_offset +%type <maybe_intval> region_size_opt +%type <maybe_intval> region_size +%type <region_listhdr> region_list_opt +%type <region_listhdr> region_list +%type <region_listhdr> region_list_entries + +%% + +flash_chip: region_name region_offset_opt region_size region_list +{ + if (!(res = parse_descriptor($1, $2, $3, $4))) + YYABORT; +}; +flash_region: region_name region_annotation_opt region_offset_opt + region_size_opt region_list_opt +{ + struct flashmap_descriptor *node = parse_descriptor($1, $3, $4, $5); + if (!node) + YYABORT; + + char *annotation = $2; + if (annotation && !fmd_process_annotation_impl(node, annotation)) { + fprintf(stderr, "ERROR: Section '%s' has unexpected annotation '(%s)'\n", + node->name, annotation); + YYABORT; + } + free(annotation); + + $$ = node; +}; +region_name: STRING +{ + if (!$1) { + perror("ERROR: While allocating section name"); + YYABORT; + } +}; +region_annotation_opt: { $$ = NULL; } + | region_annotation; +region_annotation: '(' STRING ')' { $$ = $2; }; +region_offset_opt: { $$ = (struct unsigned_option){false, 0}; } + | region_offset; +region_offset: '@' INTEGER { $$ = (struct unsigned_option){true, $2}; }; +region_size_opt: { $$ = (struct unsigned_option){false, 0}; } + | region_size; +region_size: INTEGER { $$ = (struct unsigned_option){true, $1}; }; +region_list_opt: +{ + $$ = (struct descriptor_list) + {.len = 0, .head = NULL, .tail = NULL}; +} + | region_list; +region_list: '{' region_list_entries '}' { $$ = $2; }; +region_list_entries: flash_region +{ + struct descriptor_node *node = malloc(sizeof(*node)); + if (!node) { + perror("ERROR: While allocating linked list node"); + YYABORT; + } + node->val = $1; + node->next = NULL; + $$ = (struct descriptor_list){.len = 1, .head = node, .tail = node}; +} + | region_list_entries flash_region +{ + struct descriptor_node *node = malloc(sizeof(*node)); + if (!node) { + perror("ERROR: While allocating linked list node"); + YYABORT; + } + node->val = $2; + node->next = NULL; + + $1.tail->next = node; + $$ = (struct descriptor_list) + {.len = $1.len + 1, .head = $1.head, .tail = node}; +}; + +%% + +struct flashmap_descriptor *parse_descriptor(char *name, + struct unsigned_option offset, struct unsigned_option size, + struct descriptor_list children) +{ + struct flashmap_descriptor *region = malloc(sizeof(*region)); + if (!region) { + perror("ERROR: While allocating descriptor section"); + return NULL; + } + region->name = name; + region->offset_known = offset.val_known; + region->offset = offset.val; + region->size_known = size.val_known; + region->size = size.val; + region->list_len = children.len; + if (region->list_len) { + region->list = malloc(region->list_len * sizeof(*region->list)); + if (!region->list) { + perror("ERROR: While allocating node children array"); + return NULL; + } + struct descriptor_node *cur_node = children.head; + for (unsigned idx = 0; idx < region->list_len; ++idx) { + region->list[idx] = cur_node->val; + + struct descriptor_node *next_node = cur_node->next; + free(cur_node); + cur_node = next_node; + } + } else { + region->list = NULL; + } + return region; +} + +void yyerror(const char *s) +{ + fprintf(stderr, "%s\n", s); +} diff --git a/util/cbfstool/fmd_scanner.c b/util/cbfstool/fmd_scanner.c new file mode 100644 index 0000000..d0d93d3 --- /dev/null +++ b/util/cbfstool/fmd_scanner.c @@ -0,0 +1,1852 @@ + +#line 3 "<stdout>" + +#define YY_INT_ALIGNED short int + +/* A lexical scanner generated by flex */ + +#define FLEX_SCANNER +#define YY_FLEX_MAJOR_VERSION 2 +#define YY_FLEX_MINOR_VERSION 5 +#define YY_FLEX_SUBMINOR_VERSION 39 +#if YY_FLEX_SUBMINOR_VERSION > 0 +#define FLEX_BETA +#endif + +/* First, we deal with platform-specific or compiler-specific issues. */ + +/* begin standard C headers. */ +#include <stdio.h> +#include <string.h> +#include <errno.h> +#include <stdlib.h> + +/* end standard C headers. */ + +/* flex integer type definitions */ + +#ifndef FLEXINT_H +#define FLEXINT_H + +/* C99 systems have <inttypes.h>. Non-C99 systems may or may not. */ + +#if defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L + +/* C99 says to define __STDC_LIMIT_MACROS before including stdint.h, + * if you want the limit (max/min) macros for int types. + */ +#ifndef __STDC_LIMIT_MACROS +#define __STDC_LIMIT_MACROS 1 +#endif + +#include <inttypes.h> +typedef int8_t flex_int8_t; +typedef uint8_t flex_uint8_t; +typedef int16_t flex_int16_t; +typedef uint16_t flex_uint16_t; +typedef int32_t flex_int32_t; +typedef uint32_t flex_uint32_t; +#else +typedef signed char flex_int8_t; +typedef short int flex_int16_t; +typedef int flex_int32_t; +typedef unsigned char flex_uint8_t; +typedef unsigned short int flex_uint16_t; +typedef unsigned int flex_uint32_t; + +/* Limits of integral types. */ +#ifndef INT8_MIN +#define INT8_MIN (-128) +#endif +#ifndef INT16_MIN +#define INT16_MIN (-32767-1) +#endif +#ifndef INT32_MIN +#define INT32_MIN (-2147483647-1) +#endif +#ifndef INT8_MAX +#define INT8_MAX (127) +#endif +#ifndef INT16_MAX +#define INT16_MAX (32767) +#endif +#ifndef INT32_MAX +#define INT32_MAX (2147483647) +#endif +#ifndef UINT8_MAX +#define UINT8_MAX (255U) +#endif +#ifndef UINT16_MAX +#define UINT16_MAX (65535U) +#endif +#ifndef UINT32_MAX +#define UINT32_MAX (4294967295U) +#endif + +#endif /* ! C99 */ + +#endif /* ! FLEXINT_H */ + +#ifdef __cplusplus + +/* The "const" storage-class-modifier is valid. */ +#define YY_USE_CONST + +#else /* ! __cplusplus */ + +/* C99 requires __STDC__ to be defined as 1. */ +#if defined (__STDC__) + +#define YY_USE_CONST + +#endif /* defined (__STDC__) */ +#endif /* ! __cplusplus */ + +#ifdef YY_USE_CONST +#define yyconst const +#else +#define yyconst +#endif + +/* Returned upon end-of-file. */ +#define YY_NULL 0 + +/* Promotes a possibly negative, possibly signed char to an unsigned + * integer for use as an array index. If the signed char is negative, + * we want to instead treat it as an 8-bit unsigned char, hence the + * double cast. + */ +#define YY_SC_TO_UI(c) ((unsigned int) (unsigned char) c) + +/* Enter a start condition. This macro really ought to take a parameter, + * but we do it the disgusting crufty way forced on us by the ()-less + * definition of BEGIN. + */ +#define BEGIN (yy_start) = 1 + 2 * + +/* Translate the current start state into a value that can be later handed + * to BEGIN to return to the state. The YYSTATE alias is for lex + * compatibility. + */ +#define YY_START (((yy_start) - 1) / 2) +#define YYSTATE YY_START + +/* Action number for EOF rule of a given start state. */ +#define YY_STATE_EOF(state) (YY_END_OF_BUFFER + state + 1) + +/* Special action meaning "start processing a new file". */ +#define YY_NEW_FILE yyrestart(yyin ) + +#define YY_END_OF_BUFFER_CHAR 0 + +/* Size of default input buffer. */ +#ifndef YY_BUF_SIZE +#ifdef __ia64__ +/* On IA-64, the buffer size is 16k, not 8k. + * Moreover, YY_BUF_SIZE is 2*YY_READ_BUF_SIZE in the general case. + * Ditto for the __ia64__ case accordingly. + */ +#define YY_BUF_SIZE 32768 +#else +#define YY_BUF_SIZE 16384 +#endif /* __ia64__ */ +#endif + +/* The state buf must be large enough to hold one state per character in the main buffer. + */ +#define YY_STATE_BUF_SIZE ((YY_BUF_SIZE + 2) * sizeof(yy_state_type)) + +#ifndef YY_TYPEDEF_YY_BUFFER_STATE +#define YY_TYPEDEF_YY_BUFFER_STATE +typedef struct yy_buffer_state *YY_BUFFER_STATE; +#endif + +#ifndef YY_TYPEDEF_YY_SIZE_T +#define YY_TYPEDEF_YY_SIZE_T +typedef size_t yy_size_t; +#endif + +extern yy_size_t yyleng; + +extern FILE *yyin, *yyout; + +#define EOB_ACT_CONTINUE_SCAN 0 +#define EOB_ACT_END_OF_FILE 1 +#define EOB_ACT_LAST_MATCH 2 + + #define YY_LESS_LINENO(n) + #define YY_LINENO_REWIND_TO(ptr) + +/* Return all but the first "n" matched characters back to the input stream. */ +#define yyless(n) \ + do \ + { \ + /* Undo effects of setting up yytext. */ \ + int yyless_macro_arg = (n); \ + YY_LESS_LINENO(yyless_macro_arg);\ + *yy_cp = (yy_hold_char); \ + YY_RESTORE_YY_MORE_OFFSET \ + (yy_c_buf_p) = yy_cp = yy_bp + yyless_macro_arg - YY_MORE_ADJ; \ + YY_DO_BEFORE_ACTION; /* set up yytext again */ \ + } \ + while ( 0 ) + +#define unput(c) yyunput( c, (yytext_ptr) ) + +#ifndef YY_STRUCT_YY_BUFFER_STATE +#define YY_STRUCT_YY_BUFFER_STATE +struct yy_buffer_state + { + FILE *yy_input_file; + + char *yy_ch_buf; /* input buffer */ + char *yy_buf_pos; /* current position in input buffer */ + + /* Size of input buffer in bytes, not including room for EOB + * characters. + */ + yy_size_t yy_buf_size; + + /* Number of characters read into yy_ch_buf, not including EOB + * characters. + */ + yy_size_t yy_n_chars; + + /* Whether we "own" the buffer - i.e., we know we created it, + * and can realloc() it to grow it, and should free() it to + * delete it. + */ + int yy_is_our_buffer; + + /* Whether this is an "interactive" input source; if so, and + * if we're using stdio for input, then we want to use getc() + * instead of fread(), to make sure we stop fetching input after + * each newline. + */ + int yy_is_interactive; + + /* Whether we're considered to be at the beginning of a line. + * If so, '^' rules will be active on the next match, otherwise + * not. + */ + int yy_at_bol; + + int yy_bs_lineno; /**< The line count. */ + int yy_bs_column; /**< The column count. */ + + /* Whether to try to fill the input buffer when we reach the + * end of it. + */ + int yy_fill_buffer; + + int yy_buffer_status; + +#define YY_BUFFER_NEW 0 +#define YY_BUFFER_NORMAL 1 + /* When an EOF's been seen but there's still some text to process + * then we mark the buffer as YY_EOF_PENDING, to indicate that we + * shouldn't try reading from the input source any more. We might + * still have a bunch of tokens to match, though, because of + * possible backing-up. + * + * When we actually see the EOF, we change the status to "new" + * (via yyrestart()), so that the user can continue scanning by + * just pointing yyin at a new input file. + */ +#define YY_BUFFER_EOF_PENDING 2 + + }; +#endif /* !YY_STRUCT_YY_BUFFER_STATE */ + +/* Stack of input buffers. */ +static size_t yy_buffer_stack_top = 0; /**< index of top of stack. */ +static size_t yy_buffer_stack_max = 0; /**< capacity of stack. */ +static YY_BUFFER_STATE * yy_buffer_stack = 0; /**< Stack as an array. */ + +/* We provide macros for accessing buffer states in case in the + * future we want to put the buffer states in a more general + * "scanner state". + * + * Returns the top of the stack, or NULL. + */ +#define YY_CURRENT_BUFFER ( (yy_buffer_stack) \ + ? (yy_buffer_stack)[(yy_buffer_stack_top)] \ + : NULL) + +/* Same as previous macro, but useful when we know that the buffer stack is not + * NULL or when we need an lvalue. For internal use only. + */ +#define YY_CURRENT_BUFFER_LVALUE (yy_buffer_stack)[(yy_buffer_stack_top)] + +/* yy_hold_char holds the character lost when yytext is formed. */ +static char yy_hold_char; +static yy_size_t yy_n_chars; /* number of characters read into yy_ch_buf */ +yy_size_t yyleng; + +/* Points to current character in buffer. */ +static char *yy_c_buf_p = (char *) 0; +static int yy_init = 0; /* whether we need to initialize */ +static int yy_start = 0; /* start state number */ + +/* Flag which is used to allow yywrap()'s to do buffer switches + * instead of setting up a fresh yyin. A bit of a hack ... + */ +static int yy_did_buffer_switch_on_eof; + +void yyrestart (FILE *input_file ); +void yy_switch_to_buffer (YY_BUFFER_STATE new_buffer ); +YY_BUFFER_STATE yy_create_buffer (FILE *file,int size ); +void yy_delete_buffer (YY_BUFFER_STATE b ); +void yy_flush_buffer (YY_BUFFER_STATE b ); +void yypush_buffer_state (YY_BUFFER_STATE new_buffer ); +void yypop_buffer_state (void ); + +static void yyensure_buffer_stack (void ); +static void yy_load_buffer_state (void ); +static void yy_init_buffer (YY_BUFFER_STATE b,FILE *file ); + +#define YY_FLUSH_BUFFER yy_flush_buffer(YY_CURRENT_BUFFER ) + +YY_BUFFER_STATE yy_scan_buffer (char *base,yy_size_t size ); +YY_BUFFER_STATE yy_scan_string (yyconst char *yy_str ); +YY_BUFFER_STATE yy_scan_bytes (yyconst char *bytes,yy_size_t len ); + +void *yyalloc (yy_size_t ); +void *yyrealloc (void *,yy_size_t ); +void yyfree (void * ); + +#define yy_new_buffer yy_create_buffer + +#define yy_set_interactive(is_interactive) \ + { \ + if ( ! YY_CURRENT_BUFFER ){ \ + yyensure_buffer_stack (); \ + YY_CURRENT_BUFFER_LVALUE = \ + yy_create_buffer(yyin,YY_BUF_SIZE ); \ + } \ + YY_CURRENT_BUFFER_LVALUE->yy_is_interactive = is_interactive; \ + } + +#define yy_set_bol(at_bol) \ + { \ + if ( ! YY_CURRENT_BUFFER ){\ + yyensure_buffer_stack (); \ + YY_CURRENT_BUFFER_LVALUE = \ + yy_create_buffer(yyin,YY_BUF_SIZE ); \ + } \ + YY_CURRENT_BUFFER_LVALUE->yy_at_bol = at_bol; \ + } + +#define YY_AT_BOL() (YY_CURRENT_BUFFER_LVALUE->yy_at_bol) + +/* Begin user sect3 */ + +#define yywrap() 1 +#define YY_SKIP_YYWRAP + +typedef unsigned char YY_CHAR; + +FILE *yyin = (FILE *) 0, *yyout = (FILE *) 0; + +typedef int yy_state_type; + +extern int yylineno; + +int yylineno = 1; + +extern char *yytext; +#define yytext_ptr yytext + +static yy_state_type yy_get_previous_state (void ); +static yy_state_type yy_try_NUL_trans (yy_state_type current_state ); +static int yy_get_next_buffer (void ); +static void yy_fatal_error (yyconst char msg[] ); + +/* Done after the current pattern has been matched and before the + * corresponding action - sets up yytext. + */ +#define YY_DO_BEFORE_ACTION \ + (yytext_ptr) = yy_bp; \ + yyleng = (size_t) (yy_cp - yy_bp); \ + (yy_hold_char) = *yy_cp; \ + *yy_cp = '\0'; \ + (yy_c_buf_p) = yy_cp; + +#define YY_NUM_RULES 9 +#define YY_END_OF_BUFFER 10 +/* This struct is not used in this scanner, + but its presence is necessary. */ +struct yy_trans_info + { + flex_int32_t yy_verify; + flex_int32_t yy_nxt; + }; +static yyconst flex_int16_t yy_accept[24] = + { 0, + 7, 7, 10, 7, 1, 1, 8, 8, 3, 4, + 7, 1, 0, 2, 5, 3, 7, 4, 4, 5, + 6, 6, 0 + } ; + +static yyconst flex_int32_t yy_ec[256] = + { 0, + 1, 1, 1, 1, 1, 1, 1, 1, 2, 3, + 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 2, 1, 1, 4, 1, 1, 1, 1, 5, + 5, 1, 1, 1, 1, 1, 1, 6, 7, 7, + 7, 7, 7, 7, 7, 7, 7, 1, 1, 1, + 1, 1, 1, 5, 1, 1, 1, 1, 1, 1, + 8, 1, 1, 1, 8, 1, 8, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 9, 1, 1, + 1, 1, 1, 1, 1, 1, 10, 10, 10, 10, + + 10, 10, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 9, + 1, 1, 5, 1, 5, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1 + } ; + +static yyconst flex_int32_t yy_meta[11] = + { 0, + 1, 2, 2, 3, 3, 1, 1, 1, 1, 1 + } ; + +static yyconst flex_int16_t yy_base[27] = + { 0, + 0, 0, 29, 0, 0, 0, 25, 34, 10, 15, + 0, 0, 12, 34, 16, 0, 20, 0, 0, 0, + 6, 0, 34, 12, 10, 30 + } ; + +static yyconst flex_int16_t yy_def[27] = + { 0, + 23, 1, 23, 24, 25, 25, 26, 23, 23, 24, + 24, 25, 26, 23, 9, 24, 24, 10, 24, 24, + 17, 24, 0, 23, 23, 23 + } ; + +static yyconst flex_int16_t yy_nxt[45] = + { 0, + 4, 5, 6, 7, 8, 9, 10, 4, 4, 4, + 11, 12, 11, 22, 14, 15, 15, 16, 17, 11, + 18, 18, 19, 20, 11, 21, 21, 14, 23, 21, + 13, 13, 13, 3, 23, 23, 23, 23, 23, 23, + 23, 23, 23, 23 + } ; + +static yyconst flex_int16_t yy_chk[45] = + { 0, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 9, 25, 24, 21, 13, 9, 9, 9, 9, 9, + 10, 10, 10, 15, 15, 17, 17, 7, 3, 17, + 26, 26, 26, 23, 23, 23, 23, 23, 23, 23, + 23, 23, 23, 23 + } ; + +static yy_state_type yy_last_accepting_state; +static char *yy_last_accepting_cpos; + +extern int yy_flex_debug; +int yy_flex_debug = 0; + +/* The intent behind this definition is that it'll catch + * any uses of REJECT which flex missed. + */ +#define REJECT reject_used_but_not_detected +#define yymore() yymore_used_but_not_detected +#define YY_MORE_ADJ 0 +#define YY_RESTORE_YY_MORE_OFFSET +char *yytext; +#line 1 "fmd_scanner.l" +/* + * fmd_scanner.l, scanner generator for flashmap descriptor language + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ +#line 21 "fmd_scanner.l" +#include "fmd_parser.h" + +#include <assert.h> +#include <string.h> + +int parse_integer(char *input, int base); +int copy_string(const char *input); +#line 502 "<stdout>" + +#define INITIAL 0 + +#ifndef YY_NO_UNISTD_H +/* Special case for "unistd.h", since it is non-ANSI. We include it way + * down here because we want the user's section 1 to have been scanned first. + * The user has a chance to override it with an option. + */ +#include <unistd.h> +#endif + +#ifndef YY_EXTRA_TYPE +#define YY_EXTRA_TYPE void * +#endif + +static int yy_init_globals (void ); + +/* Accessor methods to globals. + These are made visible to non-reentrant scanners for convenience. */ + +int yylex_destroy (void ); + +int yyget_debug (void ); + +void yyset_debug (int debug_flag ); + +YY_EXTRA_TYPE yyget_extra (void ); + +void yyset_extra (YY_EXTRA_TYPE user_defined ); + +FILE *yyget_in (void ); + +void yyset_in (FILE * in_str ); + +FILE *yyget_out (void ); + +void yyset_out (FILE * out_str ); + +yy_size_t yyget_leng (void ); + +char *yyget_text (void ); + +int yyget_lineno (void ); + +void yyset_lineno (int line_number ); + +/* Macros after this point can all be overridden by user definitions in + * section 1. + */ + +#ifndef YY_SKIP_YYWRAP +#ifdef __cplusplus +extern "C" int yywrap (void ); +#else +extern int yywrap (void ); +#endif +#endif + + static void yyunput (int c,char *buf_ptr ); + +#ifndef yytext_ptr +static void yy_flex_strncpy (char *,yyconst char *,int ); +#endif + +#ifdef YY_NEED_STRLEN +static int yy_flex_strlen (yyconst char * ); +#endif + +#ifndef YY_NO_INPUT + +#ifdef __cplusplus +static int yyinput (void ); +#else +static int input (void ); +#endif + +#endif + +/* Amount of stuff to slurp up with each read. */ +#ifndef YY_READ_BUF_SIZE +#ifdef __ia64__ +/* On IA-64, the buffer size is 16k, not 8k */ +#define YY_READ_BUF_SIZE 16384 +#else +#define YY_READ_BUF_SIZE 8192 +#endif /* __ia64__ */ +#endif + +/* Copy whatever the last rule matched to the standard output. */ +#ifndef ECHO +/* This used to be an fputs(), but since the string might contain NUL's, + * we now use fwrite(). + */ +#define ECHO do { if (fwrite( yytext, yyleng, 1, yyout )) {} } while (0) +#endif + +/* Gets input and stuffs it into "buf". number of characters read, or YY_NULL, + * is returned in "result". + */ +#ifndef YY_INPUT +#define YY_INPUT(buf,result,max_size) \ + if ( YY_CURRENT_BUFFER_LVALUE->yy_is_interactive ) \ + { \ + int c = '*'; \ + size_t n; \ + for ( n = 0; n < max_size && \ + (c = getc( yyin )) != EOF && c != '\n'; ++n ) \ + buf[n] = (char) c; \ + if ( c == '\n' ) \ + buf[n++] = (char) c; \ + if ( c == EOF && ferror( yyin ) ) \ + YY_FATAL_ERROR( "input in flex scanner failed" ); \ + result = n; \ + } \ + else \ + { \ + errno=0; \ + while ( (result = fread(buf, 1, max_size, yyin))==0 && ferror(yyin)) \ + { \ + if( errno != EINTR) \ + { \ + YY_FATAL_ERROR( "input in flex scanner failed" ); \ + break; \ + } \ + errno=0; \ + clearerr(yyin); \ + } \ + }\ +\ + +#endif + +/* No semi-colon after return; correct usage is to write "yyterminate();" - + * we don't want an extra ';' after the "return" because that will cause + * some compilers to complain about unreachable statements. + */ +#ifndef yyterminate +#define yyterminate() return YY_NULL +#endif + +/* Number of entries by which start-condition stack grows. */ +#ifndef YY_START_STACK_INCR +#define YY_START_STACK_INCR 25 +#endif + +/* Report a fatal error. */ +#ifndef YY_FATAL_ERROR +#define YY_FATAL_ERROR(msg) yy_fatal_error( msg ) +#endif + +/* end tables serialization structures and prototypes */ + +/* Default declaration of generated scanner - a define so the user can + * easily add parameters. + */ +#ifndef YY_DECL +#define YY_DECL_IS_OURS 1 + +extern int yylex (void); + +#define YY_DECL int yylex (void) +#endif /* !YY_DECL */ + +/* Code executed at the beginning of each rule, after yytext and yyleng + * have been set up. + */ +#ifndef YY_USER_ACTION +#define YY_USER_ACTION +#endif + +/* Code executed at the end of each rule. */ +#ifndef YY_BREAK +#define YY_BREAK break; +#endif + +#define YY_RULE_SETUP \ + YY_USER_ACTION + +/** The main scanner function which does all the work. + */ +YY_DECL +{ + register yy_state_type yy_current_state; + register char *yy_cp, *yy_bp; + register int yy_act; + + if ( !(yy_init) ) + { + (yy_init) = 1; + +#ifdef YY_USER_INIT + YY_USER_INIT; +#endif + + if ( ! (yy_start) ) + (yy_start) = 1; /* first start state */ + + if ( ! yyin ) + yyin = stdin; + + if ( ! yyout ) + yyout = stdout; + + if ( ! YY_CURRENT_BUFFER ) { + yyensure_buffer_stack (); + YY_CURRENT_BUFFER_LVALUE = + yy_create_buffer(yyin,YY_BUF_SIZE ); + } + + yy_load_buffer_state( ); + } + + { +#line 34 "fmd_scanner.l" + + +#line 719 "<stdout>" + + while ( 1 ) /* loops until end-of-file is reached */ + { + yy_cp = (yy_c_buf_p); + + /* Support of yytext. */ + *yy_cp = (yy_hold_char); + + /* yy_bp points to the position in yy_ch_buf of the start of + * the current run. + */ + yy_bp = yy_cp; + + yy_current_state = (yy_start); +yy_match: + do + { + register YY_CHAR yy_c = yy_ec[YY_SC_TO_UI(*yy_cp)] ; + if ( yy_accept[yy_current_state] ) + { + (yy_last_accepting_state) = yy_current_state; + (yy_last_accepting_cpos) = yy_cp; + } + while ( yy_chk[yy_base[yy_current_state] + yy_c] != yy_current_state ) + { + yy_current_state = (int) yy_def[yy_current_state]; + if ( yy_current_state >= 24 ) + yy_c = yy_meta[(unsigned int) yy_c]; + } + yy_current_state = yy_nxt[yy_base[yy_current_state] + (unsigned int) yy_c]; + ++yy_cp; + } + while ( yy_base[yy_current_state] != 34 ); + +yy_find_action: + yy_act = yy_accept[yy_current_state]; + if ( yy_act == 0 ) + { /* have to back up */ + yy_cp = (yy_last_accepting_cpos); + yy_current_state = (yy_last_accepting_state); + yy_act = yy_accept[yy_current_state]; + } + + YY_DO_BEFORE_ACTION; + +do_action: /* This label is used only to access EOF actions. */ + + switch ( yy_act ) + { /* beginning of action switch */ + case 0: /* must back up */ + /* undo the effects of YY_DO_BEFORE_ACTION */ + *yy_cp = (yy_hold_char); + yy_cp = (yy_last_accepting_cpos); + yy_current_state = (yy_last_accepting_state); + goto yy_find_action; + +case 1: +/* rule 1 can match eol */ +YY_RULE_SETUP +#line 36 "fmd_scanner.l" +/* Eat whitespace. */ + YY_BREAK +case 2: +*yy_cp = (yy_hold_char); /* undo effects of setting up yytext */ +(yy_c_buf_p) = yy_cp -= 1; +YY_DO_BEFORE_ACTION; /* set up yytext again */ +YY_RULE_SETUP +#line 37 "fmd_scanner.l" +/* Eat comments. */ + YY_BREAK +case 3: +#line 39 "fmd_scanner.l" +case 4: +YY_RULE_SETUP +#line 39 "fmd_scanner.l" +return parse_integer(yytext, 10); + YY_BREAK +case 5: +YY_RULE_SETUP +#line 40 "fmd_scanner.l" +return OCTAL; + YY_BREAK +case 6: +YY_RULE_SETUP +#line 41 "fmd_scanner.l" +return parse_integer(yytext + 2, 16); + YY_BREAK +case 7: +YY_RULE_SETUP +#line 42 "fmd_scanner.l" +return copy_string(yytext); + YY_BREAK +case 8: +YY_RULE_SETUP +#line 43 "fmd_scanner.l" +return *yytext; + YY_BREAK +case 9: +YY_RULE_SETUP +#line 45 "fmd_scanner.l" +ECHO; + YY_BREAK +#line 822 "<stdout>" +case YY_STATE_EOF(INITIAL): + yyterminate(); + + case YY_END_OF_BUFFER: + { + /* Amount of text matched not including the EOB char. */ + int yy_amount_of_matched_text = (int) (yy_cp - (yytext_ptr)) - 1; + + /* Undo the effects of YY_DO_BEFORE_ACTION. */ + *yy_cp = (yy_hold_char); + YY_RESTORE_YY_MORE_OFFSET + + if ( YY_CURRENT_BUFFER_LVALUE->yy_buffer_status == YY_BUFFER_NEW ) + { + /* We're scanning a new file or input source. It's + * possible that this happened because the user + * just pointed yyin at a new source and called + * yylex(). If so, then we have to assure + * consistency between YY_CURRENT_BUFFER and our + * globals. Here is the right place to do so, because + * this is the first action (other than possibly a + * back-up) that will match for the new input source. + */ + (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_n_chars; + YY_CURRENT_BUFFER_LVALUE->yy_input_file = yyin; + YY_CURRENT_BUFFER_LVALUE->yy_buffer_status = YY_BUFFER_NORMAL; + } + + /* Note that here we test for yy_c_buf_p "<=" to the position + * of the first EOB in the buffer, since yy_c_buf_p will + * already have been incremented past the NUL character + * (since all states make transitions on EOB to the + * end-of-buffer state). Contrast this with the test + * in input(). + */ + if ( (yy_c_buf_p) <= &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] ) + { /* This was really a NUL. */ + yy_state_type yy_next_state; + + (yy_c_buf_p) = (yytext_ptr) + yy_amount_of_matched_text; + + yy_current_state = yy_get_previous_state( ); + + /* Okay, we're now positioned to make the NUL + * transition. We couldn't have + * yy_get_previous_state() go ahead and do it + * for us because it doesn't know how to deal + * with the possibility of jamming (and we don't + * want to build jamming into it because then it + * will run more slowly). + */ + + yy_next_state = yy_try_NUL_trans( yy_current_state ); + + yy_bp = (yytext_ptr) + YY_MORE_ADJ; + + if ( yy_next_state ) + { + /* Consume the NUL. */ + yy_cp = ++(yy_c_buf_p); + yy_current_state = yy_next_state; + goto yy_match; + } + + else + { + yy_cp = (yy_c_buf_p); + goto yy_find_action; + } + } + + else switch ( yy_get_next_buffer( ) ) + { + case EOB_ACT_END_OF_FILE: + { + (yy_did_buffer_switch_on_eof) = 0; + + if ( yywrap( ) ) + { + /* Note: because we've taken care in + * yy_get_next_buffer() to have set up + * yytext, we can now set up + * yy_c_buf_p so that if some total + * hoser (like flex itself) wants to + * call the scanner after we return the + * YY_NULL, it'll still work - another + * YY_NULL will get returned. + */ + (yy_c_buf_p) = (yytext_ptr) + YY_MORE_ADJ; + + yy_act = YY_STATE_EOF(YY_START); + goto do_action; + } + + else + { + if ( ! (yy_did_buffer_switch_on_eof) ) + YY_NEW_FILE; + } + break; + } + + case EOB_ACT_CONTINUE_SCAN: + (yy_c_buf_p) = + (yytext_ptr) + yy_amount_of_matched_text; + + yy_current_state = yy_get_previous_state( ); + + yy_cp = (yy_c_buf_p); + yy_bp = (yytext_ptr) + YY_MORE_ADJ; + goto yy_match; + + case EOB_ACT_LAST_MATCH: + (yy_c_buf_p) = + &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)]; + + yy_current_state = yy_get_previous_state( ); + + yy_cp = (yy_c_buf_p); + yy_bp = (yytext_ptr) + YY_MORE_ADJ; + goto yy_find_action; + } + break; + } + + default: + YY_FATAL_ERROR( + "fatal flex scanner internal error--no action found" ); + } /* end of action switch */ + } /* end of scanning one token */ + } /* end of user's declarations */ +} /* end of yylex */ + +/* yy_get_next_buffer - try to read in a new buffer + * + * Returns a code representing an action: + * EOB_ACT_LAST_MATCH - + * EOB_ACT_CONTINUE_SCAN - continue scanning from current position + * EOB_ACT_END_OF_FILE - end of file + */ +static int yy_get_next_buffer (void) +{ + register char *dest = YY_CURRENT_BUFFER_LVALUE->yy_ch_buf; + register char *source = (yytext_ptr); + register int number_to_move, i; + int ret_val; + + if ( (yy_c_buf_p) > &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars) + 1] ) + YY_FATAL_ERROR( + "fatal flex scanner internal error--end of buffer missed" ); + + if ( YY_CURRENT_BUFFER_LVALUE->yy_fill_buffer == 0 ) + { /* Don't try to fill the buffer, so this is an EOF. */ + if ( (yy_c_buf_p) - (yytext_ptr) - YY_MORE_ADJ == 1 ) + { + /* We matched a single character, the EOB, so + * treat this as a final EOF. + */ + return EOB_ACT_END_OF_FILE; + } + + else + { + /* We matched some text prior to the EOB, first + * process it. + */ + return EOB_ACT_LAST_MATCH; + } + } + + /* Try to read more data. */ + + /* First move last chars to start of buffer. */ + number_to_move = (int) ((yy_c_buf_p) - (yytext_ptr)) - 1; + + for ( i = 0; i < number_to_move; ++i ) + *(dest++) = *(source++); + + if ( YY_CURRENT_BUFFER_LVALUE->yy_buffer_status == YY_BUFFER_EOF_PENDING ) + /* don't do the read, it's not guaranteed to return an EOF, + * just force an EOF + */ + YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars) = 0; + + else + { + yy_size_t num_to_read = + YY_CURRENT_BUFFER_LVALUE->yy_buf_size - number_to_move - 1; + + while ( num_to_read <= 0 ) + { /* Not enough room in the buffer - grow it. */ + + /* just a shorter name for the current buffer */ + YY_BUFFER_STATE b = YY_CURRENT_BUFFER_LVALUE; + + int yy_c_buf_p_offset = + (int) ((yy_c_buf_p) - b->yy_ch_buf); + + if ( b->yy_is_our_buffer ) + { + yy_size_t new_size = b->yy_buf_size * 2; + + if ( new_size <= 0 ) + b->yy_buf_size += b->yy_buf_size / 8; + else + b->yy_buf_size *= 2; + + b->yy_ch_buf = (char *) + /* Include room in for 2 EOB chars. */ + yyrealloc((void *) b->yy_ch_buf,b->yy_buf_size + 2 ); + } + else + /* Can't grow it, we don't own it. */ + b->yy_ch_buf = 0; + + if ( ! b->yy_ch_buf ) + YY_FATAL_ERROR( + "fatal error - scanner input buffer overflow" ); + + (yy_c_buf_p) = &b->yy_ch_buf[yy_c_buf_p_offset]; + + num_to_read = YY_CURRENT_BUFFER_LVALUE->yy_buf_size - + number_to_move - 1; + + } + + if ( num_to_read > YY_READ_BUF_SIZE ) + num_to_read = YY_READ_BUF_SIZE; + + /* Read in more data. */ + YY_INPUT( (&YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[number_to_move]), + (yy_n_chars), num_to_read ); + + YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars); + } + + if ( (yy_n_chars) == 0 ) + { + if ( number_to_move == YY_MORE_ADJ ) + { + ret_val = EOB_ACT_END_OF_FILE; + yyrestart(yyin ); + } + + else + { + ret_val = EOB_ACT_LAST_MATCH; + YY_CURRENT_BUFFER_LVALUE->yy_buffer_status = + YY_BUFFER_EOF_PENDING; + } + } + + else + ret_val = EOB_ACT_CONTINUE_SCAN; + + if ((yy_size_t) ((yy_n_chars) + number_to_move) > YY_CURRENT_BUFFER_LVALUE->yy_buf_size) { + /* Extend the array by 50%, plus the number we really need. */ + yy_size_t new_size = (yy_n_chars) + number_to_move + ((yy_n_chars) >> 1); + YY_CURRENT_BUFFER_LVALUE->yy_ch_buf = (char *) yyrealloc((void *) YY_CURRENT_BUFFER_LVALUE->yy_ch_buf,new_size ); + if ( ! YY_CURRENT_BUFFER_LVALUE->yy_ch_buf ) + YY_FATAL_ERROR( "out of dynamic memory in yy_get_next_buffer()" ); + } + + (yy_n_chars) += number_to_move; + YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] = YY_END_OF_BUFFER_CHAR; + YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars) + 1] = YY_END_OF_BUFFER_CHAR; + + (yytext_ptr) = &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[0]; + + return ret_val; +} + +/* yy_get_previous_state - get the state just before the EOB char was reached */ + + static yy_state_type yy_get_previous_state (void) +{ + register yy_state_type yy_current_state; + register char *yy_cp; + + yy_current_state = (yy_start); + + for ( yy_cp = (yytext_ptr) + YY_MORE_ADJ; yy_cp < (yy_c_buf_p); ++yy_cp ) + { + register YY_CHAR yy_c = (*yy_cp ? yy_ec[YY_SC_TO_UI(*yy_cp)] : 1); + if ( yy_accept[yy_current_state] ) + { + (yy_last_accepting_state) = yy_current_state; + (yy_last_accepting_cpos) = yy_cp; + } + while ( yy_chk[yy_base[yy_current_state] + yy_c] != yy_current_state ) + { + yy_current_state = (int) yy_def[yy_current_state]; + if ( yy_current_state >= 24 ) + yy_c = yy_meta[(unsigned int) yy_c]; + } + yy_current_state = yy_nxt[yy_base[yy_current_state] + (unsigned int) yy_c]; + } + + return yy_current_state; +} + +/* yy_try_NUL_trans - try to make a transition on the NUL character + * + * synopsis + * next_state = yy_try_NUL_trans( current_state ); + */ + static yy_state_type yy_try_NUL_trans (yy_state_type yy_current_state ) +{ + register int yy_is_jam; + register char *yy_cp = (yy_c_buf_p); + + register YY_CHAR yy_c = 1; + if ( yy_accept[yy_current_state] ) + { + (yy_last_accepting_state) = yy_current_state; + (yy_last_accepting_cpos) = yy_cp; + } + while ( yy_chk[yy_base[yy_current_state] + yy_c] != yy_current_state ) + { + yy_current_state = (int) yy_def[yy_current_state]; + if ( yy_current_state >= 24 ) + yy_c = yy_meta[(unsigned int) yy_c]; + } + yy_current_state = yy_nxt[yy_base[yy_current_state] + (unsigned int) yy_c]; + yy_is_jam = (yy_current_state == 23); + + return yy_is_jam ? 0 : yy_current_state; +} + + static void yyunput (int c, register char * yy_bp ) +{ + register char *yy_cp; + + yy_cp = (yy_c_buf_p); + + /* undo effects of setting up yytext */ + *yy_cp = (yy_hold_char); + + if ( yy_cp < YY_CURRENT_BUFFER_LVALUE->yy_ch_buf + 2 ) + { /* need to shift things up to make room */ + /* +2 for EOB chars. */ + register yy_size_t number_to_move = (yy_n_chars) + 2; + register char *dest = &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[ + YY_CURRENT_BUFFER_LVALUE->yy_buf_size + 2]; + register char *source = + &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[number_to_move]; + + while ( source > YY_CURRENT_BUFFER_LVALUE->yy_ch_buf ) + *--dest = *--source; + + yy_cp += (int) (dest - source); + yy_bp += (int) (dest - source); + YY_CURRENT_BUFFER_LVALUE->yy_n_chars = + (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_buf_size; + + if ( yy_cp < YY_CURRENT_BUFFER_LVALUE->yy_ch_buf + 2 ) + YY_FATAL_ERROR( "flex scanner push-back overflow" ); + } + + *--yy_cp = (char) c; + + (yytext_ptr) = yy_bp; + (yy_hold_char) = *yy_cp; + (yy_c_buf_p) = yy_cp; +} + +#ifndef YY_NO_INPUT +#ifdef __cplusplus + static int yyinput (void) +#else + static int input (void) +#endif + +{ + int c; + + *(yy_c_buf_p) = (yy_hold_char); + + if ( *(yy_c_buf_p) == YY_END_OF_BUFFER_CHAR ) + { + /* yy_c_buf_p now points to the character we want to return. + * If this occurs *before* the EOB characters, then it's a + * valid NUL; if not, then we've hit the end of the buffer. + */ + if ( (yy_c_buf_p) < &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] ) + /* This was really a NUL. */ + *(yy_c_buf_p) = '\0'; + + else + { /* need more input */ + yy_size_t offset = (yy_c_buf_p) - (yytext_ptr); + ++(yy_c_buf_p); + + switch ( yy_get_next_buffer( ) ) + { + case EOB_ACT_LAST_MATCH: + /* This happens because yy_g_n_b() + * sees that we've accumulated a + * token and flags that we need to + * try matching the token before + * proceeding. But for input(), + * there's no matching to consider. + * So convert the EOB_ACT_LAST_MATCH + * to EOB_ACT_END_OF_FILE. + */ + + /* Reset buffer status. */ + yyrestart(yyin ); + + /*FALLTHROUGH*/ + + case EOB_ACT_END_OF_FILE: + { + if ( yywrap( ) ) + return EOF; + + if ( ! (yy_did_buffer_switch_on_eof) ) + YY_NEW_FILE; +#ifdef __cplusplus + return yyinput(); +#else + return input(); +#endif + } + + case EOB_ACT_CONTINUE_SCAN: + (yy_c_buf_p) = (yytext_ptr) + offset; + break; + } + } + } + + c = *(unsigned char *) (yy_c_buf_p); /* cast for 8-bit char's */ + *(yy_c_buf_p) = '\0'; /* preserve yytext */ + (yy_hold_char) = *++(yy_c_buf_p); + + return c; +} +#endif /* ifndef YY_NO_INPUT */ + +/** Immediately switch to a different input stream. + * @param input_file A readable stream. + * + * @note This function does not reset the start condition to @c INITIAL . + */ + void yyrestart (FILE * input_file ) +{ + + if ( ! YY_CURRENT_BUFFER ){ + yyensure_buffer_stack (); + YY_CURRENT_BUFFER_LVALUE = + yy_create_buffer(yyin,YY_BUF_SIZE ); + } + + yy_init_buffer(YY_CURRENT_BUFFER,input_file ); + yy_load_buffer_state( ); +} + +/** Switch to a different input buffer. + * @param new_buffer The new input buffer. + * + */ + void yy_switch_to_buffer (YY_BUFFER_STATE new_buffer ) +{ + + /* TODO. We should be able to replace this entire function body + * with + * yypop_buffer_state(); + * yypush_buffer_state(new_buffer); + */ + yyensure_buffer_stack (); + if ( YY_CURRENT_BUFFER == new_buffer ) + return; + + if ( YY_CURRENT_BUFFER ) + { + /* Flush out information for old buffer. */ + *(yy_c_buf_p) = (yy_hold_char); + YY_CURRENT_BUFFER_LVALUE->yy_buf_pos = (yy_c_buf_p); + YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars); + } + + YY_CURRENT_BUFFER_LVALUE = new_buffer; + yy_load_buffer_state( ); + + /* We don't actually know whether we did this switch during + * EOF (yywrap()) processing, but the only time this flag + * is looked at is after yywrap() is called, so it's safe + * to go ahead and always set it. + */ + (yy_did_buffer_switch_on_eof) = 1; +} + +static void yy_load_buffer_state (void) +{ + (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_n_chars; + (yytext_ptr) = (yy_c_buf_p) = YY_CURRENT_BUFFER_LVALUE->yy_buf_pos; + yyin = YY_CURRENT_BUFFER_LVALUE->yy_input_file; + (yy_hold_char) = *(yy_c_buf_p); +} + +/** Allocate and initialize an input buffer state. + * @param file A readable stream. + * @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE. + * + * @return the allocated buffer state. + */ + YY_BUFFER_STATE yy_create_buffer (FILE * file, int size ) +{ + YY_BUFFER_STATE b; + + b = (YY_BUFFER_STATE) yyalloc(sizeof( struct yy_buffer_state ) ); + if ( ! b ) + YY_FATAL_ERROR( "out of dynamic memory in yy_create_buffer()" ); + + b->yy_buf_size = size; + + /* yy_ch_buf has to be 2 characters longer than the size given because + * we need to put in 2 end-of-buffer characters. + */ + b->yy_ch_buf = (char *) yyalloc(b->yy_buf_size + 2 ); + if ( ! b->yy_ch_buf ) + YY_FATAL_ERROR( "out of dynamic memory in yy_create_buffer()" ); + + b->yy_is_our_buffer = 1; + + yy_init_buffer(b,file ); + + return b; +} + +/** Destroy the buffer. + * @param b a buffer created with yy_create_buffer() + * + */ + void yy_delete_buffer (YY_BUFFER_STATE b ) +{ + + if ( ! b ) + return; + + if ( b == YY_CURRENT_BUFFER ) /* Not sure if we should pop here. */ + YY_CURRENT_BUFFER_LVALUE = (YY_BUFFER_STATE) 0; + + if ( b->yy_is_our_buffer ) + yyfree((void *) b->yy_ch_buf ); + + yyfree((void *) b ); +} + +/* Initializes or reinitializes a buffer. + * This function is sometimes called more than once on the same buffer, + * such as during a yyrestart() or at EOF. + */ + static void yy_init_buffer (YY_BUFFER_STATE b, FILE * file ) + +{ + int oerrno = errno; + + yy_flush_buffer(b ); + + b->yy_input_file = file; + b->yy_fill_buffer = 1; + + /* If b is the current buffer, then yy_init_buffer was _probably_ + * called from yyrestart() or through yy_get_next_buffer. + * In that case, we don't want to reset the lineno or column. + */ + if (b != YY_CURRENT_BUFFER){ + b->yy_bs_lineno = 1; + b->yy_bs_column = 0; + } + + b->yy_is_interactive = file ? (isatty( fileno(file) ) > 0) : 0; + + errno = oerrno; +} + +/** Discard all buffered characters. On the next scan, YY_INPUT will be called. + * @param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER. + * + */ + void yy_flush_buffer (YY_BUFFER_STATE b ) +{ + if ( ! b ) + return; + + b->yy_n_chars = 0; + + /* We always need two end-of-buffer characters. The first causes + * a transition to the end-of-buffer state. The second causes + * a jam in that state. + */ + b->yy_ch_buf[0] = YY_END_OF_BUFFER_CHAR; + b->yy_ch_buf[1] = YY_END_OF_BUFFER_CHAR; + + b->yy_buf_pos = &b->yy_ch_buf[0]; + + b->yy_at_bol = 1; + b->yy_buffer_status = YY_BUFFER_NEW; + + if ( b == YY_CURRENT_BUFFER ) + yy_load_buffer_state( ); +} + +/** Pushes the new state onto the stack. The new state becomes + * the current state. This function will allocate the stack + * if necessary. + * @param new_buffer The new state. + * + */ +void yypush_buffer_state (YY_BUFFER_STATE new_buffer ) +{ + if (new_buffer == NULL) + return; + + yyensure_buffer_stack(); + + /* This block is copied from yy_switch_to_buffer. */ + if ( YY_CURRENT_BUFFER ) + { + /* Flush out information for old buffer. */ + *(yy_c_buf_p) = (yy_hold_char); + YY_CURRENT_BUFFER_LVALUE->yy_buf_pos = (yy_c_buf_p); + YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars); + } + + /* Only push if top exists. Otherwise, replace top. */ + if (YY_CURRENT_BUFFER) + (yy_buffer_stack_top)++; + YY_CURRENT_BUFFER_LVALUE = new_buffer; + + /* copied from yy_switch_to_buffer. */ + yy_load_buffer_state( ); + (yy_did_buffer_switch_on_eof) = 1; +} + +/** Removes and deletes the top of the stack, if present. + * The next element becomes the new top. + * + */ +void yypop_buffer_state (void) +{ + if (!YY_CURRENT_BUFFER) + return; + + yy_delete_buffer(YY_CURRENT_BUFFER ); + YY_CURRENT_BUFFER_LVALUE = NULL; + if ((yy_buffer_stack_top) > 0) + --(yy_buffer_stack_top); + + if (YY_CURRENT_BUFFER) { + yy_load_buffer_state( ); + (yy_did_buffer_switch_on_eof) = 1; + } +} + +/* Allocates the stack if it does not exist. + * Guarantees space for at least one push. + */ +static void yyensure_buffer_stack (void) +{ + yy_size_t num_to_alloc; + + if (!(yy_buffer_stack)) { + + /* First allocation is just for 2 elements, since we don't know if this + * scanner will even need a stack. We use 2 instead of 1 to avoid an + * immediate realloc on the next call. + */ + num_to_alloc = 1; + (yy_buffer_stack) = (struct yy_buffer_state**)yyalloc + (num_to_alloc * sizeof(struct yy_buffer_state*) + ); + if ( ! (yy_buffer_stack) ) + YY_FATAL_ERROR( "out of dynamic memory in yyensure_buffer_stack()" ); + + memset((yy_buffer_stack), 0, num_to_alloc * sizeof(struct yy_buffer_state*)); + + (yy_buffer_stack_max) = num_to_alloc; + (yy_buffer_stack_top) = 0; + return; + } + + if ((yy_buffer_stack_top) >= ((yy_buffer_stack_max)) - 1){ + + /* Increase the buffer to prepare for a possible push. */ + int grow_size = 8 /* arbitrary grow size */; + + num_to_alloc = (yy_buffer_stack_max) + grow_size; + (yy_buffer_stack) = (struct yy_buffer_state**)yyrealloc + ((yy_buffer_stack), + num_to_alloc * sizeof(struct yy_buffer_state*) + ); + if ( ! (yy_buffer_stack) ) + YY_FATAL_ERROR( "out of dynamic memory in yyensure_buffer_stack()" ); + + /* zero only the new slots.*/ + memset((yy_buffer_stack) + (yy_buffer_stack_max), 0, grow_size * sizeof(struct yy_buffer_state*)); + (yy_buffer_stack_max) = num_to_alloc; + } +} + +/** Setup the input buffer state to scan directly from a user-specified character buffer. + * @param base the character buffer + * @param size the size in bytes of the character buffer + * + * @return the newly allocated buffer state object. + */ +YY_BUFFER_STATE yy_scan_buffer (char * base, yy_size_t size ) +{ + YY_BUFFER_STATE b; + + if ( size < 2 || + base[size-2] != YY_END_OF_BUFFER_CHAR || + base[size-1] != YY_END_OF_BUFFER_CHAR ) + /* They forgot to leave room for the EOB's. */ + return 0; + + b = (YY_BUFFER_STATE) yyalloc(sizeof( struct yy_buffer_state ) ); + if ( ! b ) + YY_FATAL_ERROR( "out of dynamic memory in yy_scan_buffer()" ); + + b->yy_buf_size = size - 2; /* "- 2" to take care of EOB's */ + b->yy_buf_pos = b->yy_ch_buf = base; + b->yy_is_our_buffer = 0; + b->yy_input_file = 0; + b->yy_n_chars = b->yy_buf_size; + b->yy_is_interactive = 0; + b->yy_at_bol = 1; + b->yy_fill_buffer = 0; + b->yy_buffer_status = YY_BUFFER_NEW; + + yy_switch_to_buffer(b ); + + return b; +} + +/** Setup the input buffer state to scan a string. The next call to yylex() will + * scan from a @e copy of @a str. + * @param yystr a NUL-terminated string to scan + * + * @return the newly allocated buffer state object. + * @note If you want to scan bytes that may contain NUL values, then use + * yy_scan_bytes() instead. + */ +YY_BUFFER_STATE yy_scan_string (yyconst char * yystr ) +{ + + return yy_scan_bytes(yystr,strlen(yystr) ); +} + +/** Setup the input buffer state to scan the given bytes. The next call to yylex() will + * scan from a @e copy of @a bytes. + * @param yybytes the byte buffer to scan + * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes. + * + * @return the newly allocated buffer state object. + */ +YY_BUFFER_STATE yy_scan_bytes (yyconst char * yybytes, yy_size_t _yybytes_len ) +{ + YY_BUFFER_STATE b; + char *buf; + yy_size_t n; + yy_size_t i; + + /* Get memory for full buffer, including space for trailing EOB's. */ + n = _yybytes_len + 2; + buf = (char *) yyalloc(n ); + if ( ! buf ) + YY_FATAL_ERROR( "out of dynamic memory in yy_scan_bytes()" ); + + for ( i = 0; i < _yybytes_len; ++i ) + buf[i] = yybytes[i]; + + buf[_yybytes_len] = buf[_yybytes_len+1] = YY_END_OF_BUFFER_CHAR; + + b = yy_scan_buffer(buf,n ); + if ( ! b ) + YY_FATAL_ERROR( "bad buffer in yy_scan_bytes()" ); + + /* It's okay to grow etc. this buffer, and we should throw it + * away when we're done. + */ + b->yy_is_our_buffer = 1; + + return b; +} + +#ifndef YY_EXIT_FAILURE +#define YY_EXIT_FAILURE 2 +#endif + +static void yy_fatal_error (yyconst char* msg ) +{ + (void) fprintf( stderr, "%s\n", msg ); + exit( YY_EXIT_FAILURE ); +} + +/* Redefine yyless() so it works in section 3 code. */ + +#undef yyless +#define yyless(n) \ + do \ + { \ + /* Undo effects of setting up yytext. */ \ + int yyless_macro_arg = (n); \ + YY_LESS_LINENO(yyless_macro_arg);\ + yytext[yyleng] = (yy_hold_char); \ + (yy_c_buf_p) = yytext + yyless_macro_arg; \ + (yy_hold_char) = *(yy_c_buf_p); \ + *(yy_c_buf_p) = '\0'; \ + yyleng = yyless_macro_arg; \ + } \ + while ( 0 ) + +/* Accessor methods (get/set functions) to struct members. */ + +/** Get the current line number. + * + */ +int yyget_lineno (void) +{ + + return yylineno; +} + +/** Get the input stream. + * + */ +FILE *yyget_in (void) +{ + return yyin; +} + +/** Get the output stream. + * + */ +FILE *yyget_out (void) +{ + return yyout; +} + +/** Get the length of the current token. + * + */ +yy_size_t yyget_leng (void) +{ + return yyleng; +} + +/** Get the current token. + * + */ + +char *yyget_text (void) +{ + return yytext; +} + +/** Set the current line number. + * @param line_number + * + */ +void yyset_lineno (int line_number ) +{ + + yylineno = line_number; +} + +/** Set the input stream. This does not discard the current + * input buffer. + * @param in_str A readable stream. + * + * @see yy_switch_to_buffer + */ +void yyset_in (FILE * in_str ) +{ + yyin = in_str ; +} + +void yyset_out (FILE * out_str ) +{ + yyout = out_str ; +} + +int yyget_debug (void) +{ + return yy_flex_debug; +} + +void yyset_debug (int bdebug ) +{ + yy_flex_debug = bdebug ; +} + +static int yy_init_globals (void) +{ + /* Initialization is the same as for the non-reentrant scanner. + * This function is called from yylex_destroy(), so don't allocate here. + */ + + (yy_buffer_stack) = 0; + (yy_buffer_stack_top) = 0; + (yy_buffer_stack_max) = 0; + (yy_c_buf_p) = (char *) 0; + (yy_init) = 0; + (yy_start) = 0; + +/* Defined in main.c */ +#ifdef YY_STDINIT + yyin = stdin; + yyout = stdout; +#else + yyin = (FILE *) 0; + yyout = (FILE *) 0; +#endif + + /* For future reference: Set errno on error, since we are called by + * yylex_init() + */ + return 0; +} + +/* yylex_destroy is for both reentrant and non-reentrant scanners. */ +int yylex_destroy (void) +{ + + /* Pop the buffer stack, destroying each element. */ + while(YY_CURRENT_BUFFER){ + yy_delete_buffer(YY_CURRENT_BUFFER ); + YY_CURRENT_BUFFER_LVALUE = NULL; + yypop_buffer_state(); + } + + /* Destroy the stack itself. */ + yyfree((yy_buffer_stack) ); + (yy_buffer_stack) = NULL; + + /* Reset the globals. This is important in a non-reentrant scanner so the next time + * yylex() is called, initialization will occur. */ + yy_init_globals( ); + + return 0; +} + +/* + * Internal utility routines. + */ + +#ifndef yytext_ptr +static void yy_flex_strncpy (char* s1, yyconst char * s2, int n ) +{ + register int i; + for ( i = 0; i < n; ++i ) + s1[i] = s2[i]; +} +#endif + +#ifdef YY_NEED_STRLEN +static int yy_flex_strlen (yyconst char * s ) +{ + register int n; + for ( n = 0; s[n]; ++n ) + ; + + return n; +} +#endif + +void *yyalloc (yy_size_t size ) +{ + return (void *) malloc( size ); +} + +void *yyrealloc (void * ptr, yy_size_t size ) +{ + /* The cast to (char *) in the following accommodates both + * implementations that use char* generic pointers, and those + * that use void* generic pointers. It works with the latter + * because both ANSI C and C++ allow castless assignment from + * any pointer type to void*, and deal with argument conversions + * as though doing an assignment. + */ + return (void *) realloc( (char *) ptr, size ); +} + +void yyfree (void * ptr ) +{ + free( (char *) ptr ); /* see yyrealloc() for (char *) cast */ +} + +#define YYTABLES_NAME "yytables" + +#line 44 "fmd_scanner.l" + + + +int parse_integer(char *input, int base) +{ + char *multiplier = NULL; + unsigned val = strtoul(input, &multiplier, base); + + if (*multiplier) { + switch(*multiplier) { + case 'K': + val *= 1024; + break; + case 'M': + val *= 1024*1024; + break; + case 'G': + val *= 1024*1024*1024; + break; + default: + // If we ever get here, the MULTIPLIER regex is allowing + // multiplier suffixes not handled by this code. + assert(false); + } + } + + yylval.intval = val; + return INTEGER; +} + +int copy_string(const char *input) +{ + yylval.strval = strdup(input); + return STRING; +} + diff --git a/util/cbfstool/fmd_scanner.h b/util/cbfstool/fmd_scanner.h new file mode 100644 index 0000000..595b530 --- /dev/null +++ b/util/cbfstool/fmd_scanner.h @@ -0,0 +1,333 @@ +#ifndef yyHEADER_H +#define yyHEADER_H 1 +#define yyIN_HEADER 1 + +#line 6 "fmd_scanner.h" + +#define YY_INT_ALIGNED short int + +/* A lexical scanner generated by flex */ + +#define FLEX_SCANNER +#define YY_FLEX_MAJOR_VERSION 2 +#define YY_FLEX_MINOR_VERSION 5 +#define YY_FLEX_SUBMINOR_VERSION 39 +#if YY_FLEX_SUBMINOR_VERSION > 0 +#define FLEX_BETA +#endif + +/* First, we deal with platform-specific or compiler-specific issues. */ + +/* begin standard C headers. */ +#include <stdio.h> +#include <string.h> +#include <errno.h> +#include <stdlib.h> + +/* end standard C headers. */ + +/* flex integer type definitions */ + +#ifndef FLEXINT_H +#define FLEXINT_H + +/* C99 systems have <inttypes.h>. Non-C99 systems may or may not. */ + +#if defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L + +/* C99 says to define __STDC_LIMIT_MACROS before including stdint.h, + * if you want the limit (max/min) macros for int types. + */ +#ifndef __STDC_LIMIT_MACROS +#define __STDC_LIMIT_MACROS 1 +#endif + +#include <inttypes.h> +typedef int8_t flex_int8_t; +typedef uint8_t flex_uint8_t; +typedef int16_t flex_int16_t; +typedef uint16_t flex_uint16_t; +typedef int32_t flex_int32_t; +typedef uint32_t flex_uint32_t; +#else +typedef signed char flex_int8_t; +typedef short int flex_int16_t; +typedef int flex_int32_t; +typedef unsigned char flex_uint8_t; +typedef unsigned short int flex_uint16_t; +typedef unsigned int flex_uint32_t; + +/* Limits of integral types. */ +#ifndef INT8_MIN +#define INT8_MIN (-128) +#endif +#ifndef INT16_MIN +#define INT16_MIN (-32767-1) +#endif +#ifndef INT32_MIN +#define INT32_MIN (-2147483647-1) +#endif +#ifndef INT8_MAX +#define INT8_MAX (127) +#endif +#ifndef INT16_MAX +#define INT16_MAX (32767) +#endif +#ifndef INT32_MAX +#define INT32_MAX (2147483647) +#endif +#ifndef UINT8_MAX +#define UINT8_MAX (255U) +#endif +#ifndef UINT16_MAX +#define UINT16_MAX (65535U) +#endif +#ifndef UINT32_MAX +#define UINT32_MAX (4294967295U) +#endif + +#endif /* ! C99 */ + +#endif /* ! FLEXINT_H */ + +#ifdef __cplusplus + +/* The "const" storage-class-modifier is valid. */ +#define YY_USE_CONST + +#else /* ! __cplusplus */ + +/* C99 requires __STDC__ to be defined as 1. */ +#if defined (__STDC__) + +#define YY_USE_CONST + +#endif /* defined (__STDC__) */ +#endif /* ! __cplusplus */ + +#ifdef YY_USE_CONST +#define yyconst const +#else +#define yyconst +#endif + +/* Size of default input buffer. */ +#ifndef YY_BUF_SIZE +#ifdef __ia64__ +/* On IA-64, the buffer size is 16k, not 8k. + * Moreover, YY_BUF_SIZE is 2*YY_READ_BUF_SIZE in the general case. + * Ditto for the __ia64__ case accordingly. + */ +#define YY_BUF_SIZE 32768 +#else +#define YY_BUF_SIZE 16384 +#endif /* __ia64__ */ +#endif + +#ifndef YY_TYPEDEF_YY_BUFFER_STATE +#define YY_TYPEDEF_YY_BUFFER_STATE +typedef struct yy_buffer_state *YY_BUFFER_STATE; +#endif + +#ifndef YY_TYPEDEF_YY_SIZE_T +#define YY_TYPEDEF_YY_SIZE_T +typedef size_t yy_size_t; +#endif + +extern yy_size_t yyleng; + +extern FILE *yyin, *yyout; + +#ifndef YY_STRUCT_YY_BUFFER_STATE +#define YY_STRUCT_YY_BUFFER_STATE +struct yy_buffer_state + { + FILE *yy_input_file; + + char *yy_ch_buf; /* input buffer */ + char *yy_buf_pos; /* current position in input buffer */ + + /* Size of input buffer in bytes, not including room for EOB + * characters. + */ + yy_size_t yy_buf_size; + + /* Number of characters read into yy_ch_buf, not including EOB + * characters. + */ + yy_size_t yy_n_chars; + + /* Whether we "own" the buffer - i.e., we know we created it, + * and can realloc() it to grow it, and should free() it to + * delete it. + */ + int yy_is_our_buffer; + + /* Whether this is an "interactive" input source; if so, and + * if we're using stdio for input, then we want to use getc() + * instead of fread(), to make sure we stop fetching input after + * each newline. + */ + int yy_is_interactive; + + /* Whether we're considered to be at the beginning of a line. + * If so, '^' rules will be active on the next match, otherwise + * not. + */ + int yy_at_bol; + + int yy_bs_lineno; /**< The line count. */ + int yy_bs_column; /**< The column count. */ + + /* Whether to try to fill the input buffer when we reach the + * end of it. + */ + int yy_fill_buffer; + + int yy_buffer_status; + + }; +#endif /* !YY_STRUCT_YY_BUFFER_STATE */ + +void yyrestart (FILE *input_file ); +void yy_switch_to_buffer (YY_BUFFER_STATE new_buffer ); +YY_BUFFER_STATE yy_create_buffer (FILE *file,int size ); +void yy_delete_buffer (YY_BUFFER_STATE b ); +void yy_flush_buffer (YY_BUFFER_STATE b ); +void yypush_buffer_state (YY_BUFFER_STATE new_buffer ); +void yypop_buffer_state (void ); + +YY_BUFFER_STATE yy_scan_buffer (char *base,yy_size_t size ); +YY_BUFFER_STATE yy_scan_string (yyconst char *yy_str ); +YY_BUFFER_STATE yy_scan_bytes (yyconst char *bytes,yy_size_t len ); + +void *yyalloc (yy_size_t ); +void *yyrealloc (void *,yy_size_t ); +void yyfree (void * ); + +/* Begin user sect3 */ + +#define yywrap() 1 +#define YY_SKIP_YYWRAP + +extern int yylineno; + +extern char *yytext; +#define yytext_ptr yytext + +#ifdef YY_HEADER_EXPORT_START_CONDITIONS +#define INITIAL 0 + +#endif + +#ifndef YY_NO_UNISTD_H +/* Special case for "unistd.h", since it is non-ANSI. We include it way + * down here because we want the user's section 1 to have been scanned first. + * The user has a chance to override it with an option. + */ +#include <unistd.h> +#endif + +#ifndef YY_EXTRA_TYPE +#define YY_EXTRA_TYPE void * +#endif + +/* Accessor methods to globals. + These are made visible to non-reentrant scanners for convenience. */ + +int yylex_destroy (void ); + +int yyget_debug (void ); + +void yyset_debug (int debug_flag ); + +YY_EXTRA_TYPE yyget_extra (void ); + +void yyset_extra (YY_EXTRA_TYPE user_defined ); + +FILE *yyget_in (void ); + +void yyset_in (FILE * in_str ); + +FILE *yyget_out (void ); + +void yyset_out (FILE * out_str ); + +yy_size_t yyget_leng (void ); + +char *yyget_text (void ); + +int yyget_lineno (void ); + +void yyset_lineno (int line_number ); + +/* Macros after this point can all be overridden by user definitions in + * section 1. + */ + +#ifndef YY_SKIP_YYWRAP +#ifdef __cplusplus +extern "C" int yywrap (void ); +#else +extern int yywrap (void ); +#endif +#endif + +#ifndef yytext_ptr +static void yy_flex_strncpy (char *,yyconst char *,int ); +#endif + +#ifdef YY_NEED_STRLEN +static int yy_flex_strlen (yyconst char * ); +#endif + +#ifndef YY_NO_INPUT + +#endif + +/* Amount of stuff to slurp up with each read. */ +#ifndef YY_READ_BUF_SIZE +#ifdef __ia64__ +/* On IA-64, the buffer size is 16k, not 8k */ +#define YY_READ_BUF_SIZE 16384 +#else +#define YY_READ_BUF_SIZE 8192 +#endif /* __ia64__ */ +#endif + +/* Number of entries by which start-condition stack grows. */ +#ifndef YY_START_STACK_INCR +#define YY_START_STACK_INCR 25 +#endif + +/* Default declaration of generated scanner - a define so the user can + * easily add parameters. + */ +#ifndef YY_DECL +#define YY_DECL_IS_OURS 1 + +extern int yylex (void); + +#define YY_DECL int yylex (void) +#endif /* !YY_DECL */ + +/* yy_get_previous_state - get the state just before the EOB char was reached */ + +#undef YY_NEW_FILE +#undef YY_FLUSH_BUFFER +#undef yy_set_bol +#undef yy_new_buffer +#undef yy_set_interactive +#undef YY_DO_BEFORE_ACTION + +#ifdef YY_DECL_IS_OURS +#undef YY_DECL_IS_OURS +#undef YY_DECL +#endif + +#line 44 "fmd_scanner.l" + + +#line 332 "fmd_scanner.h" +#undef yyIN_HEADER +#endif /* yyHEADER_H */ diff --git a/util/cbfstool/fmd_scanner.l b/util/cbfstool/fmd_scanner.l new file mode 100644 index 0000000..d2cc43d --- /dev/null +++ b/util/cbfstool/fmd_scanner.l @@ -0,0 +1,78 @@ +/* + * fmd_scanner.l, scanner generator for flashmap descriptor language + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +%{ +#include "fmd_parser.h" + +#include <assert.h> +#include <string.h> + +int parse_integer(char *input, int base); +int copy_string(const char *input); +%} + +%option noyywrap + +MULTIPLIER [KMG] + +%% + +[[:space:]]+ /* Eat whitespace. */ +#.*$ /* Eat comments. */ +0{MULTIPLIER}? | +[1-9][0-9]*{MULTIPLIER}? return parse_integer(yytext, 10); +0[0-9]+{MULTIPLIER}? return OCTAL; +0[xX][0-9a-f]+{MULTIPLIER}? return parse_integer(yytext + 2, 16); +[^#@{}()[:space:]]* return copy_string(yytext); +. return *yytext; + +%% + +int parse_integer(char *input, int base) +{ + char *multiplier = NULL; + unsigned val = strtoul(input, &multiplier, base); + + if (*multiplier) { + switch(*multiplier) { + case 'K': + val *= 1024; + break; + case 'M': + val *= 1024*1024; + break; + case 'G': + val *= 1024*1024*1024; + break; + default: + // If we ever get here, the MULTIPLIER regex is allowing + // multiplier suffixes not handled by this code. + assert(false); + } + } + + yylval.intval = val; + return INTEGER; +} + +int copy_string(const char *input) +{ + yylval.strval = strdup(input); + return STRING; +} diff --git a/util/cbfstool/option.h b/util/cbfstool/option.h new file mode 100644 index 0000000..70777f8 --- /dev/null +++ b/util/cbfstool/option.h @@ -0,0 +1,29 @@ +/* + * option.h, unsigned OPTION type + * + * Copyright (C) 2015 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA + */ + +#ifndef OPTION_H_ +#define OPTION_H_ + +struct unsigned_option { + bool val_known; + /** It is an error to read this field unless val_known is set. */ + unsigned val; +}; + +#endif

1 0

Patch set updated for coreboot: 3a8f688 cbfstool: Make the add action choose an aligned entries capacity
by Sol Boucher 01 May '15

01 May '15

Sol Boucher (solb(a)chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/9939 -gerrit commit 3a8f688ffbe15960be4085678a4b07863fb3c0ae Author: Sol Boucher <solb(a)chromium.org> Date: Fri Apr 3 09:13:04 2015 -0700 cbfstool: Make the add action choose an aligned entries capacity This fixes an inconsistency between `cbfstool create` and `cbfstool add` that was resulting in confusing claims about the amount of free space at the end of a CBFS. Calls to `cbfstool add` check whether a file fits under a given empty file entry by testing whether it would collide with the beginning of the *subsequent* file header; thus, if a file's end is unaligned, its reported size will not match the actual available capacity. Although deleted entries always end on an alignment boundary because `cbfstool remove` expands them to fill the available space, `cbfstool create` doesn't necessarily size a new entries region to result in an empty entry with an aligned end. This problem never resulted in clobbering important data because cbfstool would blindly reserve 64B (or the selected alignment) of free space immediately after the all-inclusive empty file entry. This change alters the way this reservation is reported: only the overhang past the alignment is used as hidden padding, and the empty entry's capacity is always reported such that it ends at an aligned address. Much of the time that went into this patch was spent building trust in the trickery cbfstool employs to avoid explicitly tracking the image's total capacity for entries, so below are two proofs of correctness to save others time and discourage inadvertent breakage: OBSERVATION (A): A check in cbfs_image_create() guarantees that an aligned CBFS empty file header is small enough that it won't cross another aligned address. OBSERVATION (B): In cbfs_image_create(), the initial empty entry is sized such that its contents end on an aligned address. THM. 1: Placing a new file within an empty entry located below an existing file entry will never leave an aligned flash address containing neither the beginning of a file header nor part of a file. We can prove this by contradiction: assume a newly-added file neither fills to the end of the preexisting empty entry nor leaves room for another aligned empty header after it. Then the first aligned address after the end of the newly-inserted file... - CASE 1: ...already contains a preexisting file entry header. + Then that address contains a file header. - CASE 2: ...does not already house a file entry header. + Then because CBFS content doesn't fall outside headers, the area between there and the *next* aligned address after that is unused. + By (A), we can fit a file header without clobbering anything. + Then that address now contains a file header. THM. 2: Placing a new file in an empty entry at the very end of the image such that it fits, but leaves no room for a final header, is guaranteed not to change the total amount of space for entries, even if that new file is later removed from the CBFS. Again, we use contradiction: assume that creating such a file causes a permanent... - CASE 1: ...increase in the amount of available space. + Then the combination of the inserted file, its header, and any padding must have exceeded the empty entry in size enough for it to cross at least one additional aligned address, since aligned addresses are how the limit on an entry's capacity is determined. + But adding the file couldn't have caused us to write past any further aligned addresses because they are the boundary's used when verifying that sufficient capacity exists; furthermore, by (B), no entry can ever terminate beyond where the initial empty entry did when the CBFS was first created. + Then the creation of the file did not result in a space increase. - CASE 2: ...decrease in the amount of available space. + Then the end of the new file entry crosses at least one fewer aligned address than did the empty file entry. + Then by (A), there is room to place a new file entry that describes the remaining available space at the first available aligned address. + Then there is now a new record showing the same amount of available space. + Then the creation of the file did not result in a space decrease. BUG=chromium:473726 TEST=Had the following conversation with cbfstool: $ ./cbfstool test.image create -s 0x100000 -m arm Created CBFS image (capacity = 1048408 bytes) $ ./cbfstool test.image print test.image: 1024 kB, bootblocksize 0, romsize 1048576, offset 0x40 alignment: 64 bytes, architecture: arm Name Offset Type Size (empty) 0x40 null 1048408 $ dd if=/dev/zero of=toobigmed.bin bs=1048409 count=1 1+0 records in 1+0 records out 1048409 bytes (1.0 MB) copied, 0.0057865 s, 181 MB/s $ ./cbfstool test.image add -t 0x50 -f toobigmed.bin -n toobig E: Could not add [toobigmed.bin, 1048409 bytes (1023 KB)@0x0]; too big? E: Failed to add 'toobigmed.bin' into ROM image. $ truncate -s -1 toobigmed.bin $ ./cbfstool test.image add -t 0x50 -f toobigmed.bin -n toobig $ ./cbfstool test.image print test.image: 1024 kB, bootblocksize 0, romsize 1048576, offset 0x40 alignment: 64 bytes, architecture: arm Name Offset Type Size toobig 0x40 raw 1048408 $ ./cbfstool test.image remove -n toobig $ ./cbfstool test.image print test.image: 1024 kB, bootblocksize 0, romsize 1048576, offset 0x40 alignment: 64 bytes, architecture: arm Name Offset Type Size (empty) 0x40 deleted 1048408 $ ./cbfstool test.image print test.image: 1024 kB, bootblocksize 0, romsize 1048576, offset 0x40 alignment: 64 bytes, architecture: arm Name Offset Type Size (empty) 0x40 deleted 1048408 BRANCH=None Change-Id: I118743e37469ef0226970decc900db5d9b92c5df Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Commit-Id: e317ddca14bc36bc36e6406b758378c88e9ae04e Original-Change-Id: I294ee489b4918646c359b06aa1581918f2d8badc Original-Signed-off-by: Sol Boucher <solb(a)chromium.org> Original-Reviewed-on: https://chromium-review.googlesource.com/263962 Original-Reviewed-by: Hung-Te Lin <hungte(a)chromium.org> Original-Reviewed-by: Stefan Reinauer <reinauer(a)google.com> --- util/cbfstool/cbfs_image.c | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/util/cbfstool/cbfs_image.c b/util/cbfstool/cbfs_image.c index 2581bef..8e0e9a4 100644 --- a/util/cbfstool/cbfs_image.c +++ b/util/cbfstool/cbfs_image.c @@ -28,6 +28,24 @@ #include "common.h" #include "cbfs_image.h" +/* Even though the file-adding functions---cbfs_add_entry() and + * cbfs_add_entry_at()---perform their sizing checks against the beginning of + * the subsequent section rather than a stable recorded value such as an empty + * file header's len field, it's possible to prove two interesting properties + * about their behavior: + * - Placing a new file within an empty entry located below an existing file + * entry will never leave an aligned flash address containing neither the + * beginning of a file header nor part of a file. + * - Placing a new file in an empty entry at the very end of the image such + * that it fits, but leaves no room for a final header, is guaranteed not to + * change the total amount of space for entries, even if that new file is + * later removed from the CBFS. + * These properties are somewhat nonobvious from the implementation, so the + * reader is encouraged to blame this comment and examine the full proofs + * in the commit message before making significant changes that would risk + * removing said guarantees. + */ + /* The file name align is not defined in CBFS spec -- only a preference by * (old) cbfstool. */ #define CBFS_FILENAME_ALIGN (16) @@ -185,6 +203,16 @@ int cbfs_image_create(struct cbfs_image *image, bootblock_offset, bootblock->size, header_offset, sizeof(header), entries_offset); + // This attribute must be given in order to prove that this module + // correctly preserves certain CBFS properties. See the block comment + // near the top of this file (and the associated commit message). + size_t empty_header_len = cbfs_calculate_file_header_size(""); + if (align < empty_header_len) { + ERROR("CBFS must be aligned to at least %zu bytes\n", + empty_header_len); + return -1; + } + if (buffer_create(&image->buffer, size, "(new)") != 0) return -1; if ((image->header = malloc(sizeof(*image->header))) == NULL) @@ -263,7 +291,11 @@ int cbfs_image_create(struct cbfs_image *image, cbfs_len = bootblock_offset; if (header_offset > entries_offset && header_offset < cbfs_len) cbfs_len = header_offset; - cbfs_len -= entries_offset + align + entry_header_len; + // This alignment is necessary in order to prove that this module + // correctly preserves certain CBFS properties. See the block comment + // near the top of this file (and the associated commit message). + cbfs_len -= cbfs_len % align; + cbfs_len -= entries_offset + entry_header_len; cbfs_create_empty_entry(entry, cbfs_len, ""); LOG("Created CBFS image (capacity = %d bytes)\n", cbfs_len); return 0; @@ -462,8 +494,12 @@ static int cbfs_add_entry_at(struct cbfs_image *image, assert(addr < addr_next); if (addr_next - addr < min_entry_size) { - DEBUG("No space after content to keep CBFS structure.\n"); - return -1; + DEBUG("No need for new \"empty\" entry\n"); + /* No need to increase the size of the just + * stored file to extend to next file. Alignment + * of next file takes care of this. + */ + return 0; } len = addr_next - addr - min_entry_size;

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

coreboot-gerrit May 2015