/*
* Copyright (c) 2022-2024, Undefine <undefine@undefine.pl>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <AK/CharacterTypes.h>
#include <AK/Time.h>
#include <Kernel/Debug.h>
#include <Kernel/FileSystem/FATFS/Inode.h>
#include <Kernel/Library/KBufferBuilder.h>
#include <Kernel/Tasks/Process.h>
namespace Kernel {
ErrorOr<NonnullRefPtr<FATInode>> FATInode::create(FATFS& fs, FATEntry entry, FATEntryLocation inode_metadata_location, Vector<FATLongFileNameEntry> const& lfn_entries)
{
auto filename = TRY(compute_filename(entry, lfn_entries));
return TRY(adopt_nonnull_ref_or_enomem(new (nothrow) FATInode(fs, entry, inode_metadata_location, move(filename))));
}
FATInode::FATInode(FATFS& fs, FATEntry entry, FATEntryLocation inode_metadata_location, NonnullOwnPtr<KString> filename)
: Inode(fs, inode_metadata_location.block.value() * (fs.logical_block_size() / sizeof(FATEntry)) + inode_metadata_location.entry)
, m_entry(entry)
, m_inode_metadata_location(inode_metadata_location)
, m_filename(move(filename))
{
dbgln_if(FAT_DEBUG, "FATInode[{}]::FATInode(): Creating inode with filename \"{}\"", identifier(), m_filename);
}
ErrorOr<RawPtr<Vector<u32>>> FATInode::get_cluster_list()
{
VERIFY(m_inode_lock.is_locked());
if (m_cluster_list.has_value())
return &m_cluster_list.value();
m_cluster_list = TRY(compute_cluster_list());
return &m_cluster_list.value();
}
ErrorOr<Vector<u32>> FATInode::compute_cluster_list()
{
VERIFY(m_inode_lock.is_locked());
u32 cluster = first_cluster();
dbgln_if(FAT_DEBUG, "FATInode::compute_cluster_list(): computing block list starting with cluster {}", cluster);
Vector<u32> cluster_list;
if (cluster <= 1) {
// Clusters 0 and 1 are reserved in the FAT, and their entries in the FAT will not
// point to another valid cluster in the chain. When we're dealing with the root
// directory, we use `cluster == 0` as a signal to read the root directory region
// blocks on FAT12/16 file systems. (`fs().first_block_of_cluster` will return the
// appropriate block/sectors to read given `cluster == 0`).
// When we're not dealing with the root directory, `cluster == 0` signals that the
// given entry has no allocated clusters, which is why we return an empty cluster
// list in that case.
if (this == &fs().root_inode())
TRY(cluster_list.try_append(cluster));
return cluster_list;
}
while (cluster < fs().end_of_chain_marker()) {
dbgln_if(FAT_DEBUG, "FATInode::compute_cluster_list(): Appending cluster {} to cluster chain", cluster);
TRY(cluster_list.try_append(cluster));
// Look up the next cluster to read, or read End of Chain marker from table.
cluster = TRY(fs().fat_read(cluster));
}
return cluster_list;
}
u8 FATInode::lfn_entry_checksum(FATEntry const& entry)
{
u8 checksum = entry.filename[0];
for (size_t i = 1; i < normal_filename_length; i++)
checksum = (checksum << 7) + (checksum >> 1) + entry.filename[i];
for (size_t i = 0; i < normal_extension_length; i++)
checksum = (checksum << 7) + (checksum >> 1) + entry.extension[i];
return checksum;
}
ErrorOr<Vector<ByteBuffer>> FATInode::collect_sfns()
{
MutexLocker locker(m_inode_lock);
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
Vector<ByteBuffer> sfns = {};
(void)TRY(traverse([&sfns](auto inode) -> ErrorOr<bool> {
auto sfn = TRY(ByteBuffer::create_uninitialized(12));
memcpy(sfn.data(), inode->m_entry.filename, 8);
sfn[8] = '.';
memcpy(sfn.data() + 9, inode->m_entry.extension, 3);
TRY(sfns.try_append(move(sfn)));
return false;
}));
return sfns;
}
ErrorOr<void> FATInode::create_unique_sfn_for(FATEntry& entry, NonnullRefPtr<SFNUtils::SFN> sfn, Vector<ByteBuffer> existing_sfns)
{
auto is_sfn_unique = [existing_sfns](SFNUtils::SFN const& sfn) -> ErrorOr<bool> {
auto serialized_name = TRY(sfn.serialize_name());
auto serialized_extension = TRY(sfn.serialize_extension());
for (auto const& current_sfn : existing_sfns) {
if (current_sfn.bytes().slice(0, 8) == serialized_name && current_sfn.bytes().slice(9, 3) == serialized_extension)
return false;
}
return true;
};
while (!TRY(is_sfn_unique(*sfn)))
++sfn->unique();
auto serialized_name = TRY(sfn->serialize_name());
auto serialized_extension = TRY(sfn->serialize_extension());
memcpy(entry.filename, serialized_name.data(), serialized_name.size());
memcpy(entry.extension, serialized_extension.data(), serialized_extension.size());
return {};
}
ErrorOr<void> FATInode::encode_known_good_sfn_for(FATEntry& entry, StringView name)
{
memset(entry.filename, ' ', 8);
memset(entry.extension, ' ', 3);
auto dot = name.find('.');
if (dot.has_value()) {
auto extension_length = name.length() - dot.value() - 1;
VERIFY(dot.value() <= 8);
VERIFY(extension_length <= 3);
memcpy(entry.filename, name.bytes().data(), dot.value());
memcpy(entry.extension, name.bytes().data() + dot.value() + 1, extension_length);
} else {
VERIFY(name.bytes().size() <= 8);
memcpy(entry.filename, name.bytes().data(), name.bytes().size());
}
return {};
}
ErrorOr<Vector<FATLongFileNameEntry>> FATInode::create_lfn_entries(StringView name, u8 checksum)
{
u32 lfn_entry_count = ceil_div(name.length(), characters_per_lfn_entry);
Vector<FATLongFileNameEntry> lfn_entries;
TRY(lfn_entries.try_ensure_capacity(lfn_entry_count));
auto characters_left = name.length();
for (u32 i = 0; i < lfn_entry_count; i++) {
FATLongFileNameEntry lfn_entry {};
size_t characters_in_part = min(characters_left, lfn_entry_characters_part_1_length);
for (size_t j = 0; j < characters_in_part; j++) {
lfn_entry.characters1[j] = name[name.length() - characters_left];
characters_left--;
}
if (characters_left > 0) {
characters_in_part = min(characters_left, lfn_entry_characters_part_2_length);
for (size_t j = 0; j < characters_in_part; j++) {
lfn_entry.characters2[j] = name[name.length() - characters_left];
characters_left--;
}
}
if (characters_left > 0) {
characters_in_part = min(characters_left, lfn_entry_characters_part_3_length);
for (size_t j = 0; j < characters_in_part; j++) {
lfn_entry.characters3[j] = name[name.length() - characters_left];
characters_left--;
}
}
lfn_entry.entry_index = (i + 1) | (i + 1 == lfn_entry_count ? last_lfn_entry_mask : 0);
lfn_entry.checksum = checksum;
lfn_entry.attributes = FATAttributes::LongFileName;
lfn_entries.unchecked_append(lfn_entry);
}
return lfn_entries;
}
ErrorOr<Vector<BlockBasedFileSystem::BlockIndex>> FATInode::get_block_list()
{
VERIFY(m_inode_lock.is_locked());
dbgln_if(FAT_DEBUG, "FATInode[{}]::get_block_list(): getting block list", identifier());
Vector<BlockBasedFileSystem::BlockIndex> block_list;
auto cluster_list = TRY(get_cluster_list());
for (auto cluster : *cluster_list) {
auto span = fs().first_block_of_cluster(cluster);
for (size_t i = 0; i < span.number_of_sectors; i++) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::get_block_list(): Appending block {} to block list", identifier(), BlockBasedFileSystem::BlockIndex { span.start_block.value() + i });
TRY(block_list.try_append(BlockBasedFileSystem::BlockIndex { span.start_block.value() + i }));
}
}
return block_list;
}
ErrorOr<NonnullOwnPtr<KBuffer>> FATInode::read_block_list()
{
VERIFY(m_inode_lock.is_locked());
auto block_list = TRY(get_block_list());
dbgln_if(FAT_DEBUG, "FATInode[{}]::read_block_list(): reading block list ({} blocks)", identifier(), block_list.size());
auto builder = TRY(KBufferBuilder::try_create());
u8 buffer[512];
VERIFY(fs().m_device_block_size <= sizeof(buffer));
auto buf = UserOrKernelBuffer::for_kernel_buffer(buffer);
for (BlockBasedFileSystem::BlockIndex block : block_list) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::read_block_list(): reading block: {}", identifier(), block);
TRY(fs().read_block(block, &buf, sizeof(buffer)));
TRY(builder.append((char const*)buffer, fs().m_device_block_size));
}
auto blocks = builder.build();
if (!blocks)
return ENOMEM;
return blocks.release_nonnull();
}
ErrorOr<RefPtr<FATInode>> FATInode::traverse(Function<ErrorOr<bool>(RefPtr<FATInode>)> callback)
{
VERIFY(m_inode_lock.is_locked());
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
Vector<FATLongFileNameEntry> lfn_entries;
auto blocks = TRY(read_block_list());
u32 bytes_per_cluster = fs().m_device_block_size * fs().m_parameter_block->common_bpb()->sectors_per_cluster;
for (u32 i = 0; i < blocks->size() / sizeof(FATEntry); i++) {
auto* entry = reinterpret_cast<FATEntry*>(blocks->data() + i * sizeof(FATEntry));
if (entry->filename[0] == end_entry_byte) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::traverse(): Found end entry", identifier());
return nullptr;
} else if (static_cast<u8>(entry->filename[0]) == unused_entry_byte) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::traverse(): Found unused entry", identifier());
lfn_entries.clear();
} else if (entry->attributes == FATAttributes::LongFileName) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::traverse(): Found LFN entry", identifier());
TRY(lfn_entries.try_append(*reinterpret_cast<FATLongFileNameEntry*>(entry)));
} else if ((entry->first_cluster_high << 16 | entry->first_cluster_low) <= 1 && entry->file_size > 0) {
// Because clusters 0 and 1 are reserved, only empty files (size == 0 files)
// should specify these clusters.
// This driver uses a cluster number == 0 to represent the root directory inode
// on FAT12/16 file systems (a signal to look in the root directory region),
// so we ensure that no entries read off the file system have a cluster number
// that would also point to this region.
dbgln_if(FAT_DEBUG, "FATInode[{}]::traverse(): Invalid cluster for entry", identifier());
return EINVAL;
} else {
auto entry_number_bytes = i * sizeof(FATEntry);
auto cluster_list = TRY(get_cluster_list());
auto cluster = (*cluster_list)[entry_number_bytes / bytes_per_cluster];
auto block = BlockBasedFileSystem::BlockIndex { fs().first_block_of_cluster(cluster).start_block.value() + (entry_number_bytes % bytes_per_cluster) / fs().m_device_block_size };
auto entries_per_sector = fs().m_device_block_size / sizeof(FATEntry);
u32 block_entry = i % entries_per_sector;
dbgln_if(FAT_DEBUG, "FATInode[{}]::traverse(): Found 8.3 entry at block {}, entry {}", identifier(), block, block_entry);
lfn_entries.reverse();
auto inode = TRY(FATInode::create(fs(), *entry, { block, block_entry }, lfn_entries));
if (TRY(callback(inode)))
return inode;
lfn_entries.clear();
}
}
return EINVAL;
}
ErrorOr<NonnullOwnPtr<KString>> FATInode::compute_filename(FATEntry& entry, Vector<FATLongFileNameEntry> const& lfn_entries)
{
if (lfn_entries.is_empty()) {
StringBuilder filename;
TRY(filename.try_append(byte_terminated_string(StringView(entry.filename, normal_filename_length), ' ')));
if (entry.extension[0] != ' ') {
TRY(filename.try_append('.'));
TRY(filename.try_append(byte_terminated_string(StringView(entry.extension, normal_extension_length), ' ')));
}
return TRY(KString::try_create(filename.string_view()));
} else {
StringBuilder filename;
for (auto& lfn_entry : lfn_entries) {
TRY(filename.try_append(lfn_entry.characters1[0]));
TRY(filename.try_append(lfn_entry.characters1[1]));
TRY(filename.try_append(lfn_entry.characters1[2]));
TRY(filename.try_append(lfn_entry.characters1[3]));
TRY(filename.try_append(lfn_entry.characters1[4]));
TRY(filename.try_append(lfn_entry.characters2[0]));
TRY(filename.try_append(lfn_entry.characters2[1]));
TRY(filename.try_append(lfn_entry.characters2[2]));
TRY(filename.try_append(lfn_entry.characters2[3]));
TRY(filename.try_append(lfn_entry.characters2[4]));
TRY(filename.try_append(lfn_entry.characters2[5]));
TRY(filename.try_append(lfn_entry.characters3[0]));
TRY(filename.try_append(lfn_entry.characters3[1]));
}
// Long Filenames have two terminators:
// 1. Completely unused "entries" (the `characterN` fields of
// `lfn_entry`) are filled with 0xFF (`lfn_entry_unused_byte`).
// 2. Partially used entries (within `characterN`) are null-padded.
//
// `filename` is truncated first to eliminate unused entries, and
// then further truncated to remove any existing null padding characters.
//
// Page 8 of the Long Filename Specification
// (http://www.osdever.net/documents/LongFileName.pdf)
// details this encoding ("If the long name does not fill...").
return TRY(KString::try_create(
byte_terminated_string(
byte_terminated_string(filename.string_view(), lfn_entry_unused_byte), lfn_entry_character_termination)));
}
VERIFY_NOT_REACHED();
}
StringView FATInode::byte_terminated_string(StringView string, u8 fill_byte)
{
if (auto index = string.find_last_not(fill_byte); index.has_value())
return string.substring_view(0, index.value() + 1);
return string;
}
u32 FATInode::first_cluster() const
{
VERIFY(m_inode_lock.is_locked());
if (fs().m_fat_version == FATVersion::FAT32) {
return (static_cast<u32>(m_entry.first_cluster_high) << 16) | m_entry.first_cluster_low;
}
// The space occupied in a directory entry by `first_cluster_high` (0x14)
// is reserved in FAT12/16, and may be used to store file meta-data.
// As a result, do not include it on FAT12/16 file systems.
return m_entry.first_cluster_low;
}
ErrorOr<void> FATInode::allocate_and_add_cluster_to_chain()
{
VERIFY(m_inode_lock.is_locked());
u32 allocated_cluster = TRY(fs().allocate_cluster());
dbgln_if(FAT_DEBUG, "FATInode[{}]::allocate_and_add_cluster_to_chain(): allocated cluster {}", identifier(), allocated_cluster);
auto cluster_list = TRY(get_cluster_list());
if (cluster_list->is_empty() || (cluster_list->size() == 1 && first_cluster() <= 1)) {
// This is the first cluster in the chain, so update the inode metadata.
if (fs().m_fat_version == FATVersion::FAT32) {
// Only FAT32 uses the `first_cluster_high` field.
m_entry.first_cluster_high = allocated_cluster >> 16;
}
m_entry.first_cluster_low = allocated_cluster & 0xFFFF;
set_metadata_dirty(true);
} else {
// This is not the first cluster in the chain, so we need to update the
// FAT entry for the last cluster in the chain to point to the newly
// allocated cluster.
TRY(fs().fat_write(cluster_list->last(), allocated_cluster));
}
cluster_list->append(allocated_cluster);
return {};
}
ErrorOr<void> FATInode::remove_last_cluster_from_chain()
{
VERIFY(m_inode_lock.is_locked());
auto cluster_list = TRY(get_cluster_list());
VERIFY(cluster_list->size() > 0);
u32 last_cluster = cluster_list->take_last();
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_last_cluster_from_chain(): freeing cluster {}", identifier(), last_cluster);
TRY(fs().fat_write(last_cluster, 0));
TRY(fs().notify_cluster_freed(last_cluster));
if (cluster_list->is_empty() || (cluster_list->size() == 1 && first_cluster() <= 1)) {
// We have removed the last cluster in the chain, so update the inode metadata.
if (fs().m_fat_version == FATVersion::FAT32) {
// Only FAT32 uses the `first_cluster_high` field.
m_entry.first_cluster_high = 0;
}
m_entry.first_cluster_low = 0;
set_metadata_dirty(true);
} else {
// We have removed a cluster from the chain, so update the FAT entry for
// the last cluster in the chain mark it as the end of the chain.
last_cluster = cluster_list->last();
TRY(fs().fat_write(last_cluster, fs().end_of_chain_marker()));
}
return {};
}
ErrorOr<Vector<FATEntryLocation>> FATInode::allocate_entries(u32 count)
{
// FIXME: This function ignores unused entries, we should make use of them
// FIXME: If we fail anywhere here, we should make sure the end entry is at the correct location
VERIFY(m_inode_lock.is_locked());
auto blocks = TRY(read_block_list());
auto entries = bit_cast<FATEntry*>(blocks->data());
auto const entries_per_block = fs().logical_block_size() / sizeof(FATEntry);
auto block_list = TRY(get_block_list());
Vector<FATEntryLocation> locations;
TRY(locations.try_ensure_capacity(count));
for (u32 current_entry_index = 0; current_entry_index < blocks->size() / sizeof(FATEntry); current_entry_index++) {
auto& entry = entries[current_entry_index];
if (entry.filename[0] != end_entry_byte)
continue;
while (current_entry_index < blocks->size() / sizeof(FATEntry) && locations.size() < count) {
u32 chosen_block_index = current_entry_index / entries_per_block;
u32 chosen_entry_index = current_entry_index % entries_per_block;
locations.unchecked_append({ block_list[chosen_block_index], chosen_entry_index });
dbgln_if(FAT_DEBUG, "FATInode[{}]::allocate_entries(): allocated new entry at block {}, offset {}", identifier(), block_list[chosen_block_index], chosen_entry_index);
current_entry_index++;
}
if (locations.size() == count) {
u32 block_index = current_entry_index / entries_per_block;
u32 entry_index = current_entry_index % entries_per_block;
dbgln_if(FAT_DEBUG, "FATInode[{}]::allocate_entries(): putting new end entry at block {}, offset {}", identifier(), block_list[block_index], entry_index);
FATEntry end_entry {};
end_entry.filename[0] = end_entry_byte;
TRY(fs().write_block(block_list[block_index], UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&end_entry)), sizeof(FATEntry), entry_index * sizeof(FATEntry)));
break;
}
}
if (locations.size() < count) {
VERIFY(count - locations.size() <= entries_per_block);
u32 new_block_index = block_list.size();
TRY(allocate_and_add_cluster_to_chain());
block_list = TRY(get_block_list());
u32 entry_index;
for (entry_index = 0; entry_index <= count - locations.size(); entry_index++) {
locations.unchecked_append({ block_list[new_block_index], entry_index });
dbgln_if(FAT_DEBUG, "FATInode[{}]::allocate_entries(): allocated new entry at block {}, offset {}", identifier(), block_list[new_block_index], entry_index);
}
dbgln_if(FAT_DEBUG, "FATInode[{}]::allocate_entries(): putting new end entry at block {}, offset {}", identifier(), block_list[new_block_index], entry_index);
FATEntry end_entry {};
end_entry.filename[0] = end_entry_byte;
TRY(fs().write_block(block_list[new_block_index], UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&end_entry)), sizeof(FATEntry), entry_index * sizeof(FATEntry)));
}
VERIFY(locations.size() == count);
return locations;
}
ErrorOr<size_t> FATInode::read_bytes_locked(off_t offset, size_t count, UserOrKernelBuffer& buffer, OpenFileDescription*) const
{
VERIFY(m_inode_lock.is_locked());
VERIFY(offset >= 0);
if (offset >= m_entry.file_size)
return 0;
auto block_list = TRY(const_cast<FATInode&>(*this).get_block_list());
off_t size = min(static_cast<off_t>(count), static_cast<off_t>(m_entry.file_size) - offset);
if (size < 0)
return 0;
dbgln_if(FAT_DEBUG, "FATInode[{}]::read_bytes_locked(): Reading {} bytes at offset {}", identifier(), size, offset);
u32 first_block_index = offset / fs().m_device_block_size;
u32 last_block_index = (offset + size - 1) / fs().m_device_block_size;
size_t offset_into_first_block = offset - first_block_index * fs().m_device_block_size;
size_t nread = 0;
off_t remaining_count = size;
for (u32 block_index = first_block_index; block_index <= last_block_index; ++block_index) {
size_t offset_into_block = block_index == first_block_index ? offset_into_first_block : 0;
size_t to_read = min(fs().m_device_block_size - offset_into_block, remaining_count);
auto buffer_offset = buffer.offset(nread);
dbgln_if(FAT_DEBUG, "FATInode[{}]::read_bytes_locked(): Reading {} byte(s) from block {} at offset {}", identifier(), to_read, block_list[block_index], offset_into_block);
TRY(fs().read_block(block_list[block_index], &buffer_offset, to_read, offset_into_block));
nread += to_read;
remaining_count -= to_read;
}
return size;
}
InodeMetadata FATInode::metadata() const
{
MutexLocker locker(m_inode_lock);
auto cluster_count = ceil_div(static_cast<u64>(m_entry.file_size), fs().m_device_block_size * fs().m_parameter_block->common_bpb()->sectors_per_cluster);
return {
.inode = identifier(),
.size = m_entry.file_size,
// FIXME: Linux also removes the write permission if the file has the read only attribute set.
.mode = static_cast<mode_t>((has_flag(m_entry.attributes, FATAttributes::Directory) ? S_IFDIR : S_IFREG) | 0777),
.uid = 0,
.gid = 0,
.link_count = 0,
.atime = time_from_packed_dos(m_entry.last_accessed_date, { 0 }),
.ctime = time_from_packed_dos(m_entry.creation_date, m_entry.creation_time) + Duration::from_milliseconds(m_entry.creation_time_seconds * 10),
.mtime = time_from_packed_dos(m_entry.modification_date, m_entry.modification_time),
.dtime = {},
.block_count = cluster_count * fs().m_parameter_block->common_bpb()->sectors_per_cluster,
.block_size = fs().m_device_block_size,
.major_device = 0,
.minor_device = 0,
};
}
ErrorOr<void> FATInode::traverse_as_directory(Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)> callback) const
{
MutexLocker locker(m_inode_lock);
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
[[maybe_unused]] auto inode = TRY(const_cast<FATInode&>(*this).traverse([&callback](auto inode) -> ErrorOr<bool> {
TRY(callback({ inode->m_filename->view(), inode->identifier(), static_cast<u8>(inode->m_entry.attributes) }));
return false;
}));
return {};
}
ErrorOr<NonnullRefPtr<Inode>> FATInode::lookup(StringView name)
{
MutexLocker locker(m_inode_lock);
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
auto inode = TRY(traverse([name](auto child) -> ErrorOr<bool> {
return child->m_filename->view().equals_ignoring_ascii_case(name);
}));
if (inode.is_null())
return ENOENT;
return inode.release_nonnull();
}
ErrorOr<size_t> FATInode::write_bytes_locked(off_t offset, size_t size, UserOrKernelBuffer const& buffer, OpenFileDescription*)
{
VERIFY(m_inode_lock.is_locked());
dbgln_if(FAT_DEBUG, "FATInode[{}]::write_bytes_locked(): Writing size: {} offset: {}", identifier(), size, offset);
u32 new_size = max(m_entry.file_size, offset + size);
if (new_size != m_entry.file_size) {
Optional<u64> clear_from;
Optional<u64> to_clear;
if (offset > m_entry.file_size) {
clear_from = static_cast<u64>(m_entry.file_size);
to_clear = offset - m_entry.file_size;
}
TRY(resize(new_size, clear_from, to_clear));
}
auto block_list = TRY(get_block_list());
u32 first_block_index = offset / fs().m_device_block_size;
u32 last_block_index = (offset + size - 1) / fs().m_device_block_size;
size_t offset_into_first_block = offset - first_block_index * fs().m_device_block_size;
size_t nwritten = 0;
size_t remaining_count = size;
for (u32 block_index = first_block_index; block_index <= last_block_index; ++block_index) {
size_t offset_into_block = block_index == first_block_index ? offset_into_first_block : 0;
size_t to_write = min(fs().m_device_block_size - offset_into_block, remaining_count);
dbgln_if(FAT_DEBUG, "FATInode[{}]::write_bytes_locked(): Writing {} byte(s) to block {} at offset {}", identifier(), to_write, block_list[block_index], offset_into_block);
TRY(fs().write_block(block_list[block_index], buffer.offset(nwritten), to_write, offset_into_block));
nwritten += to_write;
remaining_count -= to_write;
}
return size;
}
ErrorOr<void> FATInode::fill_in_creation_time(FATEntry& entry, UnixDateTime const& timestamp)
{
auto packed_date = TRY(to_packed_dos_date(timestamp));
auto packed_time = TRY(to_packed_dos_time(timestamp));
entry.creation_date = move(packed_date);
entry.creation_time = move(packed_time);
// NOTE: The "creation_time_seconds" field not only compensates for the fact that seconds are counted in intervals of two,
// it also adds in rudimentary support for millisecond precision, though this is limited to only two digits.
auto day_start_precision = days_since_epoch(entry.creation_date.year + AK::first_dos_year, entry.creation_date.month, entry.creation_date.day) * 86'400;
auto day_precision = entry.creation_time.hour * 60 * 60 + entry.creation_time.minute * 60 + entry.creation_time.second * 2;
entry.creation_time_seconds = (timestamp.truncated_milliseconds_since_epoch() - day_start_precision * 1000 - day_precision * 1000) / 10;
VERIFY(entry.creation_time_seconds < 200);
return {};
}
ErrorOr<NonnullRefPtr<Inode>> FATInode::create_child(StringView name, mode_t mode, dev_t, UserID, GroupID)
{
MutexLocker locker(m_inode_lock);
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
dbgln_if(FAT_DEBUG, "FATInode[{}]::create_child(): creating inode \"{}\"", identifier(), name);
if (!Kernel::is_directory(mode) && !Kernel::is_regular_file(mode))
return ENOTSUP;
FATEntry entry {};
bool valid_sfn = SFNUtils::is_valid_sfn(name);
if (valid_sfn) {
TRY(encode_known_good_sfn_for(entry, name));
} else {
auto sfn = TRY(SFNUtils::create_sfn_from_lfn(name));
auto existing_sfns = TRY(collect_sfns());
TRY(create_unique_sfn_for(entry, move(sfn), move(existing_sfns)));
}
// TODO: We should set the hidden attribute if the file starts with a dot or read only (the same way Linux does this).
if (mode & S_IFDIR)
entry.attributes |= FATAttributes::Directory;
auto now = kgettimeofday();
if (auto error_or_void = fill_in_creation_time(entry, now); !error_or_void.is_error()) {
entry.modification_date = entry.creation_date;
entry.modification_time = entry.creation_time;
entry.last_accessed_date = entry.creation_date;
}
Vector<FATLongFileNameEntry> lfn_entries = {};
if (!valid_sfn)
lfn_entries = TRY(create_lfn_entries(name, lfn_entry_checksum(entry)));
auto entries = TRY(allocate_entries(lfn_entries.size() + 1));
if (mode & S_IFDIR) {
u32 allocated_cluster = TRY(fs().allocate_cluster());
if (fs().m_fat_version == FATVersion::FAT32)
entry.first_cluster_high = allocated_cluster >> 16;
entry.first_cluster_low = allocated_cluster & 0xFFFF;
// This is used for generating a directory's "." and ".." entries.
auto create_directory_entry = [&](StringView entry_name) {
VERIFY(entry_name.length() <= 8);
FATEntry directory_entry {};
memset(directory_entry.filename, ' ', 8);
memset(directory_entry.extension, ' ', 3);
for (size_t i = 0; i < entry_name.length(); ++i)
directory_entry.filename[i] = entry_name[i];
directory_entry.attributes |= FATAttributes::Directory;
return directory_entry;
};
FATEntry current_directory = create_directory_entry("."sv);
current_directory.first_cluster_low = entry.first_cluster_low;
if (fs().m_fat_version == FATVersion::FAT32)
current_directory.first_cluster_high = entry.first_cluster_high;
FATEntry parent_directory = create_directory_entry(".."sv);
// NOTE: While setting the first cluster of the ".." entry to that of the current entry
// is _usually_ the right thing to do, we're actually supposed to set it to 0 if we are
// dealing with the root directory. This isn't an issue when dealing with FAT12 or FAT16,
// since the root directory's first cluster is always 0, but it's something to account for
// when working with FAT32.
switch (fs().m_fat_version) {
case FATVersion::FAT12:
case FATVersion::FAT16:
parent_directory.first_cluster_low = m_entry.first_cluster_low;
break;
case FATVersion::FAT32:
if (this != &fs().root_inode()) {
parent_directory.first_cluster_low = m_entry.first_cluster_low;
parent_directory.first_cluster_high = m_entry.first_cluster_high;
}
break;
}
auto block = BlockBasedFileSystem::BlockIndex { fs().first_block_of_cluster(allocated_cluster).start_block.value() };
TRY(fs().write_block(block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(¤t_directory)), sizeof(FATEntry), 0));
TRY(fs().write_block(block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&parent_directory)), sizeof(FATEntry), sizeof(FATEntry)));
}
// FIXME: If we fail here we should clean up the entries we wrote
TRY(fs().write_block(entries[lfn_entries.size()].block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&entry)), sizeof(FATEntry), entries[lfn_entries.size()].entry * sizeof(FATEntry)));
for (u32 i = 0; i < lfn_entries.size(); i++) {
auto location = entries[lfn_entries.size() - i - 1];
TRY(fs().write_block(location.block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&lfn_entries[i])), sizeof(FATLongFileNameEntry), location.entry * sizeof(FATLongFileNameEntry)));
}
return TRY(FATInode::create(fs(), entry, entries[lfn_entries.size()], lfn_entries));
}
ErrorOr<void> FATInode::add_child(Inode&, StringView, mode_t)
{
return ENOTSUP;
}
ErrorOr<void> FATInode::remove_child_impl(StringView name, FreeClusters free_clusters)
{
MutexLocker locker(m_inode_lock);
VERIFY(has_flag(m_entry.attributes, FATAttributes::Directory));
Vector<FATLongFileNameEntry> lfn_entries;
TRY(lfn_entries.try_ensure_capacity(ceil_div(max_filename_length, characters_per_lfn_entry)));
Vector<FATEntryLocation> lfn_entry_locations;
TRY(lfn_entry_locations.try_ensure_capacity(ceil_div(max_filename_length, characters_per_lfn_entry)));
auto block_list = TRY(get_block_list());
auto block_buffer = TRY(read_block_list());
for (u32 i = 0; i < block_buffer->size() / sizeof(FATEntry); i++) {
auto* entry = bit_cast<FATEntry*>(block_buffer->data() + i * sizeof(FATEntry));
auto entry_number_bytes = i * sizeof(FATEntry);
auto block = block_list[entry_number_bytes / fs().logical_block_size()];
auto entries_per_sector = fs().logical_block_size() / sizeof(FATEntry);
u32 block_entry = i % entries_per_sector;
if (entry->filename[0] == end_entry_byte) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_child(): Found end entry", identifier());
return ENOENT;
} else if (static_cast<u8>(entry->filename[0]) == unused_entry_byte) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_child(): Found unused entry", identifier());
lfn_entries.clear_with_capacity();
lfn_entry_locations.clear_with_capacity();
} else if (entry->attributes == FATAttributes::LongFileName) {
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_child(): Found LFN entry", identifier());
lfn_entries.unchecked_append(*bit_cast<FATLongFileNameEntry*>(entry));
lfn_entry_locations.unchecked_append({ block, block_entry });
} else {
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_child(): Found 8.3 entry at block {}, entry {}", identifier(), block, block_entry);
lfn_entries.reverse();
auto filename = TRY(compute_filename(*entry, lfn_entries));
if (filename->view() == name) {
// FIXME: If it's the last entry move the end entry instead of unused entries
FATEntry unused_entry {};
unused_entry.filename[0] = unused_entry_byte;
TRY(fs().write_block(block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&unused_entry)), sizeof(FATEntry), block_entry * sizeof(FATEntry)));
for (auto const& lfn_entry_location : lfn_entry_locations)
TRY(fs().write_block(lfn_entry_location.block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&unused_entry)), sizeof(FATEntry), lfn_entry_location.entry * sizeof(FATEntry)));
u32 entry_first_cluster = entry->first_cluster_low;
if (fs().m_fat_version == FATVersion::FAT32)
entry_first_cluster |= (static_cast<u32>(entry->first_cluster_high) << 16);
// Note that it isn't valid to set the first cluster to an end of chain marker,
// so if we do find an entry that does that, we just skip freeing any clusters
// to avoid doing needless damage.
if (name == "."sv || name == ".."sv || free_clusters == FreeClusters::No || entry_first_cluster <= 1 || entry_first_cluster >= fs().end_of_chain_marker())
return {};
u32 cluster = entry_first_cluster;
u32 clusters_read = 0;
while (cluster < fs().end_of_chain_marker()) {
u32 current_cluster = cluster;
cluster = TRY(fs().fat_read(cluster));
TRY(fs().fat_write(current_cluster, 0));
++clusters_read;
}
TRY(fs().notify_clusters_freed(entry_first_cluster, clusters_read));
return {};
}
lfn_entries.clear_with_capacity();
lfn_entry_locations.clear_with_capacity();
}
}
return EINVAL;
}
ErrorOr<void> FATInode::remove_child(StringView name)
{
dbgln_if(FAT_DEBUG, "FATInode[{}]::remove_child(): removing inode \"{}\"", identifier(), name);
return remove_child_impl(name, FreeClusters::Yes);
}
ErrorOr<void> FATInode::chmod(mode_t)
{
// TODO: Linux actually does do some stuff here, like setting the hidden attribute if the file starts with a dot.
return Error::from_errno(ENOTSUP);
}
ErrorOr<void> FATInode::chown(UserID, GroupID)
{
return Error::from_errno(ENOTSUP);
}
ErrorOr<void> FATInode::zero_data(u64 offset, u64 count)
{
VERIFY(m_inode_lock.is_locked());
Vector<u8> zero_buffer;
TRY(zero_buffer.try_resize(fs().m_device_block_size));
auto block_list = TRY(get_block_list());
u32 first_block_index = offset / fs().m_device_block_size;
u32 last_block_index = (offset + count - 1) / fs().m_device_block_size;
size_t offset_into_first_block = offset - first_block_index * fs().m_device_block_size;
size_t remaining_count = count;
for (u32 block_index = first_block_index; block_index <= last_block_index; ++block_index) {
size_t offset_into_block = block_index == first_block_index ? offset_into_first_block : 0;
size_t to_write = min(fs().m_device_block_size - offset_into_block, remaining_count);
dbgln_if(FAT_DEBUG, "FATInode[{}]::zero_data(): Writing {} byte(s) to block {} at offset {}", identifier(), to_write, block_list[block_index], offset_into_block);
TRY(fs().write_block(block_list[block_index], UserOrKernelBuffer::for_kernel_buffer(zero_buffer.data()), to_write, offset_into_block));
remaining_count -= to_write;
}
return {};
}
ErrorOr<void> FATInode::resize(u64 size, Optional<u64> clear_from, Optional<u64> to_clear)
{
VERIFY(m_inode_lock.is_locked());
VERIFY(size != m_entry.file_size);
auto cluster_list = TRY(get_cluster_list());
u64 bytes_per_cluster = fs().m_device_block_size * fs().m_parameter_block->common_bpb()->sectors_per_cluster;
u64 size_rounded_up_to_bytes_per_cluster = size;
if (size == 0)
size_rounded_up_to_bytes_per_cluster = bytes_per_cluster;
else if (size % bytes_per_cluster != 0)
size_rounded_up_to_bytes_per_cluster = (size + bytes_per_cluster) - (size % bytes_per_cluster);
if (size > m_entry.file_size) {
while (cluster_list->size() * bytes_per_cluster < size_rounded_up_to_bytes_per_cluster)
TRY(allocate_and_add_cluster_to_chain());
} else {
while (cluster_list->size() * bytes_per_cluster > size_rounded_up_to_bytes_per_cluster)
TRY(remove_last_cluster_from_chain());
}
m_entry.file_size = size;
set_metadata_dirty(true);
if (clear_from.has_value() && to_clear.has_value())
TRY(zero_data(*clear_from, *to_clear));
return {};
}
ErrorOr<void> FATInode::truncate_locked(u64 size)
{
VERIFY(m_inode_lock.is_locked());
if (m_entry.file_size == size)
return {};
dbgln_if(FAT_DEBUG, "FATInode[{}]::truncate_locked(): truncating to {}", identifier(), size);
Optional<u64> clear_from;
Optional<u64> to_clear;
if (size > m_entry.file_size) {
clear_from = static_cast<u64>(m_entry.file_size);
to_clear = size - m_entry.file_size;
}
TRY(resize(size, clear_from, to_clear));
return {};
}
ErrorOr<void> FATInode::flush_metadata()
{
MutexLocker locker(m_inode_lock);
if (m_inode_metadata_location.block == 0)
return {};
dbgln_if(FAT_DEBUG, "FATInode[{}]::flush_metadata(): Writing entry at block {}, entry {} (size: {}, cluster_low: {}, cluster_high: {})", identifier().index(), m_inode_metadata_location.block, m_inode_metadata_location.entry, m_entry.file_size, m_entry.first_cluster_low, m_entry.first_cluster_high);
TRY(fs().write_block(m_inode_metadata_location.block, UserOrKernelBuffer::for_kernel_buffer(bit_cast<u8*>(&m_entry)), sizeof(FATEntry), m_inode_metadata_location.entry * sizeof(FATEntry)));
set_metadata_dirty(false);
return {};
}
ErrorOr<void> FATInode::update_timestamps(Optional<UnixDateTime> atime, Optional<UnixDateTime> ctime, Optional<UnixDateTime> mtime)
{
MutexLocker locker(m_inode_lock);
Optional<DOSPackedDate> packed_last_accessed_date;
Optional<DOSPackedDate> packed_modified_date;
Optional<DOSPackedTime> packed_modified_time;
if (atime.has_value())
packed_last_accessed_date = TRY(to_packed_dos_date(atime.value()));
if (mtime.has_value()) {
packed_modified_date = TRY(to_packed_dos_date(mtime.value()));
packed_modified_time = TRY(to_packed_dos_time(mtime.value()));
}
// NOTE: This is initialized after we've parsed everything else
// to ensure that no changes will be made if we fail to parse
// any of the arguments.
if (ctime.has_value())
TRY(fill_in_creation_time(m_entry, ctime.value()));
if (atime.has_value())
m_entry.last_accessed_date = packed_last_accessed_date.release_value();
if (mtime.has_value()) {
m_entry.modification_date = packed_modified_date.release_value();
m_entry.modification_time = packed_modified_time.release_value();
}
return {};
}
}
