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.

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

Jump to bottom

Expand DatasetAccessProperties coverage, add helpers #949

Merged
merged 3 commits into from
Jun 10, 2022
Merged

Expand DatasetAccessProperties coverage, add helpers #949

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8caae10
Expand DatasetAccessProperties coverage, add helpers
mkitti Jun 6, 2022
039db75
Update src/api/helpers.jl
mkitti Jun 8, 2022
f9f17a0
Add tests
mkitti Jun 9, 2022
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
32 changes: 32 additions & 0 deletions src/api/helpers.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,14 @@ function h5p_get_chunk(plist_id)
return dims, ndims
end

function h5p_get_chunk_cache(dapl_id)
nslots = Ref{Csize_t}()
nbytes = Ref{Csize_t}()
w0 = Ref{Cdouble}()
h5p_get_chunk_cache(dapl_id, nslots, nbytes, w0)
return (nslots = nslots[], nbytes = nbytes[], w0 = w0[])
end

function h5p_get_create_intermediate_group(plist_id)
cig = Ref{Cuint}()
h5p_get_create_intermediate_group(plist_id, cig)
Expand All @@ -411,6 +419,11 @@ function h5p_get_efile_prefix(plist)
return String(buffer)
end

function h5p_set_efile_prefix(plist, sym::Symbol)
sym === :origin ? h5p_set_efile_prefix(plist, raw"$ORIGIN") :
error("The only valid symbol for h5p_set_efile_prefix is :origin.")
Copy link
Member

Choose a reason for hiding this comment

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

throw(ArgumentError(.... ?

mkitti marked this conversation as resolved.
Show resolved Hide resolved
mkitti marked this conversation as resolved.
Show resolved Hide resolved
end

function h5p_get_external(plist, idx = 0)
offset = Ref{off_t}(0)
sz = Ref{hsize_t}(0)
Expand Down Expand Up @@ -476,6 +489,25 @@ function h5p_get_userblock(plist_id)
return len[]
end

function h5p_get_virtual_prefix(dapl_id)
virtual_file_len = h5p_get_virtual_prefix(dapl_id, C_NULL, 0)
buffer = StringVector(virtual_file_len)
prefix_size = h5p_get_virtual_prefix(dapl_id, buffer, virtual_file_len+1)
return String(buffer)
end

function h5p_get_virtual_printf_gap(dapl_id)
gap = Ref{hsize_t}()
h5p_get_virtual_printf_gap(dapl_id, gap)
return gap[]
end

function h5p_get_virtual_view(dapl_id)
view = Ref{H5D_vds_view_t}()
h5p_get_virtual_view(dapl_id, view)
return view[]
end

# Note: The following function(s) implement direct ccalls because the binding generator
# cannot (yet) do the string wrapping and memory freeing.

Expand Down
32 changes: 32 additions & 0 deletions src/properties.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,21 +714,53 @@ superclass(::Type{DatatypeAccessProperties}) = LinkAccessProperties

Properties that control access to data in external, virtual, and chunked datasets.

- `chunk_cache`: Chunk cache parameters as (nslots, nbytes, w0).
Default: (521, 0x100000, 0.75)
- `efile_prefix`: Path prefix for reading external files.
The default is the current working directory.
- `:origin`: alias for `raw"\$ORIGIN"` will make the external file relative to
the HDF5 file.
- `virtual_prefix`: Path prefix for reading virtual datasets.
- `virtual_printf_gap`: The maximum number of missing source files and/or
datasets with the printf-style names when getting the extent of an unlimited
virtual dataset
- `virtual_view`: Influences whether the view of the virtual dataset includes
or excludes missing mapped elements
- `:first_missing`: includes all data before the first missing mapped data
- `:last_available`: includes all available mapped data

See [Dataset Access Properties](https://portal.hdfgroup.org/display/HDF5/Dataset+Access+Properties)
"""
@propertyclass DatasetAccessProperties API.H5P_DATASET_ACCESS
superclass(::Type{DatasetAccessProperties}) = LinkAccessProperties

class_propertynames(::Type{DatasetAccessProperties}) = (
:chunk_cache,
:efile_prefix,
:virtual_prefix,
:virtual_printf_gap,
:virtual_view
)

@enum_property(virtual_view,
:first_missing => API.H5D_VDS_FIRST_MISSING,
:last_available => API.H5D_VDS_LAST_AVAILABLE
)

function class_getproperty(::Type{DatasetAccessProperties}, p::Properties, name::Symbol)
name === :chunk_cache ? API.h5p_get_chunk_cache(p) :
name === :efile_prefix ? API.h5p_get_efile_prefix(p) :
name === :virtual_prefix ? API.h5p_get_virtual_prefix(p) :
name === :virtual_printf_gap ? API.h5p_get_virtual_printf_gap(p) :
name === :virtual_view ? get_virtual_view(p) :
class_getproperty(superclass(DatasetAccessProperties), p, name)
end
function class_setproperty!(::Type{DatasetAccessProperties}, p::Properties, name::Symbol, val)
name === :chunk_cache ? API.h5p_set_chunk_cache(p, val...) :
name === :efile_prefix ? API.h5p_set_efile_prefix(p, val) :
name === :virtual_prefix ? API.h5p_set_virtual_prefix(p, val) :
name === :virtual_printf_gap ? API.h5p_set_virtual_printf_gap(p, val) :
name === :virtual_view ? set_virtual_view!(p, val) :
class_setproperty!(superclass(DatasetAccessProperties), p, name, val)
end

Expand Down