/usr/lib/x86_64-linux-gnu/perl5/5.24/FFI/Platypus/Memory.pm is in libffi-platypus-perl 0.45-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package FFI::Platypus::Memory;
use strict;
use warnings;
use FFI::Platypus;
use base qw( Exporter );
# ABSTRACT: Memory functions for FFI
our $VERSION = '0.45'; # VERSION
our @EXPORT = qw( malloc free calloc realloc memcpy memset strdup );
my $ffi = FFI::Platypus->new;
$ffi->lib(undef);
$ffi->type($_) foreach qw( opaque size_t void int );
$ffi->attach(malloc => ['size_t'] => 'opaque' => '$');
$ffi->attach(free => ['opaque'] => 'void' => '$');
$ffi->attach(calloc => ['size_t', 'size_t'] => 'opaque' => '$$');
$ffi->attach(realloc => ['opaque', 'size_t'] => 'opaque' => '$$');
$ffi->attach(memcpy => ['opaque', 'opaque', 'size_t'] => 'opaque' => '$$$');
$ffi->attach(memset => ['opaque', 'int', 'size_t'] => 'opaque' => '$$$');
# This global may be removed at any time, do not use it
# externally. It is used by t/ffi_platypus_memory__strdup.t
# for a diagnostic.
our $_strdup_impl = 'not-loaded';
eval {
die "do not use c impl" if ($ENV{FFI_PLATYPUS_MEMORY_STRDUP_IMPL}||'c') eq 'perl';
$ffi->attach(strdup => ['string'] => 'opaque' => '$');
};
if($@)
{
$_strdup_impl = 'perl';
*strdup = sub ($) {
my($string) = @_;
my $ptr = malloc(length($string)+1);
memcpy($ptr, $ffi->cast('string' => 'opaque', $string), length($string)+1);
};
}
else
{
$_strdup_impl = 'c';
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
FFI::Platypus::Memory - Memory functions for FFI
=head1 VERSION
version 0.45
=head1 SYNOPSIS
use FFI::Platypus::Memory;
# allocate 64 bytes of memory using the
# libc malloc function.
my $pointer = malloc 64;
# use that memory wisely
...
# free the memory when you are done.
free $pointer;
=head1 DESCRIPTION
This module provides an interface to common memory functions provided by
the standard C library. They may be useful when constructing interfaces
to C libraries with FFI.
=head1 FUNCTIONS
=head2 calloc
my $pointer = calloc $count, $size;
The C<calloc> function contiguously allocates enough space for I<$count>
objects that are I<$size> bytes of memory each.
=head2 free
free $pointer;
The C<free> function frees the memory allocated by C<malloc>, C<calloc>,
C<realloc> or C<strdup>. It is important to only free memory that you
yourself have allocated. A good way to crash your program is to try and
free a pointer that some C library has returned to you.
=head2 malloc
my $pointer = malloc $size;
The C<malloc> function allocates I<$size> bytes of memory.
=head2 memcpy
memcpy $dst_pointer, $src_pointer, $size;
The C<memcpy> function copies I<$size> bytes from I<$src_pointer> to
I<$dst_pointer>. It also returns I<$dst_pointer>.
=head2 memset
memset $buffer, $value, $length;
The C<memset> function writes I<$length> bytes of I<$value> to the address
specified by I<$buffer>.
=head2 realloc
my $new_pointer = realloc $old_pointer, $size;
The C<realloc> function reallocates enough memory to fit I<$size> bytes.
It copies the existing data and frees I<$old_pointer>.
If you pass C<undef> in as I<$old_pointer>, then it behaves exactly like
C<malloc>:
my $pointer = realloc undef, 64; # same as malloc 64
=head2 strdup
my $pointer = strdup $string;
The C<strdup> function allocates enough memory to contain I<$string> and
then copies it to that newly allocated memory. This version of
C<strdup> returns an opaque pointer type, not a string type. This may
seem a little strange, but returning a string type would not be very
useful in Perl.
Platforms that do not support C<strdup> will be provided with an
equivalent using C<malloc> and C<memcpy> written in Perl. This version
is slower.
=head1 ENVIRONMENT
=head2 FFI_PLATYPUS_MEMORY_STRDUP_IMPL
C<strdup> isn't always supported by all platforms. On platforms that do not support
it, it is emulated using calls to C<malloc> and C<memcpy> which are part of the
standard C library. Because this requires two function calls it is probably not
as fast on most platforms.
If you experience problems with the C<strdup> provided by your platform, you can
force the emulated implementation using the FFI_PLATYPUS_MEMORY_STRDUP_IMPL
environment variable.
# bash:
$ export FFI_PLATYPUS_MEMORY_STRDUP_IMPL=perl
# tcsh:
% setenv FFI_PLATYPUS_MEMORY_STRDUP_IMPL perl
# Windows:
> SET FFI_PLATYPUS_MEMORY_STRDUP_IMPL=perl
=head1 SEE ALSO
=over 4
=item L<FFI::Platypus>
Main Platypus documentation.
=back
=head1 AUTHOR
Author: Graham Ollis E<lt>plicease@cpan.orgE<gt>
Contributors:
Bakkiaraj Murugesan (bakkiaraj)
Dylan Cali (calid)
pipcet
Zaki Mughal (zmughal)
Fitz Elliott (felliott)
Vickenty Fesunov (vyf)
Gregor Herrmann (gregoa)
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Graham Ollis.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|