source: mainline/uspace/srv/fs/fat/fat_dentry.h@ feeac0d

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since feeac0d was a21d837, checked in by Jakub Jermar <jakub@…>, 12 years ago

Explicitly treat the str argument to fat_lfn_str_nlength() as unaligned.

fat_lfn_str_nlength() was defined to take uint16_t * and as such had
reasons to assume natural alignment of the pointed object. This was
however not the case when the function was called from fat_lfn_size()
because the argument there is an address from inside a packed structure.
  • Property mode set to 100644
File size: 4.8 KB
Line 
1/*
2 * Copyright (c) 2008 Jakub Jermar
3 * Copyright (c) 2011 Oleg Romanenko
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup fs
31 * @{
32 */
33
34#ifndef FAT_FAT_DENTRY_H_
35#define FAT_FAT_DENTRY_H_
36
37#include <stdint.h>
38#include <stdbool.h>
39#include <sys/types.h>
40
41#define IS_D_CHAR(ch) (isalnum(ch) || ch == '_')
42#define FAT_STOP_CHARS "*?/\\\n\t|'"
43
44#define FAT_NAME_LEN 8
45#define FAT_EXT_LEN 3
46
47#define FAT_NAME_DOT ". "
48#define FAT_NAME_DOT_DOT ".. "
49#define FAT_EXT_PAD " "
50
51#define FAT_ATTR_RDONLY 0x01
52#define FAT_ATTR_HIDDEN 0x02
53#define FAT_ATTR_SYSTEM 0x04
54#define FAT_ATTR_VOLLABEL 0x08
55#define FAT_ATTR_SUBDIR 0x10
56#define FAT_ATTR_ARCHIVE 0x20
57#define FAT_ATTR_LFN \
58 (FAT_ATTR_RDONLY | FAT_ATTR_HIDDEN | FAT_ATTR_SYSTEM | FAT_ATTR_VOLLABEL)
59
60#define FAT_LCASE_LOWER_NAME 0x08
61#define FAT_LCASE_LOWER_EXT 0x10
62
63#define FAT_PAD ' '
64#define FAT_LFN_PAD 0xffff
65#define FAT_SFN_CHAR '_'
66
67#define FAT_DENTRY_UNUSED 0x00
68#define FAT_DENTRY_E5_ESC 0x05
69#define FAT_DENTRY_DOT 0x2e
70#define FAT_DENTRY_ERASED 0xe5
71#define FAT_LFN_LAST 0x40
72#define FAT_LFN_ERASED 0x80
73
74#define FAT_LFN_ORDER(d) ((d)->lfn.order)
75#define FAT_IS_LFN(d) \
76 ((FAT_LFN_ORDER((d)) & FAT_LFN_LAST) == FAT_LFN_LAST)
77#define FAT_LFN_COUNT(d) \
78 (FAT_LFN_ORDER((d)) ^ FAT_LFN_LAST)
79#define FAT_LFN_PART1(d) ((d)->lfn.part1)
80#define FAT_LFN_PART2(d) ((d)->lfn.part2)
81#define FAT_LFN_PART3(d) ((d)->lfn.part3)
82#define FAT_LFN_ATTR(d) ((d)->lfn.attr)
83#define FAT_LFN_CHKSUM(d) ((d)->lfn.check_sum)
84
85#define FAT_LFN_NAME_SIZE 260
86#define FAT_LFN_MAX_COUNT 20
87#define FAT_LFN_PART1_SIZE 5
88#define FAT_LFN_PART2_SIZE 6
89#define FAT_LFN_PART3_SIZE 2
90#define FAT_LFN_ENTRY_SIZE \
91 (FAT_LFN_PART1_SIZE + FAT_LFN_PART2_SIZE + FAT_LFN_PART3_SIZE)
92
93typedef enum {
94 FAT_DENTRY_SKIP,
95 FAT_DENTRY_LAST,
96 FAT_DENTRY_FREE,
97 FAT_DENTRY_VALID,
98 FAT_DENTRY_LFN
99} fat_dentry_clsf_t;
100
101typedef union {
102 struct {
103 uint8_t name[8];
104 uint8_t ext[3];
105 uint8_t attr;
106 uint8_t lcase;
107 uint8_t ctime_fine;
108 uint16_t ctime;
109 uint16_t cdate;
110 uint16_t adate;
111 union {
112 uint16_t eaidx; /* FAT12/FAT16 */
113 uint16_t firstc_hi; /* FAT32 */
114 } __attribute__ ((packed));
115 uint16_t mtime;
116 uint16_t mdate;
117 union {
118 uint16_t firstc; /* FAT12/FAT16 */
119 uint16_t firstc_lo; /* FAT32 */
120 } __attribute__ ((packed));
121 uint32_t size;
122 } __attribute__ ((packed));
123 struct {
124 uint8_t order;
125 uint16_t part1[FAT_LFN_PART1_SIZE];
126 uint8_t attr;
127 uint8_t type;
128 uint8_t check_sum;
129 uint16_t part2[FAT_LFN_PART2_SIZE];
130 uint16_t firstc_lo; /* MUST be 0 */
131 uint16_t part3[FAT_LFN_PART3_SIZE];
132 } __attribute__ ((packed)) lfn;
133} __attribute__ ((packed)) fat_dentry_t;
134
135extern int fat_dentry_namecmp(char *, const char *);
136extern void fat_dentry_name_get(const fat_dentry_t *, char *);
137extern void fat_dentry_name_set(fat_dentry_t *, const char *);
138extern fat_dentry_clsf_t fat_classify_dentry(const fat_dentry_t *);
139extern uint8_t fat_dentry_chksum(uint8_t *);
140
141extern size_t fat_lfn_str_nlength(const unaligned_uint16_t *, size_t);
142extern size_t fat_lfn_size(const fat_dentry_t *);
143extern size_t fat_lfn_get_entry(const fat_dentry_t *, uint16_t *, size_t *);
144extern size_t fat_lfn_set_entry(const uint16_t *, size_t *, size_t,
145 fat_dentry_t *);
146
147extern void str_to_ascii(char *, const char *, size_t, uint8_t);
148extern size_t utf16_length(const uint16_t *);
149
150extern bool fat_valid_name(const char *);
151extern bool fat_valid_short_name(const char *);
152
153#endif
154
155/**
156 * @}
157 */
Note: See TracBrowser for help on using the repository browser.