Handle improperly build image files gracefully

Images build improperly (by simply concatenating separate images) were accepted,
but anything after the first end-of-file record *silently* ignored. Now emit warning
for intel and motorola images upon non-whitespace after first end-of-file record but
continue reading anyway.
ST ships some images broken that way in their CubeMX packages ...

Change-Id: I0c5d08fa90070fed11fb805c5f0dc39817048176
Signed-off-by: Andreas Bolsch <hyphen0break@gmail.com>
Reviewed-on: http://openocd.zylin.com/4281
Tested-by: jenkins
Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>

src/helper/fileio.c

@@ -153,6 +153,11 @@ int fileio_close(struct fileio *fileio)
 	return retval;
 }
 
+int fileio_feof(struct fileio *fileio)
+{
+	return feof(fileio->file);
+}
+
 int fileio_seek(struct fileio *fileio, size_t position)
 {
 	int retval;

src/helper/fileio.h

@@ -46,6 +46,7 @@ struct fileio;
 int fileio_open(struct fileio **fileio, const char *url,
 		enum fileio_access access_type, enum fileio_type type);
 int fileio_close(struct fileio *fileio);
+int fileio_feof(struct fileio *fileio);
 
 int fileio_seek(struct fileio *fileio, size_t position);
 int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);

src/target/image.c

@@ -121,8 +121,9 @@ static int image_ihex_buffer_complete_inner(struct image *image,
 {
 	struct image_ihex *ihex = image->type_private;
 	struct fileio *fileio = ihex->fileio;
-	uint32_t full_address = 0x0;
+	uint32_t full_address;
 	uint32_t cooked_bytes;
+	bool end_rec = false;
 	int i;
 
 	/* we can't determine the number of sections that we'll have to create ahead of time,
@@ -137,6 +138,9 @@ static int image_ihex_buffer_complete_inner(struct image *image,
 	ihex->buffer = malloc(filesize >> 1);
 	cooked_bytes = 0x0;
 	image->num_sections = 0;
+
+	while (!fileio_feof(fileio)) {
+		full_address = 0x0;
 		section[image->num_sections].private = &ihex->buffer[cooked_bytes];
 		section[image->num_sections].base_address = 0x0;
 		section[image->num_sections].size = 0x0;
@@ -150,7 +154,8 @@ static int image_ihex_buffer_complete_inner(struct image *image,
 			uint8_t cal_checksum = 0;
 			size_t bytes_read = 0;
 
-		if (lpszLine[0] == '#')
+			/* skip comments and blank lines */
+			if ((lpszLine[0] == '#') || (strlen(lpszLine + strspn(lpszLine, "\n\t\r ")) == 0))
 				continue;
 
 			if (sscanf(&lpszLine[bytes_read], ":%2" SCNx32 "%4" SCNx32 "%2" SCNx32, &count,
@@ -209,7 +214,8 @@ static int image_ihex_buffer_complete_inner(struct image *image,
 					image->sections[i].flags = section[i].flags;
 				}
 
-			return ERROR_OK;
+				end_rec = true;
+				break;
 			} else if (record_type == 2) {	/* Linear Address Record */
 				uint16_t upper_address;
 
@@ -302,11 +308,21 @@ static int image_ihex_buffer_complete_inner(struct image *image,
 				LOG_ERROR("incorrect record checksum found in IHEX file");
 				return ERROR_IMAGE_CHECKSUM;
 			}
+
+			if (end_rec) {
+				end_rec = false;
+				LOG_WARNING("continuing after end-of-file record: %.40s", lpszLine);
+			}
+		}
 	}
 
-	LOG_ERROR("premature end of IHEX file, no end-of-file record found");
+	if (end_rec)
+		return ERROR_OK;
+	else {
+		LOG_ERROR("premature end of IHEX file, no matching end-of-file record found");
 		return ERROR_IMAGE_FORMAT_ERROR;
 	}
+}
 
 /**
  * Allocate memory dynamically instead of on the stack. This
@@ -510,8 +526,9 @@ static int image_mot_buffer_complete_inner(struct image *image,
 {
 	struct image_mot *mot = image->type_private;
 	struct fileio *fileio = mot->fileio;
-	uint32_t full_address = 0x0;
+	uint32_t full_address;
 	uint32_t cooked_bytes;
+	bool end_rec = false;
 	int i;
 
 	/* we can't determine the number of sections that we'll have to create ahead of time,
@@ -526,6 +543,9 @@ static int image_mot_buffer_complete_inner(struct image *image,
 	mot->buffer = malloc(filesize >> 1);
 	cooked_bytes = 0x0;
 	image->num_sections = 0;
+
+	while (!fileio_feof(fileio)) {
+		full_address = 0x0;
 		section[image->num_sections].private = &mot->buffer[cooked_bytes];
 		section[image->num_sections].base_address = 0x0;
 		section[image->num_sections].size = 0x0;
@@ -539,6 +559,10 @@ static int image_mot_buffer_complete_inner(struct image *image,
 			uint8_t cal_checksum = 0;
 			uint32_t bytes_read = 0;
 
+			/* skip comments and blank lines */
+			if ((lpszLine[0] == '#') || (strlen(lpszLine + strspn(lpszLine, "\n\t\r ")) == 0))
+				continue;
+
 			/* get record type and record length */
 			if (sscanf(&lpszLine[bytes_read], "S%1" SCNx32 "%2" SCNx32, &record_type,
 				&count) != 2)
@@ -641,7 +665,8 @@ static int image_mot_buffer_complete_inner(struct image *image,
 					image->sections[i].flags = section[i].flags;
 				}
 
-			return ERROR_OK;
+				end_rec = true;
+				break;
 			} else {
 				LOG_ERROR("unhandled S19 record type: %i", (int)(record_type));
 				return ERROR_IMAGE_FORMAT_ERROR;
@@ -656,11 +681,21 @@ static int image_mot_buffer_complete_inner(struct image *image,
 				LOG_ERROR("incorrect record checksum found in S19 file");
 				return ERROR_IMAGE_CHECKSUM;
 			}
+
+			if (end_rec) {
+				end_rec = false;
+				LOG_WARNING("continuing after end-of-file record: %.40s", lpszLine);
+			}
+		}
 	}
 
-	LOG_ERROR("premature end of S19 file, no end-of-file record found");
+	if (end_rec)
+		return ERROR_OK;
+	else {
+		LOG_ERROR("premature end of S19 file, no matching end-of-file record found");
 		return ERROR_IMAGE_FORMAT_ERROR;
 	}
+}
 
 /**
  * Allocate memory dynamically instead of on the stack. This