Gan likun / mbed-dev11

platform/LocalFileSystem.cpp@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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