srs/trunk/3rdparty/st-srs/README.md

state-threads

Fork from http://sourceforge.net/projects/state-threads, patched for SRS.

See: https://github.com/ossrs/state-threads/blob/srs/README

For original ST without any changes, checkout the ST master branch.

Usage

Get code:

git clone https://github.com/ossrs/state-threads.git st-1.9 &&
git checkout -b srs origin/srs

For Linux:

make linux-debug EXTRA_CFLAGS="-DMD_HAVE_EPOLL"

For OSX:

make darwin-debug EXTRA_CFLAGS="-DMD_HAVE_KQUEUE"

Linux with valgrind:

make linux-debug EXTRA_CFLAGS="-DMD_VALGRIND"

Remark: User must install valgrind, for instance, in centos6 sudo yum install -y valgrind valgrind-devel.

Linux with valgrind and epoll:

make linux-debug EXTRA_CFLAGS="-DMD_HAVE_EPOLL -DMD_VALGRIND"

For OSX, user must specifies the valgrind header files:

make darwin-debug EXTRA_CFLAGS="-DMD_HAVE_KQUEUE -DMD_VALGRIND -I/usr/local/include"

Remark: Latest OSX does not support ST, please use docker to run ST.

Branch SRS

The branch srs will be patched the following patches:

• Patch st.arm.patch, for ARM.
• Patch st.osx.kqueue.patch, for osx.
• Patch st.disable.examples.patch, for ubuntu.
• Refine TAB of code.
• Merge from michaeltalyansky and xzh3836598, support ARM.
• Merge from toffaletti, support valgrind for ST.
• Patch st.osx10.14.build.patch, for osx 10.14 build.
• Support macro MD_ST_NO_ASM to disable ASM, #8.
• Merge patch srs#1282 to support aarch64, #9.
• Support OSX for Apple Darwin, macOS, #11.
• Support sendmmsg for UDP, #12.
• Refine performance for sleep or epoll_wait(0), #17.
• Improve the performance of timer. 9fe8cfe5b, 7879c2b, 387cddb

GDB Tools

• Support nn_coroutines, show number of coroutines.
• Support show_coroutines, show all coroutines and caller function.

Valgrind

How to debug with gdb under valgrind, read valgrind manual.

About startup parameters, read valgrind cli.

Important cli options:

1. --undef-value-errors=<yes|no> [default: yes], Controls whether Memcheck reports uses of undefined value errors. Set this to no if you don't want to see undefined value errors. It also has the side effect of speeding up Memcheck somewhat.
2. --leak-check=<no|summary|yes|full> [default: summary], When enabled, search for memory leaks when the client program finishes. If set to summary, it says how many leaks occurred. If set to full or yes, each individual leak will be shown in detail and/or counted as an error, as specified by the options --show-leak-kinds and --errors-for-leak-kinds.
3. --track-origins=<yes|no> [default: no], Controls whether Memcheck tracks the origin of uninitialised values. By default, it does not, which means that although it can tell you that an uninitialised value is being used in a dangerous way, it cannot tell you where the uninitialised value came from. This often makes it difficult to track down the root problem.
4. --show-reachable=<yes|no> , --show-possibly-lost=<yes|no>, to show the using memory.

Docs & Analysis

• Introduction: http://ossrs.github.io/state-threads/docs/st.html
• API reference: http://ossrs.github.io/state-threads/docs/reference.html

• Programming notes: http://ossrs.github.io/state-threads/docs/notes.html

• About setjmp and longjmp, read setjmp.

• About the stack structure, read stack

• About asm code comments, read #91d530e.

• About the scheduler, read #13-scheduler.

• About the IO event system, read #13-IO.

• Code analysis, please read #15.

Winlin 2016