From f81bf65484fa8c81a1886f456c71f1e6eebe84e9 Mon Sep 17 00:00:00 2001
From: Alexis211 <alexis211@gmail.com>
Date: Tue, 10 Aug 2010 20:39:57 +0200
Subject: Added a lot of comments in kernel code. A bit of cleaning too.

---
 src/kernel/ipc/shm.c | 16 ++++++++++++++++
 src/kernel/ipc/shm.h |  5 -----
 2 files changed, 16 insertions(+), 5 deletions(-)

(limited to 'src/kernel/ipc')

diff --git a/src/kernel/ipc/shm.c b/src/kernel/ipc/shm.c
index e760a0f..6e48613 100644
--- a/src/kernel/ipc/shm.c
+++ b/src/kernel/ipc/shm.c
@@ -4,6 +4,13 @@
 #include <task/task.h>
 #include <core/sys.h>
 
+static struct segment_map* shmseg_map(struct segment* seg, struct page_directory *pagedir, size_t offset);
+static void shmseg_unmap(struct segment_map*);
+static void shmseg_delete(struct segment *seg);
+static int shmseg_handleFault(struct segment_map *map, size_t addr, int write);
+
+/*	Call this function when creating a new shared memory segment.
+	Creates the shmseg struct and segment struct, fills them in. */
 struct segment* shmseg_make(size_t len, struct process* owner) {
 	struct shmseg *ss = kmalloc(sizeof(struct shmseg));
 	struct segment *se = kmalloc(sizeof(struct segment));
@@ -21,6 +28,8 @@ struct segment* shmseg_make(size_t len, struct process* owner) {
 	return se;
 }
 
+/*	For internal use only. Called when the shared memory is mapped somewhere.
+	Creates the segment_map struct and fills it up. */
 struct segment_map *shmseg_map(struct segment *seg, struct page_directory *pagedir, size_t offset) {
 	struct segment_map *sm = kmalloc(sizeof(struct segment_map));
 	sm->start = offset;
@@ -28,6 +37,8 @@ struct segment_map *shmseg_map(struct segment *seg, struct page_directory *paged
 	return sm;
 }
 
+/*	For internal use only. Called when the shared memory is unmapped from somewhere.
+	Unmaps all the pages from that place. */
 void shmseg_unmap(struct segment_map *sm) {
 	size_t i;
 	for (i = 0; i < sm->len; i += 0x1000) {
@@ -36,6 +47,8 @@ void shmseg_unmap(struct segment_map *sm) {
 	}
 }
 
+/*	For internal use only. Called when a page fault occurs.
+	Maps a page at that place, possibly requesting a free frame first. */
 int shmseg_handleFault(struct segment_map *sm, size_t addr, int write) {
 	struct shmseg *ss = sm->seg->seg_data;
 	addr &= 0xFFFFF000;
@@ -49,6 +62,8 @@ int shmseg_handleFault(struct segment_map *sm, size_t addr, int write) {
 	return 0;
 }
 
+/*	For internal use only. Called when the shared memory is deleted.
+	Frees all the frames. */
 void shmseg_delete(struct segment *seg) {
 	struct shmseg *ss = seg->seg_data;
 	unsigned i;
@@ -58,6 +73,7 @@ void shmseg_delete(struct segment *seg) {
 	kfree(ss->frames);
 }
 
+/*	Looks through the mapped segment for a process, looking for a shared memory segment at given offset. */
 struct segment_map* shmseg_getByOff(struct process* pr, size_t offset) {
 	struct segment_map* m = pr->pagedir->mappedSegs;
 	while (m != 0) {
diff --git a/src/kernel/ipc/shm.h b/src/kernel/ipc/shm.h
index 895a619..5459dbb 100644
--- a/src/kernel/ipc/shm.h
+++ b/src/kernel/ipc/shm.h
@@ -11,11 +11,6 @@ struct shmseg {
 
 //Shared memory segment stuff
 struct segment* shmseg_make(size_t len, struct process* owner);
-struct segment_map* shmseg_map(struct segment* seg, struct page_directory *pagedir, size_t offset);
-void shmseg_unmap(struct segment_map*);
-void shmseg_delete(struct segment *seg);
-int shmseg_handleFault(struct segment_map *map, size_t addr, int write);
-
 		//find a shared memory segment in current address space by its offset
 struct segment_map* shmseg_getByOff(struct process* pr, size_t offset);	
 
-- 
cgit v1.2.3