ARCHIV

Perl (102) - Rozšiřování Perlu pomocí XS

Přestože lze v Perlu lze napsat "téměř vše", lze občas najít nějakou úlohu, na kterou by byl jiný jazyk vhodnější. Nemusí to být proto, že by v Perlu daná věc napsat nešla, ale třeba kvůli optimalizaci rychlosti běhu programu. Tento díl ukáže, jak jednoduše integrovat jazyk C do Perlu.

22.2.2010 06:00 | Jiří Václavík | Články autora | přečteno 10572×

Myšlenka spojení zdánlivě nespojitelného není složitá. Takový výsledný program se obecně skládá z několika souborů. První soubor je psán v jazyce C a obsahuje obvykle nějaké knihovny, které potřebujeme použít v našem původním perlovém programu. V perlovém souboru přistupujeme k C souboru jako k modulu. Aby to mohlo fungovat, je třeba vytvořit něco, co spojí oba tyto soubory dohromady - v literatuře se pro to vžil název vazebný kód (glue code).

Vazebný kód se musí postarat o několik věcí:

• Alokace paměti
• Převod datových typů - U standardních datových typů není problém, a tak je třeba řešit především uživatelsky definované datové typy. To vyžaduje od programátora napsat speciální funkce a jde o poměrně pokročilou záležitost.
• Dodržení syntaxe Perlu při volání (například pole jako návratová hodnota)

Příklad - s editací XS souboru

Napíšeme si jako ukázku jednoduchý modul Hello, který bude obsahovat funkci hello. Tato funkce pouze vypíše nějaký text na výstup.

Nejprve provedeme následující příkaz.

$ h2xs -nHello
Defaulting to backwards compatibility with perl 5.10.0
If you intend this module to be compatible with earlier perl versions, please
specify a minimum perl version with the -b option.

Writing Hello/ppport.h
Writing Hello/lib/Hello.pm
Writing Hello/Hello.xs
Writing Hello/fallback/const-c.inc
Writing Hello/fallback/const-xs.inc
Writing Hello/Makefile.PL
Writing Hello/README
Writing Hello/t/Hello.t
Writing Hello/Changes
Writing Hello/MANIFEST
$

Z výstupu je vidět, že se vytvoří adresář Hello, který obsahuje několik souborů. Nás teď bude nejvíce ze všech zajímat soubor Hello/Hello.xs. To je totiž soubor jazyka XS a budeme ho nyní editovat. V něm vytvoříme naši funkci hello.

Soubor Hello/Hello.xs by měl na začátku obsahovat kód podobnýmu tomuto.

#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#include "ppport.h"

#include "const-c.inc"

MODULE = Hello          PACKAGE = Hello

INCLUDE: const-xs.inc

Tento soubor upravíme a na konec přidáme kód naší funkce hello. Kód v XS souboru vypadá trochu jinak než jazyk C - je třeba zde použít klíčové slovo CODE, které určuje kód funkce. Nyní tedy máme v souboru Hello/Hello.xs následující.

#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#include "ppport.h"

#include "const-c.inc"

MODULE = Hello          PACKAGE = Hello

INCLUDE: const-xs.inc

void hello();
  CODE:
    printf("Tento text tiskne jazyk C\n");

XS soubor začíná deklaracemi jazyka C. Zde je uvedeno, které hlavičkové soubory chceme vložit. Následuje řádek tvaru

MODULE = Hello                PACKAGE = Hello

Po něm následují XS funkce, které budou přeloženy pomocí nástroje xsubpp do nějakého kódu jazyka C.

Dále budeme chtít vygenerovat z XS souboru vazebný kód. Proto nás nyní bude zajímat soubor Makefile.PL. Provedeme následující příkazy.

$ cd Hello
$ perl Makefile.PL
$ make

Teď můžeme pozorovat, že v adresáři přibylo několik souborů. Mezi nimi je i soubor Hello.c, který obsahuje onen vazebný kód. Na závěr nainstalujeme modul.

# make install

Nyní bychom měli mít v systému nový modul Hello. Přesvědčme se o tom. Vytvoříme soubor hello.pl s následujícím obsahem.

use Hello;
Hello::hello();

Spustíme program a měli bychom vidět tento výsledek.

$ perl hello.pl
Tento text tiskne jazyk C
$

Jak vzniká vazebný kód - nástroj xsubpp

xsubpp je nástroj, který konvertuje XS kód do kódu jazyka C a obvykle je spouštěn automaticky pomocí makefile. Funguje tak, že vytvoří soubor Modul.c a v něm funkce tvaru Modul_xs_funkce (například v našem příkladu je to Hello_xs_hello v souboru Hello.c).

Příklad - bez editace XS souboru

Předchozí příklad byl trochu podvod, protože ve skutečnosti jsme z žádného C programu nevycházeli. To nyní napravíme. Vytvoříme program, který bude dělat to samé, ale provedeme malé zjednodušení.

Jak je z názvu patrné, nástroj h2xs funguje tak, že převede rozhraní .h souboru do jazyka XS. Je tedy možné zavolat h2xs v následujícím tvaru.

$ h2xs -nHello2 hello2.h

Zde hello2.h obsahuje deklaraci funkce hello2.

void hello2(void);

V takovém případě se v XS souboru už objeví následující řádky:

void
hello();

Dále vytvoříme v adresáři Hello2 soubor hello2.c, který bude obsahovat funkci hello2. To znamená, že bude vypadat takto:

