Changeset 9179d0a in mainline for generic/src/synch

Timestamp:

2006-04-27T17:13:49Z (20 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

040e4e9

Parents:

eaa202a

Message:

Add some @file doxygen comments and improve already existing comments.

Location:

generic/src/synch

Files:

• condvar.c (modified) (1 diff)
• futex.c (modified) (3 diffs)
• mutex.c (modified) (1 diff)
• rwlock.c (modified) (2 diffs)
• semaphore.c (modified) (1 diff)
• waitq.c (modified) (2 diffs)

generic/src/synch/condvar.c

@@ -77 +77 @@
  *
  * For exact description of possible combinations of
- * @usec and @trywait, see comment for waitq_sleep_timeout().
+ * usec and trywait, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/futex.c

@@ -94 +94 @@
  * @param uaddr Userspace address of the futex counter.
  * @param usec If non-zero, number of microseconds this thread is willing to sleep.
- * @param trydown If @usec is zero and trydown is non-zero, conditional operation will be attempted.
+ * @param trydown If usec is zero and trydown is non-zero, conditional operation will be attempted.
  *
  * @return One of ESYNCH_TIMEOUT, ESYNCH_OK_ATOMIC and ESYNCH_OK_BLOCKED. See synch.h.
@@ -219 +219 @@
 /** Compute hash index into futex hash table.
  *
- * @param key Address where the @key (i.e. physical address of futex counter) is stored.
+ * @param key Address where the key (i.e. physical address of futex counter) is stored.
  *
  * @return Index into futex hash table.
@@ -232 +232 @@
  * @param key Address where the key (i.e. physical address of futex counter) is stored.
  *
- * @return True if the item matches the @key. False otherwise.
+ * @return True if the item matches the key. False otherwise.
  */
 bool futex_ht_compare(__native *key, count_t keys, link_t *item)

generic/src/synch/mutex.c

@@ -52 +52 @@
  *
  * For exact description of possible combinations of
- * @usec and @trylock, see comment for waitq_sleep_timeout().
+ * usec and trylock, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/rwlock.c

@@ -27 +27 @@
  */
 
-/** Reader/Writer locks
+/**
+ * @file        rwlock.c
+ * @brief       Reader/Writer locks.
  *
  * A reader/writer lock can be held by multiple readers at a time.
  * Or it can be exclusively held by a sole writer at a time.
- */
-
-/*
+ *
  * These locks are not recursive.
- * Neither readers nor writers will suffer starvation.
+ * Because technique called direct hand-off is used, neither readers
+ * nor writers will suffer starvation.
  *
  * If there is a writer followed by a reader waiting for the rwlock
@@ -146 +147 @@
  *
  * For exact description of possible combinations of
- * @usec and @trylock, see comment for waitq_sleep_timeout().
+ * usec and trylock, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/semaphore.c

@@ -66 +66 @@
  *
  * For exact description of possible combinations of
- * @usec and @trydown, see comment for waitq_sleep_timeout().
+ * usec and trydown, see comment for waitq_sleep_timeout().
  *
  * @return See comment for waitq_sleep_timeout().

generic/src/synch/waitq.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        waitq.c
+ * @brief       Wait queue.
+ *
+ * Wait queue is the basic synchronization primitive upon all
+ * other synchronization primitives build.
+ *
+ * It allows threads to wait for an event in first-come, first-served
+ * fashion. Conditional operation as well as timeouts and interruptions
+ * are supported.
  */
 
@@ -161 +173 @@
  * @param nonblocking Blocking vs. non-blocking operation mode switch.
  *
- * If @usec is greater than zero, regardless of the value of @nonblocking,
+ * If usec is greater than zero, regardless of the value of nonblocking,
  * the call will not return until either timeout or wakeup comes.
  *
- * If @usec is zero and @nonblocking is zero (false), the call
+ * If usec is zero and @nonblocking is zero (false), the call
  * will not return until wakeup comes.
  *
- * If @usec is zero and @nonblocking is non-zero (true), the call will
+ * If usec is zero and nonblocking is non-zero (true), the call will
  * immediately return, reporting either success or failure.
  *
- * @return Returns one of: ESYNCH_WOULD_BLOCK, ESYNCH_TIMEOUT,
- *         ESYNCH_OK_ATOMIC, ESYNCH_OK_BLOCKED.
- *
- * ESYNCH_WOULD_BLOCK means that the sleep failed because at the time
+ * @return      Returns one of: ESYNCH_WOULD_BLOCK, ESYNCH_TIMEOUT,
+ *              ESYNCH_OK_ATOMIC, ESYNCH_OK_BLOCKED.
+ *
+ * @li ESYNCH_WOULD_BLOCK means that the sleep failed because at the time
  * of the call there was no pending wakeup.
  *
- * ESYNCH_TIMEOUT means that the sleep timed out.
- *
- * ESYNCH_INTERRUPTED means that somebody interrupted the sleeping thread.
- *
- * ESYNCH_OK_ATOMIC means that the sleep succeeded and that there was
+ * @li ESYNCH_TIMEOUT means that the sleep timed out.
+ *
+ * @li ESYNCH_INTERRUPTED means that somebody interrupted the sleeping thread.
+ *
+ * @li ESYNCH_OK_ATOMIC means that the sleep succeeded and that there was
  * a pending wakeup at the time of the call. The caller was not put
  * asleep at all.
  * 
- * ESYNCH_OK_BLOCKED means that the sleep succeeded; the full sleep was 
+ * @li ESYNCH_OK_BLOCKED means that the sleep succeeded; the full sleep was 
  * attempted.
  */