From fd30aae780bea544aff82606e626dda96d632b4d Mon Sep 17 00:00:00 2001
From: Andre <maan@p133.(none)>
Date: Wed, 22 Feb 2006 12:21:09 +0100
Subject: [PATCH] add more ipc documentation

Also, add a GPL header and replace "shared memory area" by "shared memory segment".
---
 ipc.c | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 61 insertions(+), 2 deletions(-)

diff --git a/ipc.c b/ipc.c
index 973a9eaf..a66c8409 100644
--- a/ipc.c
+++ b/ipc.c
@@ -1,17 +1,55 @@
+/*
+ * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ *
+ *     This program is free software; you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation; either version 2 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ *
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program; if not, write to the Free Software
+ *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ */
+
+/** \file ipc.c interprocess communication and shared memory helpers */
+
 #include "para.h"
 #include "error.h"
 #include "ipc.h"
 #include <sys/ipc.h>
 #include <sys/shm.h>
 
+/** abort if semget() failed that many times */
 #define MAX_SEMOP_RETRIES 500
 
+/**
+ * define a new mutex
+ *
+ * \return the identifier for the new mutex on success, -E_SEM_GET
+ * on errors.
+ *
+ * \sa semget(2)
+ */
 int mutex_new(void)
 {
 	int ret = semget(IPC_PRIVATE, 1, IPC_CREAT | 0666);
 	return ret < 0?  -E_SEM_GET : ret;
 }
 
+/**
+ * destroy a mutex
+ *
+ * \para, id the identifier of the mutex to be destroyed
+ *
+ * \returns Positive on success, -E_SEM_REMOVE on errors.
+ *
+ * \sa semctl(2)
+ */
 int mutex_destroy(int id)
 {
 	int ret = semctl(id, 0, IPC_RMID);
@@ -32,6 +70,8 @@ static void para_semop(int id, struct sembuf *sops, int num)
 /**
  * lock the given mutex
  *
+ * This function either succeeds or aborts.
+ *
  * \sa semop(2), struct misc_meta_data
  */
 void mutex_lock(int id)
@@ -54,6 +94,10 @@ void mutex_lock(int id)
 /**
  * unlock a mutex
  *
+ * \param id the identifier of the mutex
+ *
+ * This function either succeeds or aborts.
+ *
  * \sa semop(2), struct misc_meta_data
  */
 void mutex_unlock(int id)
@@ -91,9 +135,15 @@ int shm_destroy(int id)
 }
 
 /**
- * attach a shared memory area
+ * attach a shared memory segment
+ *
+ * \param id the identifier of the shared memory segment to attach
+ * \param mode either ATTACH_RO (read only) or ATTACH_RW (read/write)
+ * \param result points to the attached arer which to the
  *
- * \sa semop(2)
+ * \returns positive on success, -E_SHM_ATTACH on errrors.
+ *
+ * \sa shmat(2)
  */
 int shm_attach(int id, enum shm_attach_mode mode, void **result)
 {
@@ -105,6 +155,15 @@ int shm_attach(int id, enum shm_attach_mode mode, void **result)
 	return *result? 1 : -E_SHM_ATTACH;
 }
 
+/**
+ * detach a shared memory segment
+ *
+ * \param addr the address of the attached segment
+ *
+ * \returns positive on success, -E_SHM_DETACH on errors.
+ *
+ * \sa shmdt(2)
+ */
 int shm_detach(void *addr)
 {
 	int ret = shmdt(addr);
-- 
2.39.5