Skip to content

fix: Memory leak issue of nginx module #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
815010453 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Memory leak issue of nginx module #367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 84 additions & 13 deletions nginx/ngx_http_mapcache_module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,25 @@
#include <apr_strings.h>
#include <apr_pools.h>


extern ngx_module_t ngx_http_mapcache_module;
apr_pool_t *process_pool = NULL;
static char *ngx_http_mapcache(ngx_conf_t *cf, ngx_command_t *cmd,
void *conf);

typedef struct{
ngx_array_t *configs; // elements: mapcache_cfg*
} ngx_http_mapcache_main_conf_t;

// Register the cleanup function for the APR pool to the nginx configuration pool.
static void ngx_http_mapcache_apr_pool_cleanup(void *data)
{
apr_pool_t *p = (apr_pool_t *)data;
if (p)
{
apr_pool_destroy(p);
}
}

static ngx_command_t ngx_http_mapcache_commands[] = {

{
Expand Down Expand Up @@ -56,12 +70,23 @@ static mapcache_context* ngx_mapcache_context_clone(mapcache_context *ctx)
static void *
ngx_http_mapcache_create_conf(ngx_conf_t *cf)
{
apr_initialize();
atexit(apr_terminate);
apr_pool_initialize();
apr_pool_create(&process_pool,NULL);
mapcache_context *ctx = apr_pcalloc(process_pool, sizeof(mapcache_ngx_context));
ctx->pool = process_pool;
// Allocate an independent APR pool for this location and attach it to the configuration pool cleanup of nginx.
apr_pool_t *loc_apr_pool = NULL;
apr_initialize(); // Ensure that APR has been initialized (safe for multiple calls)
apr_pool_create(&loc_apr_pool, NULL);
ngx_pool_cleanup_t *cln = ngx_pool_cleanup_add(cf->pool, 0);
if (cln)
{
cln->handler = ngx_http_mapcache_apr_pool_cleanup;
cln->data = loc_apr_pool;
}
mapcache_ngx_context *ngctx = ngx_pcalloc(cf->pool, sizeof(mapcache_ngx_context));
if (ngctx == NULL)
{
return NULL;
}
mapcache_context *ctx = (mapcache_context *)ngctx;
ctx->pool = loc_apr_pool; // Use the location-specific APR pool to host the configuration memory
ctx->connection_pool = NULL;
mapcache_context_init(ctx);
ctx->log = ngx_mapcache_context_log;
Expand All @@ -72,6 +97,27 @@ ngx_http_mapcache_create_conf(ngx_conf_t *cf)
return ctx;
}

static void *
ngx_http_mapcache_create_main_conf(ngx_conf_t *cf)
{
// Do not create a global APR pool here or call atexit/apr_pool_initialize
ngx_http_mapcache_main_conf_t *mcf;

mcf = ngx_pcalloc(cf->pool, sizeof(ngx_http_mapcache_main_conf_t));
if (mcf == NULL)
{
return NULL;
}

mcf->configs = ngx_array_create(cf->pool, 1, sizeof(mapcache_cfg *));
if (mcf->configs == NULL)
{
return NULL;
}

return mcf;
}


static void ngx_http_mapcache_write_response(mapcache_context *ctx, ngx_http_request_t *r,
mapcache_http_response *response)
Expand Down Expand Up @@ -156,7 +202,7 @@ static ngx_http_module_t ngx_http_mapcache_module_ctx = {
NULL, /* preconfiguration */
NULL, /* postconfiguration */

NULL, /* create main configuration */
ngx_http_mapcache_create_main_conf, /* create main configuration */
NULL, /* init main configuration */

NULL, /* create server configuration */
Expand All @@ -168,16 +214,37 @@ static ngx_http_module_t ngx_http_mapcache_module_ctx = {

static ngx_int_t ngx_mapcache_init_process(ngx_cycle_t *cycle)
{
/* Executed when each worker process starts */
apr_initialize();
atexit(apr_terminate);
apr_pool_initialize();
apr_pool_create(&process_pool,NULL);
// Do not use apr_pool_initialize or atexit
apr_pool_create(&process_pool, NULL);

ngx_http_mapcache_main_conf_t *mcf =
(ngx_http_mapcache_main_conf_t *)ngx_http_cycle_get_module_main_conf(cycle, ngx_http_mapcache_module);

mapcache_cfg **confs = (mapcache_cfg **)mcf->configs->elts;
ngx_uint_t i;

mapcache_context *ctx = apr_pcalloc(process_pool, sizeof(mapcache_ngx_context));
ctx->pool = process_pool;
mapcache_context_init(ctx);
ctx->log = ngx_mapcache_context_log;
ctx->clone = ngx_mapcache_context_clone;

for (i = 0; i < mcf->configs->nelts; i++)
{
// Perform per-child initialization for each cache, using the process_pool of this worker.
mapcache_cache_child_init(ctx, confs[i], process_pool);
}
return NGX_OK;
}

static void ngx_mapcache_exit_process(ngx_cycle_t *cycle)
{
apr_pool_destroy(process_pool);
if (process_pool){
apr_pool_destroy(process_pool);
process_pool = NULL;
}
}

ngx_module_t ngx_http_mapcache_module = {
Expand Down Expand Up @@ -300,14 +367,18 @@ ngx_http_mapcache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "no mapcache <service>s configured/enabled, no point in continuing.");
return NGX_CONF_ERROR;
}
mapcache_cache_child_init(ctx,ctx->config,ctx->pool);
if(GC_HAS_ERROR(ctx)) {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,ctx->get_error_message(ctx));
return NGX_CONF_ERROR;
}
mapcache_connection_pool_create(ctx->config, &ctx->connection_pool,ctx->pool);
ctx->config->non_blocking = 1;

/* add the mapcache config to the list of configs to be initialized on worker startup */
ngx_http_mapcache_main_conf_t *mcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_mapcache_module);
mapcache_cfg **pcfg = ngx_array_push(mcf->configs);
*pcfg = ctx->config;

ngx_http_core_loc_conf_t *clcf;

clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
Expand Down