Skip to content

Commit

Permalink
doc: philosophers: move to rst syntax
Browse files Browse the repository at this point in the history
Change-Id: Idc808f062853bc201c22e4c30f0e3687f055265d
Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
nashif committed Jan 6, 2017
1 parent 2e293c5 commit f562349
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 57 deletions.
43 changes: 43 additions & 0 deletions samples/philosophers/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Dining Philosophers
###################

Overview
========

An implementation of a solution to the Dining Philosophers problem (a classic
multi-thread synchronization problem). This particular implementation
demonstrates the usage of multiple preemptible and cooperative threads of
differing priorities, as well as dynamic mutexes and thread sleeping.

The philosopher always tries to get the lowest fork first (f1 then f2). When
done, he will give back the forks in the reverse order (f2 then f1). If he
gets two forks, he is EATING. Otherwise, he is THINKING. Transitional states
are shown as well, such as STARVING when the philosopher is hungry but the
forks are not available, and HOLDING ONE FORK when a philosopher is waiting
for the second fork to be available.

Each Philosopher will randomly alternate between the EATING and THINKING state.

Building and Running
====================

This project outputs to the console. It can be built and executed
on QEMU as follows:

.. code-block:: console
make qemu
Sample Output
-------------

.. code-block:: console
Philosopher 0 [P: 3] HOLDING ONE FORK
Philosopher 1 [P: 2] HOLDING ONE FORK
Philosopher 2 [P: 1] EATING [ 1900 ms ]
Philosopher 3 [P: 0] THINKING [ 2500 ms ]
Philosopher 4 [C:-1] THINKING [ 2200 ms ]
Philosopher 5 [C:-2] THINKING [ 1700 ms ]
57 changes: 0 additions & 57 deletions samples/philosophers/README.txt

This file was deleted.

0 comments on commit f562349

Please sign in to comment.