Finish portability support for AC_HEADER_STDBOOL configure macro.
[openocd.git] / src / helper / fileio.c
index 756e0f460cbf20de7abd5553520d8c118551972f..070c0ac5e62fcd990fe55b41e954004d98916609 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     *
@@ -24,6 +30,7 @@
 #include "types.h"
 #include "replacements.h"
 #include "log.h"
+#include "configuration.h"
 
 #include "fileio.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);
-
-int fileio_open_local(fileio_t *fileio)
+static inline int fileio_open_local(fileio_t *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)
        {
                case FILEIO_READ:
@@ -82,270 +64,81 @@ int fileio_open_local(fileio_t *fileio)
                        strcpy(access, "a+");   
                        break;
                default:
-                       free(fileio_local);
-                       ERROR("BUG: access neither read, write nor readwrite");
+                       LOG_ERROR("BUG: access neither read, write nor readwrite");
                        return ERROR_INVALID_ARGUMENTS;
        }
        
-       if (fileio->access == FILEIO_READ)
+       /* win32 always opens in binary mode */
+#ifndef _WIN32
+       if (fileio->type == FILEIO_BINARY)
+#endif
        {
-               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))
+       if (!(fileio->file = open_file_from_path (fileio->url, access)))
        {
-               fileio->size = fileio_local->file_stat.st_size;
-       }
-       else
-       {
-               fileio->size = 0x0;
-       }
-       
-       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");
+               LOG_ERROR("couldn't open %s", fileio->url);
                return ERROR_FILEIO_OPERATION_FAILED;
        }
        
-       if (raw_bytes_read != ihex->raw_size)
-       {
-               free(buffer);
-               ERROR("failed buffering complete IHEX file, only partially read");
-               return ERROR_FILEIO_OPERATION_FAILED;
-       }
-       
-       raw_bytes = 0x0;
-       while (raw_bytes < raw_bytes_read)
+       if ((fileio->access != FILEIO_WRITE) || (fileio->access == FILEIO_READWRITE))
        {
-               u32 count;
-               u32 address;
-               u32 record_type;
-               u32 checksum;
+               /* 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;
                
-               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;
+               result = fseek(fileio->file, 0, SEEK_END);
+
+               fileio->size = ftell(fileio->file);
                
-               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;
+               result2 = fseek(fileio->file, 0, SEEK_SET); 
                        
-                       image->has_start_address = 1;
-                       image->start_address = be_to_h_u32((u8*)&start_address);
-               }
-               else
+               if ((fileio->size<0)||(result<0)||(result2<0))
                {
-                       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);
+                       fileio_close(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
-
-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->size = 0x0;
        }
        
+       return ERROR_OK;
+}
+
+int fileio_open(fileio_t *fileio, const char *url, enum fileio_access access,  enum fileio_type type)
+{
+       int retval = ERROR_OK;
+
+       fileio->type = type;
        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;
+       retval = fileio_open_local(fileio);
+
+       return retval;
 }
 
-int fileio_close_local(fileio_t *fileio)
+static inline int fileio_close_local(fileio_t *fileio)
 {
        int retval;
-       fileio_local_t *fileio_local = fileio->location_private;
-       
-       if ((retval = fclose(fileio_local->file)) != 0)
+       if ((retval = fclose(fileio->file)) != 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;
 }
 
@@ -353,193 +146,93 @@ int fileio_close(fileio_t *fileio)
 {
        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;
+       retval = fileio_close_local(fileio);
        
        free(fileio->url);
+       fileio->url = NULL;
        
-       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;
+       return retval;
 }
 
-int fileio_seek_local(fileio_t *fileio, u32 position)
+int fileio_seek(fileio_t *fileio, u32 position)
 {
        int retval;
-       fileio_local_t *fileio_local = fileio->location_private;
-       
-       if ((retval = fseek(fileio_local->file, position, SEEK_SET)) != 0)
+       if ((retval = fseek(fileio->file, position, SEEK_SET)) != 0)
        {
-               snprintf(fileio->error_str, FILEIO_MAX_ERROR_STRING, "couldn't seek file %s: %s", fileio->url, strerror(errno));
+               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 inline int fileio_local_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
 {
-       switch (fileio->location)
-       {
-               case FILEIO_LOCAL:
-                       return fileio_seek_local(fileio, position);
-                       break;
-               default:
-                       ERROR("BUG: should never get here");
-       }
+       *size_read = fread(buffer, 1, size, fileio->file);
        
        return ERROR_OK;
 }
 
-int fileio_local_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
-{
-       fileio_local_t *fileio_local = fileio->location_private;
-       
-       *size_read = fread(buffer, 1, size, fileio_local->file);
-       
-       return ERROR_OK;
-}
-
-int fileio_dispatch_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *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);
-       }
+       return fileio_local_read(fileio, size, buffer, size_read);
 }
 
-int fileio_read_ihex(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+int fileio_read_u32(fileio_t *fileio, u32 *data)
 {
-       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);
-       }
+       u8 buf[4];
+       u32 size_read;
+       int retval;
+       
+       if ((retval = fileio_local_read(fileio, 4, buf, &size_read)) != ERROR_OK)
+               return retval;
+       *data = be_to_h_u32(buf);
        
-#ifdef FILEIO_BUFFER_COMPLETE_IHEX
-       memcpy(buffer, fileio_ihex->buffer + fileio_ihex->position, size);
-       *size_read = size;
-#endif
-
        return ERROR_OK;
 }
 
-int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read)
+static inline int fileio_local_fgets(fileio_t *fileio, u32 size, char *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);
-       }
+       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(fileio_t *fileio, u32 size, char *buffer)
 {
-       fileio_local_t *fileio_local = fileio->location_private;
-       
-       *size_written = fwrite(buffer, 1, size, fileio_local->file);
-       
-       return ERROR_OK;
+       return fileio_local_fgets(fileio, size, buffer);
 }
 
-int fileio_dispatch_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+static inline int fileio_local_write(fileio_t *fileio, u32 size, const u8 *buffer, u32 *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");
-       }
+       *size_written = fwrite(buffer, 1, size, fileio->file);
        
        return ERROR_OK;
 }
 
-int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written)
+int fileio_write(fileio_t *fileio, u32 size, const u8 *buffer, u32 *size_written)
 {
-       int retval = ERROR_FILEIO_OPERATION_NOT_SUPPORTED;
-       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;
-       }
+       int retval;
        
-       if (retval != ERROR_OK)
-               return retval;
-               
-       fileio->size += size;
+       retval = fileio_local_write(fileio, size, buffer, size_written);
        
-       return ERROR_OK;
+       if (retval == ERROR_OK)
+               fileio->size += *size_written;
+       
+       return retval;;
 }
 
-int fileio_identify_image_type(enum fileio_sec_type *sec_type, char *type_string)
+int fileio_write_u32(fileio_t *fileio, u32 data)
 {
-       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;
-       }
+       u8 buf[4];
+       u32 size_written;
+       int retval;
+       
+       h_u32_to_be(buf, data);
+       
+       if ((retval = fileio_local_write(fileio, 4, buf, &size_written)) != ERROR_OK)
+               return retval;
        
        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)