Gan likun / mbed-dev

00

platform/LocalFileSystem.cpp@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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