source: mainline/uspace/lib/ext4/libext4_directory.h@ 2f2feadb

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 2f2feadb was 7689590, checked in by Frantisek Princ <frantisek.princ@…>, 13 years ago

Code refactoring (for dentry searching)
  • Property mode set to 100644
File size: 4.9 KB
Line 
1/*
2 * Copyright (c) 2011 Frantisek Princ
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libext4
30 * @{
31 */
32
33#ifndef LIBEXT4_LIBEXT4_DIRECTORY_H_
34#define LIBEXT4_LIBEXT4_DIRECTORY_H_
35
36#include "libext4_filesystem.h"
37#include "libext4_inode.h"
38
39#define EXT4_DIRECTORY_FILENAME_LEN 255
40
41#define EXT4_DIRECTORY_FILETYPE_UNKNOWN 0
42#define EXT4_DIRECTORY_FILETYPE_REG_FILE 1
43#define EXT4_DIRECTORY_FILETYPE_DIR 2
44#define EXT4_DIRECTORY_FILETYPE_CHRDEV 3
45#define EXT4_DIRECTORY_FILETYPE_BLKDEV 4
46#define EXT4_DIRECTORY_FILETYPE_FIFO 5
47#define EXT4_DIRECTORY_FILETYPE_SOCK 6
48#define EXT4_DIRECTORY_FILETYPE_SYMLINK 7
49
50/**
51 * Linked list directory entry structure
52 */
53typedef struct ext4_directory_entry_ll {
54 uint32_t inode; // Inode for the entry
55 uint16_t entry_length; // Distance to the next directory entry
56 uint8_t name_length; // Lower 8 bits of name length
57 union {
58 uint8_t name_length_high; // Higher 8 bits of name length
59 uint8_t inode_type; // Type of referenced inode (in rev >= 0.5)
60 } __attribute__ ((packed));
61 uint8_t name[EXT4_DIRECTORY_FILENAME_LEN]; // Entry name
62} __attribute__ ((packed)) ext4_directory_entry_ll_t;
63
64typedef struct ext4_directory_iterator {
65 ext4_filesystem_t *fs;
66 ext4_inode_ref_t *inode_ref;
67 block_t *current_block;
68 aoff64_t current_offset;
69 ext4_directory_entry_ll_t *current;
70} ext4_directory_iterator_t;
71
72typedef struct ext4_directory_search_result {
73 block_t *block;
74 ext4_directory_entry_ll_t *dentry;
75} ext4_directory_search_result_t;
76
77extern uint32_t ext4_directory_entry_ll_get_inode(ext4_directory_entry_ll_t *);
78extern void ext4_directory_entry_ll_set_inode(ext4_directory_entry_ll_t *,
79 uint32_t);
80extern uint16_t ext4_directory_entry_ll_get_entry_length(
81 ext4_directory_entry_ll_t *);
82extern void ext4_directory_entry_ll_set_entry_length(
83 ext4_directory_entry_ll_t *, uint16_t);
84extern uint16_t ext4_directory_entry_ll_get_name_length(
85 ext4_superblock_t *, ext4_directory_entry_ll_t *);
86extern void ext4_directory_entry_ll_set_name_length(ext4_superblock_t *,
87 ext4_directory_entry_ll_t *, uint16_t);
88extern uint8_t ext4_directory_entry_ll_get_inode_type(ext4_superblock_t *,
89 ext4_directory_entry_ll_t *);
90extern void ext4_directory_entry_ll_set_inode_type(ext4_superblock_t *,
91 ext4_directory_entry_ll_t *, uint8_t);
92
93extern int ext4_directory_iterator_init(ext4_directory_iterator_t *,
94 ext4_filesystem_t *, ext4_inode_ref_t *, aoff64_t);
95extern int ext4_directory_iterator_next(ext4_directory_iterator_t *);
96extern int ext4_directory_iterator_seek(ext4_directory_iterator_t *, aoff64_t);
97extern int ext4_directory_iterator_fini(ext4_directory_iterator_t *);
98
99extern int ext4_directory_append_block(ext4_filesystem_t *,
100 ext4_inode_ref_t *, uint32_t *, uint32_t *);
101
102extern void ext4_directory_write_entry(ext4_superblock_t *,
103 ext4_directory_entry_ll_t *, uint16_t, ext4_inode_ref_t *,
104 const char *, size_t);
105extern int ext4_directory_add_entry(ext4_filesystem_t *, ext4_inode_ref_t *,
106 const char *, ext4_inode_ref_t *);
107extern int ext4_directory_find_entry(ext4_filesystem_t *,
108 ext4_directory_search_result_t *, ext4_inode_ref_t *, const char *);
109extern int ext4_directory_remove_entry(ext4_filesystem_t* ,
110 ext4_inode_ref_t *, const char *);
111
112extern int ext4_directory_try_insert_entry(ext4_superblock_t *,
113 block_t *, ext4_inode_ref_t *, const char *, uint32_t);
114
115extern int ext4_directory_find_in_block(block_t *,
116 ext4_superblock_t *, size_t, const char *,
117 ext4_directory_entry_ll_t **);
118
119extern int ext4_directory_destroy_result(ext4_directory_search_result_t *);
120#endif
121
122/**
123 * @}
124 */
Note: See TracBrowser for help on using the repository browser.