Clean up const usage to avoid excessive casting
[openocd.git] / src / helper / fileio.c
1 /***************************************************************************
2 * Copyright (C) 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 ***************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "log.h"
32 #include "configuration.h"
33 #include "fileio.h"
34
35 struct fileio_internal {
36 char *url;
37 ssize_t size;
38 enum fileio_type type;
39 enum fileio_access access;
40 FILE *file;
41 };
42
43 static inline int fileio_close_local(struct fileio_internal *fileio);
44 static inline int fileio_open_local(struct fileio_internal *fileio)
45 {
46 char file_access[4];
47
48 switch (fileio->access) {
49 case FILEIO_READ:
50 strcpy(file_access, "r");
51 break;
52 case FILEIO_WRITE:
53 strcpy(file_access, "w");
54 break;
55 case FILEIO_READWRITE:
56 strcpy(file_access, "w+");
57 break;
58 case FILEIO_APPEND:
59 strcpy(file_access, "a");
60 break;
61 case FILEIO_APPENDREAD:
62 strcpy(file_access, "a+");
63 break;
64 default:
65 LOG_ERROR("BUG: access neither read, write nor readwrite");
66 return ERROR_COMMAND_SYNTAX_ERROR;
67 }
68
69 /* win32 always opens in binary mode */
70 #ifndef _WIN32
71 if (fileio->type == FILEIO_BINARY)
72 #endif
73 strcat(file_access, "b");
74
75 fileio->file = open_file_from_path(fileio->url, file_access);
76 if (!fileio->file) {
77 LOG_ERROR("couldn't open %s", fileio->url);
78 return ERROR_FILEIO_OPERATION_FAILED;
79 }
80
81 if ((fileio->access != FILEIO_WRITE) || (fileio->access == FILEIO_READWRITE)) {
82 /* NB! Here we use fseek() instead of stat(), since stat is a
83 * more advanced operation that might not apply to e.g. a disk path
84 * that refers to e.g. a tftp client */
85 int result, result2;
86
87 result = fseek(fileio->file, 0, SEEK_END);
88
89 fileio->size = ftell(fileio->file);
90
91 result2 = fseek(fileio->file, 0, SEEK_SET);
92
93 if ((fileio->size < 0) || (result < 0) || (result2 < 0)) {
94 fileio_close_local(fileio);
95 return ERROR_FILEIO_OPERATION_FAILED;
96 }
97 } else
98 fileio->size = 0x0;
99
100 return ERROR_OK;
101 }
102
103 int fileio_open(struct fileio *fileio_p,
104 const char *url,
105 enum fileio_access access_type,
106 enum fileio_type type)
107 {
108 int retval = ERROR_OK;
109
110 struct fileio_internal *fileio = malloc(sizeof(struct fileio_internal));
111 fileio_p->fp = fileio;
112
113 fileio->type = type;
114 fileio->access = access_type;
115 fileio->url = strdup(url);
116
117 retval = fileio_open_local(fileio);
118
119 return retval;
120 }
121
122 static inline int fileio_close_local(struct fileio_internal *fileio)
123 {
124 int retval = fclose(fileio->file);
125 if (retval != 0) {
126 if (retval == EBADF)
127 LOG_ERROR("BUG: fileio_local->file not a valid file descriptor");
128 else
129 LOG_ERROR("couldn't close %s: %s", fileio->url, strerror(errno));
130
131 return ERROR_FILEIO_OPERATION_FAILED;
132 }
133
134 return ERROR_OK;
135 }
136
137 int fileio_close(struct fileio *fileio_p)
138 {
139 int retval;
140 struct fileio_internal *fileio = fileio_p->fp;
141
142 retval = fileio_close_local(fileio);
143
144 free(fileio->url);
145 fileio->url = NULL;
146
147 free(fileio);
148 fileio_p->fp = NULL;
149
150 return retval;
151 }
152
153 int fileio_seek(struct fileio *fileio_p, size_t position)
154 {
155 int retval;
156 struct fileio_internal *fileio = fileio_p->fp;
157 retval = fseek(fileio->file, position, SEEK_SET);
158 if (retval != 0) {
159 LOG_ERROR("couldn't seek file %s: %s", fileio->url, strerror(errno));
160 return ERROR_FILEIO_OPERATION_FAILED;
161 }
162
163 return ERROR_OK;
164 }
165
166 static int fileio_local_read(struct fileio_internal *fileio,
167 size_t size, void *buffer, size_t *size_read)
168 {
169 ssize_t retval = fread(buffer, 1, size, fileio->file);
170 *size_read = (retval >= 0) ? retval : 0;
171 return (retval < 0) ? retval : ERROR_OK;
172 }
173
174 int fileio_read(struct fileio *fileio_p, size_t size, void *buffer,
175 size_t *size_read)
176 {
177 struct fileio_internal *fileio = fileio_p->fp;
178 return fileio_local_read(fileio, size, buffer, size_read);
179 }
180
181 int fileio_read_u32(struct fileio *fileio_p, uint32_t *data)
182 {
183 uint8_t buf[4];
184 size_t size_read;
185 struct fileio_internal *fileio = fileio_p->fp;
186 int retval = fileio_local_read(fileio, sizeof(uint32_t), buf, &size_read);
187 if (ERROR_OK == retval && sizeof(uint32_t) != size_read)
188 retval = -EIO;
189 if (ERROR_OK == retval)
190 *data = be_to_h_u32(buf);
191 return retval;
192 }
193
194 static int fileio_local_fgets(struct fileio_internal *fileio,
195 size_t size, void *buffer)
196 {
197 if (fgets(buffer, size, fileio->file) == NULL)
198 return ERROR_FILEIO_OPERATION_FAILED;
199
200 return ERROR_OK;
201 }
202
203 int fileio_fgets(struct fileio *fileio_p, size_t size, void *buffer)
204 {
205 struct fileio_internal *fileio = fileio_p->fp;
206 return fileio_local_fgets(fileio, size, buffer);
207 }
208
209 static int fileio_local_write(struct fileio_internal *fileio,
210 size_t size, const void *buffer, size_t *size_written)
211 {
212 ssize_t retval = fwrite(buffer, 1, size, fileio->file);
213 *size_written = (retval >= 0) ? retval : 0;
214 return (retval < 0) ? retval : ERROR_OK;
215 }
216
217 int fileio_write(struct fileio *fileio_p,
218 size_t size, const void *buffer, size_t *size_written)
219 {
220 struct fileio_internal *fileio = fileio_p->fp;
221 int retval = fileio_local_write(fileio, size, buffer, size_written);
222 if (retval == ERROR_OK)
223 fileio->size += *size_written;
224 return retval;
225 }
226
227 int fileio_write_u32(struct fileio *fileio_p, uint32_t data)
228 {
229 uint8_t buf[4];
230 h_u32_to_be(buf, data);
231 size_t size_written;
232 int retval = fileio_write(fileio_p, 4, buf, &size_written);
233 if (ERROR_OK == retval && size_written != sizeof(uint32_t))
234 retval = -EIO;
235
236 return retval;
237 }
238
239 /**
240 * FIX!!!!
241 *
242 * For now this can not fail, but that's because a seek was executed
243 * on startup.
244 *
245 * Avoiding the seek on startup opens up for using streams.
246 *
247 */
248 int fileio_size(struct fileio *fileio_p, int *size)
249 {
250 struct fileio_internal *fileio = fileio_p->fp;
251 *size = fileio->size;
252 return ERROR_OK;
253 }