Version vom 8. Juni 2008, 21:18 Uhr

In C versteht man unter Inline Assembler die Möglichkeit, direkt Assembler-Befehle in den Code einzufügen bzw. die eingefügten Assembler-Befehle selbst.

Neben den einzufügenden Befehlen muss beschrieben werden, welche Nebeneffekte die Befehle auf die Maschine haben und wo/wie Parameter übergeben werden, bzw. wie die Zuordnung von Variablen zu den Registern ist. Diese Beschreibung ist notwendig weil der Compiler keine Vorstellung davon hat, welche Effekte und Nebenwirkungen die Assembler-Kommandos auf Register, Variablen und Speicher haben, denn der Assembler-Schnippsel ist für den Compiler lediglich eine "Black Box".

Obgleich das dazu verwendete Schlüsselwort __asm zum ANSI-C-Standard gehört, ist dies in jedem C-Compiler anders implementiert. Das gilt insbesondere für die Schnittstellenbeschreibung Variablen/Register. Dieser Artikel bezieht sich auf den Inline Assembler von avr-gcc. Viele Erklärungen aus diesem Artikel sind auch gültig für Inline-Assembler anderer C-Compiler der gcc-Familie. Instruktionen und Registerklassen werden sich aber unterscheiden, weil diese natürlich abhängig sind vom verwendeten Controller bzw. der Controller-Familie.

Assembler oder Inline-Assembler?

Assembler

Längere und komplexere Code-Stücke sind komfortabler direkt in Assembler auszudrücken. Dazu schreibt man Assembler-Funktionen und ruft diese von C aus auf. Natürlich können auch C-Funktionen von Assembler aus aufgerufen werden. Zudem kann man im Assembler den C-Präprozessor nutzen, was bei Inline-Assembler nur auf C-Ebene geht. Der Build-Prozess wird allerdings komplizierter, da extra asm-Dateien übersetzt werden müssen.

Inline-Assembler

Mit Inline-Assembler kann man kleine Assembler-Stückchen direkt in den C-Code einbetten. Es muss dann keine Assembler-Funktion aufgerufen werden. Dies kann von der Registerverwendung her deutlich günstiger sein, da gcc genau weiß, welche Register gebraucht werden und welche nicht.

Eine (Assembler-)Funktion ist hingegen eine Black Box, bei der von der Standard-Registerverwendung ausgegangen werden muss, auch wenn weniger Register in der Funktion verwendet werden. Ein Funktionsaufruf bedeutet also meistens einen Laufzeit-Overhead im Vergleich zu einem Inline-Code.

Bei mehrfacher Verwendung einer längeren Codesequenz ist eine Funktion jedoch sparsamer im Flash-Verbrauch. Legt man eine Funktion als C-Funktion an und ihren Body als Inline-Assembler (eine s.g. Stub-Funktion, von engl. Stub = Stumpf), dann übernimmt gcc das Verwalten von Funktions-Argumenten, return-Wert, etc. und man brauch sich nicht selber um die Aufruf-Konvention zu kümmern. Auch innerhalb einer Funktion kann C mit Assembler gemischt werden.

Ein Vorteil von Inline-Assembler ist, daß eine C-Funktion, die Inline-Assembler enthält, vom C-Compiler geinlinet werden kann. Die ist mit einer reinen Assembler-Funktion nicht möglich.

Begriffe

Assembler-Template

Das Template (Schablone) ist ein statischer, konstanter String im Sinne von C. Es enthält die Assembler-Befehle sowie Platzhalter, in deren Stelle später die Operanden treten

Constraint

Die Constraints (Nebenbedingungen) beschreiben Einschränkungen an die zu verwendeten Register. Dies ist notwendig, da nicht alle Maschinenbefehle auf alle Register anwendbar sind

Clobber-List

Das ist eine Liste von Registern, deren Inhalt durch den Inline-Assembler zerstört wird

Syntax und Semantik

Das Schlüsselwort, um eine Inline-Assembler Sequenz einzuleiten, ist __asm (ANSI). Oft ist auch asm oder __asm__ verwendbar. Um zu kennzeichnen, daß die Sequenz keinesfalls wegoptimiert werden darf – etwa dann, wenn der Assembler keine Wirkung auf C-Variablen hat – wird dem asm ein volatile bzw. __volatile nachgestellt. Danach folgen in runden Klammern die durch : getrennten Abschnitte des Inline-Assemblers:

