Skip to content

feat: add core main-conf access#272

Merged
bavshin-f5 merged 4 commits into
nginx:mainfrom
ryan-surname-p:rnpridgeon/core_conf
Apr 21, 2026
Merged

feat: add core main-conf access#272
bavshin-f5 merged 4 commits into
nginx:mainfrom
ryan-surname-p:rnpridgeon/core_conf

Conversation

@ryan-surname-p

@ryan-surname-p ryan-surname-p commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Add core main-conf wrapper for accessing top-level core main
configuration in ngx-rust.

This introduces:

  • CoreModuleConfExt for ngx_conf_t and ngx_cycle_t
  • core_main_conf / core_main_conf_mut typed helpers
  • NgxCoreModule convenience accessors for ngx_core_conf_t

The new API mirrors the existing HTTP config helper style while
centralizing the unsafe conf_ctx slot traversal in one place.

Why:

Modules that need core process configuration currently have to manually
walk cycle->conf_ctx, index with ngx_core_module.index, and cast to
ngx_core_conf_t. That is repetitive, easy to get wrong, and noisy in
reviews.

The immediate use case is the nginx-wasm issue where module
code needs access to core config such as the env state.

Ref: https://github.com/nginx/nginx-wasm/issues/37

@ryan-surname-p ryan-surname-p changed the title Add core main-conf access helpers for ngx_core_module feat: add core main-conf access Apr 3, 2026
@ensh63

ensh63 commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

This is a really useful addition. But I'd like to suggest to make one step further and implement configuration trait for arbitrary core module similar to HttpModuleMainConf with associated type for config data and functions to get it. Current approach defines interface for main core module only which may not be enough. It does not allow to define config interface for new core modules, and it does not include definitions for module-specific config data types.

@ryan-surname-p

ryan-surname-p commented Apr 3, 2026

Copy link
Copy Markdown
Contributor Author

Sure thing @ensh63 , I'll follow up next week with CoreModuleConf

@ryan-surname-p

ryan-surname-p commented Apr 7, 2026

Copy link
Copy Markdown
Contributor Author

Updated with CoreModuleMainConf, made NgxCoreModule a concrete implementation of it.

Cleaned out the lingering public accessors from testing.

ensh63
ensh63 reviewed Apr 14, 2026
View reviewed changes
Comment thread src/core/conf.rs
}

/// Auxiliary structure to access `ngx_core_module` configuration.
pub struct NgxCoreModule;

@ensh63 ensh63 Apr 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we may expect a special trait for core module, similar to HttpModule trait. To make this PR minimal, I'd suggest to include only module() method to it for now. In future this will allow to add all other necessary components to this trait.

@ryan-surname-p ryan-surname-p Apr 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience and guidance on this one, I'm still wrapping my head around all this but I believe the recent change achieves what you are asking.

@bavshin-f5 bavshin-f5 merged commit 56f27a4 into nginx:main Apr 21, 2026
14 of 15 checks passed
bavshin-f5 pushed a commit to bavshin-f5/ngx-rust that referenced this pull request Apr 30, 2026
@ryan-surname-p @bavshin-f5
feat: add core main-conf access (nginx#272)
b83fec5 
Add core main-conf wrapper for accessing top-level core main
configuration in ngx-rust.

This introduces:

 - CoreModuleConfExt for ngx_conf_t and ngx_cycle_t
 - core_main_conf / core_main_conf_mut typed helpers
 - NgxCoreModule convenience accessors for ngx_core_conf_t

The new API mirrors the existing HTTP config helper style while
centralizing the unsafe conf_ctx slot traversal in one place.

Why:

Modules that need core process configuration currently have to manually
walk cycle->conf_ctx, index with ngx_core_module.index, and cast to
ngx_core_conf_t. That is repetitive, easy to get wrong, and noisy in
reviews.

(cherry picked from commit 56f27a4)
@bavshin-f5 bavshin-f5 mentioned this pull request Apr 30, 2026
Merged
bavshin-f5 pushed a commit that referenced this pull request May 1, 2026
@ryan-surname-p @bavshin-f5
feat: add core main-conf access (#272)
36b715d 
Add core main-conf wrapper for accessing top-level core main
configuration in ngx-rust.

This introduces:

 - CoreModuleConfExt for ngx_conf_t and ngx_cycle_t
 - core_main_conf / core_main_conf_mut typed helpers
 - NgxCoreModule convenience accessors for ngx_core_conf_t

The new API mirrors the existing HTTP config helper style while
centralizing the unsafe conf_ctx slot traversal in one place.

Why:

Modules that need core process configuration currently have to manually
walk cycle->conf_ctx, index with ngx_core_module.index, and cast to
ngx_core_conf_t. That is repetitive, easy to get wrong, and noisy in
reviews.

(cherry picked from commit 56f27a4)
u5surf added a commit to u5surf/ngx-rust that referenced this pull request May 24, 2026
@u5surf
feat(http): expose upstream_states and request timing/byte accessors
2d4aceb 
Add safe accessors for request struct fields that previously
required raw-pointer deref:

  - `Request::upstream_states() -> &[UpstreamState]` walks each
    upstream attempt (one per peer for `proxy_next_upstream`
    retries) via a `#[repr(transparent)]` wrapper exposing
    `peer`, `status`, `response_time`, `connect_time`,
    `header_time`, `queue_time`, `bytes_sent`, `bytes_received`,
    `response_length`.
  - `Request::start_sec()`, `start_msec()`, `request_length()`,
    `bytes_sent()` for the request-level timing/byte fields.

`Request::upstream()` (the raw-pointer accessor) is left untouched
to preserve compatibility.

Unit tests follow the `MaybeUninit::zeroed` pattern from nginx#272.
@u5surf u5surf mentioned this pull request May 25, 2026
Open
7 tasks
u5surf added a commit to u5surf/ngx-rust that referenced this pull request May 25, 2026
@u5surf
feat(http): expose upstream_states and request timing/byte accessors
0cec0b9 
Add safe accessors for request struct fields that previously
required raw-pointer deref:

  - `Request::upstream_states() -> &[UpstreamState]` walks each
    upstream attempt (one per peer for `proxy_next_upstream`
    retries) via a `#[repr(transparent)]` wrapper exposing
    `peer`, `status`, `response_time`, `connect_time`,
    `header_time`, `queue_time`, `bytes_sent`, `bytes_received`,
    `response_length`.
  - `Request::start_sec()`, `start_msec()`, `request_length()`,
    `bytes_sent()` for the request-level timing/byte fields.

`Request::upstream()` (the raw-pointer accessor) is left untouched
to preserve compatibility.

Unit tests follow the `MaybeUninit::zeroed` pattern from nginx#272.

Signed-off-by: Y.Horie <u5.horie@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ensh63 ensh63 ensh63 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ryan-surname-p @ensh63 @bavshin-f5