(Personal open source) nginx source code comments

Address

https://github.com/langsim/nginx-1.6.2-comment

Introduction

I hope to complete a highly readable nginx source code comment.

Content that will not be commented

1. spdy-related code, because spdy has been replaced by http2.
2. Thread-related code, because at least in version 1.6.2 nginx threads are still in the experimental stage.
3. Others than Linux Platform code.
4. Code of other event models other than epoll
5. Code of other compilers other than gcc.
6. mail-related code.

Completion level

1. core directory 60%
2. event directory 20%
3. http directory 10%
4. os directory 80%

Function linked list

1. http filter module, ngx_http_top_header_filter and ngx_http_top_body_filter will form two function linked lists, the calling order of the functions in the linked list will be the same as that of the corresponding module in the ngx_modules array The order is reversed.
2. Many of the 11 stages of http request processing can have multiple callback functions. The order of calling callback functions in the same stage is the same as the order of the corresponding modules in the ngx_modules array.

Log

nginx has two log files by default:

1. access.log: Each http request will generate a line of records in it.
2. error.log: Some general, error or debug logs when nginx is running.

Process model

Four process states may appear after nginx is started:

1. Single process running in the foreground
2. Single process daemon mode
3. One master process, one (or more) worker processes, one (or 0) ) cachemanager processes and one (or 0) cacheloader processes run together in the foreground
4. A master process, one (or more) worker processes, one (or 0) cachemanager processes and one (or 0) cacheloader processes are in Run in daemon state.
   
   • The master process is used to start other processes during startup, and is used to manage other processes after startup is completed.
   • woker process, used to actually handle link requests.
   • The cachemanager process is used to clean cache files as required.
   • When the cacheloader process starts, it will index the cache files that meet the requirements in the cache directory in the memory, clear the cache files that do not meet the requirements, and then exit.
5. After starting, send a signal to the main process of running nginx, and then exit.

Switching of process running status

1. Reload configuration file (reload)
2. Hot upgrade executable file

Compilation

nginx compilation is the same as the compilation method of regular open source software on the Linux platform, both are run./ configure && make && make install, you can add your own custom options after ./configure.

nginx uses signals

1. TERM, INT for quick shutdown
2. QUIT for graceful shutdown
3. HUP for smooth restart and reloading the configuration file
4. USR1 to reopen the log file, which is more useful when cutting logs
5. USR2 for smooth upgrade executable The program
6. WINCH shuts down the working process gracefully

nginx memory pool

nginx has two memory pools

1. The memory pool used to allocate memory on shared memory
2. The memory pool used to apply for memory on ordinary memory, the purpose is Efficient use of memory

nginx uses calculation hash algorithm

1. crc32
2. crc16
3. sha1
4. murmurhash
5. md5

nignx process communication and synchronization

1. shared memory Use
2. signal
3. unix socket

The above introduces the (personal open source) nginx source code comments, including the relevant content. I hope it will be helpful to friends who are interested in PHP tutorials.