Building a non-debug version of Openresty 1.7.7.1

joeblow68 · 2015-01-12T23:30:06+00:00

On Tuesday, January 13, 2015 at 8:53:31 AM UTC+11, agentzh wrote:Yes, you can just expose an internal endpoint in your nginx by a special "location = /updat...

Building a non-debug version of Openresty 1.7.7.1

joeblow68

Hi,

I'm trying to build a production version of openresty 1.7.7.1 on Debian Wheezy, as per instructions on openresty.org.

When I .configure and then make, the binary is build with debugging symbols, coming out at 12MB. I've looked at the configure script and the resulting makefile always includes '-g', whether I provide --with-debug parameter or not. For example, after running ./configure, I get this:

ngx_openresty-1.7.7.1# cat build/nginx-1.7.7/objs/Makefile

CC = cc

CFLAGS = -pipe -O -W -Wall -Wpointer-arith -Wno-unused-parameter -g -I/ngx_openresty-1.7.7.1/build/luajit-root/usr/local/openresty/luajit/include/luajit-2.1 -O2 -DNDK_SET_VAR -DNDK_UPSTREAM_LIST -DNDK_SET_VAR -DNDK_SET_VAR -DNDK_SET_VAR -DLUA_DEFAULT_PATH='"/usr/local/openresty/lualib/?.lua;/usr/local/openresty/lualib/?/init.lua"' -DLUA_DEFAULT_CPATH='"/usr/local/openresty/lualib/?.so"' -DNDK_SET_VAR

(Note the -g in CFLAGS). I've manually fixed that Makefile to get the non-debug version, but how do I go about doing it without a manual fix?

Thanks,

Jonathan

agentzh

Hello!

On Mon, Jan 12, 2015 at 7:30 AM, Jonathan wrote:
> When I .configure and then make, the binary is build with debugging symbols,
> coming out at 12MB. I've looked at the configure script and the resulting
> makefile always includes '-g', whether I provide --with-debug parameter or
> not. For example, after running ./configure, I get this:
>

This is just because debug symbols are meant to be included in online
builds. The standard nginx core also includes the debug symbols by
default even without ./configure --with-debug. And OpenResty just
inherits that behavior without changes.

Debug symbols are important to be included in the production builds
because of debug-ability (in case of core dump analysis, online
tracing and profiling). See

https://github.com/openresty/nginx-gdb-utils

https://github.com/openresty/nginx-systemtap-toolkit

https://github.com/openresty/stapxx

These tools all require debug symbols in the online builds.

Regards,
-agentzh

joeblow68

Hello agentzh,

thank you so much for your prompt answer.

Does this mean that there is no version to build a non-debug-symbols build with the source you provide? IOW, if I wanted to build a release without debug symbols (let's say I can't use those tools in a specific scenario or don't care), I would need to modify the configure script myself and keep it around for building future versions as well?

Thanks!

Jonathan

On Monday, January 12, 2015 at 10:47:41 PM UTC+1, agentzh wrote:

Hello!

On Mon, Jan 12, 2015 at 7:30 AM, Jonathan wrote:
> When I .configure and then make, the binary is build with debugging symbols,
> coming out at 12MB. I've looked at the configure script and the resulting
> makefile always includes '-g', whether I provide --with-debug parameter or
> not. For example, after running ./configure, I get this:
>

This is just because debug symbols are meant to be included in online
builds. The standard nginx core also includes the debug symbols by
default even without ./configure --with-debug. And OpenResty just
inherits that behavior without changes.

Debug symbols are important to be included in the production builds
because of debug-ability (in case of core dump analysis, online
tracing and profiling). See

https://github.com/openresty/nginx-gdb-utils

https://github.com/openresty/nginx-systemtap-toolkit

https://github.com/openresty/stapxx

These tools all require debug symbols in the online builds.

Regards,
-agentzh

agentzh

Hello!

On Mon, Jan 12, 2015 at 1:55 PM, Jonathan wrote:
> Does this mean that there is no version to build a non-debug-symbols build
> with the source you provide?

If you really want that, you can strip the symbols after installation
yourself. No need to touch the OpenResty build system.

Just run the "strip" command-line utility upon the "nginx" binary like this:

    sudo strip /usr/local/openresty/nginx/sbin/nginx

And you are done. You can also strip other .so files in the openresty
installation tree as well. All up to you :)

Regards,
-agentzh

joeblow68

Hello agentzh,

thanks so much for your lightning fast answers. The strip command works! (You can tell I'm new to all this linux building stuff).

While at it, another question: does the production server need anything from luajit installation directories beyond libluajit-5.1.so.2 file that ldd nginx returns? I presume the luajit binary and the headers are not needed to run Openresty apps in production?

Thanks!

Jonathan

On Monday, January 12, 2015 at 10:59:02 PM UTC+1, agentzh wrote:

Hello!

On Mon, Jan 12, 2015 at 1:55 PM, Jonathan wrote:
> Does this mean that there is no version to build a non-debug-symbols build
> with the source you provide?

If you really want that, you can strip the symbols after installation
yourself. No need to touch the OpenResty build system.

Just run the "strip" command-line utility upon the "nginx" binary like this:

sudo strip /usr/local/openresty/nginx/sbin/nginx

And you are done. You can also strip other .so files in the openresty
installation tree as well. All up to you :)

Regards,
-agentzh

agentzh

Hello!

On Mon, Jan 12, 2015 at 2:08 PM, Jonathan wrote:
> While at it, another question: does the production server need anything from
> luajit installation directories beyond libluajit-5.1.so.2 file that ldd
> nginx returns? I presume the luajit binary and the headers are not needed to
> run Openresty apps in production?

Usually not, unless you want to use some of the LuaJIT standard
libraries like jit.v and jit.vmdef.

