X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Ffileio.c;h=c6f45e6ba78bb23d8dec0bcdb00abe2b5ee4ed15;hp=742bc6892c3c81912e3c2479a8f01e2bc5a23772;hb=517ba0690dcc9e859a05df2113ce32401a5ab254;hpb=f251b925ffe230de9aa01849ba7b53230a5c492f diff --git a/src/helper/fileio.c b/src/helper/fileio.c index 742bc6892c..c6f45e6ba7 100644 --- a/src/helper/fileio.c +++ b/src/helper/fileio.c @@ -2,6 +2,12 @@ * Copyright (C) 2007 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007,2008 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * + * Copyright (C) 2008 by Spencer Oliver * + * spen@spen-soft.co.uk * + * * * 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 * @@ -15,315 +21,233 @@ * 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. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif -#include "types.h" -#include "replacements.h" #include "log.h" - +#include "configuration.h" #include "fileio.h" -#include -#include -#include -#include -#include -#include -#include -#include - -int fileio_close(fileio_t *fileio); -int fileio_dispatch_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read); +struct fileio_internal { + char *url; + ssize_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_internal *fileio); +static inline int fileio_open_local(struct fileio_internal *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; - } - } - - switch (fileio->access) - { + char file_access[4]; + + 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; - } + LOG_ERROR("BUG: access neither read, write nor readwrite"); + return ERROR_COMMAND_SYNTAX_ERROR; } /* win32 always opens in binary mode */ #ifndef _WIN32 if (fileio->type == FILEIO_BINARY) #endif - { - 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); + 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; } - - if ((fileio->access != FILEIO_WRITE) || (fileio->access == FILEIO_READWRITE)) - { - fileio->size = fileio_local->file_stat.st_size; - } - else - { + + 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); + + fileio->size = ftell(fileio->file); + + result2 = fseek(fileio->file, 0, SEEK_SET); + + if ((fileio->size < 0) || (result < 0) || (result2 < 0)) { + fileio_close_local(fileio); + return ERROR_FILEIO_OPERATION_FAILED; + } + } else fileio->size = 0x0; - } - + return ERROR_OK; } -int fileio_open(fileio_t *fileio, char *url, enum fileio_access access, enum fileio_type type) +int fileio_open(struct fileio *fileio_p, + const char *url, + enum fileio_access access_type, + enum fileio_type type) { int retval = ERROR_OK; - char *resource_identifier = NULL; - /* try to identify file location */ - if ((resource_identifier = strstr(url, "bootp://")) && (resource_identifier == url)) - { - ERROR("bootp resource location isn't supported yet"); - return ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN; - } - else if ((resource_identifier = strstr(url, "tftp://")) && (resource_identifier == url)) - { - ERROR("tftp resource location isn't supported yet"); - return ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN; - } - else - { - /* default to local files */ - fileio->location = FILEIO_LOCAL; - } - + struct fileio_internal *fileio = malloc(sizeof(struct fileio_internal)); + fileio_p->fp = fileio; + fileio->type = type; - fileio->access = access; + fileio->access = access_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; - - return ERROR_OK; + + retval = fileio_open_local(fileio); + + return retval; } -int fileio_close_local(fileio_t *fileio) +static inline int fileio_close_local(struct fileio_internal *fileio) { - int retval; - fileio_local_t *fileio_local = fileio->location_private; - - if ((retval = fclose(fileio_local->file)) != 0) - { + int retval = fclose(fileio->file); + if (retval != 0) { if (retval == EBADF) - { - snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "BUG: fileio_local->file not a valid file descriptor"); - } + LOG_ERROR("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)); - } + LOG_ERROR("couldn't close %s: %s", fileio->url, strerror(errno)); return ERROR_FILEIO_OPERATION_FAILED; } - - free(fileio->location_private); - + return ERROR_OK; } -int fileio_close(fileio_t *fileio) +int fileio_close(struct fileio *fileio_p) { int retval; - - switch (fileio->location) - { - case FILEIO_LOCAL: - retval = fileio_close_local(fileio); - break; - default: - ERROR("BUG: should never get here"); - retval = ERROR_FILEIO_OPERATION_FAILED; - } - - if (retval != ERROR_OK) - return retval; - + struct fileio_internal *fileio = fileio_p->fp; + + retval = fileio_close_local(fileio); + free(fileio->url); - - return ERROR_OK; + fileio->url = NULL; + + free(fileio); + fileio_p->fp = NULL; + + return retval; } -int fileio_seek_local(fileio_t *fileio, u32 position) +int fileio_seek(struct fileio *fileio_p, 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)); + struct fileio_internal *fileio = fileio_p->fp; + 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_internal *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 = 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_p, 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; + struct fileio_internal *fileio = fileio_p->fp; + return fileio_local_read(fileio, size, buffer, size_read); } -int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read) +int fileio_read_u32(struct fileio *fileio_p, 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); - } + uint8_t buf[4]; + size_t size_read; + struct fileio_internal *fileio = fileio_p->fp; + int retval = fileio_local_read(fileio, sizeof(uint32_t), buf, &size_read); + if (ERROR_OK == retval && sizeof(uint32_t) != size_read) + retval = -EIO; + if (ERROR_OK == retval) + *data = be_to_h_u32(buf); + return retval; } -int fileio_read_u32(fileio_t *fileio, u32 *data) +static int fileio_local_fgets(struct fileio_internal *fileio, + size_t size, void *buffer) { - u8 buf[4]; - u32 size_read; - int retval; - - switch (fileio->location) - { - case FILEIO_LOCAL: - if ((retval = fileio_local_read(fileio, 4, buf, &size_read)) != ERROR_OK) - return retval; - *data = be_to_h_u32(buf); - break; - default: - ERROR("BUG: should never get here"); - exit(-1); - } - + if (fgets(buffer, size, fileio->file) == NULL) + return ERROR_FILEIO_OPERATION_FAILED; + return ERROR_OK; } -int fileio_local_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written) +int fileio_fgets(struct fileio *fileio_p, size_t size, void *buffer) { - fileio_local_t *fileio_local = fileio->location_private; - - *size_written = fwrite(buffer, 1, size, fileio_local->file); - - return ERROR_OK; + struct fileio_internal *fileio = fileio_p->fp; + return fileio_local_fgets(fileio, size, buffer); } -int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written) +static int fileio_local_write(struct fileio_internal *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; + ssize_t retval = fwrite(buffer, 1, size, fileio->file); + *size_written = (retval >= 0) ? retval : 0; + return (retval < 0) ? retval : ERROR_OK; } -int fileio_write_u32(fileio_t *fileio, u32 data) +int fileio_write(struct fileio *fileio_p, + size_t size, const void *buffer, size_t *size_written) { - u8 buf[4]; - u32 size_written; - int retval; - + struct fileio_internal *fileio = fileio_p->fp; + int retval = fileio_local_write(fileio, size, buffer, size_written); + if (retval == ERROR_OK) + fileio->size += *size_written; + return retval; +} + +int fileio_write_u32(struct fileio *fileio_p, uint32_t data) +{ + uint8_t buf[4]; h_u32_to_be(buf, data); - - switch (fileio->location) - { - case FILEIO_LOCAL: - if ((retval = fileio_local_write(fileio, 4, buf, &size_written)) != ERROR_OK) - return retval; - break; - default: - ERROR("BUG: should never get here"); - } - + size_t size_written; + int retval = fileio_write(fileio_p, 4, buf, &size_written); + if (ERROR_OK == retval && size_written != sizeof(uint32_t)) + retval = -EIO; + + return retval; +} + +/** + * 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_p, int *size) +{ + struct fileio_internal *fileio = fileio_p->fp; + *size = fileio->size; return ERROR_OK; }