PDL::CallExt--3pm

CallExt(3pm)          User Contributed Perl Documentation         CallExt(3pm)



NAME
       PDL::CallExt - call functions in external shared libraries

SYNOPSIS
        use PDL::CallExt;
        callext('file.so', 'foofunc', $x, $y); # pass piddles to foofunc()

        % perl -MPDL::CallExt -e callext_cc file.c

DESCRIPTION
       callext() loads in a shareable object (i.e. compiled code) using Perl's
       dynamic loader, calls the named function and passes a list of piddle
       arguments to it.

       It provides a reasonably portable way of doing this, including compil-
       ing the code with the right flags, though it requires simple perl and C
       wrapper routines to be written. You may prefer to use PP, which is much
       more portable. See PDL::PP. You should definitely use the latter for a
       'proper' PDL module, or if you run in to the limitations of this mod-
       ule.

API
       callext_cc() allows one to compile the shared objects using Perl's
       knowledge of compiler flags.

       The named function (e.g. 'foofunc') must take a list of piddle struc-
       tures as arguments, there is now way of doing portable general argument
       construction hence this limitation.

       In detail the code in the original file.c would look like this:

        #include "pdlsimple.h" /* Declare simple piddle structs - note this .h file
                                  contains NO perl/PDL dependencies so can be used
                                  standalone */

        int foofunc(int nargs, pdlsimple **args); /* foofunc prototype */

       i.e. foofunc() takes an array of pointers to pdlsimple structs. The use
       is similar to that of "main(int nargs, char **argv)" in UNIX C applica-
       tions.

       pdlsimple.h defines a simple N-dimensional data structure which looks
       like this:

         struct pdlsimple {
            int    datatype;  /* whether byte/int/float etc. */
            void  *data;      /* Generic pointer to the data block */
            int    nvals;     /* Number of data values */
            PDL_Long *dims;   /* Array of data dimensions */
            int    ndims;     /* Number of data dimensions */
         };

       (PDL_Long is always a 4 byte int and is defined in pdlsimple.h)

       This is a simplification of the internal reprensation of piddles in PDL
       which is more complicated because of threading, dataflow, etc. It will
       usually be found somewhere like /usr/local/lib/perl5/site_perl/PDL/pdl-
       simple.h

       Thus to actually use this to call real functions one would need to
       right a wrapper.  e.g. to call a 2D image processing routine:

        void myimage_processer(double* image, int nx, int ny);

        int foofunc(int nargs, pdlsimple **args) {
           pdlsimple* image = pdlsimple[0];
           myimage_processer( image->data, *(image->dims), *(image->dims+1) );
           ...
        }

       Obviously a real wrapper would include more error and argument check-
       ing.

       This might be compiled (e.g. Linux):

        cc -shared -o mycode.so mycode.c

       In general Perl knows how to do this, so you should be able to get away
       with:

        perl -MPDL::CallExt -e callext_cc file.c

       callext_cc() is a function defined in PDL::CallExt to generate the cor-
       rect compilation flags for shared objects.

       If their are problems you will need to refer to you C compiler manual
       to find out how to generate shared libraries.

       See t/callext.t in the distribution for a working example.

       It is up to the caller to ensure datatypes of piddles are correct - if
       not peculiar results or SEGVs will result.

FUNCTIONS
       callext

       Call a function in an external library using Perl dynamic loading

         callext('file.so', 'foofunc', $x, $y); # pass piddles to foofunc()

       The file must be compiled with dynamic loading options (see
       "callext_cc"). See the module docs "PDL::Callext" for a description of
       the API.

       callext_cc

       Compile external C code for dynamic loading

       Usage:

        % perl -MPDL::CallExt -e callext_cc file.c -o file.so

       This works portably because when Perl has built in knowledge of how to
       do dynamic loading on the system on which it was installed.  See the
       module docs "PDL::Callext" for a description of the API.

AUTHORS
       Copyright (C) Karl Glazebrook 1997.  All rights reserved. There is no
       warranty. You are allowed to redistribute this software / documentation
       under certain conditions. For details, see the file COPYING in the PDL
       distribution. If this file is separated from the PDL distribution, the
       copyright notice should be included in the file.



perl v5.8.8                       2005-02-03                      CallExt(3pm)