Regards,
-agentzh

joeblow68

To add to the issue with debug version: even if I manually clean up -g flags from all makefiles, luajit library seems to still include debug symbols. The size of libluajit comes out at 3M, while I'd expect it to be around 500K:

du -haL usr/local/luajit/lib
0M usr/local/luajit/lib/libluajit-5.1.so.2
7M usr/local/luajit/lib/libluajit-5.1.a
0K usr/local/luajit/lib/lua/5.1
0K usr/local/luajit/lib/lua
0K usr/local/luajit/lib/pkgconfig/luajit.pc
0K usr/local/luajit/lib/pkgconfig
6M usr/local/luajit/lib

Are all of these files needed for production use?

It appears that this build is a development version, as it installs the headers and so on. What would be the right way to install a minimum-size working production version?

Thanks,

Jonathan

On Monday, January 12, 2015 at 4:30:05 PM UTC+1, Jonathan wrote:

Hi,

I'm trying to build a production version of openresty 1.7.7.1 on Debian Wheezy, as per instructions on openresty.org.

When I .configure and then make, the binary is build with debugging symbols, coming out at 12MB. I've looked at the configure script and the resulting makefile always includes '-g', whether I provide --with-debug parameter or not. For example, after running ./configure, I get this:

ngx_openresty-1.7.7.1# cat build/nginx-1.7.7/objs/Makefile

CC = cc

CFLAGS = -pipe -O -W -Wall -Wpointer-arith -Wno-unused-parameter -g -I/ngx_openresty-1.7.7.1/build/luajit-root/usr/local/openresty/luajit/include/luajit-2.1 -O2 -DNDK_SET_VAR -DNDK_UPSTREAM_LIST -DNDK_SET_VAR -DNDK_SET_VAR -DNDK_SET_VAR -DLUA_DEFAULT_PATH='"/usr/local/openresty/lualib/?.lua;/usr/local/openresty/lualib/?/init.lua"' -DLUA_DEFAULT_CPATH='"/usr/local/openresty/lualib/?.so"' -DNDK_SET_VAR
(Note the -g in CFLAGS). I've manually fixed that Makefile to get the non-debug version, but how do I go about doing it without a manual fix?

Thanks,
Jonathan

agentzh

Hello!

On Mon, Jan 12, 2015 at 9:31 AM, Jonathan wrote:
> To add to the issue with debug version:

Let me re-emphasize that builds with debug symbols are not "debug
versions" of builds. You won't see any measurable runtime overhead
involved with the inclusion of debug symbols, either in terms of
memory footprint and performance. You just pay a little bit more disk
space, which is never an issue for non-embedded systems today.

> even if I manually clean up -g flags
> from all makefiles, luajit library seems to still include debug symbols.

LuaJIT includes hand-written assembly code which does not go through
any C compilers. You need to remove the "CCDEBUG=-g" argument from
LuaJIT's "make" command line. Or easier, as I've said, use the "strip"
utility after the build.

> The
> size of libluajit comes out at 3M, while I'd expect it to be around 500K:
>
> du -haL usr/local/luajit/lib
> 3.0M usr/local/luajit/lib/libluajit-5.1.so.2

This file is a symbolic link to libluajit-5.1.so.2.1.0.

> 5.7M usr/local/luajit/lib/libluajit-5.1.a

You usually don't need this.

> It appears that this build is a development version, as it installs the
> headers and so on. What would be the right way to install a minimum-size
> working production version?
>

You can just remove whatever files you don't need. But as I've said
these files are really small as compared to many other things and we
always install them by default in production, which can make online
debugging much easier.

Regards,
-agentzh

joeblow68

Thanks again for your super-prompt answers and apologies for the noise—I’ve sent this email a minute after sending the OP, yet somehow it only arrived to Google Groups today! How embarrassing.

Was not aware of the fact that -g just embeds debug symbols and does not build a slower debug build. Thanks again for your fantastic and detailed answers, and of course for openresty. Learned a ton in the past day. You rock, man!

Thanks to your advice and support, I’ve managed to build a small working container with stripped binaries and am very happy.

Thanks again,
Jon

> On 13 janv. 2015, at 21:25, Yichun Zhang (agentzh) <age...@gmail.com> wrote:
> 
> Hello!
> 
> On Mon, Jan 12, 2015 at 9:31 AM, Jonathan wrote:
>> To add to the issue with debug version:
> 
> Let me re-emphasize that builds with debug symbols are not "debug
> versions" of builds. You won't see any measurable runtime overhead
> involved with the inclusion of debug symbols, either in terms of
> memory footprint and performance. You just pay a little bit more disk
> space, which is never an issue for non-embedded systems today.
> 
>> even if I manually clean up -g flags
>> from all makefiles, luajit library seems to still include debug symbols.
> 
> LuaJIT includes hand-written assembly code which does not go through
> any C compilers. You need to remove the "CCDEBUG=-g" argument from
> LuaJIT's "make" command line. Or easier, as I've said, use the "strip"
> utility after the build.
> 
>> The
>> size of libluajit comes out at 3M, while I'd expect it to be around 500K:
>> 
>> du -haL usr/local/luajit/lib
>> 3.0M usr/local/luajit/lib/libluajit-5.1.so.2
> 
> This file is a symbolic link to libluajit-5.1.so.2.1.0.
> 
>> 5.7M usr/local/luajit/lib/libluajit-5.1.a
> 
> You usually don't need this.
> 
>> It appears that this build is a development version, as it installs the
>> headers and so on. What would be the right way to install a minimum-size
>> working production version?
>> 
> 
> You can just remove whatever files you don't need. But as I've said
> these files are really small as compared to many other things and we
> always install them by default in production, which can make online
> debugging much easier.
> 
> Regards,
> -agentzh
> 
>