annotate auto/lib/perl/make @ 9017:106328a70f4e

Added warning about redefinition of listen socket protocol options. The "listen" directive in the http module can be used multiple times in different server blocks. Originally, it was supposed to be specified once with various socket options, and without any parameters in virtual server blocks. For example: server { listen 80 backlog=1024; server_name foo; ... } server { listen 80; server_name bar; ... } server { listen 80; server_name bazz; ... } The address part of the syntax ("address[:port]" / "port" / "unix:path") uniquely identifies the listening socket, and therefore is enough for name-based virtual servers (to let nginx know that the virtual server accepts requests on the listening socket in question). To ensure that listening options do not conflict between virtual servers, they were allowed only once. For example, the following configuration will be rejected ("duplicate listen options for 0.0.0.0:80 in ..."): server { listen 80 backlog=1024; server_name foo; ... } server { listen 80 backlog=512; server_name bar; ... } At some point it was, however, noticed, that it is sometimes convenient to repeat some options for clarity. In nginx 0.8.51 the "ssl" parameter was allowed to be specified multiple times, e.g.: server { listen 443 ssl backlog=1024; server_name foo; ... } server { listen 443 ssl; server_name bar; ... } server { listen 443 ssl; server_name bazz; ... } This approach makes configuration more readable, since SSL sockets are immediately visible in the configuration. If this is not needed, just the address can still be used. Later, additional protocol-specific options similar to "ssl" were introduced, notably "http2" and "proxy_protocol". With these options, one can write: server { listen 443 ssl backlog=1024; server_name foo; ... } server { listen 443 http2; server_name bar; ... } server { listen 443 proxy_protocol; server_name bazz; ... } The resulting socket will use ssl, http2, and proxy_protocol, but this is not really obvious from the configuration. To emphasize such misleading configurations are discouraged, nginx now warns as long as the "listen" directive is used with options different from the options previously used if this is potentially confusing. In particular, the following configurations are allowed: server { listen 8401 ssl backlog=1024; server_name foo; } server { listen 8401 ssl; server_name bar; } server { listen 8401 ssl; server_name bazz; } server { listen 8402 ssl http2 backlog=1024; server_name foo; } server { listen 8402 ssl; server_name bar; } server { listen 8402 ssl; server_name bazz; } server { listen 8403 ssl; server_name bar; } server { listen 8403 ssl; server_name bazz; } server { listen 8403 ssl http2; server_name foo; } server { listen 8404 ssl http2 backlog=1024; server_name foo; } server { listen 8404 http2; server_name bar; } server { listen 8404 http2; server_name bazz; } server { listen 8405 ssl http2 backlog=1024; server_name foo; } server { listen 8405 ssl http2; server_name bar; } server { listen 8405 ssl http2; server_name bazz; } server { listen 8406 ssl; server_name foo; } server { listen 8406; server_name bar; } server { listen 8406; server_name bazz; } And the following configurations will generate warnings: server { listen 8501 ssl http2 backlog=1024; server_name foo; } server { listen 8501 http2; server_name bar; } server { listen 8501 ssl; server_name bazz; } server { listen 8502 backlog=1024; server_name foo; } server { listen 8502 ssl; server_name bar; } server { listen 8503 ssl; server_name foo; } server { listen 8503 http2; server_name bar; } server { listen 8504 ssl; server_name foo; } server { listen 8504 http2; server_name bar; } server { listen 8504 proxy_protocol; server_name bazz; } server { listen 8505 ssl http2 proxy_protocol; server_name foo; } server { listen 8505 ssl http2; server_name bar; } server { listen 8505 ssl; server_name bazz; } server { listen 8506 ssl http2; server_name foo; } server { listen 8506 ssl; server_name bar; } server { listen 8506; server_name bazz; } server { listen 8507 ssl; server_name bar; } server { listen 8507; server_name bazz; } server { listen 8507 ssl http2; server_name foo; } server { listen 8508 ssl; server_name bar; } server { listen 8508; server_name bazz; } server { listen 8508 ssl backlog=1024; server_name foo; } server { listen 8509; server_name bazz; } server { listen 8509 ssl; server_name bar; } server { listen 8509 ssl backlog=1024; server_name foo; } The basic idea is that at most two sets of protocol options are allowed: the main one (with socket options, if any), and a shorter one, with options being a subset of the main options, repeated for clarity. As long as the shorter set of protocol options is used, all listen directives except the main one should use it.
author Maxim Dounin <mdounin@mdounin.ru>
date Sat, 28 Jan 2023 01:29:45 +0300
parents 53ea5694d1cc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
1
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
2 # Copyright (C) Igor Sysoev
4412
d620f497c50f Copyright updated.
Maxim Konovalov <maxim@nginx.com>
parents: 1187
diff changeset
3 # Copyright (C) Nginx, Inc.
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
4
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
5
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
6 cat << END >> $NGX_MAKEFILE
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
7
6419
39a806ccf21e Dynamic modules: perl.
Ruslan Ermilov <ru@nginx.com>
parents: 5265
diff changeset
8 $NGX_OBJS/src/http/modules/perl/ngx_http_perl_module.o: \\
39a806ccf21e Dynamic modules: perl.
Ruslan Ermilov <ru@nginx.com>
parents: 5265
diff changeset
9 $NGX_OBJS/$ngx_perl_module
39a806ccf21e Dynamic modules: perl.
Ruslan Ermilov <ru@nginx.com>
parents: 5265
diff changeset
10
39a806ccf21e Dynamic modules: perl.
Ruslan Ermilov <ru@nginx.com>
parents: 5265
diff changeset
11 $NGX_OBJS/$ngx_perl_module: \\
5143
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
12 \$(CORE_DEPS) \$(HTTP_DEPS) \\
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
13 src/http/modules/perl/ngx_http_perl_module.h \\
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
14 $NGX_OBJS/src/http/modules/perl/Makefile
4841
95ce3172493e Configure: fixed make macros to use parentheses instead of braces.
Maxim Dounin <mdounin@mdounin.ru>
parents: 4740
diff changeset
15 cd $NGX_OBJS/src/http/modules/perl && \$(MAKE)
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
16
740
5187a63d9fca force perl modules reinstallation after rebuilding
Igor Sysoev <igor@sysoev.ru>
parents: 681
diff changeset
17 rm -rf $NGX_OBJS/install_perl
5187a63d9fca force perl modules reinstallation after rebuilding
Igor Sysoev <igor@sysoev.ru>
parents: 681
diff changeset
18
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
19
5143
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
20 $NGX_OBJS/src/http/modules/perl/Makefile: \\
5265
9f17e765a21e Configure: perl Makefile rebuild after configure.
Maxim Dounin <mdounin@mdounin.ru>
parents: 5180
diff changeset
21 $NGX_AUTO_CONFIG_H \\
5146
f45b83d20cfb Simplified nginx version maintenance.
Ruslan Ermilov <ru@nginx.com>
parents: 5145
diff changeset
22 src/core/nginx.h \\
5143
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
23 src/http/modules/perl/Makefile.PL \\
5144
273754fad787 Configure: improved make dependencies for perl module.
Ruslan Ermilov <ru@nginx.com>
parents: 5143
diff changeset
24 src/http/modules/perl/nginx.pm \\
273754fad787 Configure: improved make dependencies for perl module.
Ruslan Ermilov <ru@nginx.com>
parents: 5143
diff changeset
25 src/http/modules/perl/nginx.xs \\
273754fad787 Configure: improved make dependencies for perl module.
Ruslan Ermilov <ru@nginx.com>
parents: 5143
diff changeset
26 src/http/modules/perl/typemap
6848
53ea5694d1cc Configure: detect nginx version for nginx.pm at make time.
Ruslan Ermilov <ru@nginx.com>
parents: 6700
diff changeset
27 grep 'define NGINX_VERSION' src/core/nginx.h \\
53ea5694d1cc Configure: detect nginx version for nginx.pm at make time.
Ruslan Ermilov <ru@nginx.com>
parents: 6700
diff changeset
28 | sed -e 's/^.*"\(.*\)".*/\1/' > \\
53ea5694d1cc Configure: detect nginx version for nginx.pm at make time.
Ruslan Ermilov <ru@nginx.com>
parents: 6700
diff changeset
29 $NGX_OBJS/src/http/modules/perl/version
53ea5694d1cc Configure: detect nginx version for nginx.pm at make time.
Ruslan Ermilov <ru@nginx.com>
parents: 6700
diff changeset
30 sed "s/%%VERSION%%/\`cat $NGX_OBJS/src/http/modules/perl/version\`/" \\
53ea5694d1cc Configure: detect nginx version for nginx.pm at make time.
Ruslan Ermilov <ru@nginx.com>
parents: 6700
diff changeset
31 src/http/modules/perl/nginx.pm > \\
5146
f45b83d20cfb Simplified nginx version maintenance.
Ruslan Ermilov <ru@nginx.com>
parents: 5145
diff changeset
32 $NGX_OBJS/src/http/modules/perl/nginx.pm
f45b83d20cfb Simplified nginx version maintenance.
Ruslan Ermilov <ru@nginx.com>
parents: 5145
diff changeset
33 cp -p src/http/modules/perl/nginx.xs $NGX_OBJS/src/http/modules/perl/
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
34 cp -p src/http/modules/perl/typemap $NGX_OBJS/src/http/modules/perl/
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
35 cp -p src/http/modules/perl/Makefile.PL $NGX_OBJS/src/http/modules/perl/
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
36
5143
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
37 cd $NGX_OBJS/src/http/modules/perl \\
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
38 && NGX_PM_CFLAGS="\$(NGX_PM_CFLAGS) -g $NGX_CC_OPT" \\
6700
0d2956dfc4e6 Perl: pass additional linker options to perl module.
Konstantin Pavlov <thresh@nginx.com>
parents: 6419
diff changeset
39 NGX_PM_LDFLAGS="$NGX_LD_OPT \$(NGX_PM_LDFLAGS)" \\
5180
2db6bdcaedc0 Configure: fixed perl Makefile generation (ticket #334).
Maxim Dounin <mdounin@mdounin.ru>
parents: 5168
diff changeset
40 NGX_INCS="$CORE_INCS $NGX_OBJS $HTTP_INCS" \\
5168
482fda984556 Configure: fixed nginx.so rebuild (broken by r5145).
Maxim Dounin <mdounin@mdounin.ru>
parents: 5146
diff changeset
41 NGX_DEPS="\$(CORE_DEPS) \$(HTTP_DEPS)" \\
5143
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
42 $NGX_PERL Makefile.PL \\
6dd4875eb526 Configure: improved layout of the generated makefile.
Ruslan Ermilov <ru@nginx.com>
parents: 5070
diff changeset
43 LIB=$NGX_PERL_MODULES \\
950
9581fba9ea12 fix for nginx.pm default installation
Igor Sysoev <igor@sysoev.ru>
parents: 948
diff changeset
44 INSTALLSITEMAN3DIR=$NGX_PERL_MODULES_MAN
599
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
45
869b6444d234 nginx-0.3.21-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
46 END