coffi/CHANGELOG.md

# Change Log
All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).

## [1.0.472] - 2024-10-03
### Added
- New `coffi.mem/null` var for implementing custom types

### Performance
- Upcall functions serialized from functions returned by deserializing function pointers now use the backing function pointer directly
- Upcall and downcall classes have been changed to be memoized, meaning ASM is no longer invoked every time a function is serialized, which should drastically improve performance where functions are serialized in a hot loop

### Fixed
- Incorrect docstring on `coffi.mem/address-of` that implied some type of pointer type was returned rather than a long
- Usage of deprecated `(Class/STATIC_FIELD)` access pattern

## [1.0.450] - 2024-10-02
### Added
- Support for JDK 22
- `reinterpret` function which changes the size associated with a segment, optionally associating it with an arena and cleanup action

### Changed
- Arglists and docstrings of functions to refer to arenas rather than the outdated terms scope or session
- Change the arguments to `as-segment` to take longs to account for the removal of an Address type

### Removed
- Deprecated functions referring to sessions and scopes
- Deprecated functions `slice-into` and `with-offset`, replaced by the function `slice`

### Fixed
- Prep step when using coffi as a dependency wouldn't re-run if it failed during execution, e.g. when using the incorrect java version

## [0.6.409] - 2023-03-31
### Added
- Support for JDK 19
- New macros for defining vars with values from native code
- New function to allow getting the backing memory segment of a `coffi.ffi.StaticVariable`, to replace the `Addressable` implementation lost in the migration to JDK 18

### Fixed
- Bug where `static-variable`s with primitive types would not deserialize properly on `deref`
- Uses of `defvar` not compiling
- Bug where nil values would not be correctly coerced to null pointers when passed to inlined functions
- Bug where inline serde functions would fail on complex pointer types
- Bug where padding in structs may be increased when fields have alignments less than their size
- Bug where pointer alignment was incorrectly defined

### Changed
- References to `scope` as a term have been changed to `session` to match Panama messaging. Where this conflicts with function names, old versions have been deprecated and new names have been introduced.

## [0.5.357] - 2022-07-07
### Removed
- `:coffi.mem/long-long` primitive type
- `coffi.mem/slice-into`; the function no longer has an equivalent in panama, but see 2-arity of `coffi.mem/as-segment` for an alternative

### Changed
- `coffi.mem/as-segment` no longer has a close action arity
- JDK version from 17 to 18

## [0.4.341] - 2022-01-23
### Added
- Constants for size and alignment of primitive types
- Support for non-native byte orders of primitive types
- Functions for reading and writing primitive types (e.g. `coffi.mem/read-float`, `coffi.mem/write-long`, etc.)
- Layout objects may now be passed to `coffi.mem/size-of` and `coffi.mem/align-of`
- Constants for native-order primitive layouts
- Constants for byte orders

### Changed
- The `coffi.mem/primitive?` predicate is now actually a function instead of a set

## [0.3.298] - 2022-01-10
### Added
- New `coffi.layout` namespace with support for forcing C layout rules on structs

### Fixed
- C-characters were being read as UTF-16 rather than ASCII code points

## [0.2.277] - 2021-10-25
### Fixed
- Non-primitive arguments on upcalls would generate invalid bytecode with `nil` instructions

## [0.2.259] - 2021-10-16
### Fixed
- Long and double arguments to upcalls failed to compile in some cases
- Void return types on upcalls would crash on serialization

## [0.1.251] - 2021-10-14
### Fixed
- Bug with the inline expansion of `make-serde-wrapper`, make it more maintainable

## [0.1.246] - 2021-10-14
### Fixed
- Incorrect inline expansion of `make-serde-wrapper` in cases where a function has no arguments

## [0.1.241] - 2021-10-14
### Performance
- Added an `:inline` function to `make-serde-wrapper` to remove serialization overhead on primitives
- Added multimethod implementations for primitives in (de)serialization functions, rather than using the default

### Fixed
- `cfn` didn't add serializers with non-primitive types in some cases

