teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

common/LocalFileSystem.cpp@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2006-2013 ARM Limited
<> 144:ef7eb2e8f9f7 3 *
<> 144:ef7eb2e8f9f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 5 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 6 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 9 *
<> 144:ef7eb2e8f9f7 10 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 13 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 14 * limitations under the License.
<> 144:ef7eb2e8f9f7 15 */
<> 144:ef7eb2e8f9f7 16 #include "LocalFileSystem.h"
<> 144:ef7eb2e8f9f7 17
<> 144:ef7eb2e8f9f7 18 #if DEVICE_LOCALFILESYSTEM
<> 144:ef7eb2e8f9f7 19
<> 144:ef7eb2e8f9f7 20 #include "semihost_api.h"
<> 144:ef7eb2e8f9f7 21 #include <string.h>
<> 144:ef7eb2e8f9f7 22 #include <stdio.h>
<> 144:ef7eb2e8f9f7 23
<> 144:ef7eb2e8f9f7 24 namespace mbed {
<> 144:ef7eb2e8f9f7 25
<> 144:ef7eb2e8f9f7 26 /* Extension to FINFO type defined in RTL.h (in Keil RL) - adds 'create time'. */
<> 144:ef7eb2e8f9f7 27 typedef struct {
<> 144:ef7eb2e8f9f7 28 unsigned char hr; /* Hours [0..23] */
<> 144:ef7eb2e8f9f7 29 unsigned char min; /* Minutes [0..59] */
<> 144:ef7eb2e8f9f7 30 unsigned char sec; /* Seconds [0..59] */
<> 144:ef7eb2e8f9f7 31 unsigned char day; /* Day [1..31] */
<> 144:ef7eb2e8f9f7 32 unsigned char mon; /* Month [1..12] */
<> 144:ef7eb2e8f9f7 33 unsigned short year; /* Year [1980..2107] */
<> 144:ef7eb2e8f9f7 34 } FTIME;
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 typedef struct { /* File Search info record */
<> 144:ef7eb2e8f9f7 37 char name[32]; /* File name */
<> 144:ef7eb2e8f9f7 38 long size; /* File size in bytes */
<> 144:ef7eb2e8f9f7 39 int fileID; /* System File Identification */
<> 144:ef7eb2e8f9f7 40 FTIME create_time; /* Date & time file was created */
<> 144:ef7eb2e8f9f7 41 FTIME write_time; /* Date & time of last write */
<> 144:ef7eb2e8f9f7 42 } XFINFO;
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44 #define RESERVED_FOR_USER_APPLICATIONS (0x100) /* 0x100 - 0x1ff */
<> 144:ef7eb2e8f9f7 45 #define USR_XFFIND (RESERVED_FOR_USER_APPLICATIONS + 0)
<> 144:ef7eb2e8f9f7 46
<> 144:ef7eb2e8f9f7 47 static int xffind (const char *pattern, XFINFO *info) {
<> 144:ef7eb2e8f9f7 48 unsigned param[4];
<> 144:ef7eb2e8f9f7 49
<> 144:ef7eb2e8f9f7 50 param[0] = (unsigned long)pattern;
<> 144:ef7eb2e8f9f7 51 param[1] = (unsigned long)strlen(pattern);
<> 144:ef7eb2e8f9f7 52 param[2] = (unsigned long)info;
<> 144:ef7eb2e8f9f7 53 param[3] = (unsigned long)sizeof(XFINFO);
<> 144:ef7eb2e8f9f7 54
<> 144:ef7eb2e8f9f7 55 return __semihost(USR_XFFIND, param);
<> 144:ef7eb2e8f9f7 56 }
<> 144:ef7eb2e8f9f7 57
<> 144:ef7eb2e8f9f7 58 #define OPEN_R 0
<> 144:ef7eb2e8f9f7 59 #define OPEN_B 1
<> 144:ef7eb2e8f9f7 60 #define OPEN_PLUS 2
<> 144:ef7eb2e8f9f7 61 #define OPEN_W 4
<> 144:ef7eb2e8f9f7 62 #define OPEN_A 8
<> 144:ef7eb2e8f9f7 63 #define OPEN_INVALID -1
<> 144:ef7eb2e8f9f7 64
<> 144:ef7eb2e8f9f7 65 int posix_to_semihost_open_flags(int flags) {
<> 144:ef7eb2e8f9f7 66 /* POSIX flags -> semihosting open mode */
<> 144:ef7eb2e8f9f7 67 int openmode;
<> 144:ef7eb2e8f9f7 68 if (flags & O_RDWR) {
<> 144:ef7eb2e8f9f7 69 /* a plus mode */
<> 144:ef7eb2e8f9f7 70 openmode = OPEN_PLUS;
<> 144:ef7eb2e8f9f7 71 if (flags & O_APPEND) {
<> 144:ef7eb2e8f9f7 72 openmode |= OPEN_A;
<> 144:ef7eb2e8f9f7 73 } else if (flags & O_TRUNC) {
<> 144:ef7eb2e8f9f7 74 openmode |= OPEN_W;
<> 144:ef7eb2e8f9f7 75 } else {
<> 144:ef7eb2e8f9f7 76 openmode |= OPEN_R;
<> 144:ef7eb2e8f9f7 77 }
<> 144:ef7eb2e8f9f7 78 } else if (flags & O_WRONLY) {
<> 144:ef7eb2e8f9f7 79 /* write or append */
<> 144:ef7eb2e8f9f7 80 if (flags & O_APPEND) {
<> 144:ef7eb2e8f9f7 81 openmode = OPEN_A;
<> 144:ef7eb2e8f9f7 82 } else {
<> 144:ef7eb2e8f9f7 83 openmode = OPEN_W;
<> 144:ef7eb2e8f9f7 84 }
<> 144:ef7eb2e8f9f7 85 } else if (flags == O_RDONLY) {
<> 144:ef7eb2e8f9f7 86 /* read mode */
<> 144:ef7eb2e8f9f7 87 openmode = OPEN_R;
<> 144:ef7eb2e8f9f7 88 } else {
<> 144:ef7eb2e8f9f7 89 /* invalid flags */
<> 144:ef7eb2e8f9f7 90 openmode = OPEN_INVALID;
<> 144:ef7eb2e8f9f7 91 }
<> 144:ef7eb2e8f9f7 92
<> 144:ef7eb2e8f9f7 93 return openmode;
<> 144:ef7eb2e8f9f7 94 }
<> 144:ef7eb2e8f9f7 95
<> 144:ef7eb2e8f9f7 96 FILEHANDLE local_file_open(const char* name, int flags) {
<> 144:ef7eb2e8f9f7 97 int openmode = posix_to_semihost_open_flags(flags);
<> 144:ef7eb2e8f9f7 98 if (openmode == OPEN_INVALID) {
<> 144:ef7eb2e8f9f7 99 return (FILEHANDLE)NULL;
<> 144:ef7eb2e8f9f7 100 }
<> 144:ef7eb2e8f9f7 101
<> 144:ef7eb2e8f9f7 102 FILEHANDLE fh = semihost_open(name, openmode);
<> 144:ef7eb2e8f9f7 103 if (fh == -1) {
<> 144:ef7eb2e8f9f7 104 return (FILEHANDLE)NULL;
<> 144:ef7eb2e8f9f7 105 }
<> 144:ef7eb2e8f9f7 106
<> 144:ef7eb2e8f9f7 107 return fh;
<> 144:ef7eb2e8f9f7 108 }
<> 144:ef7eb2e8f9f7 109
<> 144:ef7eb2e8f9f7 110 LocalFileHandle::LocalFileHandle(FILEHANDLE fh) : _fh(fh), pos(0) {
<> 144:ef7eb2e8f9f7 111 // No lock needed in constructor
<> 144:ef7eb2e8f9f7 112 }
<> 144:ef7eb2e8f9f7 113
<> 144:ef7eb2e8f9f7 114 int LocalFileHandle::close() {
<> 144:ef7eb2e8f9f7 115 int retval = semihost_close(_fh);
<> 144:ef7eb2e8f9f7 116 delete this;
<> 144:ef7eb2e8f9f7 117 return retval;
<> 144:ef7eb2e8f9f7 118 }
<> 144:ef7eb2e8f9f7 119
<> 144:ef7eb2e8f9f7 120 ssize_t LocalFileHandle::write(const void *buffer, size_t length) {
<> 144:ef7eb2e8f9f7 121 lock();
<> 144:ef7eb2e8f9f7 122 ssize_t n = semihost_write(_fh, (const unsigned char*)buffer, length, 0); // number of characters not written
<> 144:ef7eb2e8f9f7 123 n = length - n; // number of characters written
<> 144:ef7eb2e8f9f7 124 pos += n;
<> 144:ef7eb2e8f9f7 125 unlock();
<> 144:ef7eb2e8f9f7 126 return n;
<> 144:ef7eb2e8f9f7 127 }
<> 144:ef7eb2e8f9f7 128
<> 144:ef7eb2e8f9f7 129 ssize_t LocalFileHandle::read(void *buffer, size_t length) {
<> 144:ef7eb2e8f9f7 130 lock();
<> 144:ef7eb2e8f9f7 131 ssize_t n = semihost_read(_fh, (unsigned char*)buffer, length, 0); // number of characters not read
<> 144:ef7eb2e8f9f7 132 n = length - n; // number of characters read
<> 144:ef7eb2e8f9f7 133 pos += n;
<> 144:ef7eb2e8f9f7 134 unlock();
<> 144:ef7eb2e8f9f7 135 return n;
<> 144:ef7eb2e8f9f7 136 }
<> 144:ef7eb2e8f9f7 137
<> 144:ef7eb2e8f9f7 138 int LocalFileHandle::isatty() {
<> 144:ef7eb2e8f9f7 139 lock();
<> 144:ef7eb2e8f9f7 140 int ret = semihost_istty(_fh);
<> 144:ef7eb2e8f9f7 141 unlock();
<> 144:ef7eb2e8f9f7 142 return ret;
<> 144:ef7eb2e8f9f7 143 }
<> 144:ef7eb2e8f9f7 144
<> 144:ef7eb2e8f9f7 145 off_t LocalFileHandle::lseek(off_t position, int whence) {
<> 144:ef7eb2e8f9f7 146 lock();
<> 144:ef7eb2e8f9f7 147 if (whence == SEEK_CUR) {
<> 144:ef7eb2e8f9f7 148 position += pos;
<> 144:ef7eb2e8f9f7 149 } else if (whence == SEEK_END) {
<> 144:ef7eb2e8f9f7 150 position += semihost_flen(_fh);
<> 144:ef7eb2e8f9f7 151 } /* otherwise SEEK_SET, so position is fine */
<> 144:ef7eb2e8f9f7 152
<> 144:ef7eb2e8f9f7 153 /* Always seems to return -1, so just ignore for now. */
<> 144:ef7eb2e8f9f7 154 semihost_seek(_fh, position);
<> 144:ef7eb2e8f9f7 155 pos = position;
<> 144:ef7eb2e8f9f7 156 unlock();
<> 144:ef7eb2e8f9f7 157 return position;
<> 144:ef7eb2e8f9f7 158 }
<> 144:ef7eb2e8f9f7 159
<> 144:ef7eb2e8f9f7 160 int LocalFileHandle::fsync() {
<> 144:ef7eb2e8f9f7 161 lock();
<> 144:ef7eb2e8f9f7 162 int ret = semihost_ensure(_fh);
<> 144:ef7eb2e8f9f7 163 unlock();
<> 144:ef7eb2e8f9f7 164 return ret;
<> 144:ef7eb2e8f9f7 165 }
<> 144:ef7eb2e8f9f7 166
<> 144:ef7eb2e8f9f7 167 off_t LocalFileHandle::flen() {
<> 144:ef7eb2e8f9f7 168 lock();
<> 144:ef7eb2e8f9f7 169 off_t off = semihost_flen(_fh);
<> 144:ef7eb2e8f9f7 170 unlock();
<> 144:ef7eb2e8f9f7 171 return off;
<> 144:ef7eb2e8f9f7 172 }
<> 144:ef7eb2e8f9f7 173
<> 144:ef7eb2e8f9f7 174 void LocalFileHandle::lock() {
<> 144:ef7eb2e8f9f7 175 _mutex.lock();
<> 144:ef7eb2e8f9f7 176 }
<> 144:ef7eb2e8f9f7 177
<> 144:ef7eb2e8f9f7 178 void LocalFileHandle::unlock() {
<> 144:ef7eb2e8f9f7 179 _mutex.unlock();
<> 144:ef7eb2e8f9f7 180 }
<> 144:ef7eb2e8f9f7 181
<> 144:ef7eb2e8f9f7 182 class LocalDirHandle : public DirHandle {
<> 144:ef7eb2e8f9f7 183
<> 144:ef7eb2e8f9f7 184 public:
<> 144:ef7eb2e8f9f7 185 struct dirent cur_entry;
<> 144:ef7eb2e8f9f7 186 XFINFO info;
<> 144:ef7eb2e8f9f7 187
<> 144:ef7eb2e8f9f7 188 LocalDirHandle() : cur_entry(), info() {
<> 144:ef7eb2e8f9f7 189 }
<> 144:ef7eb2e8f9f7 190
<> 144:ef7eb2e8f9f7 191 virtual int closedir() {
<> 144:ef7eb2e8f9f7 192 // No lock can be used in destructor
<> 144:ef7eb2e8f9f7 193 delete this;
<> 144:ef7eb2e8f9f7 194 return 0;
<> 144:ef7eb2e8f9f7 195 }
<> 144:ef7eb2e8f9f7 196
<> 144:ef7eb2e8f9f7 197 virtual struct dirent *readdir() {
<> 144:ef7eb2e8f9f7 198 lock();
<> 144:ef7eb2e8f9f7 199 if (xffind("*", &info)!=0) {
<> 144:ef7eb2e8f9f7 200 unlock();
<> 144:ef7eb2e8f9f7 201 return NULL;
<> 144:ef7eb2e8f9f7 202 }
<> 144:ef7eb2e8f9f7 203 memcpy(cur_entry.d_name, info.name, sizeof(info.name));
<> 144:ef7eb2e8f9f7 204 unlock();
<> 144:ef7eb2e8f9f7 205 return &cur_entry;
<> 144:ef7eb2e8f9f7 206 }
<> 144:ef7eb2e8f9f7 207
<> 144:ef7eb2e8f9f7 208 virtual void rewinddir() {
<> 144:ef7eb2e8f9f7 209 lock();
<> 144:ef7eb2e8f9f7 210 info.fileID = 0;
<> 144:ef7eb2e8f9f7 211 unlock();
<> 144:ef7eb2e8f9f7 212 }
<> 144:ef7eb2e8f9f7 213
<> 144:ef7eb2e8f9f7 214 virtual off_t telldir() {
<> 144:ef7eb2e8f9f7 215 lock();
<> 144:ef7eb2e8f9f7 216 int fileId = info.fileID;
<> 144:ef7eb2e8f9f7 217 unlock();
<> 144:ef7eb2e8f9f7 218 return fileId;
<> 144:ef7eb2e8f9f7 219 }
<> 144:ef7eb2e8f9f7 220
<> 144:ef7eb2e8f9f7 221 virtual void seekdir(off_t offset) {
<> 144:ef7eb2e8f9f7 222 lock();
<> 144:ef7eb2e8f9f7 223 info.fileID = offset;
<> 144:ef7eb2e8f9f7 224 unlock();
<> 144:ef7eb2e8f9f7 225 }
<> 144:ef7eb2e8f9f7 226
<> 144:ef7eb2e8f9f7 227 protected:
<> 144:ef7eb2e8f9f7 228 PlatformMutex _mutex;
<> 144:ef7eb2e8f9f7 229
<> 144:ef7eb2e8f9f7 230 virtual void lock() {
<> 144:ef7eb2e8f9f7 231 _mutex.lock();
<> 144:ef7eb2e8f9f7 232 }
<> 144:ef7eb2e8f9f7 233
<> 144:ef7eb2e8f9f7 234 virtual void unlock() {
<> 144:ef7eb2e8f9f7 235 _mutex.unlock();
<> 144:ef7eb2e8f9f7 236 }
<> 144:ef7eb2e8f9f7 237 };
<> 144:ef7eb2e8f9f7 238
<> 144:ef7eb2e8f9f7 239 FileHandle *LocalFileSystem::open(const char* name, int flags) {
<> 144:ef7eb2e8f9f7 240 // No global state modified so function is thread safe
<> 144:ef7eb2e8f9f7 241
<> 144:ef7eb2e8f9f7 242 /* reject filenames with / in them */
<> 144:ef7eb2e8f9f7 243 for (const char *tmp = name; *tmp; tmp++) {
<> 144:ef7eb2e8f9f7 244 if (*tmp == '/') {
<> 144:ef7eb2e8f9f7 245 return NULL;
<> 144:ef7eb2e8f9f7 246 }
<> 144:ef7eb2e8f9f7 247 }
<> 144:ef7eb2e8f9f7 248
<> 144:ef7eb2e8f9f7 249 int openmode = posix_to_semihost_open_flags(flags);
<> 144:ef7eb2e8f9f7 250 if (openmode == OPEN_INVALID) {
<> 144:ef7eb2e8f9f7 251 return NULL;
<> 144:ef7eb2e8f9f7 252 }
<> 144:ef7eb2e8f9f7 253
<> 144:ef7eb2e8f9f7 254 FILEHANDLE fh = semihost_open(name, openmode);
<> 144:ef7eb2e8f9f7 255 if (fh == -1) {
<> 144:ef7eb2e8f9f7 256 return NULL;
<> 144:ef7eb2e8f9f7 257 }
<> 144:ef7eb2e8f9f7 258 return new LocalFileHandle(fh);
<> 144:ef7eb2e8f9f7 259 }
<> 144:ef7eb2e8f9f7 260
<> 144:ef7eb2e8f9f7 261 int LocalFileSystem::remove(const char *filename) {
<> 144:ef7eb2e8f9f7 262 // No global state modified so function is thread safe
<> 144:ef7eb2e8f9f7 263
<> 144:ef7eb2e8f9f7 264 return semihost_remove(filename);
<> 144:ef7eb2e8f9f7 265 }
<> 144:ef7eb2e8f9f7 266
<> 144:ef7eb2e8f9f7 267 DirHandle *LocalFileSystem::opendir(const char *name) {
<> 144:ef7eb2e8f9f7 268 // No global state modified so function is thread safe
<> 144:ef7eb2e8f9f7 269
<> 144:ef7eb2e8f9f7 270 return new LocalDirHandle();
<> 144:ef7eb2e8f9f7 271 }
<> 144:ef7eb2e8f9f7 272
<> 144:ef7eb2e8f9f7 273 } // namespace mbed
<> 144:ef7eb2e8f9f7 274
<> 144:ef7eb2e8f9f7 275 #endif