#include <stdio.h>

void hello2(void){
    printf("Toto je uz opravdu ciste C");
}

Nyní upravíme Makefile.PL, abychom slinkovali vše, co je potřeba. Uvnitř něj se volá funkce WriteMakefile, což by mělo vypadat zhruba takto.

WriteMakefile(
    NAME              => 'Hello2',
    VERSION_FROM      => 'lib/Hello2.pm', # finds $VERSION
    PREREQ_PM         => {}, # e.g., Module::Name => 1.1
    ($] >= 5.005 ?     ## Add these new keywords supported since 5.005
      (ABSTRACT_FROM  => 'lib/Hello2.pm', # retrieve abstract from module
       AUTHOR         => 'Jiri Vaclavik <jv@jv.cz>') : ()),
    LIBS              => [''], # e.g., '-lm'
    DEFINE            => '', # e.g., '-DHAVE_SOMETHING'
    INC               => '-I.', # e.g., '-I. -I/usr/include/other'
        # Un-comment this if you add C files to link with later:
    # OBJECT            => '$(O_FILES)', # link all the C files too
);

V tomto volání upravíme řádek s OBJECT. Přepišme celý příkaz znovu. V nové podobě bude vypadat takto.

WriteMakefile(
    NAME              => 'Hello2',
    VERSION_FROM      => 'lib/Hello2.pm', # finds $VERSION
    PREREQ_PM         => {}, # e.g., Module::Name => 1.1
    ($] >= 5.005 ?     ## Add these new keywords supported since 5.005
      (ABSTRACT_FROM  => 'lib/Hello2.pm', # retrieve abstract from module
       AUTHOR         => 'Jiri Vaclavik <jv@jv.cz>') : ()),
    LIBS              => [''], # e.g., '-lm'
    DEFINE            => '', # e.g., '-DHAVE_SOMETHING'
    INC               => '-I.', # e.g., '-I. -I/usr/include/other'
        # Un-comment this if you add C files to link with later:
    OBJECT            => 'hello2.o Hello2.o', # link all the C files too
);

Nyní již postupujeme stejně jako posledně, to jest následujícími příkazy.

$ perl Makefile.PL
$ make
# make install

Nyní bychom měli mít nainstalován modul Hello2 s funkcí hello2, která opět vypíše nějaký text.

Detekce prvočísel - ukázka zahrnutí parametrů

Ukážeme ještě jedno trochu smysluplnější použití spojení jazyků C a Perl. V C implementujeme funkci, která o daném čísle zjistí, zda je nebo není prvočíslo. Vytvoříme tedy nejdříve v jazyce C funkci je_prvocislo. V souboru prvocislo.h bude hlavička.

int je_prvocislo(int cislo);

A v souboru prvocislo.c samotná implementace. Zde je jednoduchý algoritmus, který zjistí, zda je předané číslo prvočíslem.

#include <stdio.h>

int je_prvocislo(int cislo){
  int delitel, prvocislo=1;
  for(delitel=2; prvocislo!=0; delitel++){
    if (delitel<cislo){
      if (cislo%delitel!=0)
        prvocislo=1;
      else
        prvocislo=0;
    }else
        break;
  }
  if (prvocislo==0) return 0;
  else return 1;
}

A úplně stejně jako v předchozím příkladu vytvoříme modul. Zavoláme tedy příkaz h2xs.

$ h2xs -x -n Prvocislo prvocislo.h

Pro zajímavost můžeme nahlédnout do souboru Prvocislo.xs. Zde se nám na konci souboru objevil následující obsah.

int
je_prvocislo(cislo)
        int     cislo

V závorce jsou obvykle parametry bez datového typu, který je určen posléze pro každý argument na vlastním řádku.

Dále postupujeme opět standardní cestou. Editujeme soubor Makefile.PL a volání funkce WriteMakefile přepíšeme do následující podoby.

WriteMakefile(
    NAME              => 'Prvocislo',
    VERSION_FROM      => 'lib/Prvocislo.pm', # finds $VERSION
    PREREQ_PM         => {}, # e.g., Module::Name => 1.1
    ($] >= 5.005 ?     ## Add these new keywords supported since 5.005
      (ABSTRACT_FROM  => 'lib/Prvocislo.pm', # retrieve abstract from module
       AUTHOR         => 'Jiri Vaclavik <jv@jv.cz>') : ()),
    LIBS              => [''], # e.g., '-lm'
    DEFINE            => '', # e.g., '-DHAVE_SOMETHING'
    INC               => '-I.', # e.g., '-I. -I/usr/include/other'
        # Un-comment this if you add C files to link with later:
    OBJECT            => 'prvocislo.o Prvocislo.o', # link all the C files too
);

Následuje trojice obligátních příkazů.

$ perl Makefile.PL
$ make
# make install

Nyní můžeme vytvořit perl program prvocislo.pl využívající modul Prvocislo.

#!/usr/bin/env perl
use Prvocislo;
print $_.(Prvocislo::je_prvocislo($_)?" je ":" neni ")."prvocislo\n" for (1..10);

Po jeho spuštění bychom měli spatřit následující výstup.

$ perl prvocislo.pl
1 je prvocislo
2 je prvocislo
3 je prvocislo
4 neni prvocislo
5 je prvocislo
6 neni prvocislo
7 je prvocislo
8 neni prvocislo
9 neni prvocislo
10 neni prvocislo
$

Verze pro tisk