## [0.1.220] - 2021-10-09
### Fixed
- All-primitive method types still used serialization when called from `cfn`
- Arrays deserialized to non-vector sequences
- Non-primitive argument types fail to link

## [0.1.205] - 2021-10-06
### Added
- An `address?` predicate

### Fixed
- Compound types caused problems in arglists meta on expansion of `defcfn`
- Compound types were not allowed as return types in `defcfn`
- `nil` was not considered a null pointer
- Primitive-serializing types fail to compile as arguments to downcall handles
- Primitive-serializing types fail to load as arguments to upcall functions
- Void return types on upcalls crash the JVM
- Invalid implementation of serialize-into for primitive types

## [0.1.192] - 2021-09-30
### Added
- An `::ffi/address` key to wrapper functions' metadata

### Fixed
- Usage of a method no longer in Panama that breaks `with-acquired`

## [0.1.184] - 2021-09-30
### Fixed
- Deserializing nullpointers as functions threw an exception
- Upcall stubs with non-primitive arguments failed to compile
- Upcall stubs had incorrect types

## [0.1.176] - 2021-09-29
### Fixed
- Usage of `defcfn` without a docstring produced an invalid `def` form

## [0.1.169] - 2021-09-28
### Added
- Macro for easily wrapping native functions with arbitrary logic
- Functions for creating wrapper fns for native functions
- Macro for easily aliasing types
- Functions to create scopes for deterministic deallocation
- Functions to load libraries by name or path
- Support for serializing and deserializing arbitrary Clojure functions
- Support for serializing and deserializing arbitrary Clojure data structures

[1.0.472]: https://github.com/IGJoshua/coffi/compare/v1.0.450...v1.0.472
[1.0.450]: https://github.com/IGJoshua/coffi/compare/v0.6.409...v1.0.450
[0.6.409]: https://github.com/IGJoshua/coffi/compare/v0.5.357...v0.6.409
[0.5.357]: https://github.com/IGJoshua/coffi/compare/v0.4.341...v0.5.357
[0.4.341]: https://github.com/IGJoshua/coffi/compare/v0.3.298...v0.4.341
[0.3.298]: https://github.com/IGJoshua/coffi/compare/v0.2.277...v0.3.298
[0.2.277]: https://github.com/IGJoshua/coffi/compare/v0.2.259...v0.2.277
[0.2.259]: https://github.com/IGJoshua/coffi/compare/v0.1.251...v0.2.259
[0.1.251]: https://github.com/IGJoshua/coffi/compare/v0.1.246...v0.1.251
[0.1.246]: https://github.com/IGJoshua/coffi/compare/v0.1.241...v0.1.246
[0.1.241]: https://github.com/IGJoshua/coffi/compare/v0.1.220...v0.1.241
[0.1.220]: https://github.com/IGJoshua/coffi/compare/v0.1.205...v0.1.220
[0.1.205]: https://github.com/IGJoshua/coffi/compare/v0.1.192...v0.1.205
[0.1.192]: https://github.com/IGJoshua/coffi/compare/v0.1.184...v0.1.192
[0.1.184]: https://github.com/IGJoshua/coffi/compare/v0.1.176...v0.1.184
[0.1.176]: https://github.com/IGJoshua/coffi/compare/v0.1.169...v0.1.176
[0.1.169]: https://github.com/IGJoshua/coffi/compare/16f56bc31d69142ec4d2fb61b15b069d78b127ca...v0.1.169
Initial commit 2021-09-14 21:29:41 +00:00			`# Change Log`
			`All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).`

Update changelog 2024-10-03 18:20:31 +00:00			`## [1.0.472] - 2024-10-03`
Add `null` for implementing serdes 2024-10-02 20:22:29 +00:00			`### Added`
			- New `coffi.mem/null` var for implementing custom types

Implement memoization of upcall and downcall classes 2024-10-03 14:55:54 +00:00			`### Performance`
Optimize re-serializing deserialized functions 2024-10-03 15:12:37 +00:00			`- Upcall functions serialized from functions returned by deserializing function pointers now use the backing function pointer directly`
Implement memoization of upcall and downcall classes 2024-10-03 14:55:54 +00:00			`- Upcall and downcall classes have been changed to be memoized, meaning ASM is no longer invoked every time a function is serialized, which should drastically improve performance where functions are serialized in a hot loop`

