Skip to content
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.

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

Port bufpage.h functions #1982

Merged
merged 6 commits into from
Feb 24, 2025

Conversation

rebasedming
Copy link
Contributor

Ports functions from bufpage.h that are used to interact with block storage

Copy link
Contributor

@eeeebbbbrrrr eeeebbbbrrrr left a comment

Choose a reason for hiding this comment

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

Just the one change and I think this will be good to merge.

Thanks, @rebasedming

Comment on lines 396 to 401
// #define BufferGetPageSize(buffer) \
// ( \
// AssertMacro(BufferIsValid(buffer)), \
// (Size)BLCKSZ \
// )
pg_sys::BLCKSZ as pg_sys::Size
Copy link
Contributor

@eeeebbbbrrrr eeeebbbbrrrr Feb 24, 2025

Choose a reason for hiding this comment

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

For completeness, this should do what the BufferIsValid() macro does too. Can you add another top-level function for that and then assert!(BufferIsValid(buffer)) here, too?

/*
 * BufferIsValid
 *		True iff the given buffer number is valid (either as a shared
 *		or local buffer).
 *
 * Note: For a long time this was defined the same as BufferIsPinned,
 * that is it would say False if you didn't hold a pin on the buffer.
 * I believe this was bogus and served only to mask logic errors.
 * Code should always know whether it has a buffer reference,
 * independently of the pin state.
 *
 * Note: For a further long time this was not quite the inverse of the
 * BufferIsInvalid() macro, in that it also did sanity checks to verify
 * that the buffer number was in range.  Most likely, this macro was
 * originally intended only to be used in assertions, but its use has
 * since expanded quite a bit, and the overhead of making those checks
 * even in non-assert-enabled builds can be significant.  Thus, we've
 * now demoted the range checks to assertions within the macro itself.
 */
static inline bool
BufferIsValid(Buffer bufnum)
{
	Assert(bufnum <= NBuffers);
	Assert(bufnum >= -NLocBuffer);

	return bufnum != InvalidBuffer;
}

I think the rust port would basically be:

/// <comments from above, please>
pub unsafe fn BufferIsValid(bufnum: pg_sys::Buffer) -> bool {
   assert!(bufnum <= pg_sys::NBuffers);
   assert!(bufnum >= -pg_sys::NLocBuffer);
   bufnum != pg_sys::InvalidBuffer
}

Copy link
Contributor

@eeeebbbbrrrr eeeebbbbrrrr left a comment

Choose a reason for hiding this comment

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

oops, requesting changes

@eeeebbbbrrrr
Copy link
Contributor

I'll figure out what's wrong with CI -- appears to be unrelated to this PR.

@eeeebbbbrrrr
Copy link
Contributor

Thank you @rebasedming. Merging!

@eeeebbbbrrrr eeeebbbbrrrr merged commit a467a28 into pgcentralfoundation:develop Feb 24, 2025
1 of 14 checks passed
eeeebbbbrrrr added a commit that referenced this pull request Feb 24, 2025
Welcome to pgrx v0.13.0. The first update in a little bit, which makes
pgrx current with upstream dependencies, rust 1.85.0 (but not 2024
Edition, yet), and a slew of fixes and cleanups and community
contributions.

# Upgrading

You'll need to `cargo install cargo-pgrx --version 0.13.0 --locked` to
get the latest `cargo-pgrx` tool, and then you can run `cargo pgrx
upgrade` in your extension crates to update their dependencies.

# Breaking Changes

Generally, the only breaking changes in v0.13.0 are related to the
user-facing SPI APIs. In general, SPI functions that previously took a
Vec of Arguments now take a `&[DatumWithOid]`, with proper lifetime
bounds. This is a fairly straightforward, boilerplate to update to.

@YohDeadfall has done a lot of work on improving SPI's safety and it's
greatly appreciated!

# What's Changed

## `cargo-pgrx`

* fix a deadlock in `cargo pgrx install` during `get_git_hash()` by
@eeeebbbbrrrr in #1935
* `cargo pgrx test --runas` envar passing by @eeeebbbbrrrr in
#1674
* Search for sql upgrade scripts relative to the package manifest by
@tristan957 in #1979

## Build System

* use `allowlist_file` for bindgen by @usamoi in
#1922
* add `pg_config --libdir` to linker search path by @usamoi in
#1932
* lock patch version of pgrx-bindgen by @usamoi in
#1939
* Introduce a blocklist of "yanked" Postgres versions by @eeeebbbbrrrr
in #1950
* Make sure bindgen gets the cppflags even if we aren't using macOS by
@thomcc in #1336

## SPI

* Made SPI query arguments type safe by @YohDeadfall in
#1858
* Changed args of prepare methods to be slices by @YohDeadfall in
#1933
* Added connect_mut for data changing SPI operations by @YohDeadfall in
#1913

## General `pgrx-pg-sys` Interfaces

* Allow creating Oid from a u32 in a const context by @syvb in
#1943
* Add utils/acl.h by @daamien in
#1945
* Add catalog/catalog.h by @daamien in
#1946
* Added `oids_of!` macro by @YohDeadfall in
#1879
* Port `bufpage.h` functions by @rebasedming in
#1982

## Bug Fixes

* Check wakeup_flags from `wait_latch` function to exit on
`WL_POSTMASTER_DEATH` by @var77 in
#1938


## Overall Code Cleanup