asm volatile (asm-template : output-operand-list : input-operand-list : clobber-list);

Abschnitte, die leer sind, können auch weggelassen werden, wenn dahinter kein weiterer Abschnitt folgt:

asm volatile (asm-template);

Oder, wenn weder Input- noch Output-Operanden gebraucht werden, aber Register oder Speicher verändert werden:

asm volatile (asm-template ::: clobber-list);

Assembler-Template

Im Template stehen die durch Zeilenumbrüche getrennten Assembler-Befehle. Das Template kann zudem %-Ausdrücke als Platzhalter enthalten, welche durch die Operanden ersetzt werden. Dabei bezieht sich %0 auf den ersten Operanden, %1 auf den zweiten Operanden, etc. Die Operanden selbst werden im zweiten und dritten Abschnitt des Templates als Komma-getrennte Liste angegeben.

Ein Platzhalter kann zusätzlich einen einbuchstabigen Modifier enthalten, um ein Register in einem speziellen Format darzustellen. Wird z.B. ein Wert ab Register r28 (dem Y-Register) gehalten, dann wären folgende Ersetzungen denkbar (als erstes Argument):

Im einfachsten Falle enthält das Templater nur einen Befehl:

"nop"

oder sogar garkeinen Befehl und lediglich einen Kommentar:

"; ein Kommentar"

Operanden und Constraints

Ein Operand besteht aus der Angabe des Constraint-Strings (also der Registerklasse und Kennzeichnung, ob es sich um einen Output-Operanden handelt) und dahinter in runden Klammern der C-Ausdruck, der in Register der angegebenen Klasse geladen werden soll. Die Operanden werden mit 0 beginnend von links nach rechts durchnumeriert und über diese Nummer angesprochen, um sie ins Assembler-Schnippsel einzufügen.

Mehrere Input- bzw. Output-Operanden werden durch Komma getrennt.

Ein Input-Operand könnte also so aussehen, wobei foo eine C-Variable ist. Als Register dient ein (je nach Typ von foo auch mehrere) obere Register, irgendwo von r16 bis r31 (Constraint "d"):

"d" (foo)

In den Klammern kann ein beliebiger, gültiger C-Ausdruck stehen, der beim folgenden Beispiel in irgendeinem Register landet (Constraint "r"), ohne weitere Einschränkung an das Register:

"r" ((foo >= 0) ? foo : -foo)

