source: mainline/uspace/lib/ext4/libext4_superblock.h@ 9fc72fb3

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

added TODOs for comments and first part of superblock comments

  • Property mode set to 100644
File size: 10.1 KB
RevLine 
[eb91db7]1/*
[f22d5ef0]2 * Copyright (c) 2012 Frantisek Princ
[eb91db7]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 * @{
[9875711]31 */
[eb91db7]32
33#ifndef LIBEXT4_LIBEXT4_SUPERBLOCK_H_
34#define LIBEXT4_LIBEXT4_SUPERBLOCK_H_
35
[01ab41b]36#include <libblock.h>
[9875711]37#include <sys/types.h>
38
[b53a733]39#include "libext4_types.h"
[7bc4508]40
[3712434]41extern uint32_t ext4_superblock_get_inodes_count(ext4_superblock_t *);
[fe27eb4]42extern void ext4_superblock_set_inodes_count(ext4_superblock_t *, uint32_t);
[3712434]43extern uint64_t ext4_superblock_get_blocks_count(ext4_superblock_t *);
[fe27eb4]44extern void ext4_superblock_set_blocks_count(ext4_superblock_t *, uint64_t);
[3712434]45extern uint64_t ext4_superblock_get_reserved_blocks_count(ext4_superblock_t *);
[fe27eb4]46extern void ext4_superblock_set_reserved_blocks_count(ext4_superblock_t *, uint64_t);
[3712434]47extern uint64_t ext4_superblock_get_free_blocks_count(ext4_superblock_t *);
[ae3d4f8]48extern void ext4_superblock_set_free_blocks_count(ext4_superblock_t *, uint64_t);
[3712434]49extern uint32_t ext4_superblock_get_free_inodes_count(ext4_superblock_t *);
[fe27eb4]50extern void ext4_superblock_set_free_inodes_count(ext4_superblock_t *, uint32_t);
[3712434]51extern uint32_t ext4_superblock_get_first_data_block(ext4_superblock_t *);
[fe27eb4]52extern void ext4_superblock_set_first_data_block(ext4_superblock_t *, uint32_t);
[3712434]53extern uint32_t ext4_superblock_get_log_block_size(ext4_superblock_t *);
[fe27eb4]54extern void ext4_superblock_set_log_block_size(ext4_superblock_t *, uint32_t);
[01ab41b]55extern uint32_t ext4_superblock_get_block_size(ext4_superblock_t *);
[fe27eb4]56extern void ext4_superblock_set_block_size(ext4_superblock_t *, uint32_t);
[3712434]57extern uint32_t ext4_superblock_get_blocks_per_group(ext4_superblock_t *);
[fe27eb4]58extern void ext4_superblock_set_blocks_per_group(ext4_superblock_t *, uint32_t);
[3712434]59extern uint32_t ext4_superblock_get_inodes_per_group(ext4_superblock_t *);
[fe27eb4]60extern void ext4_superblock_set_inodes_per_group(ext4_superblock_t *, uint32_t);
[3712434]61extern uint32_t ext4_superblock_get_mount_time(ext4_superblock_t *);
[fe27eb4]62extern void ext4_superblock_set_mount_time(ext4_superblock_t *, uint32_t);
[3712434]63extern uint32_t ext4_superblock_get_write_time(ext4_superblock_t *);
[fe27eb4]64extern void ext4_superblock_set_write_time(ext4_superblock_t *, uint32_t);
[3712434]65extern uint16_t ext4_superblock_get_mount_count(ext4_superblock_t *);
[fe27eb4]66extern void ext4_superblock_set_mount_count(ext4_superblock_t *, uint16_t);
[3712434]67extern uint16_t ext4_superblock_get_max_mount_count(ext4_superblock_t *);
[fe27eb4]68extern void ext4_superblock_set_max_mount_count(ext4_superblock_t *, uint16_t);
[3712434]69extern uint16_t ext4_superblock_get_magic(ext4_superblock_t *);
[9fc72fb3]70extern void ext4_superblock_set_magic(ext4_superblock_t *sb, uint16_t magic);
[3712434]71extern uint16_t ext4_superblock_get_state(ext4_superblock_t *);
[fe27eb4]72extern void ext4_superblock_set_state(ext4_superblock_t *, uint16_t);
[3712434]73extern uint16_t ext4_superblock_get_errors(ext4_superblock_t *);
[fe27eb4]74extern void ext4_superblock_set_errors(ext4_superblock_t *, uint16_t);
[3712434]75extern uint16_t ext4_superblock_get_minor_rev_level(ext4_superblock_t *);
[fe27eb4]76extern void ext4_superblock_set_minor_rev_level(ext4_superblock_t *, uint16_t);
[3712434]77extern uint32_t ext4_superblock_get_last_check_time(ext4_superblock_t *);
[fe27eb4]78extern void ext4_superblock_set_last_check_time(ext4_superblock_t *, uint32_t);
[3712434]79extern uint32_t ext4_superblock_get_check_interval(ext4_superblock_t *);
[fe27eb4]80extern void ext4_superblock_set_check_interval(ext4_superblock_t *, uint32_t);
[3712434]81extern uint32_t ext4_superblock_get_creator_os(ext4_superblock_t *);
[fe27eb4]82extern void ext4_superblock_set_creator_os(ext4_superblock_t *, uint32_t);
[3712434]83extern uint32_t ext4_superblock_get_rev_level(ext4_superblock_t *);
[fe27eb4]84extern void ext4_superblock_set_rev_level(ext4_superblock_t *, uint32_t);
85extern uint16_t ext4_superblock_get_def_resuid(ext4_superblock_t *);
86extern void ext4_superblock_set_def_resuid(ext4_superblock_t *, uint16_t);
87extern uint16_t ext4_superblock_get_def_resgid(ext4_superblock_t *);
88extern void ext4_superblock_set_def_resgid(ext4_superblock_t *, uint16_t);
[3712434]89extern uint32_t ext4_superblock_get_first_inode(ext4_superblock_t *);
[fe27eb4]90extern void ext4_superblock_set_first_inode(ext4_superblock_t *, uint32_t);
[3712434]91extern uint16_t ext4_superblock_get_inode_size(ext4_superblock_t *);
[fe27eb4]92extern void ext4_superblock_set_inode_size(ext4_superblock_t *, uint16_t);
[3712434]93extern uint16_t ext4_superblock_get_block_group_number(ext4_superblock_t *);
[fe27eb4]94extern void ext4_superblock_set_block_group_number(ext4_superblock_t *, uint16_t);
[9c0c0e1]95extern uint32_t ext4_superblock_get_features_compatible(ext4_superblock_t *);
[fe27eb4]96extern void ext4_superblock_set_features_compatible(ext4_superblock_t *, uint32_t);
[9c0c0e1]97extern uint32_t ext4_superblock_get_features_incompatible(ext4_superblock_t *);
[fe27eb4]98extern void ext4_superblock_set_features_incompatible(ext4_superblock_t *, uint32_t);
[9c0c0e1]99extern uint32_t ext4_superblock_get_features_read_only(ext4_superblock_t *);
[fe27eb4]100extern void ext4_superblock_set_features_read_only(ext4_superblock_t *, uint32_t);
[01ab41b]101
[291af81]102extern const uint8_t * ext4_superblock_get_uuid(ext4_superblock_t *);
103extern void ext4_superblock_set_uuid(ext4_superblock_t *, const uint8_t *);
104extern const char * ext4_superblock_get_volume_name(ext4_superblock_t *);
105extern void ext4_superblock_set_volume_name(ext4_superblock_t *, const char *);
106extern const char * ext4_superblock_get_last_mounted(ext4_superblock_t *);
107extern void ext4_superblock_set_last_mounted(ext4_superblock_t *, const char *);
108
[3712434]109/*
110uint32_t s_algorithm_usage_bitmap; // For compression
111uint8_t s_prealloc_blocks; // Number of blocks to try to preallocate
112uint8_t s_prealloc_dir_blocks; // Number to preallocate for dirs
113uint16_t s_reserved_gdt_blocks; // Per group desc for online growth
114uint8_t s_journal_uuid[16]; // UUID of journal superblock
115uint32_t s_journal_inum; // Inode number of journal file
116uint32_t s_journal_dev; // Device number of journal file
[7bc4508]117*/
[ebcaff4]118extern uint32_t ext4_superblock_get_last_orphan(ext4_superblock_t *);
119extern void ext4_superblock_set_last_orphan(ext4_superblock_t *, uint32_t);
[7bc4508]120extern uint32_t* ext4_superblock_get_hash_seed(ext4_superblock_t *);
[7eb033ce]121extern uint8_t ext4_superblock_get_default_hash_version(ext4_superblock_t *);
122extern void ext4_superblock_set_default_hash_version(ext4_superblock_t *, uint8_t);
[7bc4508]123/*
[3712434]124uint8_t s_jnl_backup_type;
[c25e39b]125*/
126
127extern uint16_t ext4_superblock_get_desc_size(ext4_superblock_t *);
[fe27eb4]128extern void ext4_superblock_set_desc_size(ext4_superblock_t *, uint16_t);
[c25e39b]129
130/*
[3712434]131uint32_t s_default_mount_opts; // Default mount options
132uint32_t s_first_meta_bg; // First metablock block group
133uint32_t s_mkfs_time; // When the filesystem was created
134uint32_t s_jnl_blocks[17]; // Backup of the journal inode
135uint16_t s_min_extra_isize; // All inodes have at least # bytes
136uint16_t s_want_extra_isize; // New inodes should reserve # bytes
[7bc4508]137*/
138extern uint32_t ext4_superblock_get_flags(ext4_superblock_t *);
[fe27eb4]139extern void ext4_superblock_set_flags(ext4_superblock_t *, uint32_t);
[7bc4508]140/*
[3712434]141uint16_t s_raid_stride; // RAID stride
142uint16_t s_mmp_interval; // # seconds to wait in MMP checking
143uint64_t s_mmp_block; // Block for multi-mount protection
144uint32_t s_raid_stripe_width; // blocks on all data disks (N*stride)
145uint8_t s_log_groups_per_flex; // FLEX_BG group size
146uint8_t s_reserved_char_pad;
147uint16_t s_reserved_pad;
148uint64_t s_kbytes_written; // Number of lifetime kilobytes written
149uint32_t s_snapshot_inum; // Inode number of active snapshot
150uint32_t s_snapshot_id; // Sequential ID of active snapshot
151uint64_t s_snapshot_r_blocks_count; // reserved blocks for active snapshot's future use
152uint32_t s_snapshot_list; // inode number of the head of the on-disk snapshot list
153uint32_t s_error_count; // number of fs errors
154uint32_t s_first_error_time; // First time an error happened
155uint32_t s_first_error_ino; // Inode involved in first error
156uint64_t s_first_error_block; // block involved of first error
157uint8_t s_first_error_func[32]; // Function where the error happened
158uint32_t s_first_error_line; // Line number where error happened
159uint32_t s_last_error_time; // Most recent time of an error
160uint32_t s_last_error_ino; // Inode involved in last error
161uint32_t s_last_error_line; // Line number where error happened
162uint64_t s_last_error_block; // block involved of last error
163uint8_t s_last_error_func[32]; // function where the error happened
164uint8_t s_mount_opts[64];
165*/
166
167/* More complex superblock functions */
[7bc4508]168extern bool ext4_superblock_has_flag(ext4_superblock_t *, uint32_t);
[c25e39b]169extern bool ext4_superblock_has_feature_compatible(ext4_superblock_t *, uint32_t);
170extern bool ext4_superblock_has_feature_incompatible(ext4_superblock_t *, uint32_t);
171extern bool ext4_superblock_has_feature_read_only(ext4_superblock_t *, uint32_t);
[01ab41b]172extern int ext4_superblock_read_direct(service_id_t, ext4_superblock_t **);
[ae3d4f8]173extern int ext4_superblock_write_direct(service_id_t, ext4_superblock_t *);
[01ab41b]174extern int ext4_superblock_check_sanity(ext4_superblock_t *);
[eb91db7]175
[b12ca16]176extern uint32_t ext4_superblock_get_block_group_count(ext4_superblock_t *);
177extern uint32_t ext4_superblock_get_blocks_in_group(ext4_superblock_t *, uint32_t);
178extern uint32_t ext4_superblock_get_inodes_in_group(ext4_superblock_t *, uint32_t);
179
[eb91db7]180#endif
181
182/**
183 * @}
184 */
Note: See TracBrowser for help on using the repository browser.