* refactor: remove redundant references (`&`) by @hamirmahal in
#1941
* fix warnings by @usamoi in
#1948
* Updating readme.md by @ChronicallyJD in
#1949
* style: simplify some statements for readability by @hamirmahal in
#1962
* docs: fix pgx info in cargo-pgrx README by @mrdrivingduck in
#1953
* Updated expected UI test outputs by @YohDeadfall in
#1981
* Fix "about" info for cross subcommand by @mjgarton in
#1974
* update dependencies and fix compilation issues by @eeeebbbbrrrr in
#1983

# Thanks!

Thanks to the community, past, present, and future. Especially to our
new contributors...

# New Contributors
* @var77 made their first contribution in
#1938
* @ChronicallyJD made their first contribution in
#1949
* @mrdrivingduck made their first contribution in
#1953
* @tristan957 made their first contribution in
#1979
* @mjgarton made their first contribution in
#1974

**Full Changelog**:
v0.12.7...v0.13.0
@philippemnoel philippemnoel deleted the port-bufpage branch March 1, 2025 01:17
usamoi pushed a commit to tensorchord/pgrx that referenced this pull request Mar 6, 2025
Ports functions from `bufpage.h` that are used to interact with block storage
usamoi pushed a commit to tensorchord/pgrx that referenced this pull request Mar 6, 2025
Welcome to pgrx v0.13.0. The first update in a little bit, which makes
pgrx current with upstream dependencies, rust 1.85.0 (but not 2024
Edition, yet), and a slew of fixes and cleanups and community
contributions.

# Upgrading

You'll need to `cargo install cargo-pgrx --version 0.13.0 --locked` to
get the latest `cargo-pgrx` tool, and then you can run `cargo pgrx
upgrade` in your extension crates to update their dependencies.

# Breaking Changes

Generally, the only breaking changes in v0.13.0 are related to the
user-facing SPI APIs. In general, SPI functions that previously took a
Vec of Arguments now take a `&[DatumWithOid]`, with proper lifetime
bounds. This is a fairly straightforward, boilerplate to update to.

@YohDeadfall has done a lot of work on improving SPI's safety and it's
greatly appreciated!

# What's Changed

## `cargo-pgrx`

* fix a deadlock in `cargo pgrx install` during `get_git_hash()` by
@eeeebbbbrrrr in pgcentralfoundation#1935
* `cargo pgrx test --runas` envar passing by @eeeebbbbrrrr in
pgcentralfoundation#1674
* Search for sql upgrade scripts relative to the package manifest by
@tristan957 in pgcentralfoundation#1979

## Build System

* use `allowlist_file` for bindgen by @usamoi in
pgcentralfoundation#1922
* add `pg_config --libdir` to linker search path by @usamoi in
pgcentralfoundation#1932
* lock patch version of pgrx-bindgen by @usamoi in
pgcentralfoundation#1939
* Introduce a blocklist of "yanked" Postgres versions by @eeeebbbbrrrr
in pgcentralfoundation#1950
* Make sure bindgen gets the cppflags even if we aren't using macOS by
@thomcc in pgcentralfoundation#1336

## SPI

* Made SPI query arguments type safe by @YohDeadfall in
pgcentralfoundation#1858
* Changed args of prepare methods to be slices by @YohDeadfall in
pgcentralfoundation#1933
* Added connect_mut for data changing SPI operations by @YohDeadfall in
pgcentralfoundation#1913

## General `pgrx-pg-sys` Interfaces

* Allow creating Oid from a u32 in a const context by @syvb in
pgcentralfoundation#1943
* Add utils/acl.h by @daamien in
pgcentralfoundation#1945
* Add catalog/catalog.h by @daamien in
pgcentralfoundation#1946
* Added `oids_of!` macro by @YohDeadfall in
pgcentralfoundation#1879
* Port `bufpage.h` functions by @rebasedming in
pgcentralfoundation#1982

## Bug Fixes

* Check wakeup_flags from `wait_latch` function to exit on
`WL_POSTMASTER_DEATH` by @var77 in
pgcentralfoundation#1938


## Overall Code Cleanup

* refactor: remove redundant references (`&`) by @hamirmahal in
pgcentralfoundation#1941
* fix warnings by @usamoi in
pgcentralfoundation#1948
* Updating readme.md by @ChronicallyJD in
pgcentralfoundation#1949
* style: simplify some statements for readability by @hamirmahal in
pgcentralfoundation#1962
* docs: fix pgx info in cargo-pgrx README by @mrdrivingduck in
pgcentralfoundation#1953
* Updated expected UI test outputs by @YohDeadfall in
pgcentralfoundation#1981
* Fix "about" info for cross subcommand by @mjgarton in
pgcentralfoundation#1974
* update dependencies and fix compilation issues by @eeeebbbbrrrr in
pgcentralfoundation#1983

# Thanks!

Thanks to the community, past, present, and future. Especially to our
new contributors...

# New Contributors
* @var77 made their first contribution in
pgcentralfoundation#1938
* @ChronicallyJD made their first contribution in
pgcentralfoundation#1949
* @mrdrivingduck made their first contribution in
pgcentralfoundation#1953
* @tristan957 made their first contribution in
pgcentralfoundation#1979
* @mjgarton made their first contribution in
pgcentralfoundation#1974

**Full Changelog**:
pgcentralfoundation/pgrx@v0.12.7...v0.13.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants