1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
// Copyright 2020 ZomboDB, LLC <zombodb@gmail.com>. All rights reserved. Use of this source code is
// governed by the MIT license that can be found in the LICENSE file.
/// Similar to Rust's `Box<T>` type, `PgBox<T>` also represents heap-allocated memory.
use crate::{pg_sys, PgMemoryContexts};
//use std::fmt::{Debug, Error, Formatter};
use std::marker::PhantomData;
use std::ops::{Deref, DerefMut};
use std::ptr::NonNull;
/// Similar to Rust's `Box<T>` type, `PgBox<T>` also represents heap-allocated memory.
///
/// However, it represents a heap-allocated pointer that was allocated by **Postgres's** memory
/// allocation functions (`palloc`, etc). Think of `PgBox<T>` as a wrapper around an otherwise
/// opaque Postgres type that is projected as a concrete Rust type.
///
/// Depending on its usage, it'll interoperate correctly with Rust's Drop semantics, such that the
/// backing Postgres-allocated memory is `pfree()'d` when the `PgBox<T>` is dropped, but it is
/// possible to effectively return management of the memory back to Postgres (to free on Transaction
/// end, for example) by calling `::into_pg()` or ``::into_pg_boxed()`. This is especially useful
/// for returning values back to Postgres.
///
/// ## Examples
///
/// This example allocates a simple Postgres structure, modifies it, and returns it back to Postgres:
///
/// ```rust,no_run
/// use pgx::*;
///
/// #[pg_guard]
/// pub fn do_something() -> pg_sys::ItemPointer {
/// // postgres-allocate an ItemPointerData structure
/// let mut tid = PgBox::<pg_sys::ItemPointerData>::alloc();
///
/// // set its position to 42
/// tid.ip_posid = 42;
///
/// // return it to Postgres
/// tid.into_pg()
/// }
/// ```
///
/// A similar example, but instead the `PgBox<T>`'s backing memory gets freed when the box is
/// dropped:
///
/// ```rust,no_run
/// use pgx::*;
///
/// #[pg_guard]
/// pub fn do_something() {
/// // postgres-allocate an ItemPointerData structure
/// let mut tid = PgBox::<pg_sys::ItemPointerData>::alloc();
///
/// // set its position to 42
/// tid.ip_posid = 42;
///
/// // tid gets dropped here and as such, gets immediately pfree()'d
/// }
/// ```
///
/// Alternatively, perhaps you want to work with a pointer Postgres gave you as if it were a Rust type,
/// but it can't be freed on Drop since you don't own it -- Postgres does:
///
/// ```rust,no_run
/// use pgx::*;
///
/// #[pg_guard]
/// pub fn do_something() {
/// // open a relation and project it as a pg_sys::Relation
/// let relid: pg_sys::Oid = 42;
/// let lockmode = pg_sys::AccessShareLock as i32;
/// let relation = unsafe { PgBox::from_pg(pg_sys::relation_open(relid, lockmode)) };
///
/// // do something with/to 'relation'
/// // ...
///
/// // pass the relation back to Postgres
/// unsafe { pg_sys::relation_close(relation.as_ptr(), lockmode); }
///
/// // While the `PgBox` instance gets dropped, the backing Postgres-allocated pointer is
/// // **not** freed since it came "::from_pg()". We don't own the underlying memory so
/// // we can't free it
/// }
/// ```
#[repr(transparent)]
pub struct PgBox<T, AllocatedBy: WhoAllocated<T> = AllocatedByPostgres> {
ptr: Option<NonNull<T>>,
__marker: PhantomData<AllocatedBy>,
}
/// A trait to track if the contents of a [PgBox] were allocated by Rust or Postgres.
pub trait WhoAllocated<T> {
fn free(ptr: *mut T);
}
/// Indicates the [PgBox] contents were allocated by Postgres. This is also PgBox' default
/// understanding.
pub struct AllocatedByPostgres;
/// Indicates the [PgBox] contents were allocated by Rust.
pub struct AllocatedByRust;
impl<T> WhoAllocated<T> for AllocatedByPostgres {
/// Doesn't do anything
fn free(_ptr: *mut T) {}
}
impl<T> WhoAllocated<T> for AllocatedByRust {
/// Uses [pg_sys::pfree] to free the specified pointer
#[inline]
fn free(ptr: *mut T) {
unsafe {
pg_sys::pfree(ptr as *mut _);
}
}
}
impl<T> PgBox<T, AllocatedByPostgres> {
/// Box a pointer that cames from Postgres.
///
/// When this `PgBox<T>` is dropped, the boxed memory is **not** freed. Since Postgres
/// allocated it, Postgres is responsible for freeing it.
#[inline]
pub unsafe fn from_pg(ptr: *mut T) -> PgBox<T, AllocatedByPostgres> {
PgBox::<T, AllocatedByPostgres> {
ptr: NonNull::new(ptr),
__marker: PhantomData,
}
}
}
impl<T> PgBox<T, AllocatedByRust> {
/**
Allocates memory in PostgreSQL and then places `val` into it.
This value is managed by Rust, so gets dropped via normal [`Drop`][std::ops::Drop]
semantics.
If you need to give the boxed pointer to Postgres, call [`.into_pg()`][PgBox::into_pg].
```rust,no_run
use pgx::{PgBox, AllocatedByRust};
let ptr: PgBox<i32, AllocatedByRust> = PgBox::new(5);
assert_eq!(*ptr, 5);
let mut ptr: PgBox<Vec<i32>, AllocatedByRust> = PgBox::new(vec![]);
assert_eq!(*ptr, Vec::<i32>::default());
ptr.push(1);
assert_eq!(*ptr, vec![1]);
ptr.push(2);
assert_eq!(*ptr, vec![1, 2]);
ptr.push(3);
assert_eq!(*ptr, vec![1, 2, 3]);
let drained = ptr.drain(..).collect::<Vec<_>>();
assert_eq!(drained, vec![1, 2, 3])
```
*/
pub fn new(val: T) -> PgBox<T, AllocatedByRust> {
let ptr = Self::alloc0();
unsafe { core::ptr::write(ptr.as_ptr(), val) };
ptr
}
/**
Allocates memory in PostgreSQL and then places `val` into it.
This value is managed by Rust, so gets dropped via normal [`Drop`][std::ops::Drop]
semantics.
If you need to give the boxed pointer to Postgres, call [`.into_pg()`][PgBox::into_pg].
```rust,no_run
use pgx::{PgBox, PgMemoryContexts, AllocatedByRust};
let ptr: PgBox<i32, AllocatedByRust> = PgBox::new_in_context(5, PgMemoryContexts::CurrentMemoryContext);
assert_eq!(*ptr, 5);
```
*/
pub fn new_in_context(val: T, memory_context: PgMemoryContexts) -> PgBox<T, AllocatedByRust> {
let ptr = Self::alloc0_in_context(memory_context);
unsafe { core::ptr::write(ptr.as_ptr(), val) };
ptr
}
}
impl<T, AllocatedBy: WhoAllocated<T>> PgBox<T, AllocatedBy> {
/// Box a pointer that was allocated within Rust
///
/// When this `PgBox<T>` is dropped, the boxed memory is freed. Since Rust
/// allocated it, Rust is responsible for freeing it.
///
/// If you need to give the boxed pointer to Postgres, call [`.into_pg()`][PgBox::into_pg]
#[inline]
pub unsafe fn from_rust(ptr: *mut T) -> PgBox<T, AllocatedByRust> {
PgBox::<T, AllocatedByRust> {
ptr: NonNull::new(ptr),
__marker: PhantomData,
}
}
/// Allocate enough memory for the type'd struct, within Postgres' `CurrentMemoryContext` The
/// allocated memory is uninitialized.
///
/// When this object is dropped the backing memory will be pfree'd,
/// unless it is instead turned `into_pg()`, at which point it will be freeded
/// when its owning MemoryContext is deleted by Postgres (likely transaction end).
///
/// ## Examples
/// ```rust,no_run
/// use pgx::{PgBox, pg_sys};
/// let ctid = PgBox::<pg_sys::ItemPointerData>::alloc();
/// ```
#[inline]
pub fn alloc() -> PgBox<T, AllocatedByRust> {
PgBox::<T, AllocatedByRust> {
ptr: Some(unsafe {
NonNull::new_unchecked(pg_sys::palloc(std::mem::size_of::<T>()) as *mut T)
}),
__marker: PhantomData,
}
}
/// Allocate enough memory for the type'd struct, within Postgres' `CurrentMemoryContext` The
/// allocated memory is zero-filled.
///
/// When this object is dropped the backing memory will be pfree'd,
/// unless it is instead turned `into_pg()`, at which point it will be freeded
/// when its owning MemoryContext is deleted by Postgres (likely transaction end).
///
/// ## Examples
/// ```rust,no_run
/// use pgx::{PgBox, pg_sys};
/// let ctid = PgBox::<pg_sys::ItemPointerData>::alloc0();
/// ```
#[inline]
pub fn alloc0() -> PgBox<T, AllocatedByRust> {
PgBox::<T, AllocatedByRust> {
ptr: Some(unsafe {
NonNull::new_unchecked(pg_sys::palloc0(std::mem::size_of::<T>()) as *mut T)
}),
__marker: PhantomData,
}
}
/// Allocate enough memory for the type'd struct, within the specified Postgres MemoryContext.
/// The allocated memory is uninitalized.
///
/// When this object is dropped the backing memory will be pfree'd,
/// unless it is instead turned `into_pg()`, at which point it will be freeded
/// when its owning MemoryContext is deleted by Postgres (likely transaction end).
///
/// ## Examples
/// ```rust,no_run
/// use pgx::{PgBox, pg_sys, PgMemoryContexts};
/// let ctid = PgBox::<pg_sys::ItemPointerData>::alloc_in_context(PgMemoryContexts::TopTransactionContext);
/// ```
#[inline]
pub fn alloc_in_context(memory_context: PgMemoryContexts) -> PgBox<T, AllocatedByRust> {
PgBox::<T, AllocatedByRust> {
ptr: Some(unsafe {
NonNull::new_unchecked(pg_sys::MemoryContextAlloc(
memory_context.value(),
std::mem::size_of::<T>(),
) as *mut T)
}),
__marker: PhantomData,
}
}
/// Allocate enough memory for the type'd struct, within the specified Postgres MemoryContext.
/// The allocated memory is zero-filled.
///
/// When this object is dropped the backing memory will be pfree'd,
/// unless it is instead turned `into_pg()`, at which point it will be freeded
/// when its owning MemoryContext is deleted by Postgres (likely transaction end).
///
/// ## Examples
/// ```rust,no_run
/// use pgx::{PgBox, pg_sys, PgMemoryContexts};
/// let ctid = PgBox::<pg_sys::ItemPointerData>::alloc0_in_context(PgMemoryContexts::TopTransactionContext);
/// ```
#[inline]
pub fn alloc0_in_context(memory_context: PgMemoryContexts) -> PgBox<T, AllocatedByRust> {
PgBox::<T, AllocatedByRust> {
ptr: Some(unsafe {
NonNull::new_unchecked(pg_sys::MemoryContextAllocZero(
memory_context.value(),
std::mem::size_of::<T>(),
) as *mut T)
}),
__marker: PhantomData,
}
}
/// Allocate a Postgres `pg_sys::Node` subtype, using `palloc` in the `CurrentMemoryContext`.
///
/// The allocated node will have it's `type_` field set to the `node_tag` argument, and will
/// otherwise be initialized with all zeros
///
/// ## Examples
/// ```rust,no_run
/// use pgx::{PgBox, pg_sys};
/// let create_trigger_statement = PgBox::<pg_sys::CreateTrigStmt>::alloc_node(pg_sys::NodeTag_T_CreateTrigStmt);
/// ```
#[inline]
pub fn alloc_node(node_tag: pg_sys::NodeTag) -> PgBox<T, AllocatedByRust> {
let node = PgBox::<T>::alloc0();
let ptr = node.as_ptr();
unsafe {
(ptr as *mut _ as *mut pg_sys::Node).as_mut().unwrap().type_ = node_tag;
}
node
}
/// Box nothing
#[inline]
pub fn null() -> PgBox<T, AllocatedByPostgres> {
PgBox::<T, AllocatedByPostgres> {
ptr: None,
__marker: PhantomData,
}
}
/// Are we boxing a NULL?
#[inline]
pub fn is_null(&self) -> bool {
self.ptr.is_none()
}
/// Return the boxed pointer, so that it can be passed back into a Postgres function
#[inline]
pub fn as_ptr(&self) -> *mut T {
match self.ptr.as_ref() {
Some(ptr) => unsafe { ptr.clone().as_mut() as *mut T },
None => std::ptr::null_mut(),
}
}
/// Useful for returning the boxed pointer back to Postgres (as a return value, for example).
///
/// The boxed pointer is **not** free'd by Rust
#[inline]
pub fn into_pg(mut self) -> *mut T {
match self.ptr.take() {
Some(ptr) => ptr.as_ptr(),
None => std::ptr::null_mut(),
}
}
/// Useful for returning the boxed pointer back to Postgres (as a return value, for example).
///
/// The boxed pointer is **not** free'd by Rust
#[inline]
pub fn into_pg_boxed(mut self) -> PgBox<T, AllocatedByPostgres> {
// SAFETY: we know our internal pointer is good so we can now make it owned by Postgres
unsafe {
PgBox::from_pg(match self.ptr.take() {
Some(ptr) => ptr.as_ptr(),
None => std::ptr::null_mut(),
})
}
}
/// Execute a closure with a mutable, `PgBox`'d form of the specified `ptr`
#[inline]
pub unsafe fn with<F: FnOnce(&mut PgBox<T>)>(ptr: *mut T, func: F) {
func(&mut PgBox::from_pg(ptr))
}
}
impl<T, AllocatedBy: WhoAllocated<T>> Deref for PgBox<T, AllocatedBy> {
type Target = T;
fn deref(&self) -> &Self::Target {
match self.ptr.as_ref() {
Some(ptr) => unsafe { ptr.as_ref() },
None => panic!("Attempt to dereference null pointer during Deref of PgBox"),
}
}
}
impl<T, AllocatedBy: WhoAllocated<T>> DerefMut for PgBox<T, AllocatedBy> {
fn deref_mut(&mut self) -> &mut T {
match self.ptr.as_mut() {
Some(ptr) => unsafe { ptr.as_mut() },
None => panic!("Attempt to dereference null pointer during DerefMut of PgBox"),
}
}
}
impl<T, AllocatedBy: WhoAllocated<T>> Drop for PgBox<T, AllocatedBy> {
fn drop(&mut self) {
if let Some(ptr) = self.ptr {
AllocatedBy::free(ptr.as_ptr());
}
}
}