+// SPDX-License-Identifier: GPL-2.0-or-later
+
/***************************************************************************
* Copyright (C) 2007 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * 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 2 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. *
+ * Copyright (C) 2007,2008 Øyvind Harboe *
+ * oyvind.harboe@zylin.com *
* *
- * 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., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * Copyright (C) 2008 by Spencer Oliver *
+ * spen@spen-soft.co.uk *
***************************************************************************/
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
-#include "types.h"
-#include "replacements.h"
#include "log.h"
-
+#include "configuration.h"
#include "fileio.h"
+#include "replacements.h"
-#include <stdio.h>
-#include <string.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <errno.h>
-#include <ctype.h>
-
-int fileio_close(fileio_t *fileio);
-int fileio_dispatch_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read);
+struct fileio {
+ char *url;
+ size_t size;
+ enum fileio_type type;
+ enum fileio_access access;
+ FILE *file;
+};
-int fileio_open_local(fileio_t *fileio)
+static inline int fileio_close_local(struct fileio *fileio)
{
- fileio_local_t *fileio_local = malloc(sizeof(fileio_local_t));
- char access[4];
-
- fileio->location_private = fileio_local;
-
- if ((fileio->access != FILEIO_WRITE) && (fileio->access != FILEIO_READWRITE))
- {
- if (stat(fileio->url, &fileio_local->file_stat) == -1)
- {
- free(fileio_local);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING,
- "couldn't stat() %s: %s", fileio->url, strerror(errno));
- return ERROR_FILEIO_NOT_FOUND;
- }
-
- if (S_ISDIR(fileio_local->file_stat.st_mode))
- {
- free(fileio_local);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "%s is a directory", fileio->url);
- return ERROR_FILEIO_NOT_FOUND;
- }
+ int retval = fclose(fileio->file);
+ if (retval != 0) {
+ if (retval == EBADF)
+ LOG_ERROR("BUG: fileio->file not a valid file descriptor");
+ else
+ LOG_ERROR("couldn't close %s: %s", fileio->url, strerror(errno));
+
+ return ERROR_FILEIO_OPERATION_FAILED;
}
-
- switch (fileio->access)
- {
+
+ return ERROR_OK;
+}
+
+static inline int fileio_open_local(struct fileio *fileio)
+{
+ char file_access[4];
+ ssize_t file_size;
+
+ switch (fileio->access) {
case FILEIO_READ:
- strcpy(access, "r");
+ strcpy(file_access, "r");
break;
case FILEIO_WRITE:
- strcpy(access, "w");
+ strcpy(file_access, "w");
break;
case FILEIO_READWRITE:
- strcpy(access, "w+");
+ strcpy(file_access, "w+");
break;
case FILEIO_APPEND:
- strcpy(access, "a");
+ strcpy(file_access, "a");
break;
case FILEIO_APPENDREAD:
- strcpy(access, "a+");
+ strcpy(file_access, "a+");
break;
default:
- free(fileio_local);
- ERROR("BUG: access neither read, write nor readwrite");
- return ERROR_INVALID_ARGUMENTS;
- }
-
- if (fileio->access == FILEIO_READ)
- {
- if (fileio_local->file_stat.st_size == 0)
- {
- /* tried to open an empty file for reading */
- free(fileio_local);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "empty file %s", fileio->url);
- return ERROR_FILEIO_OPERATION_FAILED;
- }
- }
-
- if (fileio->pri_type == FILEIO_IMAGE)
- strcat(access, "b");
-
- if (!(fileio_local->file = fopen(fileio->url, access)))
- {
- free(fileio_local);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't open %s", fileio->url);
- return ERROR_FILEIO_OPERATION_FAILED;
- }
-
- if ((fileio->access != FILEIO_WRITE) || (fileio->access == FILEIO_READWRITE))
- {
- fileio->size = fileio_local->file_stat.st_size;
- }
- else
- {
- fileio->size = 0x0;
+ LOG_ERROR("BUG: access neither read, write nor readwrite");
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
-
- return ERROR_OK;
-}
-//#ifdef FILEIO_BUFFER_COMPLETE_IHEX
-int fileio_ihex_buffer_complete(fileio_t *fileio)
-{
- fileio_image_t *image = fileio->pri_type_private;
- fileio_ihex_t *ihex = fileio->sec_type_private;
- u32 raw_bytes_read, raw_bytes;
- int retval;
- u32 full_address = image->base_address;
- char *buffer = malloc(ihex->raw_size);
- u32 cooked_bytes = 0x0;
-
- ihex->raw_size = fileio->size;
- ihex->buffer = malloc(ihex->raw_size >> 1);
-
- if ((retval = fileio_dispatch_read(fileio, ihex->raw_size, (u8*)buffer, &raw_bytes_read)) != ERROR_OK)
- {
- free(buffer);
- ERROR("failed buffering IHEX file, read failed");
- return ERROR_FILEIO_OPERATION_FAILED;
- }
-
- if (raw_bytes_read != ihex->raw_size)
- {
- free(buffer);
- ERROR("failed buffering complete IHEX file, only partially read");
+ /* win32 always opens in binary mode */
+#ifndef _WIN32
+ if (fileio->type == FILEIO_BINARY)
+#endif
+ strcat(file_access, "b");
+
+ fileio->file = open_file_from_path(fileio->url, file_access);
+ if (!fileio->file) {
+ LOG_ERROR("couldn't open %s", fileio->url);
return ERROR_FILEIO_OPERATION_FAILED;
}
-
- raw_bytes = 0x0;
- while (raw_bytes < raw_bytes_read)
- {
- u32 count;
- u32 address;
- u32 record_type;
- u32 checksum;
-
- if (sscanf(&buffer[raw_bytes], ":%2x%4x%2x", &count, &address, &record_type) != 3)
- {
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "invalid IHEX record");
- return ERROR_FILEIO_OPERATION_FAILED;
- }
- raw_bytes += 9;
-
- if (record_type == 0)
- {
- if ((full_address & 0xffff) != address)
- {
- free(buffer);
- ERROR("can't handle non-linear IHEX file");
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "can't handle non-linear IHEX file");
- return ERROR_FILEIO_OPERATION_FAILED;
- }
-
- while (count-- > 0)
- {
- sscanf(&buffer[raw_bytes], "%2hhx", &ihex->buffer[cooked_bytes]);
- raw_bytes += 2;
- cooked_bytes += 1;
- full_address++;
- }
- }
- else if (record_type == 1)
- {
- free(buffer);
- fileio->size = cooked_bytes;
- return ERROR_OK;
- }
- else if (record_type == 4)
- {
- u16 upper_address;
-
- sscanf(&buffer[raw_bytes], "%4hx", &upper_address);
- raw_bytes += 4;
-
- if ((full_address >> 16) != upper_address)
- {
- free(buffer);
- ERROR("can't handle non-linear IHEX file");
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "can't handle non-linear IHEX file");
- return ERROR_FILEIO_OPERATION_FAILED;
- }
- }
- else if (record_type == 5)
- {
- u32 start_address;
-
- sscanf(&buffer[raw_bytes], "%8x", &start_address);
- raw_bytes += 8;
-
- image->has_start_address = 1;
- image->start_address = be_to_h_u32((u8*)&start_address);
- }
- else
- {
- free(buffer);
- ERROR("unhandled IHEX record type: %i", record_type);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "unhandled IHEX record type: %i", record_type);
+
+ file_size = 0;
+
+ if ((fileio->access != FILEIO_WRITE) || (fileio->access == FILEIO_READWRITE)) {
+ /* NB! Here we use fseek() instead of stat(), since stat is a
+ * more advanced operation that might not apply to e.g. a disk path
+ * that refers to e.g. a tftp client */
+ int result, result2;
+
+ result = fseek(fileio->file, 0, SEEK_END);
+
+ file_size = ftell(fileio->file);
+
+ result2 = fseek(fileio->file, 0, SEEK_SET);
+
+ if ((file_size < 0) || (result < 0) || (result2 < 0)) {
+ fileio_close_local(fileio);
return ERROR_FILEIO_OPERATION_FAILED;
}
-
- sscanf(&buffer[raw_bytes], "%2x", &checksum);
- raw_bytes += 2;
-
- /* consume new-line character(s) */
- if ((buffer[raw_bytes] == '\n') || (buffer[raw_bytes] == '\r'))
- raw_bytes++;
-
- if ((buffer[raw_bytes] == '\n') || (buffer[raw_bytes] == '\r'))
- raw_bytes++;
}
- free(buffer);
- ERROR("premature end of IHEX file, no end-of-file record found");
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "premature end of IHEX file, no end-of-file record found");
- return ERROR_FILEIO_OPERATION_FAILED;
-}
-//#endif
+ fileio->size = file_size;
-int fileio_open(fileio_t *fileio, char *url, enum fileio_access access,
- enum fileio_pri_type pri_type, void *pri_info, enum fileio_sec_type sec_type)
-{
- int retval = ERROR_OK;
-
- if ((!url) || (strlen(url) < 3))
- {
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "invalid file url");
- return ERROR_INVALID_ARGUMENTS;
- }
-
- if ((url[0] == '/') || (isalpha(url[0])) || ((url[1] == ':') && (url[2] == '\\')))
- {
- fileio->location = FILEIO_LOCAL;
- }
- else
- {
- ERROR("couldn't identify resource location from URL '%s'", url);
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't identify resource location from URL '%s'", url);
- return ERROR_FILEIO_LOCATION_UNKNOWN;
- }
-
- fileio->access = access;
- fileio->pri_type = pri_type;
- fileio->sec_type = sec_type;
- fileio->url = strdup(url);
-
- switch (fileio->location)
- {
- case FILEIO_LOCAL:
- retval = fileio_open_local(fileio);
- break;
- default:
- ERROR("BUG: should never get here");
- exit(-1);
- }
-
- if (retval != ERROR_OK)
- return retval;
-
- if (fileio->pri_type == FILEIO_TEXT)
- {
- /* do nothing for now */
- return ERROR_OK;
- }
- else if (fileio->pri_type == FILEIO_IMAGE)
- {
- fileio_image_t *image = malloc(sizeof(fileio_image_t));
- fileio_image_t *image_info = pri_info;
-
- fileio->pri_type_private = image;
- *image = *image_info;
-
- if (fileio->sec_type == FILEIO_PLAIN)
- {
- fileio->sec_type_private = NULL;
- }
- else if (fileio->sec_type == FILEIO_IHEX)
- {
- fileio_ihex_t *fileio_ihex;
-
- if (fileio->access != FILEIO_READ)
- {
- ERROR("can't write/append to a IHEX file");
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "can't write/append to a IHEX file");
- fileio_close(fileio);
- return ERROR_FILEIO_OPERATION_FAILED;
- }
-
- fileio_ihex = malloc(sizeof(fileio_ihex_t));
- fileio->sec_type_private = fileio_ihex;
-
- fileio_ihex->position = 0;
- fileio_ihex->raw_size = fileio->size;
-#ifdef FILEIO_BUFFER_COMPLETE_IHEX
- if (fileio_ihex_buffer_complete(fileio) != ERROR_OK)
- {
- fileio_close(fileio);
- return ERROR_FILEIO_OPERATION_FAILED;
- }
-#endif
- }
- }
-
return ERROR_OK;
}
-int fileio_close_local(fileio_t *fileio)
+int fileio_open(struct fileio **fileio, const char *url,
+ enum fileio_access access_type, enum fileio_type type)
{
int retval;
- fileio_local_t *fileio_local = fileio->location_private;
-
- if ((retval = fclose(fileio_local->file)) != 0)
- {
- if (retval == EBADF)
- {
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "BUG: fileio_local->file not a valid file descriptor");
- }
- else
- {
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't close %s: %s", fileio->url, strerror(errno));
- }
+ struct fileio *tmp;
- return ERROR_FILEIO_OPERATION_FAILED;
+ tmp = malloc(sizeof(struct fileio));
+
+ tmp->type = type;
+ tmp->access = access_type;
+ tmp->url = strdup(url);
+
+ retval = fileio_open_local(tmp);
+
+ if (retval != ERROR_OK) {
+ free(tmp->url);
+ free(tmp);
+ return retval;
}
-
- free(fileio->location_private);
-
+
+ *fileio = tmp;
+
return ERROR_OK;
}
-int fileio_close(fileio_t *fileio)
+int fileio_close(struct fileio *fileio)
{
int retval;
-
- switch (fileio->location)
- {
- case FILEIO_LOCAL:
- retval = fileio_close_local(fileio);
- break;
- default:
- ERROR("BUG: should never get here");
- }
-
- if (retval != ERROR_OK)
- return retval;
-
+
+ retval = fileio_close_local(fileio);
+
free(fileio->url);
-
- if (fileio->pri_type == FILEIO_TEXT)
- {
- /* do nothing for now */
- }
- else if (fileio->pri_type == FILEIO_IMAGE)
- {
- if (fileio->sec_type == FILEIO_PLAIN)
- {
- /* nothing special to do for plain binary */
- }
- else if (fileio->sec_type == FILEIO_IHEX)
- {
- fileio_ihex_t *fileio_ihex = fileio->sec_type_private;
-
- if (fileio_ihex->buffer)
- free(fileio_ihex->buffer);
-
- free(fileio->sec_type_private);
- }
-
- free(fileio->pri_type_private);
- }
-
- return ERROR_OK;
+ free(fileio);
+
+ return retval;
+}
+
+int fileio_feof(struct fileio *fileio)
+{
+ return feof(fileio->file);
}
-int fileio_seek_local(fileio_t *fileio, u32 position)
+int fileio_seek(struct fileio *fileio, size_t position)
{
int retval;
- fileio_local_t *fileio_local = fileio->location_private;
-
- if ((retval = fseek(fileio_local->file, position, SEEK_SET)) != 0)
- {
- snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't seek file %s: %s", fileio->url, strerror(errno));
+
+ retval = fseek(fileio->file, position, SEEK_SET);
+
+ if (retval != 0) {
+ LOG_ERROR("couldn't seek file %s: %s", fileio->url, strerror(errno));
return ERROR_FILEIO_OPERATION_FAILED;
}
-
+
return ERROR_OK;
}
-int fileio_seek(fileio_t *fileio, u32 position)
+static int fileio_local_read(struct fileio *fileio, size_t size, void *buffer,
+ size_t *size_read)
{
- switch (fileio->location)
- {
- case FILEIO_LOCAL:
- return fileio_seek_local(fileio, position);
- break;
- default:
- ERROR("BUG: should never get here");
- }
-
- return ERROR_OK;
+ ssize_t retval;
+
+ retval = fread(buffer, 1, size, fileio->file);
+ *size_read = (retval >= 0) ? retval : 0;
+
+ return (retval < 0) ? retval : ERROR_OK;
}
-int fileio_local_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+int fileio_read(struct fileio *fileio, size_t size, void *buffer,
+ size_t *size_read)
{
- fileio_local_t *fileio_local = fileio->location_private;
-
- *size_read = fread(buffer, 1, size, fileio_local->file);
-
- return ERROR_OK;
+ return fileio_local_read(fileio, size, buffer, size_read);
}
-int fileio_dispatch_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+int fileio_read_u32(struct fileio *fileio, uint32_t *data)
{
- switch (fileio->location)
- {
- case FILEIO_LOCAL:
- return fileio_local_read(fileio, size, buffer, size_read);
- break;
- default:
- ERROR("BUG: should never get here");
- exit(-1);
- }
+ int retval;
+ uint8_t buf[4];
+ size_t size_read;
+
+ retval = fileio_local_read(fileio, sizeof(uint32_t), buf, &size_read);
+
+ if (retval == ERROR_OK && sizeof(uint32_t) != size_read)
+ retval = -EIO;
+ if (retval == ERROR_OK)
+ *data = be_to_h_u32(buf);
+
+ return retval;
}
-int fileio_read_ihex(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+static int fileio_local_fgets(struct fileio *fileio, size_t size, void *buffer)
{
- fileio_ihex_t *fileio_ihex = fileio->sec_type_private;
-
- if ((fileio_ihex->position + size) > fileio->size)
- {
- /* don't read past the end of the file */
- size = (fileio->size - fileio_ihex->position);
- }
-
-#ifdef FILEIO_BUFFER_COMPLETE_IHEX
- memcpy(buffer, fileio_ihex->buffer + fileio_ihex->position, size);
- *size_read = size;
-#endif
+ if (!fgets(buffer, size, fileio->file))
+ return ERROR_FILEIO_OPERATION_FAILED;
return ERROR_OK;
}
-int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+int fileio_fgets(struct fileio *fileio, size_t size, void *buffer)
{
- if (fileio->sec_type == FILEIO_PLAIN)
- {
- return fileio_dispatch_read(fileio, size, buffer, size_read);
- }
- else if (fileio->sec_type == FILEIO_IHEX)
- {
- return fileio_read_ihex(fileio, size, buffer, size_read);
- }
-
- return ERROR_OK;
+ return fileio_local_fgets(fileio, size, buffer);
}
-int fileio_local_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+static int fileio_local_write(struct fileio *fileio, size_t size,
+ const void *buffer, size_t *size_written)
{
- fileio_local_t *fileio_local = fileio->location_private;
-
- *size_written = fwrite(buffer, 1, size, fileio_local->file);
-
- return ERROR_OK;
+ ssize_t retval;
+
+ retval = fwrite(buffer, 1, size, fileio->file);
+ *size_written = (retval >= 0) ? retval : 0;
+
+ return (retval < 0) ? retval : ERROR_OK;
}
-int fileio_dispatch_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+int fileio_write(struct fileio *fileio, size_t size, const void *buffer,
+ size_t *size_written)
{
- switch (fileio->location)
- {
- case FILEIO_LOCAL:
- return fileio_local_write(fileio, size, buffer, size_written);
- break;
- default:
- ERROR("BUG: should never get here");
- }
-
- return ERROR_OK;
+ int retval;
+
+ retval = fileio_local_write(fileio, size, buffer, size_written);
+
+ if (retval == ERROR_OK)
+ fileio->size += *size_written;
+
+ return retval;
}
-int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+int fileio_write_u32(struct fileio *fileio, uint32_t data)
{
int retval;
- if (fileio->sec_type == FILEIO_PLAIN)
- {
- retval = fileio_dispatch_write(fileio, size, buffer, size_written);
- }
- else if (fileio->sec_type == FILEIO_IHEX)
- {
- return ERROR_FILEIO_OPERATION_NOT_SUPPORTED;
- }
-
- if (retval != ERROR_OK)
- return retval;
-
- fileio->size += size;
-
- return ERROR_OK;
+ uint8_t buf[4];
+ h_u32_to_be(buf, data);
+ size_t size_written;
+
+ retval = fileio_write(fileio, 4, buf, &size_written);
+
+ if (retval == ERROR_OK && size_written != sizeof(uint32_t))
+ retval = -EIO;
+
+ return retval;
}
-int fileio_identify_image_type(enum fileio_sec_type *sec_type, char *type_string)
+/**
+ * FIX!!!!
+ *
+ * For now this can not fail, but that's because a seek was executed
+ * on startup.
+ *
+ * Avoiding the seek on startup opens up for using streams.
+ *
+ */
+int fileio_size(struct fileio *fileio, size_t *size)
{
- if (type_string)
- {
- if (!strcmp(type_string, "bin"))
- {
- *sec_type = FILEIO_PLAIN;
- }
- else if (!strcmp(type_string, "ihex"))
- {
- *sec_type = FILEIO_IHEX;
- }
- else
- {
- return ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN;
- }
- }
- else
- {
- *sec_type = FILEIO_PLAIN;
- }
-
+ *size = fileio->size;
+
return ERROR_OK;
}
projects / fw / openocd / blobdiff