Blame view

RIOT/sys/shell/commands/sc_vfs.c 15.4 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
  /*
   * Copyright (C) 2016 Eistec AB
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @ingroup     sys_shell_commands
   * @{
   *
   * @file
   * @brief       Shell commands for the VFS module
   *
   * @author      Joakim Nohlgård <joakim.nohlgard@eistec.se>
   *
   * @}
   */
  
  #if MODULE_VFS
  #include <stdint.h>
  #include <inttypes.h>
  #include <stdlib.h>
  #include <stdio.h>
  #include <string.h>
  #include <ctype.h>
  #include <errno.h>
  #include <unistd.h>
  #include <fcntl.h>
  
  #include "vfs.h"
  
  #define SHELL_VFS_BUFSIZE 256
  static uint8_t _shell_vfs_data_buffer[SHELL_VFS_BUFSIZE];
  
  static void _ls_usage(char **argv)
  {
      printf("%s <path>\n", argv[0]);
      puts("list files in <path>");
  }
  
  static void _vfs_usage(char **argv)
  {
      printf("%s r <path> [bytes] [offset]\n", argv[0]);
      printf("%s w <path> <ascii|hex> <a|o> <data>\n", argv[0]);
      printf("%s ls <path>\n", argv[0]);
      printf("%s cp <src> <dest>\n", argv[0]);
      printf("%s mv <src> <dest>\n", argv[0]);
      printf("%s rm <file>\n", argv[0]);
      printf("%s df [path]\n", argv[0]);
      puts("r: Read [bytes] bytes at [offset] in file <path>");
      puts("w: Write (<a>: append, <o> overwrite) <ascii> or <hex> string <data> in file <path>");
      puts("ls: list files in <path>");
      puts("mv: Move <src> file to <dest>");
      puts("cp: Copy <src> file to <dest>");
      puts("rm: Unlink (delete) <file>");
      puts("df: show file system space utilization stats");
  }
  
  /* Macro used by _errno_string to expand errno labels to string and print it */
  #define _case_snprintf_errno_name(x) \
      case x: \
          res = snprintf(buf, buflen, #x); \
          break
  
  static int _errno_string(int err, char *buf, size_t buflen)
  {
      int len = 0;
      int res;
      if (err < 0) {
          res = snprintf(buf, buflen, "-");
          if (res < 0) {
              return res;
          }
          if ((size_t)res <= buflen) {
              buf += res;
              buflen -= res;
          }
          len += res;
          err = -err;
      }
      switch (err) {
          _case_snprintf_errno_name(EACCES);
          _case_snprintf_errno_name(ENOENT);
          _case_snprintf_errno_name(EINVAL);
          _case_snprintf_errno_name(EFAULT);
          _case_snprintf_errno_name(EROFS);
          _case_snprintf_errno_name(EIO);
          _case_snprintf_errno_name(ENAMETOOLONG);
          _case_snprintf_errno_name(EPERM);
  
          default:
              res = snprintf(buf, buflen, "%d", err);
              break;
      }
      if (res < 0) {
          return res;
      }
      len += res;
      return len;
  }
  #undef _case_snprintf_errno_name
  
  static void _print_df(const char *path)
  {
      struct statvfs buf;
      int res = vfs_statvfs(path, &buf);
      printf("%-16s ", path);
      if (res < 0) {
          char err[16];
          _errno_string(res, err, sizeof(err));
          printf("statvfs failed: %s\n", err);
          return;
      }
      printf("%12lu %12lu %12lu %7lu%%\n", (unsigned long)buf.f_blocks,
          (unsigned long)(buf.f_blocks - buf.f_bfree), (unsigned long)buf.f_bavail,
          (unsigned long)(((buf.f_blocks - buf.f_bfree) * 100) / buf.f_blocks));
  }
  
  static int _df_handler(int argc, char **argv)
  {
      puts("Mountpoint              Total         Used    Available     Capacity");
      if (argc > 1) {
          const char *path = argv[1];
          _print_df(path);
      }
      else {
          /* Iterate through all mount points */
          const vfs_mount_t *it = NULL;
          while ((it = vfs_iterate_mounts(it)) != NULL) {
              _print_df(it->mount_point);
          }
      }
      return 0;
  }
  
  static int _read_handler(int argc, char **argv)
  {
      uint8_t buf[16];
      size_t nbytes = sizeof(buf);
      off_t offset = 0;
      char *path = argv[1];
      if (argc < 2) {
          puts("vfs read: missing file name");
          return 1;
      }
      if (argc > 2) {
          nbytes = atoi(argv[2]);
      }
      if (argc > 3) {
          offset = atoi(argv[3]);
      }
  
      int res;
      res = vfs_normalize_path(path, path, strlen(path) + 1);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("Invalid path \"%s\": %s\n", path, buf);
          return 5;
      }
  
      int fd = vfs_open(path, O_RDONLY, 0);
      if (fd < 0) {
          _errno_string(fd, (char *)buf, sizeof(buf));
          printf("Error opening file \"%s\": %s\n", path, buf);
          return 3;
      }
  
      res = vfs_lseek(fd, offset, SEEK_SET);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("Seek error: %s\n", buf);
          vfs_close(fd);
          return 4;
      }
  
      while (nbytes > 0) {
          memset(buf, 0, sizeof(buf));
          size_t line_len = (nbytes < sizeof(buf) ? nbytes : sizeof(buf));
          res = vfs_read(fd, buf, line_len);
          if (res < 0) {
              _errno_string(res, (char *)buf, sizeof(buf));
              printf("Read error: %s\n", buf);
              vfs_close(fd);
              return 5;
          }
          else if ((size_t)res > line_len) {
              printf("BUFFER OVERRUN! %d > %lu\n", res, (unsigned long)line_len);
              vfs_close(fd);
              return 6;
          }
          else if (res == 0) {
              /* EOF */
              printf("-- EOF --\n");
              break;
          }
          printf("%08lx:", (unsigned long)offset);
          for (int k = 0; k < res; ++k) {
              if ((k % 2) == 0) {
                  putchar(' ');
              }
              printf("%02x", buf[k]);
          }
          for (unsigned k = res; k < sizeof(buf); ++k) {
              if ((k % 2) == 0) {
                  putchar(' ');
              }
              putchar(' ');
              putchar(' ');
          }
          putchar(' ');
          putchar(' ');
          for (int k = 0; k < res; ++k) {
              if (isprint(buf[k])) {
                  putchar(buf[k]);
              }
              else {
                  putchar('.');
              }
          }
          puts("");
          offset += res;
          nbytes -= res;
      }
  
      vfs_close(fd);
      return 0;
  }
  
  static inline int _dehex(char c)
  {
      if ('0' <= c && c <= '9') {
          return c - '0';
      }
      else if ('A' <= c && c <= 'F') {
          return c - 'A' + 10;
      }
      else if ('a' <= c && c <= 'f') {
          return c - 'a' + 10;
      }
      else {
          return 0;
      }
  }
  
  static int _write_handler(int argc, char **argv)
  {
      char *w_buf;
      char buf[16];
      size_t nbytes = 0;
      size_t nb_str = 0;
      char *path = argv[1];
      int ascii = 0;
      int flag = O_CREAT;
      if (argc < 2) {
          puts("vfs write: missing file name");
          return 1;
      }
  
      if (argc < 3) {
          puts("vfs write: missing format");
          return 1;
      }
      if (strcmp(argv[2], "ascii") == 0) {
          ascii = 1;
      }
      else if (strcmp(argv[2], "hex") == 0) {
          ascii = 0;
      }
      else {
          printf("vfs write: unknown format: %s\n", argv[2]);
          return 1;
      }
  
      if (argc < 4) {
          puts("vfs write: missing <a|o> flag");
          return 1;
      }
      if (strcmp(argv[3], "a") == 0) {
          flag |= O_WRONLY | O_APPEND;
      }
      else if (strcmp(argv[3], "o") == 0) {
          flag |= O_WRONLY;
      }
      else {
          printf("vfs write: invalid flag %s\n", argv[3]);
          return 1;
      }
  
      if (argc < 5) {
          puts("vfs write: missing data");
          return 1;
      }
      w_buf = argv[4];
      nbytes = strlen(w_buf);
      /* in hex string mode, bytes may be seperated by spaces */
      /* in ascii mode, there could be spaces */
      /* we need the total number of strings to go through */
      nb_str = argc - 4;
      if (!ascii) {
          /* sanity check: only hex digit and hex strings length must be even */
          for (size_t i = 0; i < nb_str; i++) {
              char c;
              size_t j = 0;
              do {
                  c = argv[argc - nb_str + i][j];
                  j++;
                  if (c != '\0' && !isxdigit((int)c)) {
                      printf("Non-hex character: %c\n", c);
                      return 6;
                  }
              } while (c != '\0');
              j--;
              if (j % 2 != 0) {
                  puts("Invalid string length");
                  return 6;
              }
          }
      }
  
      int res;
      res = vfs_normalize_path(path, path, strlen(path) + 1);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("Invalid path \"%s\": %s\n", path, buf);
          return 5;
      }
  
      int fd = vfs_open(path, flag, 0);
      if (fd < 0) {
          _errno_string(fd, (char *)buf, sizeof(buf));
          printf("Error opening file \"%s\": %s\n", path, buf);
          return 3;
      }
  
      if (ascii) {
          while (nb_str > 0) {
              res = vfs_write(fd, w_buf, nbytes);
              if (res < 0) {
                  _errno_string(res, (char *)buf, sizeof(buf));
                  printf("Write error: %s\n", buf);
                  vfs_close(fd);
                  return 4;
              }
              nb_str--;
              if (nb_str) {
                  vfs_write(fd, " ", 1);
                  w_buf = argv[argc - nb_str];
              }
          }
      }
      else {
          while (nb_str > 0) {
              w_buf = argv[argc - nb_str];
              nbytes = strlen(w_buf);
              while (nbytes > 0) {
                  uint8_t byte = _dehex(*w_buf) << 4 | _dehex(*(w_buf + 1));
                  res = vfs_write(fd, &byte, 1);
                  if (res < 0) {
                      _errno_string(res, (char *)buf, sizeof(buf));
                      printf("Write error: %s\n", buf);
                      vfs_close(fd);
                      return 4;
                  }
                  w_buf += 2;
                  nbytes -= 2;
              }
              nb_str--;
          }
      }
  
      vfs_close(fd);
      return 0;
  }
  
  static int _cp_handler(int argc, char **argv)
  {
      char errbuf[16];
      if (argc < 3) {
          _vfs_usage(argv);
          return 1;
      }
      char *src_name = argv[1];
      char *dest_name = argv[2];
      printf("%s: copy src: %s dest: %s\n", argv[0], src_name, dest_name);
  
      int fd_in = vfs_open(src_name, O_RDONLY, 0);
      if (fd_in < 0) {
          _errno_string(fd_in, (char *)errbuf, sizeof(errbuf));
          printf("Error opening file for reading \"%s\": %s\n", src_name, errbuf);
          return 2;
      }
      int fd_out = vfs_open(dest_name, O_WRONLY | O_TRUNC | O_CREAT, S_IRWXU | S_IRWXG | S_IRWXO);
      if (fd_out < 0) {
          _errno_string(fd_out, (char *)errbuf, sizeof(errbuf));
          printf("Error opening file for writing \"%s\": %s\n", dest_name, errbuf);
          return 2;
      }
      int eof = 0;
      while (eof == 0) {
          size_t bufspace = sizeof(_shell_vfs_data_buffer);
          size_t pos = 0;
          while (bufspace > 0) {
              int res = vfs_read(fd_in, &_shell_vfs_data_buffer[pos], bufspace);
              if (res < 0) {
                  _errno_string(res, (char *)errbuf, sizeof(errbuf));
                  printf("Error reading %lu bytes @ 0x%lx in \"%s\" (%d): %s\n",
                      (unsigned long)bufspace, (unsigned long)pos, src_name, fd_in, errbuf);
                  vfs_close(fd_in);
                  vfs_close(fd_out);
                  return 2;
              }
              if (res == 0) {
                  /* EOF */
                  eof = 1;
                  break;
              }
              if (((unsigned)res) > bufspace) {
                  printf("READ BUFFER OVERRUN! %d > %lu\n", res, (unsigned long)bufspace);
                  vfs_close(fd_in);
                  vfs_close(fd_out);
                  return 3;
              }
              pos += res;
              bufspace -= res;
          }
          bufspace = pos;
          pos = 0;
          while (bufspace > 0) {
              int res = vfs_write(fd_out, &_shell_vfs_data_buffer[pos], bufspace);
              if (res <= 0) {
                  _errno_string(res, (char *)errbuf, sizeof(errbuf));
                  printf("Error writing %lu bytes @ 0x%lx in \"%s\" (%d): %s\n",
                      (unsigned long)bufspace, (unsigned long)pos, dest_name, fd_out, errbuf);
                  vfs_close(fd_in);
                  vfs_close(fd_out);
                  return 4;
              }
              if (((unsigned)res) > bufspace) {
                  printf("WRITE BUFFER OVERRUN! %d > %lu\n", res, (unsigned long)bufspace);
                  vfs_close(fd_in);
                  vfs_close(fd_out);
                  return 5;
              }
              bufspace -= res;
          }
      }
      printf("Copied: %s -> %s\n", src_name, dest_name);
      vfs_close(fd_in);
      vfs_close(fd_out);
      return 0;
  }
  
  static int _mv_handler(int argc, char **argv)
  {
      if (argc < 3) {
          _vfs_usage(argv);
          return 1;
      }
      char *src_name = argv[1];
      char *dest_name = argv[2];
      printf("%s: move src: %s dest: %s\n", argv[0], src_name, dest_name);
  
      int res = vfs_rename(src_name, dest_name);
      if (res < 0) {
          char errbuf[16];
          _errno_string(res, (char *)errbuf, sizeof(errbuf));
          printf("mv ERR: %s\n", errbuf);
          return 2;
      }
      return 0;
  }
  
  static int _rm_handler(int argc, char **argv)
  {
      if (argc < 2) {
          _vfs_usage(argv);
          return 1;
      }
      char *rm_name = argv[1];
      printf("%s: unlink: %s\n", argv[0], rm_name);
  
      int res = vfs_unlink(rm_name);
      if (res < 0) {
          char errbuf[16];
          _errno_string(res, (char *)errbuf, sizeof(errbuf));
          printf("rm ERR: %s\n", errbuf);
          return 2;
      }
      return 0;
  }
  
  int _ls_handler(int argc, char **argv)
  {
      if (argc < 2) {
          _ls_usage(argv);
          return 1;
      }
      char *path = argv[1];
      uint8_t buf[16];
      int res;
      int ret = 0;
      res = vfs_normalize_path(path, path, strlen(path) + 1);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("Invalid path \"%s\": %s\n", path, buf);
          return 5;
      }
      vfs_DIR dir;
      res = vfs_opendir(&dir, path);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("vfs_opendir error: %s\n", buf);
          return 1;
      }
      unsigned int nfiles = 0;
  
      while (1) {
          vfs_dirent_t entry;
          res = vfs_readdir(&dir, &entry);
          if (res < 0) {
              _errno_string(res, (char *)buf, sizeof(buf));
              printf("vfs_readdir error: %s\n", buf);
              if (res == -EAGAIN) {
                  /* try again */
                  continue;
              }
              ret = 2;
              break;
          }
          if (res == 0) {
              /* end of stream */
              break;
          }
          printf("%s\n", entry.d_name);
          ++nfiles;
      }
      if (ret == 0) {
          printf("total %u files\n", nfiles);
      }
  
      res = vfs_closedir(&dir);
      if (res < 0) {
          _errno_string(res, (char *)buf, sizeof(buf));
          printf("vfs_closedir error: %s\n", buf);
          return 2;
      }
      return ret;
  }
  
  int _vfs_handler(int argc, char **argv)
  {
      if (argc < 2) {
          _vfs_usage(argv);
          return 1;
      }
      if (strcmp(argv[1], "r") == 0) {
          /* pass on to read handler, shifting the arguments by one */
          return _read_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "w") == 0) {
          return _write_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "ls") == 0) {
          return _ls_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "cp") == 0) {
          return _cp_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "mv") == 0) {
          return _mv_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "rm") == 0) {
          return _rm_handler(argc - 1, &argv[1]);
      }
      else if (strcmp(argv[1], "df") == 0) {
          return _df_handler(argc - 1, &argv[1]);
      }
      else {
          printf("vfs: unsupported sub-command \"%s\"\n", argv[1]);
          return 1;
      }
  }
  #endif