Fix bad usage of static fields as calls 2024-10-02 20:16:09 +00:00			`### Fixed`
Update docstring to reflect address-of returning a long 2024-10-03 18:11:57 +00:00			- Incorrect docstring on `coffi.mem/address-of` that implied some type of pointer type was returned rather than a long
Fix bad usage of static fields as calls 2024-10-02 20:16:09 +00:00			- Usage of deprecated `(Class/STATIC_FIELD)` access pattern
Update changelog 2024-10-02 19:45:13 +00:00
Update changelog for release date 2024-10-02 18:47:46 +00:00			`## [1.0.450] - 2024-10-02`
Update changelog 2024-07-24 23:32:30 +00:00			`### Added`
			`- Support for JDK 22`
Update changelog for removal of deprecations etc. 2024-10-01 17:36:46 +00:00			- `reinterpret` function which changes the size associated with a segment, optionally associating it with an arena and cleanup action

			`### Changed`
			`- Arglists and docstrings of functions to refer to arenas rather than the outdated terms scope or session`
			- Change the arguments to `as-segment` to take longs to account for the removal of an Address type

			`### Removed`
			`- Deprecated functions referring to sessions and scopes`
			- Deprecated functions `slice-into` and `with-offset`, replaced by the function `slice`
Update changelog 2024-07-24 23:32:30 +00:00
			`### Fixed`
			`- Prep step when using coffi as a dependency wouldn't re-run if it failed during execution, e.g. when using the incorrect java version`
Update changelog 2023-03-31 15:33:42 +00:00
Update changelog 2023-03-31 15:22:05 +00:00			`## [0.6.409] - 2023-03-31`
Add function to get the segment from a static variable 2022-07-07 18:05:39 +00:00			`### Added`
Update changelog for JDK 19 support 2022-11-11 20:09:20 +00:00			`- Support for JDK 19`
Add macros to ease creating static variable references 2022-07-07 18:27:02 +00:00			`- New macros for defining vars with values from native code`
Add function to get the segment from a static variable 2022-07-07 18:05:39 +00:00			- New function to allow getting the backing memory segment of a `coffi.ffi.StaticVariable`, to replace the `Addressable` implementation lost in the migration to JDK 18
Add unreleased section to changelog 2022-07-07 15:02:32 +00:00
Fix incorrect pointer alignment 2022-10-31 16:36:16 +00:00			`### Fixed`
Update changelog 2023-03-28 19:26:10 +00:00			- Bug where `static-variable`s with primitive types would not deserialize properly on `deref`
			- Uses of `defvar` not compiling
Fix nullpointer serialization in simpler inline cases 2022-10-31 18:38:07 +00:00			`- Bug where nil values would not be correctly coerced to null pointers when passed to inlined functions`
Fix bug with inlined serdes causing complex pointer serdes to fail 2022-10-31 18:23:31 +00:00			`- Bug where inline serde functions would fail on complex pointer types`
Fix incorrect padding in C-layout structs 2022-10-31 16:36:38 +00:00			`- Bug where padding in structs may be increased when fields have alignments less than their size`
Fix incorrect pointer alignment 2022-10-31 16:36:16 +00:00			`- Bug where pointer alignment was incorrectly defined`

Update changelog for JDK 19 support 2022-11-11 20:09:20 +00:00			`### Changed`
			- References to `scope` as a term have been changed to `session` to match Panama messaging. Where this conflicts with function names, old versions have been deprecated and new names have been introduced.

Update changelog for release 2022-07-07 14:56:25 +00:00			`## [0.5.357] - 2022-07-07`
Update mem namespace to jdk18 2022-04-15 14:56:38 +00:00			`### Removed`
Update readme and changelog about removal of long-long 2022-07-07 14:25:58 +00:00			- `:coffi.mem/long-long` primitive type
			- `coffi.mem/slice-into`; the function no longer has an equivalent in panama, but see 2-arity of `coffi.mem/as-segment` for an alternative
