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
586/****************************************************************************
* fs/mount/fs_mount.c
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/mount.h>
#include <stdbool.h>
#include <string.h>
#include <errno.h>
#include <assert.h>
#include <debug.h>
#include <nuttx/fs/fs.h>
#include "driver/driver.h"
#include "inode/inode.h"
#include "vfs/vfs.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
/* In the canonical case, a file system is bound to a block driver. However,
* some less typical cases a block driver is not required. Examples are
* pseudo file systems (like BINFS or PROCFS) and MTD file systems (like
* NXFFS).
*
* These file systems all require block drivers:
*/
#if defined(CONFIG_FS_FAT) || defined(CONFIG_FS_ROMFS) || \
defined(CONFIG_FS_SMARTFS) || defined(CONFIG_FS_LITTLEFS)
# define BDFS_SUPPORT 1
#endif
/* These file systems require MTD drivers */
#if (defined(CONFIG_FS_SPIFFS) || defined(CONFIG_FS_LITTLEFS) || \
defined(CONFIG_FS_MNEMOFS)) && defined(CONFIG_MTD)
# define MDFS_SUPPORT 1
#endif
/* These file systems do not require block or MTD drivers */
#if defined(CONFIG_FS_NXFFS) || defined(CONFIG_FS_BINFS) || \
defined(CONFIG_FS_PROCFS) || defined(CONFIG_NFS) || \
defined(CONFIG_FS_TMPFS) || defined(CONFIG_FS_USERFS) || \
defined(CONFIG_FS_CROMFS) || defined(CONFIG_FS_UNIONFS) || \
defined(CONFIG_FS_HOSTFS) || defined(CONFIG_FS_ZIPFS) || \
defined(CONFIG_FS_RPMSGFS) || defined(CONFIG_FS_V9FS)
# define NODFS_SUPPORT
#endif
/****************************************************************************
* Private Types
****************************************************************************/
struct fsmap_t
{
FAR const char *fs_filesystemtype;
FAR const struct mountpt_operations *fs_mops;
};
/****************************************************************************
* Private Data
****************************************************************************/
#ifdef BDFS_SUPPORT
/* File systems that require block drivers */
#ifdef CONFIG_FS_FAT
extern const struct mountpt_operations g_fat_operations;
#endif
#ifdef CONFIG_FS_ROMFS
extern const struct mountpt_operations g_romfs_operations;
#endif
#ifdef CONFIG_FS_SMARTFS
extern const struct mountpt_operations g_smartfs_operations;
#endif
#ifdef CONFIG_FS_LITTLEFS
extern const struct mountpt_operations g_littlefs_operations;
#endif
static const struct fsmap_t g_bdfsmap[] =
{
#ifdef CONFIG_FS_FAT
{ "vfat", &g_fat_operations },
#endif
#ifdef CONFIG_FS_ROMFS
{ "romfs", &g_romfs_operations },
#endif
#ifdef CONFIG_FS_SMARTFS
{ "smartfs", &g_smartfs_operations },
#endif
#ifdef CONFIG_FS_LITTLEFS
{ "littlefs", &g_littlefs_operations },
#endif
{ NULL, NULL },
};
#endif /* BDFS_SUPPORT */
#ifdef MDFS_SUPPORT
/* File systems that require MTD drivers */
#ifdef CONFIG_FS_SPIFFS
extern const struct mountpt_operations g_spiffs_operations;
#endif
#ifdef CONFIG_FS_LITTLEFS
extern const struct mountpt_operations g_littlefs_operations;
#endif
#ifdef CONFIG_FS_MNEMOFS
extern const struct mountpt_operations g_mnemofs_operations;
#endif
static const struct fsmap_t g_mdfsmap[] =
{
#ifdef CONFIG_FS_SPIFFS
{ "spiffs", &g_spiffs_operations },
#endif
#ifdef CONFIG_FS_LITTLEFS
{ "littlefs", &g_littlefs_operations },
#endif
#ifdef CONFIG_FS_MNEMOFS
{ "mnemofs", &g_mnemofs_operations },
#endif
{ NULL, NULL },
};
#endif /* MDFS_SUPPORT */
#ifdef NODFS_SUPPORT
/* File systems that require neither block nor MTD drivers */
#ifdef CONFIG_FS_NXFFS
extern const struct mountpt_operations g_nxffs_operations;
#endif
#ifdef CONFIG_FS_TMPFS
extern const struct mountpt_operations g_tmpfs_operations;
#endif
#ifdef CONFIG_NFS
extern const struct mountpt_operations g_nfs_operations;
#endif
#ifdef CONFIG_FS_BINFS
extern const struct mountpt_operations g_binfs_operations;
#endif
#ifdef CONFIG_FS_PROCFS
extern const struct mountpt_operations g_procfs_operations;
#endif
#ifdef CONFIG_FS_USERFS
extern const struct mountpt_operations g_userfs_operations;
#endif
#ifdef CONFIG_FS_HOSTFS
extern const struct mountpt_operations g_hostfs_operations;
#endif
#ifdef CONFIG_FS_CROMFS
extern const struct mountpt_operations g_cromfs_operations;
#endif
#ifdef CONFIG_FS_UNIONFS
extern const struct mountpt_operations g_unionfs_operations;
#endif
#ifdef CONFIG_FS_RPMSGFS
extern const struct mountpt_operations g_rpmsgfs_operations;
#endif
#ifdef CONFIG_FS_ZIPFS
extern const struct mountpt_operations g_zipfs_operations;
#endif
#ifdef CONFIG_FS_V9FS
extern const struct mountpt_operations g_v9fs_operations;
#endif
static const struct fsmap_t g_nonbdfsmap[] =
{
#ifdef CONFIG_FS_NXFFS
{ "nxffs", &g_nxffs_operations },
#endif
#ifdef CONFIG_FS_TMPFS
{ "tmpfs", &g_tmpfs_operations },
#endif
#ifdef CONFIG_NFS
{ "nfs", &g_nfs_operations },
#endif
#ifdef CONFIG_FS_BINFS
{ "binfs", &g_binfs_operations },
#endif
#ifdef CONFIG_FS_PROCFS
{ "procfs", &g_procfs_operations },
#endif
#ifdef CONFIG_FS_USERFS
{ "userfs", &g_userfs_operations },
#endif
#ifdef CONFIG_FS_HOSTFS
{ "hostfs", &g_hostfs_operations },
#endif
#ifdef CONFIG_FS_CROMFS
{ "cromfs", &g_cromfs_operations },
#endif
#ifdef CONFIG_FS_UNIONFS
{ "unionfs", &g_unionfs_operations },
#endif
#ifdef CONFIG_FS_RPMSGFS
{ "rpmsgfs", &g_rpmsgfs_operations },
#endif
#ifdef CONFIG_FS_ZIPFS
{ "zipfs", &g_zipfs_operations},
#endif
#ifdef CONFIG_FS_V9FS
{ "v9fs", &g_v9fs_operations},
#endif
{ NULL, NULL },
};
#endif /* NODFS_SUPPORT */
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: mount_findfs
*
* Description:
* find the specified filesystem
*
****************************************************************************/
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT) || defined(NODFS_SUPPORT)
static FAR const struct mountpt_operations *
mount_findfs(FAR const struct fsmap_t *fstab, FAR const char *filesystemtype)
{
FAR const struct fsmap_t *fsmap;
for (fsmap = fstab; fsmap->fs_filesystemtype; fsmap++)
{
if (strcmp(filesystemtype, fsmap->fs_filesystemtype) == 0)
{
return fsmap->fs_mops;
}
}
return NULL;
}
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nx_mount
*
* Description:
* nx_mount() is similar to the standard 'mount' interface except that is
* not a cancellation point and it does not modify the errno variable.
*
* nx_mount() is an internal NuttX interface and should not be called from
* applications.
*
* Returned Value:
* Zero is returned on success; a negated value is returned on any failure.
*
****************************************************************************/
int nx_mount(FAR const char *source, FAR const char *target,
FAR const char *filesystemtype, unsigned long mountflags,
FAR const void *data)
{
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT) || defined(NODFS_SUPPORT)
FAR struct inode *drvr_inode = NULL;
FAR struct inode *mountpt_inode = NULL;
FAR const struct mountpt_operations *mops = NULL;
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
struct inode_search_s desc;
#endif
FAR void *fshandle = NULL;
int ret;
/* Verify required pointer arguments */
DEBUGASSERT(target && filesystemtype);
/* Find the specified filesystem. Try the block driver filesystems first */
if (source != NULL && source[0] != '\0' &&
find_blockdriver(source, mountflags, &drvr_inode) >= 0)
{
/* Find the block based file system */
#ifdef BDFS_SUPPORT
mops = mount_findfs(g_bdfsmap, filesystemtype);
#endif /* BDFS_SUPPORT */
if (mops == NULL)
{
ferr("ERROR: Failed to find block based file system %s\n",
filesystemtype);
ret = -ENODEV;
goto errout_with_inode;
}
}
else if (source != NULL && source[0] != '\0' &&
(ret = find_mtddriver(source, &drvr_inode)) >= 0)
{
/* Find the MTD based file system */
#ifdef MDFS_SUPPORT
mops = mount_findfs(g_mdfsmap, filesystemtype);
#endif /* MDFS_SUPPORT */
if (mops == NULL)
{
#ifdef BDFS_SUPPORT
mops = mount_findfs(g_bdfsmap, filesystemtype);
#endif /* BDFS_SUPPORT */
if (mops == NULL)
{
ferr("ERROR: Failed to find MTD based file system %s\n",
filesystemtype);
ret = -ENODEV;
goto errout_with_inode;
}
#ifdef CONFIG_MTD
else
{
inode_release(drvr_inode);
ret = mtd_proxy(source, mountflags, &drvr_inode);
if (ret < 0)
{
goto errout_with_inode;
}
}
#endif
}
}
else
#ifdef NODFS_SUPPORT
if ((mops = mount_findfs(g_nonbdfsmap, filesystemtype)) != NULL)
{
finfo("found %s\n", filesystemtype);
}
else
#endif /* NODFS_SUPPORT */
{
ferr("ERROR: Failed to find block driver %s\n", source);
ret = -ENOTBLK;
goto errout;
}
inode_lock();
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
/* Check if the inode already exists */
SETUP_SEARCH(&desc, target, false);
ret = inode_find(&desc);
if (ret >= 0)
{
/* Successfully found. The reference count on the inode has been
* incremented.
*/
mountpt_inode = desc.node;
DEBUGASSERT(mountpt_inode != NULL);
/* But is it a directory node (i.e., not a driver or other special
* node)?
*/
if (!INODE_IS_PSEUDODIR(mountpt_inode))
{
ferr("ERROR: target %s exists and is a special node\n", target);
ret = -ENOTDIR;
inode_release(mountpt_inode);
goto errout_with_lock;
}
}
#endif
/* Bind the block driver to an instance of the file system. The file
* system returns a reference to some opaque, fs-dependent structure
* that encapsulates this binding.
*/
if (mops->bind == NULL)
{
/* The filesystem does not support the bind operation ??? */
ferr("ERROR: Filesystem does not support bind\n");
ret = -EINVAL;
goto errout_with_lock;
}
/* Increment reference count for the reference we pass to the file system */
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT)
#ifdef NODFS_SUPPORT
if (drvr_inode != NULL)
#endif
{
atomic_fetch_add(&drvr_inode->i_crefs, 1);
}
#endif
inode_unlock();
/* On failure, the bind method returns -errorcode */
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT)
ret = mops->bind(drvr_inode, data, &fshandle);
#else
ret = mops->bind(NULL, data, &fshandle);
#endif
inode_lock();
if (ret < 0)
{
/* The inode is unhappy with the driver for some reason. Back out
* the count for the reference we failed to pass and exit with an
* error.
*/
ferr("ERROR: Bind method failed: %d\n", ret);
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT)
#ifdef NODFS_SUPPORT
if (drvr_inode != NULL)
#endif
{
atomic_fetch_sub(&drvr_inode->i_crefs, 1);
}
#endif
goto errout_with_lock;
}
/* Insert a dummy node -- we need to hold the inode semaphore
* to do this because we will have a momentarily bad structure.
* NOTE that the new inode will be created with an initial reference
* count of zero.
*/
if (mountpt_inode == NULL)
{
ret = inode_reserve(target, 0777, &mountpt_inode);
if (ret < 0)
{
/* inode_reserve can fail for a couple of reasons, but the most
* likely one is that the inode already exists. inode_reserve may
* return:
*
* -EINVAL - 'path' is invalid for this operation
* -EEXIST - An inode already exists at 'path'
* -ENOMEM - Failed to allocate in-memory resources for the
* operation
*/
ferr("ERROR: Failed to reserve inode for target %s\n", target);
goto errout_with_bind;
}
}
/* We have it, now populate it with driver specific information. */
INODE_SET_MOUNTPT(mountpt_inode);
mountpt_inode->u.i_mops = mops;
mountpt_inode->i_private = fshandle;
inode_unlock();
/* We can release our reference to the blkdrver_inode, if the filesystem
* wants to retain the blockdriver inode (which it should), then it must
* have called inode_addref(). There is one reference on mountpt_inode
* that will persist until umount2() is called.
*/
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT)
#ifdef NODFS_SUPPORT
if (drvr_inode != NULL)
#endif
{
inode_release(drvr_inode);
}
#endif
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
RELEASE_SEARCH(&desc);
#endif
#ifdef CONFIG_FS_NOTIFY
notify_create(target);
#endif
return OK;
/* A lot of goto's! But they make the error handling much simpler */
errout_with_bind:
if (mops->unbind != NULL)
{
mops->unbind(fshandle, &drvr_inode, 0);
}
errout_with_lock:
inode_unlock();
#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS
RELEASE_SEARCH(&desc);
#endif
errout_with_inode:
#if defined(BDFS_SUPPORT) || defined(MDFS_SUPPORT)
if (drvr_inode != NULL)
{
inode_release(drvr_inode);
}
#endif
errout:
return ret;
#else
ferr("ERROR: No filesystems enabled\n");
return -ENOSYS;
#endif /* BDFS_SUPPORT || MDFS_SUPPORT || NODFS_SUPPORT */
}
/****************************************************************************
* Name: mount
*
* Description:
* mount() attaches the filesystem specified by the 'source' block device
* name into the root file system at the path specified by 'target.'
*
* Returned Value:
* Zero is returned on success; -1 is returned on an error and errno is
* set appropriately:
*
* EACCES A component of a path was not searchable or mounting a read-only
* filesystem was attempted without giving the MS_RDONLY flag.
* EBUSY 'source' is already mounted.
* EFAULT One of the pointer arguments points outside the user address
* space.
* EINVAL 'source' had an invalid superblock.
* ENODEV 'filesystemtype' not configured
* ENOENT A pathname was empty or had a nonexistent component.
* ENOMEM Could not allocate a memory to copy filenames or data into.
* ENOTBLK 'source' is not a block device
*
****************************************************************************/
int mount(FAR const char *source, FAR const char *target,
FAR const char *filesystemtype, unsigned long mountflags,
FAR const void *data)
{
int ret;
ret = nx_mount(source, target, filesystemtype, mountflags, data);
if (ret < 0)
{
set_errno(-ret);
ret = ERROR;
}
return ret;
}