refactor: rename lru_lock to ftable_lock for greater clarity, and update comments to reflect this

This commit is contained in:
Themis Demetriades
2024-12-06 15:31:27 +00:00
parent 4104d2c852
commit 3d6e30119b
2 changed files with 17 additions and 17 deletions

View File

@@ -40,8 +40,8 @@ struct frame_metadata
within 'frame_table', whose key is the within 'frame_table', whose key is the
kernel virtual address of the frame. */ kernel virtual address of the frame. */
struct list_elem list_elem; /* Tracks the position of the frame metadata struct list_elem list_elem; /* Tracks the position of the frame metadata
in either the 'active' or 'inactive' list, within 'lru_list', so a victim can be
so a victim can be chosen for eviction. */ chosen for eviction. */
}; };
hash_hash_func frame_metadata_hash; hash_hash_func frame_metadata_hash;
@@ -63,7 +63,7 @@ frame_init (void)
hash_init (&frame_table, frame_metadata_hash, frame_metadata_less, NULL); hash_init (&frame_table, frame_metadata_hash, frame_metadata_less, NULL);
list_init (&lru_list); list_init (&lru_list);
lock_init (&lru_lock); lock_init (&ftable_lock);
} }
/* TODO: Consider synchronisation more closely (i.e. just for hash /* TODO: Consider synchronisation more closely (i.e. just for hash
@@ -79,7 +79,7 @@ frame_alloc (enum palloc_flags flags, void *upage, struct thread *owner)
struct frame_metadata *frame_metadata; struct frame_metadata *frame_metadata;
flags |= PAL_USER; flags |= PAL_USER;
lock_acquire (&lru_lock); lock_acquire (&ftable_lock);
void *frame = palloc_get_page (flags); void *frame = palloc_get_page (flags);
/* If a frame couldn't be allocated we must be out of main memory. Thus, /* If a frame couldn't be allocated we must be out of main memory. Thus,
@@ -122,7 +122,7 @@ frame_alloc (enum palloc_flags flags, void *upage, struct thread *owner)
memset (victim->frame, 0, PGSIZE); memset (victim->frame, 0, PGSIZE);
/* 3. Indicate that the new frame's metadata will be stored /* 3. Indicate that the new frame's metadata will be stored
inside the same structure that stored the victim's metadata. inside the same structure that stored the victim's metadata.frame.c
As both the new frame and the victim frame share the same kernel As both the new frame and the victim frame share the same kernel
virtual address, the hash map need not be updated, and neither virtual address, the hash map need not be updated, and neither
the list_elem value as both share the same lru_list position. */ the list_elem value as both share the same lru_list position. */
@@ -133,7 +133,7 @@ frame_alloc (enum palloc_flags flags, void *upage, struct thread *owner)
we must update the frame table with a new entry, and grow lru_list. */ we must update the frame table with a new entry, and grow lru_list. */
else else
{ {
/* Must own lru_lock here, as otherwise there is a race condition /* Must own ftable_lock here, as otherwise there is a race condition
with next_victim either being NULL or uninitialized. */ with next_victim either being NULL or uninitialized. */
frame_metadata = malloc (sizeof (struct frame_metadata)); frame_metadata = malloc (sizeof (struct frame_metadata));
if (frame_metadata == NULL) if (frame_metadata == NULL)
@@ -165,7 +165,7 @@ frame_alloc (enum palloc_flags flags, void *upage, struct thread *owner)
list_push_back (&frame_metadata->owners, &frame_owner->elem); list_push_back (&frame_metadata->owners, &frame_owner->elem);
frame_metadata->upage = upage; frame_metadata->upage = upage;
frame_metadata->pinned = false; frame_metadata->pinned = false;
lock_release (&lru_lock); lock_release (&ftable_lock);
return frame_metadata->frame; return frame_metadata->frame;
} }
@@ -173,28 +173,28 @@ void
frame_pin (void *frame) frame_pin (void *frame)
{ {
ASSERT (frame != NULL); ASSERT (frame != NULL);
lock_acquire (&lru_lock); lock_acquire (&ftable_lock);
struct frame_metadata *frame_metadata = frame_metadata_get (frame); struct frame_metadata *frame_metadata = frame_metadata_get (frame);
if (frame_metadata == NULL) if (frame_metadata == NULL)
PANIC ("Attempted to pin a frame at an unallocated kernel address '%p'\n", PANIC ("Attempted to pin a frame at an unallocated kernel address '%p'\n",
frame); frame);
frame_metadata->pinned = true; frame_metadata->pinned = true;
lock_release (&lru_lock); lock_release (&ftable_lock);
} }
void void
frame_unpin (void *frame) frame_unpin (void *frame)
{ {
ASSERT (frame != NULL); ASSERT (frame != NULL);
lock_acquire (&lru_lock); lock_acquire (&ftable_lock);
struct frame_metadata *frame_metadata = frame_metadata_get (frame); struct frame_metadata *frame_metadata = frame_metadata_get (frame);
if (frame_metadata == NULL) if (frame_metadata == NULL)
PANIC ("Attempted to unpin a frame at an unallocated kernel address '%p'\n", PANIC ("Attempted to unpin a frame at an unallocated kernel address '%p'\n",
frame); frame);
frame_metadata->pinned = false; frame_metadata->pinned = false;
lock_release (&lru_lock); lock_release (&ftable_lock);
} }
/* Attempt to deallocate a frame for a user process by removing it from the /* Attempt to deallocate a frame for a user process by removing it from the
@@ -210,7 +210,7 @@ frame_free (void *frame)
frame); frame);
free_owners (&frame_metadata->owners); free_owners (&frame_metadata->owners);
lock_acquire (&lru_lock); lock_acquire (&ftable_lock);
hash_delete (&frame_table, &frame_metadata->hash_elem); hash_delete (&frame_table, &frame_metadata->hash_elem);
list_remove (&frame_metadata->list_elem); list_remove (&frame_metadata->list_elem);
@@ -224,7 +224,7 @@ frame_free (void *frame)
else else
next_victim = lru_next (next_victim); next_victim = lru_next (next_victim);
} }
lock_release (&lru_lock); lock_release (&ftable_lock);
free (frame_metadata); free (frame_metadata);
palloc_free_page (frame); palloc_free_page (frame);
@@ -287,9 +287,8 @@ frame_metadata_find (void *frame)
return hash_entry (e, struct frame_metadata, hash_elem); return hash_entry (e, struct frame_metadata, hash_elem);
} }
/* TODO: Account for page aliases when checking accessed bit. */
/* A pre-condition for calling this function is that the calling thread /* A pre-condition for calling this function is that the calling thread
owns lru_lock and that lru_list is non-empty. */ owns ftable_lock and that lru_list is non-empty. */
static struct frame_metadata * static struct frame_metadata *
get_victim (void) get_victim (void)
{ {

View File

@@ -11,8 +11,9 @@ struct frame_owner
}; };
/* Synchronisation variables. */ /* Synchronisation variables. */
/* Protects access to 'lru_list'. */ /* Protects access to the frame table and its related components. */
struct lock lru_lock; struct lock ftable_lock;
void frame_init (void); void frame_init (void);
void *frame_alloc (enum palloc_flags, void *, struct thread *); void *frame_alloc (enum palloc_flags, void *, struct thread *);