Update mem namespace to jdk18 2022-04-15 14:56:38 +00:00
Update to jdk 18 in changelog 2022-04-15 14:58:10 +00:00			`### Changed`
Update mem namespace to jdk18 2022-04-15 14:56:38 +00:00			- `coffi.mem/as-segment` no longer has a close action arity
Update to jdk 18 in changelog 2022-04-15 14:58:10 +00:00			`- JDK version from 17 to 18`
Add unreleased section to changelog 2022-01-24 02:28:56 +00:00
Update changelog for release 2022-01-24 02:18:58 +00:00			`## [0.4.341] - 2022-01-23`
Update changelog 2022-01-18 20:24:10 +00:00			`### Added`
Update changelog 2022-01-19 17:01:52 +00:00			`- Constants for size and alignment of primitive types`
Update changelog 2022-01-18 20:24:10 +00:00			`- Support for non-native byte orders of primitive types`
			- Functions for reading and writing primitive types (e.g. `coffi.mem/read-float`, `coffi.mem/write-long`, etc.)
			- Layout objects may now be passed to `coffi.mem/size-of` and `coffi.mem/align-of`
			`- Constants for native-order primitive layouts`
			`- Constants for byte orders`

			`### Changed`
			- The `coffi.mem/primitive?` predicate is now actually a function instead of a set
Add unreleased section 2022-01-10 21:36:42 +00:00
Update changelog for release 2022-01-10 21:05:46 +00:00			`## [0.3.298] - 2022-01-10`
Update changelog 2022-01-10 20:54:53 +00:00			`### Added`
			- New `coffi.layout` namespace with support for forcing C layout rules on structs
Add section for unreleased 2021-10-25 14:46:41 +00:00
Update changelog 2022-01-10 20:46:00 +00:00			`### Fixed`
			`- C-characters were being read as UTF-16 rather than ASCII code points`
Add section for unreleased 2021-10-25 14:46:41 +00:00
Update changelog for release 2021-10-25 14:44:03 +00:00			`## [0.2.277] - 2021-10-25`
Fixup changelog 2021-10-25 14:34:26 +00:00			`### Fixed`
			- Non-primitive arguments on upcalls would generate invalid bytecode with `nil` instructions

Update readme and changelog for release 2021-10-16 14:41:36 +00:00			`## [0.2.259] - 2021-10-16`
Fix crash when returning void in an upcall 2021-10-15 00:22:30 +00:00			`### Fixed`
Fix incorrect argument loading in upcall stubs 2021-10-16 03:13:45 +00:00			`- Long and double arguments to upcalls failed to compile in some cases`
Fix crash when returning void in an upcall 2021-10-15 00:22:30 +00:00			`- Void return types on upcalls would crash on serialization`
Update changelog unreleased 2021-10-14 23:38:10 +00:00
Update readme and changelog for release 2021-10-14 23:36:11 +00:00			`## [0.1.251] - 2021-10-14`
Rewrite the inline expansion macro 2021-10-14 23:25:06 +00:00			`### Fixed`
			- Bug with the inline expansion of `make-serde-wrapper`, make it more maintainable
Update changelog for unreleased 2021-10-14 18:25:42 +00:00
Fix changelog and readme for release 2021-10-14 18:20:10 +00:00			`## [0.1.246] - 2021-10-14`
Fix bug with inline expansion with no arguments 2021-10-14 18:05:51 +00:00			`### Fixed`
			- Incorrect inline expansion of `make-serde-wrapper` in cases where a function has no arguments
Add unreleased section to the changelog 2021-10-14 17:44:20 +00:00
Update version in changelog and readme 2021-10-14 15:23:59 +00:00			`## [0.1.241] - 2021-10-14`
Update changelog for multimethod impls 2021-10-10 17:44:21 +00:00			`### Performance`
Update changelog 2021-10-13 18:57:32 +00:00			- Added an `:inline` function to `make-serde-wrapper` to remove serialization overhead on primitives
Update changelog for multimethod impls 2021-10-10 17:44:21 +00:00			`- Added multimethod implementations for primitives in (de)serialization functions, rather than using the default`
Add unreleased section to the changelog 2021-10-10 17:42:53 +00:00
Update changelog 2021-10-13 18:57:32 +00:00			`### Fixed`
			- `cfn` didn't add serializers with non-primitive types in some cases

