Using cmake with nginx

Dmitry Petrov dmitry.petroff at gmail.com
Mon Dec 5 00:16:50 UTC 2022


>So, the issues you are talking about is the fact that nginx won't
magically find out which header files you are using, but instead
requires you to list them in the ngx_module_deps variable when
calling the auto/module in the module config script, correct?

That's not magic. This is what make + gcc/clang/icc can do on *nix. The
general pattern is simple:
-include $dep
$obj $dep: $src
    $(CC) ... -MMD -MP -MT $obj -MT $dep ...
This would make the compiler generate a dependency file together with an
object file and make would include/update it when needed.
I'm not aware if nginx supports compilers other than gcc/clang, but this
trick would work for said compilers. icc mimics gcc on Linux, so generally
it will work there too . I'm attaching objs/ngx_modules.d being
automatically generated by this approach.

That would be a really simple change to auto/make, but it would work much
better that _*DEPS.
I'm providing a proof-of-working auto/make script from nginx-1.20.2 which
uses this technique. You can check how it differs by observing that only
several files getting recompiled after
touch src/core/ngx_md5.h && make
This example should handle addon dependencies too.

On Mon, Dec 5, 2022 at 12:10 AM Maxim Dounin <mdounin at mdounin.ru> wrote:

> Hello!
>
> On Sun, Dec 04, 2022 at 11:12:55PM +0300, Dmitry Petrov wrote:
>
> > >You may want to be more specific about issues you are talking
> > about.  In general, nginx build system requires little to no
> > effort from developers.
> >
> > I'm speaking about manual vs automatic source-level dependency handling.
> > For example, CORE_DEPS is an easy but inaccurate cross-platform hack. The
> > same is true for ADDON_DEPS: if you add any header here, all addons will
> be
> > rebuilt on that header change.
> > That's not a big deal, because C compiles fast enough and ccache could be
> > used to mitigate "false positives" of hand-written deps. But there's room
> > for improvement for sure.
> > For example, I had build issues because of forgetting to include headers
> > into core/addon deps after splitting addon into a set of header/source
> > files.
>
> So, the issues you are talking about is the fact that nginx won't
> magically find out which header files you are using, but instead
> requires you to list them in the ngx_module_deps variable when
> calling the auto/module in the module config script, correct?
>
> Thanks for the explanation.
>
> > >There are no plans to support CMake.
> > Targeting any modern C-oriented build system would add many benefits
> > including "standardized" routines for library detection, dependency
> > handling, etc.
>
> The "make" build system as used by nginx is a modern, C-oriented
> build system.  Further, it is standardized, and provides as much
> portability as no other build system known.  Shell, as used to
> generate makefiles, is believed to be simple enough to implement
> any needed library detection.
>
> > Are there any plans on adding "per-addon header deps" so changes to a
> > single header don't result in all addons recompiling?
>
> As of now, there are no such plans.  Just rebuilding all the
> modules if a header changes is believed to be fast enough
> approach.  Further, it is usually trivial to configure a build
> environment for development which does not contain any additional
> modules, reducing potential benefits from such a change.
>
> --
> Maxim Dounin
> http://mdounin.ru/
> _______________________________________________
> nginx-devel mailing list -- nginx-devel at nginx.org
> To unsubscribe send an email to nginx-devel-leave at nginx.org
>


-- 
Regards,
Dmitry
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20221205/6611ae58/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ngx_modules.d
Type: text/x-dsrc
Size: 2598 bytes
Desc: not available
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20221205/6611ae58/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: auto-make-1.20.2.gz
Type: application/gzip
Size: 2785 bytes
Desc: not available
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20221205/6611ae58/attachment-0001.bin>


More information about the nginx-devel mailing list