Um einen Operanden als Output-Operanden zu kennzeichnen, wird dem Constraint ein "=" vorangestellt. Soll foo ein Output-Operand sein, der in den Registern r0...r15 landen soll (Constraint "l", sieht es so aus. Dabei muss foo ein sogenannter Lvalue sein, also ein Wert, dem etwas zugewiesen werden kann:

"=l" (foo)

Ist foo sowohl Input als auch Output, schreibt man foo als Output- und als Input-Operand hin. In der Input-Constraint bezieht man sich dann auf die Operanden-Nummer von foo. Hier ein komplettes Beispiel, das die Nibbles von foo tauscht. Weil swap auf alle Register anwendbar ist, kann als Registerklasse "r" genommen werden:

unsigned char foo;
...
asm volatile ("swap %0" : "=r" (foo) : "0" (foo));

foo als Input-Operand soll im gleichen Register liegen wie foo als Output-Operand. Daher wird als Constraint "0" angegeben, d.h. es wird ins gleiche Register geladen wie der Operand Numero 0 "r" (foo).

Benannte Constraints

Um das Assembler-Schnippsel besser lesbar zu halten, kann man Constraints einen Namen geben:

asm volatile ("swap %[bar]" : [bar] "+r" (foo));

Damit ist der Assembler auch unabhängig von der Reihenfolge der Operanden. Das macht die Anpassung, wenn ein neuer Operand hinzukommt, wesentlich einfacher und den Schnippsel zudem besser lesbar.

Hier wird bar als Alias für die C-Variable foo benutzt; es könnte aber auch jeder andere gültige C-Bezeichner sein, also insbesondere auch foo.

Instruktionen und Constraints

Die folgende Tabelle enhält eine Auflistung von AVR-Instruktionen und dazu passende Argumente bzw. Constraints. Nicht alle Shorthands sind in der Tabelle enthalten, so ist "clr Rn" nur eine Abkürzung für "eor Rn, Rn", ähnliches gilt für den Zoo von Instruktionen rund um das SREG wie branch, bit set, bit clear, etc., die im Endeffekt auf nur vier Instruktionen abbilden. Instruktionen wie nop, die keine Argumente brauchen, sind ebenfalls nicht in der Tabelle enthalten.

"load" ist ein "load from SRAM"
"store" ist "store to SRAM"

Hier noch ein paar der gebräuchlichsten Shorthands und deren Abbildung auf "Basis"-Instruktionen:

Clobbers

In der Komma-getrennten Clobber-Liste kann man angeben, welche Register durch den Inline-Assembler ihren Wert ändern. Ändern z.B. r2 und r3 ihre Werte, dann ist die Clobber-Liste

"r2", "r3"

Wird schreibend auf das RAM zugegriffen, dann muss man das auch mitteilen, damit RAM-Inhalte, die sich evtl. in Registern befinden, nach dem Inline-Assembler neu gelesen werden. Der Clobber dafür ist:

"memory"

Beispiel:

Es soll ein Inline-Assembler geschrieben werden, das den Inhalt zweier aufeinanderfolgender Speicherstellen austauscht. Die Adresse soll in addr stehen. Sie ist Input-Operand und muss in Register X, Y oder Z stehen, um den ld bzw. st-Befehl anwenden zu können. Die passende Constraint ist also "e". Nach der Sequenz liegt addr unverändert vor.

   asm volatile (
      "ld r2,  %a0+"   "\n\t"
      "ld r3,  %a0"    "\n\t"
      "st %a0,  r2"    "\n\t"
      "st -%a0, r3"
         : /* keine Output-Operanden */
         : "e" (addr)
         : "r2", "r3", "memory"
   );

avr-gcc entscheidet sich dazu, das Z-Register für addr zu verwenden:

	ld r2,  Z+
	ld r3,  Z
	st Z,  r2
	st -Z, r3

Günstiger ist es jedoch, dem Compiler auch die Entscheidung zu überlassen, welche(s) Register als Hilfsregister verwendet werden sollen. Ein Register kann __tmp_reg__ sein, für das zweite legen wir eine lokale 8-Bit-Variable hilf an:

   {
      char hilf;
	
      asm volatile (
         "ld __tmp_reg__,  %a1+"           "\n\t"
         "ld %0,           %a1"            "\n\t"
         "st %a1,          __tmp_reg__"    "\n\t"
         "st -%a1,         %0"
            : "=&r" (hilf)
            : "e"   (addr)
            : "memory"
      );
   }

__tmp_reg__ (also r0) brauch nicht in die Clobber-Liste aufgenommen zu werden. Um das zweite benötigte Register (hier r24, in dem hilf lebt) kümmert sich avr-gcc und sichert es, falls nötig

       	ld	r0, Z+
       	ld	r24, Z
       	st	Z, r0
       	st	-Z, r24

clr __zero_reg__

Vordefinierte Bezeichner und Makros

Je nach Assembler, für den avr-gcc Code erzeugt, gibt es unterschiedliche vordefinierte Funktionen/Makros, die von Inline-Assembler aus verwendbar sind.

GNU-Assembler

Beispiele

nop

Mit den bisherigen Vorkenntnissen ist zu nop nicht viel zu sagen:

asm volatile ("nop");

Oder als C-Makro:

#define nop() \
   asm volatile ("nop")

nop hat weder Input- noch Output-Operanden, und Register/RAM ändern sich natürlich nicht. Bei der Makro-Definition ist lediglich darauf zu achten, daß das Makro nicht mit einem ; endet, damit man den C-Code wie gewohnt mit ; schreiben kann:

if (x)
   nop();
else
   ...

swap Nibbles

Ein einfaches Beispiel für swap haben wir bereits oben kennen gelernt. Der Inline-Assembler dreht die Nibbles von foo um:

unsigned char foo;
...
asm volatile ("swap %0" : "=r" (foo) : "0" (foo));

Wünschenswert wäre eher, swap wie eine normale C-Funktion verwenden zu können und hinzuschreiben:

a = swap(b);

ohne daß b seinen Wert ändert. Soll b geswappt werden, dann via

b = swap(b);

zudem soll das Argument ein Ausdruck sein können:

if (b == swap (b+1))
   ...

Dazu verwenden wir eine lokale Variable __x__, in die der ursprüngliche Wert x gesichert wird:

#define swap(x)                                            \
 ({                                                        \
    unsigned char __x__ = (unsigned char) x;               \
    asm volatile ("swap %0" : "=r" (__x__) : "0" (__x__)); \
    __x__;                                                 \
  })

alternativ könnten wie eine inline-Funktion definieren:

static inline unsigned char swap (unsigned char x)
{
    asm volatile ("swap %0" : "=r" (x) : "0" (x));
    return x;
}

swap Bytes

Werden Zahlen zwischen verschiedenen Plattformen übertragen, kann es sein, daß diese unterschiedlich dargestellt werden: Das low-Byte kann in sich im unteren Byte befinden (AVR), es kann aber auch im oberen Byte sein. Ist das so, dann müssen die Werte beim Senden/Empfang umgewandelt werden, indem die Bytes getauscht werden. Liegt der 16-Bit-Wert in x_in und soll der konvertierte Wert nach x_out gespeichert werden, dann könnte man auf die Idee kommen, so etwas zu schreiben:

   asm volatile (
      "mov %A0, %B1"   "\n\t"
      "mov %B0, %A1"
         : "=r" (x_out)
         : "r"  (x_in)
   );

Daraus könnte folgender Code entstehen:

      	mov	r24, r25
       	mov	r25, r24

Das ist offenbar Käse! Was ist passiert?

avr-gcc hat sich dazu entschieden, x_in in r25:r24 anzulegen. Auch x_out wird in diesen Registern angelegt. Das ist erst mal in Ordnung, wenn x_in nach dem Inline nicht mehr gebraucht wird.

Allerdings wird das Inline nicht en bloc — also nicht zeitparallel — ausgeführt, sondern sequenziell. Bei gleichzeitiger Ausführung der beiden mov-Instruktionen wäre auch nichts dagegen zu sagen! Ein swap-Kommando z.B. tauscht die Nibbles gleichzeitig, und der Input-Operand kann im gleichen Register leben wie der Output-Operand, wenn der Input nicht weiter verwendet wird.

Mit den beiden Bytes geht es aber nicht. Wir müssen daher kennzeichnen, daß sich x_out in einem Register befindet, das nur als Output dient, was durch das & in der Output-Constraint erreicht wird:

   asm volatile (
      "mov %A0, %B1"   "\n\t"
      "mov %B0, %A1"
         : "=&r" (x_out)
         : "r"   (x_in)
   );

Damit erfolgt eine korrekte Registerzuordnung. x_out steht jetzt in r19:r18 und überschneidet nich nicht mehr mit x_in:

       	mov	r18, r25
       	mov	r19, r24

Alternativ können wir wie bei swap Nibbles eine lokale Variable verwenden, und alles als (inline-)Funktion machen. In dem folgenden Beispiel wird ein etwas anderer Code zum Tauschen verwendet:

static inline unsigned short swap_16 (unsigned short x_in)
{
   asm volatile (
      "eor %A0, %B0"   "\n\t"
      "eor %B0, %A0"   "\n\t"
      "eor %A0, %B0"
         : "=r" (x_in)
         : "0"  (x_in)
   );
	
   return x_in;
}

Die eor-Sequenz tauscht die Inhalte von r24 und r25. Sie ist genauso schnell und knapp wie ein "Dreiecks-Tausch", kommt aber ohne Hilfsregister aus. Nachrechnen, es stimmt!

       	eor	r24, r25
       	eor	r25, r24
       	eor	r24, r25

Zugriff auf SFRs

Um auf SFRs zuzugreifen, können im asm-Template keine Defines aus avr/io.h verwendet werden, weil der Präprozessor nicht mehr über den erzeugten Assembler-Code läuft (er läuft vor dem Compilieren). Um nicht die hex-Codes des SFRs angeben zu müssen, kann man dem Inline die Adressen als Konstanten übergeben. Weil die Adressen RAM-Adressen sind, müssen sie in das _SFR_IO_ADDR Makro verpackt werden, um den Offset für den I/O-Bereich abzuziehen. tcnt1 wird auf den Inhalt von TCNT1 gesetzt:

#include <avr/io.h>
   ... 
   uint16_t tcnt1;

   asm volatile (
      "in %A0, %1"    "\n\t"
      "in %B0, %1+1"
         : "=r" (tcnt1)
         : "M" (_SFR_IO_ADDR (TCNT1))
   );

wird umgesetzt zu

	in r24, 44
	in r25, 44+1

Das nur als Beispiel. Von C aus geht das natürlich auch mit

uint16_t tcnt1 = TCNT1;

Zugriff aufs SRAM

Auf bekannte globale Symbole kann man direkt von Assembler aus zugreifen:

   extern int einInt;

   asm volatile (
      "lds %A0, einInt"   "\n\t"
      "lds %B0, einInt+1"
         : "=r" (...)
   );

ergibt

	lds r24, einInt
	lds r25, einInt+1

alternativ ginge

   asm volatile (
      "lds %A0, %A1"   "\n\t"
      "lds %B0, %B1"
         : "=r" (...)
         : "m" (einInt)
   );

Falls die Adresse eines Objekts zur Compilezeit bekannt ist, kann man auch die Adresse von C aus übergeben:

struct foo_t {
   int a[2], b[2];
} foo;

...
{
   asm volatile (
      "lds %A0, %1"    "\n\t"
      "lds %B0, %1+1"
         : "=r" (...)
         : "i" (& foo.b[1])
   );
}

ergibt

	lds r24, einStruct+6
	lds r25, einStruct+6+1

Falls die Adresse zur Compilezeit nicht bekannt ist, muss sie natürlich in einem Adress- oder Basisregister übergeben werden:

void blah (struct foo_t * pfoo)
{
   asm volatile (
      "ld  %A0, %a1"    "\n\t"
      "ldd %B0, %a1+1"
         : "=&r" (...)
         : "b" (& pfoo->b[1])
   );
}

ergibt

	ld  r24, Z
	ldd r25, Z+1

Auch hier muss der Output-Operand mit einem & gekennzeichnet werden, damit er nicht ins gleiche Register geladen wird wie die Adresse.

Labels und Schleifen

Für Labels in Sprüngen und Schleifen können keine festen Bezeichner verwendet werden, weil ein Label, der via Makro oder inline-Funktion in den Code eingefügt wird, nicht mehrfach vorkommen darf. Dazu kann man sich durch Einfügen von "%=" Labels zusammenbauen, etwa L_a%=, L_b%=, etc. Das "%=" wird durch eine für die Übersetzungseinheit und den Code-Schnippsel eindeutige Zahl ersetzt. Die obigen Sequenzen könnten also z.B. umgesetzt werden als L_a14 und L_b14, wenn sie im gleichen Schnippsel stehen.

Etwas bequemer ist die Verwendung einer Ziffer als Label. Beim Sprung gibt man direkt hinter der Ziffer an, in welche Richtung das Label gesucht wird. Ist das Label n, dann sucht und springt

• nb zurück (backward)
• nf nach vorne (forward)

Es wird zum nächsten auffindbaren Label in der angegebenen Richtung gesprungen.

Bits zählen

Dieses Assembler-Schnippsel zählt die Anzahl der gesetzten Bits in einem Byte eingabe. Die Eingabe wird nach rechts ins Carry geschoben, und das Carry zum Ergebnis dazu addiert.

static inline unsigned char count_bits (unsigned char eingabe)
{                                              
   unsigned char count;

   asm volatile ( 
      "clr %0"                "\n"
      "0:"                    "\n\t"
      "lsr %1"                "\n\t"
      "adc %0, __zero_reg__"  "\n\t"
      "tst %1"                "\n\t"
      "brne 0b"
         : "=&r" (count), "=r" (eingabe)
         : "1"  (eingabe)
   );

   return count;
}

Damit kann man sich ein Parity bauen:

#define parity(x) (count_bits(x) & 1)

und hätte eine schlankere (aber etwas langsamere) Parity-Implementierung als in avr/parity.h. Ein

if (parity(foo))
   ...

wird in Assembler dann zu (r24 = eingabe, r25 = count):

	lds r24,foo
/* #APP */
	clr r25
0:
	lsr r24
	adc r25, __zero_reg__
	tst r24
	brne 0b
/* #NOAPP */
	sbrs r25,0
	rjmp .L1
        ...

Bugs

• Um das Sonderzeichen "%~" benutzen zu können, muss bei parameterlosen Inline Assembler dem Template ein Doppelpunkt folgen:

asm volatile ("%~call some_function" :);

Quellen

• Doku zur avr-libc
• Doku zu avr-gcc
• Quellen von gcc

Siehe auch

• AVR Assembler Einführung
• Quellcode Assembler
• Sourcevergleich#GCC (Assembler einfügen)
• avr-gcc