Update docs for new release 2021-10-09 16:26:13 +00:00			`## [0.1.220] - 2021-10-09`
Fix a bug where non-primitive argument types failed to link 2021-10-07 00:37:15 +00:00			`### Fixed`
Fix bug where primitive arg optimizations weren't applied to `cfn` 2021-10-09 14:50:56 +00:00			- All-primitive method types still used serialization when called from `cfn`
Make arrays deserialize to vectors 2021-10-09 00:26:46 +00:00			`- Arrays deserialized to non-vector sequences`
Fix a bug where non-primitive argument types failed to link 2021-10-07 00:37:15 +00:00			`- Non-primitive argument types fail to link`
Add unreleased section to changelog 2021-10-06 16:42:02 +00:00
Add release date to changelog 2021-10-06 16:40:59 +00:00			`## [0.1.205] - 2021-10-06`
Add an address predicate 2021-10-05 00:20:47 +00:00			`### Added`
			- An `address?` predicate

Fixed bug with serialize-into and primitives 2021-10-01 01:15:58 +00:00			`### Fixed`
Fix bug where compound types in arglist metadata failed 2021-10-06 13:53:02 +00:00			- Compound types caused problems in arglists meta on expansion of `defcfn`
Fix bug where compound types were not permitted as return values in defcfn 2021-10-05 00:20:55 +00:00			- Compound types were not allowed as return types in `defcfn`
Consider nil as `null?` 2021-10-01 17:03:39 +00:00			- `nil` was not considered a null pointer
Fix bug with primitive-serializing arguments to downcalls not compiling 2021-10-01 15:39:32 +00:00			`- Primitive-serializing types fail to compile as arguments to downcall handles`
Fix primitive arguments to upcalls not compiling 2021-10-01 15:38:42 +00:00			`- Primitive-serializing types fail to load as arguments to upcall functions`
Fix a bug where void returns on upcalls crash the JVM 2021-10-01 15:37:38 +00:00			`- Void return types on upcalls crash the JVM`
Fixed bug with serialize-into and primitives 2021-10-01 01:15:58 +00:00			`- Invalid implementation of serialize-into for primitive types`
Add unreleased section in changelog 2021-10-01 01:15:21 +00:00
Update changelog and readme for new release 2021-10-01 01:04:34 +00:00			`## [0.1.192] - 2021-09-30`
Add a function's address to the metadata of deserialized functions 2021-09-30 20:40:55 +00:00			`### Added`
Add address metadata key to defcfn as well 2021-09-30 20:45:10 +00:00			- An `::ffi/address` key to wrapper functions' metadata
Update changelog for unreleased section 2021-09-29 16:00:21 +00:00
Remove reference to method that isn't in panama anymore 2021-10-01 00:54:48 +00:00			`### Fixed`
			- Usage of a method no longer in Panama that breaks `with-acquired`

Update readme and changelog for release 2021-09-30 20:31:14 +00:00			`## [0.1.184] - 2021-09-30`
Fix upcall stubs having incorrect type descriptors 2021-09-30 20:25:21 +00:00			`### Fixed`
Fix bug where deserializing nullpointers as functions failed instead of returning nil 2021-09-30 20:26:56 +00:00			`- Deserializing nullpointers as functions threw an exception`
Fix upcall stubs not compiling with non-primitive argument types 2021-09-30 20:25:58 +00:00			`- Upcall stubs with non-primitive arguments failed to compile`
Fix upcall stubs having incorrect type descriptors 2021-09-30 20:25:21 +00:00			`- Upcall stubs had incorrect types`

Update for new clojars release 2021-09-29 15:55:05 +00:00			`## [0.1.176] - 2021-09-29`
Fix invalid macroexpansion of `defcfn` without docstring 2021-09-29 15:20:10 +00:00			`### Fixed`
			- Usage of `defcfn` without a docstring produced an invalid `def` form
