SWIG Simplified Wrapper and Interface Generator. Christian Claus

Transkript

1 SWIG Simplified Wrapper and Interface Generator Christian Claus 1

2 Inhaltsübersicht 1. Einführung in SWIG 2. Funktionsweise von SWIG 3. Beispiel 4. SWIG im Detail 5. Fazit 2

3 Einführung in SWIG 3

4 Was ist SWIG C / C++ Module für andere Sprachen verfügbar machen Besonders wertvoll für Skriptsprachen und Java Zielsprache muss Mechanismus bereitstellen, um C Bibliothek anzusprechen (z.b. JNI in Java) SWIG untersteht zwei Copyright Lizenzen (University of Chicago / Utah) Code darf aber verändert werden, wenn Lizenz mit eingebunden wird. 4

5 Problemstellung Es gibt eine C Bibliothek (z.b. crypto.des) die sich um Verschlüsselung kümmert. Wir brauchen die Funktionalität und wollen sie nicht neu schreiben Aber all unsere Entwickler können kein C 5

6 Lösung Man nehme sich die Bibliothek und schreibt die benötigten Funktionen in die SWIG Moduldatei Danach wirft man den SWIG Interpreter und gcc an...fertig 6

7 Historie Juli 1995: Autor Dave Beazley (Theoretical Physics Division am Los Alamos National Laboratory) Januar 1996: University of Utah (Tcl, Perl, Guile) September 1996: Python wird unterstützt Juli 1998: Entwicklung zur University of Chicago verlegt Seit dem: Viele neue Templates und insgesamt 18 Sprachen Letztes Release: SWIG (3-4 Releases pro Jahr) 7

8 Unterstützte Sprachen AllegroCL C# Mono C#.NET CFFI CHICKEN CLISP Guile Java Lua 8 MzScheme Ocaml Octave Perl PHP Python R Ruby Tcl/Tk

9 Warum SWIG nutzen? Einfache, systemnahe Entwicklung, ohne Kenntnisse von C / C++ Skriptsprachen sind leichter zu erlernen Skriptsprachen sind flexibler C Bilbliotheken Objektorientiert nutzen Beispiel: parapin - a Parallel Port Pin Programming Library for Linux (Mit Skriptsprache Serielle Schnittstelle steuern) 9

10 bekannte Projekte subversion (Version Control System) PyOgre (3D Graphics Engine) PyOpenGL (Open GL Grafics) Weave (Scientific tools library) QuantLib (Search engine library) 10

11 Funktionsweise von SWIG 11

12 Funktionsweise lib.h C / C++ Headers lib.i Interface Beschreibung Swig Binding Code lib_wrap.c lib_wrap.so Modul in Zielsprache gcc [6] 12

13 SWIG Installieren Für Windows findet sich ein vorkompiliertes Binary Linux / Unix Paketverwaltung: z.b: aptitude install swig / port install swig wget...swig.tgz..../configure && make && make install 13

14 Beispiel 14

15 Beispiel Namespace %module example %{ #include "example.h" %} %include "example.h" 15

16 Beispiel Inhalt der Klammern wird in wrapper kopiert. (C / C++) %module example %{ #include "example.h" %} %include "example.h" 16

17 Beispiel Header Datei soll von SWIG geparsed werden %module example %{ #include "example.h" %} %include "example.h" 17

18 Beispiel /* File : example.h */ #include <time.h> double My_variable = 3.0; int fact(int n) { if (n <= 1) return 1; else return n * fact(n - 1); } int my_mod(int x, int y) { return (x % y); } char *get_time() { time_t ltime; time(&ltime); return ctime(&ltime); } 18

19 Kompilieren Java /usr/bin/swig -java -outdir /my_dir/src example.i gcc -c example_wrap.c -I /System/Library/Frameworks/ JavaVM.framework/Headers/ -c *.c gcc -dynamiclib -o libexample.jnilib *.o -framework JavaVM sudo cp libexample.jnilib /usr/lib/java/ Python python setup.py build cp build/lib.macosx-10.5-i /_example.so. 19

20 Beispiel - Java /* File : Test.java */ public class Test { public static void main(string[] args) { System.loadLibrary("example"); } } System.out.println("get_time: " + example.get_time()); System.out.println("My_Variable: " + example.getmy_variable()); System.out.println("my_mod: " + example.my_mod(10, 3)); System.out.println("fact: " + example.fact(42)); 20

21 Beispiel - Java Ausgabe: get_time: Sun May 31 23:28: My_Variable: 3.0 my_mod: 1 fact: 0 21

22 SWIG im Detail 22

23 SWIG Eigenschaften Funktionsnamen werden für Konventionen der Zielsprache generiert Ruby: module.do_something_difficult Perl: module->dosomethingdifficult; SWIG generiert Getter und Setter: struct Vector { double x,y,z; } double Vector_x_get(struct Vector *obj) { return obj->x; } void Vector_x_set(struct Vector *obj, double value) { }... obj->x = value; 23

24 SWIG Eigenschaften Elemente vor SWIG verstecken %ignore my_module::my_struct %include my_module.h Alle Elemente bis auf bestimmte vor SWIG verstecken typedef struct my_struct {} MyStruct; %extend MyStruct {... } 24

25 SWIG Eigenschaften SWIG ruft als Konstruktor von Objekten auf: malloc(sizeof(myobj)) Davon wird abgeraten - stattdessen sollte man folgendes verwenden: %nodefault MyObj; %extend MyObj { } MyObj() { return my_helper_create(); } ~MyObj() { my_helper_free( $self ); } $self ist Äquivalent zu einem this Zeiger 25

26 SWIG Eigenschaften SWIG übernimmt Funktionsaufrufe 1:1, aber C ist nicht objektorientiert. Hierauf will man nicht verzichten! void do_some_thing(myobj *obj, Queue *jobs) Ruby: my_obj = MyObj.new do_some_thing my_obj, jobs my_obj.do_some_thing jobs (Wollen wir nicht) (Wollen wir!) 26

27 SWIG Eigenschaften Wir nutzen %extend um C - quasi - Objektorientiert zu gestalten. Zur Erinnerung: void do_some_things(myobj *obj, Queue *jobs) %extend MyObj { int do_the_same_thing(queue *jobs) { do_some_thing($self, jobs); return $self->problems.count == 0; } } Jetzt ist es möglich my_obj.do_the_same_things jobs aufzurufen. 27

28 SWIG Alternativen SWIG wird sehr stark unter Python Programmierern verwendet, aber genau hier gibt es die Alternative python::boost Hier ein Vergleich: triviale Funktion 10k mal aufgerufen Größe bei 10, 100, 1k und 10k LoC [5] 28

29 Fazit 29

30 Fazit Nützliches Werkzeug um mit Skriptsprachen vorhandene C Bibliotheken einzubinde Kein Erlernen von JNI Notwendig, um von Java aus performanten C Code auszuführen Speichermanagement kann sich als schwierig erweisen, da SWIG komplexere Datentypen als Zeiger repräsentiert Für Entwickler unter OSX stellt sich die mangelhafte Dokumentation als Hürde dar Für einige Sprachen gibt es leichter zu handhabene Alternativen, die teilweise auf SWIG aufbauen. Hier seien sig, xs und python::boost genannt. [4] 30

31 Literatur- und Abbildungsverzeichnis Kkaempf_KnowledgeSharing_Swig.pdf 31

32 Vielen Dank für eure Aufmerksamkeit Fragen? Christian Claus 32