Clean up const usage to avoid excessive casting
[openocd.git] / src / helper / fileio.c
index 351c8e04c51a19a26c1d420a4b845912716509b9..c6f45e6ba78bb23d8dec0bcdb00abe2b5ee4ed15 100644 (file)
@@ -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     *
  *   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 <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_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;
-       
-       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;
+                       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))
-       {
-               // 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=fseek(fileio_local->file, 0, SEEK_END);
-
-               fileio->size = ftell(fileio_local->file);
-               
-               int result2 = fseek(fileio_local->file, 0, SEEK_SET); 
-                       
-               if ((fileio->size<0)||(result<0)||(result2<0))
-               {
-                       fileio_close(fileio);
+
+       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
-       {
+       } 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. We only hijack the file paths we understand, the rest is
-        * passed on to the OS which might implement e.g. tftp via a mounted tftp device.
-        */
-       if ((resource_identifier = strstr(url, "bootp://")) && (resource_identifier == url))
-       {
-               ERROR("bootp 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 (fileio->location_private == NULL)
-       {
-               snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't close %s: ", fileio->url);
-               return ERROR_FILEIO_OPERATION_FAILED;
-       }
-       
-       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);
-       fileio->location_private = NULL;
-       
+
        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);
        fileio->url = NULL;
-       
-       return ERROR_OK;
+
+       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)
-{
-       switch (fileio->location)
-       {
-               case FILEIO_LOCAL:
-                       return fileio_seek_local(fileio, position);
-                       break;
-               default:
-                       ERROR("BUG: should never get here");
-       }
-       
        return ERROR_OK;
 }
 
-int fileio_local_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+static int fileio_local_read(struct fileio_internal *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;
+       ssize_t retval = fread(buffer, 1, size, fileio->file);
+       *size_read = (retval >= 0) ? retval : 0;
+       return (retval < 0) ? retval : ERROR_OK;
 }
 
-int fileio_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)
 {
-       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);
-       }
+       struct fileio_internal *fileio = fileio_p->fp;
+       return fileio_local_read(fileio, size, buffer, size_read);
 }
 
-int fileio_read_u32(fileio_t *fileio, u32 *data)
+int fileio_read_u32(struct fileio *fileio_p, uint32_t *data)
 {
-       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);
-       }
-       
-       return ERROR_OK;
+       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_local_fgets(fileio_t *fileio, u32 size, u8 *buffer)
+static int fileio_local_fgets(struct fileio_internal *fileio,
+       size_t size, void *buffer)
 {
-       fileio_local_t *fileio_local = fileio->location_private;
-       
-       if( fgets(buffer, size, fileio_local->file) == NULL)
+       if (fgets(buffer, size, fileio->file) == NULL)
                return ERROR_FILEIO_OPERATION_FAILED;
-       
+
        return ERROR_OK;
 }
 
-int fileio_fgets(fileio_t *fileio, u32 size, u8 *buffer)
+int fileio_fgets(struct fileio *fileio_p, size_t size, void *buffer)
 {
-       switch (fileio->location)
-       {
-               case FILEIO_LOCAL:
-                       return fileio_local_fgets(fileio, size, buffer);
-                       break;
-               default:
-                       ERROR("BUG: should never get here");
-                       exit(-1);
-       }
+       struct fileio_internal *fileio = fileio_p->fp;
+       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_internal *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 = fwrite(buffer, 1, size, fileio->file);
+       *size_written = (retval >= 0) ? retval : 0;
+       return (retval < 0) ? retval : ERROR_OK;
 }
 
-int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+int fileio_write(struct fileio *fileio_p,
+       size_t size, const void *buffer, size_t *size_written)
 {
-       int retval;
-       
-       switch (fileio->location)
-       {
-               case FILEIO_LOCAL:
-                       retval = fileio_local_write(fileio, size, buffer, size_written);
-                       break;
-               default:
-                       ERROR("BUG: should never get here");
-                       exit(-1);
-       }
-       
+       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;;
+       return retval;
 }
 
-int fileio_write_u32(fileio_t *fileio, u32 data)
+int fileio_write_u32(struct fileio *fileio_p, uint32_t data)
 {
-       u8 buf[4];
-       u32 size_written;
-       int retval;
-       
+       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;
 }

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)