Add unreleased section 2021-09-29 15:18:45 +00:00
Update the changelog for the release 2021-09-29 15:16:41 +00:00			`## [0.1.169] - 2021-09-28`
Add description of basic features to changelog 2021-09-23 20:02:02 +00:00			`### Added`
			`- Macro for easily wrapping native functions with arbitrary logic`
			`- Functions for creating wrapper fns for native functions`
Update the changelog for the release 2021-09-29 15:16:41 +00:00			`- Macro for easily aliasing types`
Add description of basic features to changelog 2021-09-23 20:02:02 +00:00			`- Functions to create scopes for deterministic deallocation`
			`- Functions to load libraries by name or path`
			`- Support for serializing and deserializing arbitrary Clojure functions`
			`- Support for serializing and deserializing arbitrary Clojure data structures`
Initial commit 2021-09-14 21:29:41 +00:00
Update changelog 2024-10-03 18:20:31 +00:00			`[1.0.472]: https://github.com/IGJoshua/coffi/compare/v1.0.450...v1.0.472`
Update changelog link to diff 2024-10-02 19:43:23 +00:00			`[1.0.450]: https://github.com/IGJoshua/coffi/compare/v0.6.409...v1.0.450`
Merge branch 'release/v0.6.409' 2023-03-31 15:30:09 +00:00			`[0.6.409]: https://github.com/IGJoshua/coffi/compare/v0.5.357...v0.6.409`
Fix broken link in changelog 2022-07-07 15:02:21 +00:00			`[0.5.357]: https://github.com/IGJoshua/coffi/compare/v0.4.341...v0.5.357`
Update changelog for release 2022-01-24 02:18:58 +00:00			`[0.4.341]: https://github.com/IGJoshua/coffi/compare/v0.3.298...v0.4.341`
Update changelog for release 2022-01-10 21:05:46 +00:00			`[0.3.298]: https://github.com/IGJoshua/coffi/compare/v0.2.277...v0.3.298`
Update changelog for release 2021-10-25 14:44:03 +00:00			`[0.2.277]: https://github.com/IGJoshua/coffi/compare/v0.2.259...v0.2.277`
Update changelog for correct link 2021-10-17 19:53:33 +00:00			`[0.2.259]: https://github.com/IGJoshua/coffi/compare/v0.1.251...v0.2.259`
Update readme and changelog for release 2021-10-14 23:36:11 +00:00			`[0.1.251]: https://github.com/IGJoshua/coffi/compare/v0.1.246...v0.1.251`
Fix changelog and readme for release 2021-10-14 18:20:10 +00:00			`[0.1.246]: https://github.com/IGJoshua/coffi/compare/v0.1.241...v0.1.246`
Update version in changelog and readme 2021-10-14 15:23:59 +00:00			`[0.1.241]: https://github.com/IGJoshua/coffi/compare/v0.1.220...v0.1.241`
Update docs for new release 2021-10-09 16:26:13 +00:00			`[0.1.220]: https://github.com/IGJoshua/coffi/compare/v0.1.205...v0.1.220`
Update release tags 2021-10-06 16:38:39 +00:00			`[0.1.205]: https://github.com/IGJoshua/coffi/compare/v0.1.192...v0.1.205`
Update changelog and readme for new release 2021-10-01 01:04:34 +00:00			`[0.1.192]: https://github.com/IGJoshua/coffi/compare/v0.1.184...v0.1.192`
Update readme and changelog for release 2021-09-30 20:31:14 +00:00			`[0.1.184]: https://github.com/IGJoshua/coffi/compare/v0.1.176...v0.1.184`
Update changelog for release 2021-09-29 15:58:56 +00:00			`[0.1.176]: https://github.com/IGJoshua/coffi/compare/v0.1.169...v0.1.176`
Update the changelog for the release 2021-09-29 15:16:41 +00:00			`[0.1.169]: https://github.com/IGJoshua/coffi/compare/16f56bc31d69142ec4d2fb61b15b069d78b127ca...v0.1.169`