Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 –...

123
Konfigurierbare Systemsoftware (KSS) VL 3 – A spect-O riented P rogramming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme und Betriebssysteme Friedrich-Alexander-Universität Erlangen-Nürnberg SS 15 – 2015-04-28 http://www4.informatik.uni-erlangen.de/Lehre/SS15/V _ KSS

Transcript of Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 –...

Page 1: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Konfigurierbare Systemsoftware

(KSS)

VL 3 – Aspect-Oriented Programming (AOP)

Daniel Lohmann

Lehrstuhl für Informatik 4Verteilte Systeme und Betriebssysteme

Friedrich-Alexander-UniversitätErlangen-Nürnberg

SS 15 – 2015-04-28

http://www4.informatik.uni-erlangen.de/Lehre/SS15/V_KSS

Page 2: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

About this Lecture

Problem Space Solution Space

Specif ic Problem Specif ic Solution

Domain Expert ��

��

����

������

Features and Dependencies

Architect / Developer

�����

�����

�����Class

�����Aspect...

Architecture and Implementation

System User

����...

�Conf igurationA

B

D

C

System User

inst

ance

leve

lm

odel

leve

l

Variant

intendedproperties

actual implementation

intentional side extensional side

c© dl KSS (VL 3 | SS 15) 3 AOP 3–2

Page 3: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Implementation Techniques: Classification

Decompositional Approaches

Configuration

Components Variant

Text-based filtering (untyped)

Preprocessors

Compositional Approaches

Configuration

Components Variant

Language-based composition

mechanisms (typed)

OOP, AOP, Templates

Generative Approaches

Configuration

Generator VariantTemplates

Metamodel-based generation

of components (typed)

MDD, C++ TMP, generators

c© dl KSS (VL 3 | SS 15) 3 AOP 3–3

Page 4: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP 3–4

Page 5: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of ConcernsExample: I4WeatherMon

Example: eCos

AOP

3.2 Tutorial: AspectC++

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–5

Page 6: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

I4WeatherMon (CPP): Implementation (Excerpt)/************************************************************/#ifndef __Weather_h__

#define __Weather_h__

#include "util/types.h"

struct Weather {

#ifdef cfWM_WINDUInt16 _w;

#endif

#ifdef cfWM_PRESSUREUInt16 _p;

#endif

#ifdef cfWM_TEMPERATUREInt8 _t1;UInt8 _t2;

#endif

#ifdef cfWM_STACKunsigned int _maxstack;

#endif

};

extern Weather data;

#endif // __Weather_h__

/************************************************************/#include "CiAO.h"#include "Weather.h"

// Sensor implementations#ifdef cfWM_STACK

#include "StackUsage.h"#endif#ifdef cfWM_WIND

#include "Wind.h"#endif

#ifdef cfWM_PRESSURE#include "Pressure.h"

#endif

#ifdef cfWM_TEMPERATURE#include "Temperature.h"

#endif

// Actor implementations, must be included after sensors#ifdef cfWM_DISPLAY

#include "Display.h"#endif

#ifdef cfWM_PCCON_XML#include "XMLConnection.h"

#endif

// The global weather dataWeather data = {0};

// helper functionsstatic void wait () {

for (volatile unsigned char i = 100; i != 0; --i)for (volatile unsigned char j = 100; j != 0; --j);

}

// sensor processinginline void init_sensors() {#ifdef cfWM_STACK

stack_init();#endif#ifdef cfWM_WIND

wind_init();#endif

#ifdef cfWM_PRESSUREpressure_init();

#endif

#ifdef cfWM_TEMPERATUREtemperature_init();

#endif}

inline void measure() {#ifdef cfWM_WINDwind_measure();

#endif

#ifdef cfWM_PRESSUREpressure_measure();

#endif

#ifdef cfWM_TEMPERATUREtemperature_measure();

#endif

#ifdef cfWM_STACKstack_measure();

#endif}

// actor processinginline void init_sinks() {#ifdef cfWM_DISPLAYdisplay_init();

#endif

#ifdef cfWM_PCCON_XMLXMLCon_init();

#endif}

inline void process () {#ifdef cfWM_DISPLAYdisplay_process();

#endif

#ifdef cfWM_PCCON_XMLXMLCon_process();

#endif

}int main() {// initialize the CiAO system

CiAO::start ();

// init the sensors and actorsinit_sensors();init_sinks();

asm("sei");DDRD |= 0x7f; // program for output

while (true) {

// set port D output pins to 1PORTD |= 0x7f;

// measure the weather datameasure ();

// process the weather data somehowprocess ();

// set port D output pins to 0PORTD &= ~0x7f;

// wait for some timewait ();

}

}

/************************************************************/#ifndef __Wind_h__

#define __Wind_h__

#ifdef cfWM_WIND

#include "Weather.h"#include "CiAO.h"#include "String.h"

extern UInt16 _wind_counter;

inline void wind_init() {// load timer and allow timer interruptsCiAO::Timer &timer = CiAO::timer ();timer.period (500000L); // 100mstimer.start ();

// stetup PORTD and the external event counterPORTD |= 0x80;DDRD &= ~0x80;CiAO::TimerCounter::external (CiAO::TimerCounter::EXT_FALL);

}

inline void wind_measure() {data._w = _wind_counter;

}

inline char* wind_name() {return "Wind";

}

inline char* wind_unit() {return "m/s";

}

inline void wind_stringval( char* buf ) {itoa_convert( data._w, buf, 4, false);buf[4] = ’\0’;

}

#endif // cfWM_WIND#endif // __Wind_h__

/************************************************************/#include "CiAO.h"#include "util/types.h"

#ifdef cfWM_WIND

// global object used for the communication with the interrupthandler

UInt16 _wind_counter = 0;

#include "hw/dev/timer/AVRTimer1.h"

// application defined timer interrupt handlervoid ciao::AVRTimer1::tick () {

_wind_counter = CiAO::TimerCounter::value ();CiAO::TimerCounter::value (0);CiAO::Timer &timer = CiAO::timer ();timer.restart ();

}

#endif

/************************************************************/#ifndef __XMLConnection_ah__

#define __XMLConnection_ah__

#ifdef cfWM_PCCON_XML

#include "Serial.h"

void XMLCon_data (const char *name, const char *val_str);

inline void XMLCon_init() {Serial::init();

}

inline void XMLCon_process() {char val[ 5 ];

Serial::send ("<?xml version=\"1.0\"?>\n" "<weather>\n");

#ifdef cfWM_WINDwind_stringval( val );XMLCon_data ( wind_name(), val );

#endif

#ifdef cfWM_PRESSUREpressure_stringval( val );XMLCon_data ( pressure_name(), val );

#endif

#ifdef cfWM_TEMPERATUREtemperature_stringval( val );XMLCon_data ( temperature_name(), val );

#endif

#ifdef cfWM_STACKstack_stringval( val );XMLCon_data ( stack_name(), val );

#endif

Serial::send ("</weather>\n");

}

#endif cfWM_PCCON_XML#endif // __XMLConnection_ah__

/************************************************************/#ifdef cfWM_PCCON_XML

#include "Serial.h"

// send a valuevoid XMLCon_data (const char *name, const char *val_str) {

Serial::send (" <data name=\"");Serial::send (name);Serial::send ("\" value=\"");Serial::send (val_str);Serial::send ("\"/>\n");

}

#endif

c© dl KSS (VL 2 | SS 15) 2 Software Product Lines | 2.5 Solution Space 2–37

I4WeatherMon

example from

last lecture

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–6

Page 7: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Case Study eCos [4]

The embedded Configurable operating system

Operating system for embedded applicationsOpen source, maintained by eCosCentric Inc.Many 16-bit and 32-bit platforms supportedBroadly accepted real-world system

More than 750 configuration options (kernel)

Feature-based selectionPreprocessor-based implementation

S

lications

ntric

ptions

n

code!

9

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–7

Page 8: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

11

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

Kernel policies: SynchronizationInstrumentationTracing

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–8

Page 9: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

11

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

Cyg_Mutex::Cyg_Mutex() {CYG_REPORT_FUNCTION();locked = false;owner = NULL;

#if defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT) && \defined(CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC)

#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_INHERITprotocol = INHERIT;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_CEILINGprotocol = CEILING;ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#endif#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_NONEprotocol = NONE;

#endif#else // not (DYNAMIC and DEFAULT defined)#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING#ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY// if there is a default priority ceiling defined, use that to initialize// the ceiling.ceiling = CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DEFAULT_PRIORITY;

#else// Otherwise set it to zero.ceiling = 0;

#endif#endif#endif // DYNAMIC and DEFAULT definedCYG_REPORT_RETURN();

}

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

Kernel policies: SynchronizationInstrumentationTracing

Cyg_Mutex::Cyg_Mutex() {locked = false;owner = NULL;

}

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–8

Page 10: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

12

Kernel policies: SynchronizationInstrumentationTracing

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–8

Page 11: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

12

Kernel policies: SynchronizationInstrumentationTracing

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

Issue

Crosscutting Concerns

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–8

Page 12: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Aspect-Oriented Programming (AOP) [2]

Aspect-Oriented Programming

➢ AOP is about modularizing crosscutting concerns

➢ Examples: tracing, synchronization, security, buffering, error handling, constraint checks, ...

badly modularized

well modularized concern

without AOP with AOP

aspect

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–9

Page 13: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AOP: The Basic Idea

Separation of what from where:

Join Points 7→ where

positions in the static structure or dynamic control flow (event)

given declaratively by pointcut expressions

Advice 7→ what

additional elements (members, ...) to introduce at join points

additional behavior (code) to superimpose at join points

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–10

Page 14: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

12

Kernel policies: SynchronizationInstrumentationTracing

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

PROTOCOL

CEILING

INHERIT

DYNAMIC

Mutex

options:

Crosscutting Concerns

Can we do better

with aspects?

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–11

Page 15: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Implementation of Crosscutting Concerns with AOP

aspect int_sync {

pointcut sync() = execution(...) // kernel calls to sync|| construction(...)|| destruction(...);

// advise kernel code to invoke lock() and unlock()advice sync() : before() {Cyg_Scheduler::lock();

}advice sync() : after() {Cyg_Scheduler::unlock();

}

// In eCos, a new thread always starts with a lock value of 0advice execution("%Cyg_HardwareThread::thread_entry(...)") : before() {Cyg_Scheduler::zero_sched_lock();

}...

};

where

what

Synchronization

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–12

Page 16: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Static Configurability with the CPP?

Kernel policies: SynchronizationInstrumentationTracing

Result

after refactoring

into aspects [4]

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–13

Page 17: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ [5, 6]

AspectC++ is an AOP language extension for C++

superset of ISO C++ 98 [1]; every C++ program is also an AspectC++ programadditionally supports AOP concepts

Technical approach: source-to-source transformation

ac++ weaver transforms AspectC++ code into C++ coderesulting C++ code can be compiled with any standard-compliantcompiler (especially gcc)ag++ weaver wrapper works as replacement for g++ in makefiles

Language and weaver are open source (GPL2)

http://www.aspectc.org

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.1 Motivation: Separation of Concerns 3–14

Page 18: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++Example Szenario

First Steps And Language Overview

Advanced Concepts

Weaver Transformations

Further Examples

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–15

Page 19: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

Scenario: A Queue utility class

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–16

Page 20: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

The Simple Queue Class

namespace util { class Item {

friend class Queue; Item* next; public:

Item() : next(0){} };

class Queue { Item* first; Item* last;

public: Queue() : first(0), last(0) {}

void enqueue( Item* item ) { printf( " > Queue::enqueue()\n" ); if( last ) {

last->next = item; last = item; } else

last = first = item; printf( " < Queue::enqueue()\n" ); }

Item* dequeue() { printf(" > Queue::dequeue()\n"); Item* res = first;

if( first == last ) first = last = 0; else

first = first->next; printf(" < Queue::dequeue()\n"); return res;

} }; // class Queue} // namespace util

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–17

Page 21: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

Scenario: The Problem

Please extend the

Queue class by an

element counter!

I want Queue to

throw exceptions!

Queue should be

thread-safe!

Various users of Queue demand extensions:

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–18

Page 22: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

The Not So Simple Queue Class

class Queue {

Item *first, *last; int counter; os::Mutex lock;

public: Queue () : first(0), last(0) { counter = 0;

} void enqueue(Item* item) { lock.enter();

try { if (item == 0) throw QueueInvalidItemError();

if (last) { last->next = item; last = item;

} else { last = first = item; } ++counter;

} catch (...) { lock.leave(); throw; }

lock.leave(); }

Item* dequeue() { Item* res;

lock.enter(); try { res = first;

if (first == last) first = last = 0; else first = first->next;

if (counter > 0) –counter; if (res == 0) throw QueueEmptyError();

} catch (...) { lock.leave(); throw;

} lock.leave(); return res;

} int count() { return counter; }

}; // class Queue

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–19

Page 23: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

What Code Does What?

class Queue { Item *first, *last;

int counter; os::Mutex lock;public:

Queue () : first(0), last(0) { counter = 0; }

void enqueue(Item* item) { lock.enter(); try {

if (item == 0) throw QueueInvalidItemError(); if (last) {

last->next = item; last = item;

} else { last = first = item; } ++counter; } catch (...) {

lock.leave(); throw; } lock.leave();

}

Item* dequeue() { Item* res; lock.enter();

try { res = first; if (first == last)

first = last = 0; else first = first->next; if (counter > 0) –counter;

if (res == 0) throw QueueEmptyError(); } catch (...) {

lock.leave(); throw;

} lock.leave(); return res;

} int count() { return counter; }}; // class Queue

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–20

Page 24: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Scenario: A Simple Queue

Problem Summary

The component code is “polluted” with code for several logically independent concerns, thus it is ...

➢ hard to write the code– many different things have to be considered simultaneously

➢ hard to read the code– many things are going on at the same time

➢ hard to maintain and evolve the code

– the implementation of concerns such as locking is scattered over the entire source base (a “crosscutting concern”)

➢ hard to configure at compile time– the users get a “one fits all” queue class

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–21

Page 25: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Goal: A configurable Queue

Queue

Operations

enqueue() dequeue()

Counting

count()

Thread safety Error propagation

Return codes Exceptions

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–22

Page 26: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Goal: A configurable Queue

Configuring with the Preprocessor?

class Queue { Item *first, *last;#ifdef COUNTING_ASPECT int counter;#endif#ifdef LOCKING_ASPECT os::Mutex lock;#endifpublic: Queue () : first(0), last(0) {#ifdef COUNTING_ASPECT counter = 0;#endif } void enqueue(Item* item) {#ifdef LOCKING_ASPECT lock.enter(); try {#endif#ifdef ERRORHANDLING_ASPECT if (item == 0) throw QueueInvalidItemError();#endif if (last) { last->next = item; last = item; } else { last = first = item; }#ifdef COUNTING_ASPECT ++counter;#endif#ifdef LOCKING_ASPECT } catch (...) { lock.leave(); throw; } lock.leave();#endif }

Item* dequeue() { Item* res;#ifdef LOCKING_ASPECT lock.enter(); try {#endif res = first; if (first == last) first = last = 0; else first = first->next;#ifdef COUNTING_ASPECT if (counter > 0) --counter;#endif#ifdef ERRORHANDLING_ASPECT if (res == 0) throw QueueEmptyError();#endif#ifdef LOCKING_ASPECT } catch (...) { lock.leave(); throw; } lock.leave();#endif return res; }#ifdef COUNTING_ASPECT int count() { return counter; }#endif}; // class Queue

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–23

Page 27: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++Example Szenario

First Steps And Language Overview

Advanced Concepts

Weaver Transformations

Further Examples

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–24

Page 28: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

Queue: Demanded Extensions

I. Element counting

II. Errorhandling (signaling of errors by exceptions)

III. Thread safety (synchronization by mutex variables)

Please extend

the Queue class

by an element

counter!

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–25

Page 29: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

Element counting: The Idea

➢ Increment a counter variable after eachexecution of util::Queue::enqueue()

➢ Decrement it after each execution of util::Queue::dequeue()

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–26

Page 30: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

ElementCounter1.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–27

Page 31: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Elements

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

We introduced a new aspect named

ElementCounter.

An aspect starts with the keyword aspect

and is syntactically much like a class.

ElementCounter1.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–28

Page 32: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Elements

ElementCounter1.ah

Like a class, an aspect

can define data members,

constructors and so on

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–29

Page 33: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Elements

ElementCounter1.ah

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

We give after advice (= some

crosscuting code to be executed

after certain control flow positions)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–30

Page 34: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Elements

ElementCounter1.ah

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

This pointcut expression denotes

where the advice should be given.

(After execution of methods that match

the pattern)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–31

Page 35: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Elements

ElementCounter1.ah

Aspect member elements can be

accessed from within the advice body

aspect ElementCounter {

int counter; ElementCounter() { counter = 0; }

advice execution("% util::Queue::enqueue(...)") : after() { ++counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); } advice execution("% util::Queue::dequeue(...)") : after() { if( counter > 0 ) --counter; printf( " Aspect ElementCounter: # of elements = %d\n", counter ); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–32

Page 36: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 - Result

main.cc

int main() { util::Queue queue;

printf("main(): enqueueing an item\n"); queue.enqueue( new util::Item );

printf("main(): dequeueing two items\n"); Util::Item* item; item = queue.dequeue(); item = queue.dequeue();}

main(): enqueueing am item > Queue::enqueue(00320FD0) < Queue::enqueue(00320FD0) Aspect ElementCounter: # of elements = 1 main(): dequeueing two items > Queue::dequeue() < Queue::dequeue() returning 00320FD0 Aspect ElementCounter: # of elements = 0 > Queue::dequeue() < Queue::dequeue() returning 00000000 Aspect ElementCounter: # of elements = 0

<Output>

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–33

Page 37: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter1 – What's next?

➢ The aspect is not the ideal place to store the counter,

because it is shared between all Queue instances

➢ Ideally, counter becomes a member of Queue

➢ In the next step, we

– move counter into Queue by introduction

– expose context about the aspect invocation to access the current Queue instance

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–34

Page 38: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2aspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public: int count() const { return counter; }

}; advice execution("% util::Queue::enqueue(...)") && that(queue) : after( util::Queue& queue ) {

++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) { if( queue.count() > 0 ) --queue.counter;

printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); } advice construction("util::Queue")

&& that(queue) : before( util::Queue& queue ) { queue.counter = 0; }

};

ElementCounter2.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–35

Page 39: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Elementsaspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public: int count() const { return counter; }

}; advice execution("% util::Queue::enqueue(...)") && that(queue) : after( util::Queue& queue ) {

++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) { if( queue.count() > 0 ) --queue.counter;

printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); } advice construction("util::Queue")

&& that(queue) : before( util::Queue& queue ) { queue.counter = 0; }

};

Introduces a slice of members into

all classes denoted by the pointcut

"util::Queue"

ElementCounter2.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–36

Page 40: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Elements

ElementCounter2.ah

aspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public:

int count() const { return counter; } }; advice execution("% util::Queue::enqueue(...)")

&& that(queue) : after( util::Queue& queue ) { ++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() );

} advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) {

if( queue.count() > 0 ) --queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice construction("util::Queue") && that(queue) : before( util::Queue& queue ) { queue.counter = 0;

}};

We introduce a private

counter element and a

public method to read it

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–37

Page 41: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Elementsaspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public:

int count() const { return counter; } }; advice execution("% util::Queue::enqueue(...)")

&& that(queue) : after( util::Queue& queue ) { ++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() );

} advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) {

if( queue.count() > 0 ) --queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice construction("util::Queue") && that(queue) : before( util::Queue& queue ) { queue.counter = 0;

}};

A context variable queue is bound

to that (the calling instance).

The calling instance has to be

an util::Queue

ElementCounter2.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–38

Page 42: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Elementsaspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public:

int count() const { return counter; } }; advice execution("% util::Queue::enqueue(...)")

&& that(queue) : after( util::Queue& queue ) { ++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() );

} advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) {

if( queue.count() > 0 ) --queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice construction("util::Queue") && that(queue) : before( util::Queue& queue ) { queue.counter = 0;

}};

The context variable queue is

used to access the calling

instance.

ElementCounter2.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–39

Page 43: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Elements

By giving construction advice

we ensure that counter gets

initialized

ElementCounter2.ah

aspect ElementCounter {

advice "util::Queue" : slice class {

int counter; public:

int count() const { return counter; } }; advice execution("% util::Queue::enqueue(...)")

&& that(queue) : after( util::Queue& queue ) { ++queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() );

} advice execution("% util::Queue::dequeue(...)") && that(queue) : after( util::Queue& queue ) {

if( queue.count() > 0 ) --queue.counter; printf( " Aspect ElementCounter: # of elements = %d\n", queue.count() ); }

advice construction("util::Queue") && that(queue) : before( util::Queue& queue ) { queue.counter = 0;

}};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–40

Page 44: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Result

main.cc

int main() { util::Queue queue; printf("main(): Queue contains %d items\n", queue.count()); printf("main(): enqueueing some items\n"); queue.enqueue(new util::Item); queue.enqueue(new util::Item); printf("main(): Queue contains %d items\n", queue.count()); printf("main(): dequeueing one items\n"); util::Item* item; item = queue.dequeue(); printf("main(): Queue contains %d items\n", queue.count()); }

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–41

Page 45: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter2 - Result

main.cc

int main() { util::Queue queue; printf("main(): Queue contains %d items\n", queue.count()); printf("main(): enqueueing some items\n"); queue.enqueue(new util::Item); queue.enqueue(new util::Item); printf("main(): Queue contains %d items\n", queue.count()); printf("main(): dequeueing one items\n"); util::Item* item; item = queue.dequeue(); printf("main(): Queue contains %d items\n", queue.count()); }

main(): Queue contains 0 itemsmain(): enqueueing some items > Queue::enqueue(00320FD0) < Queue::enqueue(00320FD0) Aspect ElementCounter: # of elements = 1 > Queue::enqueue(00321000) < Queue]::enqueue(00321000) Aspect ElementCounter: # of elements = 2main(): Queue contains 2 itemsmain(): dequeueing one items > Queue::dequeue() < Queue::dequeue() returning 00320FD0 Aspect ElementCounter: # of elements = 1main(): Queue contains 1 items

<Output>

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–42

Page 46: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Element Counting

ElementCounter – Lessons Learned

You have seen...

➢ the most important concepts of AspectC++– Aspects are introduced with the keyword aspect

– They are much like a class, may contain methods, data members, types, inner classes, etc.

– Additionaly, aspects can give advice to be woven in at certain positions (joinpoints). Advice can be given to Functions/Methods/Constructors: code to execute (code advice)

Classes or structs: new elements (introductions)

– Joinpoints are described by pointcut expressions

➢ We will now take a closer look at some of them

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–43

Page 47: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

advice type

Syntactic Elements

aspect ElementCounter {

advice execution("% util::Queue::enqueue(...)") : after() { printf( " Aspect ElementCounter: after Queue::enqueue!\n" ); }

...};

ElementCounter1.ah

pointcut expression

advice body

aspect name

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–44

Page 48: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

Joinpoints

➢ A joinpoint denotes a position to give advice

– Code joinpointa point in the control flow of a running program, e.g. execution of a function

call of a function

– Name joinpoint a named C++ program entity (identifier)

class, function, method, type, namespace

➢ Joinpoints are given by pointcut expressions

a pointcut expression describes a set of joinpoints

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–45

Page 49: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

Pointcut Expressions

➢ Pointcut expressions are made from ...

– match expressions, e.g. "% util::queue::enqueue(...)" are matched against C++ programm entities → name joinpoints

support wildcards

– pointcut functions, e.g execution(...), call(...), that(...) execution: all points in the control flow, where a function is about to

be executed → code joinpoints

call: all points in the control flow, where a function is about to be

called → code joinpoints

➢ Pointcut functions can be combined into expressions using logical connectors: &&, ||, !

Example: call("% util::Queue::enqueue(...)") && within("% main(...)")

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–46

Page 50: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

AdviceAdvice to functions

– before advice Advice code is executed before the original code

Advice may read/modify parameter values

– after advice Advice code is executed after the original code

Advice may read/modify return value

– around advice Advice code is executed instead of the original code

Original code may be called explicitly: tjp->proceed()

Introductions A slice of additional methods, types, etc. is added to the class Can be used to extend the interface of a class

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–47

Page 51: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

class ClassA {public: void foo(){ printf(“ClassA::foo()”\n); }}

int main(){ printf(“main()\n”); ClassA a; a.foo();}

advice execution(“void ClassA::foo()”) : before()

advice execution(“void ClassA::foo()”) : after()

advice call (“void ClassA::foo()”) : before()

advice call (“void ClassA::foo()”) : after()

Before / After Advice

with call joinpoints:

with execution joinpoints:

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–48

Page 52: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

class ClassA {public: void foo(){ printf(“ClassA::foo()”\n); }}

int main(){ printf(“main()\n”); ClassA a; a.foo();}

advice execution(“void ClassA::foo()”) : around()

before code

tjp->proceed()

after code

advice call(“void ClassA::foo()”) : around()

before code

tjp->proceed()

after code

Around Advice

with call joinpoints:

with execution joinpoints:

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–49

Page 53: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

AspectC++ Language Elements

class ClassA {

public:

void foo(){ printf(“ClassA::foo()”\n); }}

advice “ClassA” : slice class {

element to introduce

Introductions

public:

element to introduce

};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–50

Page 54: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

Queue: Demanded Extensions

I. Element counting

II. Errorhandling (signaling of errors by exceptions)

III. Thread safety (synchronization by mutex variables)

I want Queue to

throw exceptions!

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–51

Page 55: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

Errorhandling: The Idea

➢ We want to check the following constraints:

– enqueue() is never called with a NULL item

– dequeue() is never called on an empty queue

➢ In case of an error an exception should be thrown

➢ To implement this, we need access to ...

– the parameter passed to enqueue()

– the return value returned by dequeue()

... from within the advice

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–52

Page 56: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

ErrorExceptionnamespace util { struct QueueInvalidItemError {}; struct QueueEmptyError {};}

aspect ErrorException {

advice execution("% util::Queue::enqueue(...)") && args(item) : before(util::Item* item) { if( item == 0 ) throw util::QueueInvalidItemError(); } advice execution("% util::Queue::dequeue(...)") && result(item) : after(util::Item* item) { if( item == 0 ) throw util::QueueEmptyError(); }};

ErrorException.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–53

Page 57: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

ErrorException - Elementsnamespace util { struct QueueInvalidItemError {}; struct QueueEmptyError {};}

aspect ErrorException {

advice execution("% util::Queue::enqueue(...)") && args(item) : before(util::Item* item) { if( item == 0 ) throw util::QueueInvalidItemError(); } advice execution("% util::Queue::dequeue(...)") && result(item) : after(util::Item* item) { if( item == 0 ) throw util::QueueEmptyError(); }};

ErrorException.ah

We give advice to be executed before

enqueue() and after dequeue()

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–54

Page 58: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

ErrorException - Elementsnamespace util { struct QueueInvalidItemError {}; struct QueueEmptyError {};}

aspect ErrorException {

advice execution("% util::Queue::enqueue(...)") && args(item) : before(util::Item* item) { if( item == 0 ) throw util::QueueInvalidItemError(); } advice execution("% util::Queue::dequeue(...)") && result(item) : after(util::Item* item) { if( item == 0 ) throw util::QueueEmptyError(); }};

A context variable item is bound to

the first argument of type util::Item*

passed to the matching methods

ErrorException.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–55

Page 59: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

ErrorException - Elementsnamespace util { struct QueueInvalidItemError {}; struct QueueEmptyError {};}

aspect ErrorException {

advice execution("% util::Queue::enqueue(...)") && args(item) : before(util::Item* item) { if( item == 0 ) throw util::QueueInvalidItemError(); } advice execution("% util::Queue::dequeue(...)") && result(item) : after(util::Item* item) { if( item == 0 ) throw util::QueueEmptyError(); }};

Here the context variable item is

bound to the result of type util::Item*

returned by the matching methods

ErrorException.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–56

Page 60: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Error Handling

ErrorException – Lessons Learned

You have seen how to ...

➢ use different types of advice

– before advice

– after advice

➢ expose context in the advice body

– by using args to read/modify parameter values

– by using result to read/modify the return value

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–57

Page 61: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

Queue: Demanded Extensions

I. Element counting

II. Errorhandling (signaling of errors by exceptions)

III. Thread safety (synchronization by mutex variables)

Queue should be

thread-safe!

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–58

Page 62: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

Thread Safety: The Idea

➢ Protect enqueue() and dequeue() by a mutex object

➢ To implement this, we need to

– introduce a mutex variable into class Queue

– lock the mutex before the execution of enqueue() / dequeue()

– unlock the mutex after execution of enqueue() / dequeue()

➢ The aspect implementation should be exception safe!

– in case of an exception, pending after advice is not called

– solution: use around advice

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–59

Page 63: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex

LockingMutex.ah

aspect LockingMutex { advice "util::Queue" : slice class { os::Mutex lock; };

pointcut sync_methods() = "% util::Queue::%queue(...)";

advice execution(sync_methods()) && that(queue) : around( util::Queue& queue ) { queue.lock.enter(); try { tjp->proceed(); } catch(...) { queue.lock.leave(); throw; } queue.lock.leave(); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–60

Page 64: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex - Elements

LockingMutex.ah

aspect LockingMutex { advice "util::Queue" : slice class { os::Mutex lock; };

pointcut sync_methods() = "% util::Queue::%queue(...)";

advice execution(sync_methods()) && that(queue) : around( util::Queue& queue ) { queue.lock.enter(); try { tjp->proceed(); } catch(...) { queue.lock.leave(); throw; } queue.lock.leave(); }};

We introduce a mutex

member into class Queue

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–61

Page 65: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex - Elementsaspect LockingMutex { advice "util::Queue" : slice class { os::Mutex lock; };

pointcut sync_methods() = "% util::Queue::%queue(...)";

advice execution(sync_methods()) && that(queue) : around( util::Queue& queue ) { queue.lock.enter(); try { tjp->proceed(); } catch(...) { queue.lock.leave(); throw; } queue.lock.leave(); }};

LockingMutex.ah

Pointcuts can be named.

sync_methods describes all

methods that have to be

synchronized by the mutex

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–62

Page 66: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex - Elements

LockingMutex.ah

aspect LockingMutex { advice "util::Queue" : slice class { os::Mutex lock; };

pointcut sync_methods() = "% util::Queue::%queue(...)";

advice execution(sync_methods()) && that(queue) : around( util::Queue& queue ) { queue.lock.enter(); try { tjp->proceed(); } catch(...) { queue.lock.leave(); throw; } queue.lock.leave(); }};

sync_methods is used to give

around advice to the execution

of the methods

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–63

Page 67: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex - Elements

LockingMutex.ah

aspect LockingMutex { advice "util::Queue" : slice class { os::Mutex lock; };

pointcut sync_methods() = "% util::Queue::%queue(...)";

advice execution(sync_methods()) && that(queue) : around( util::Queue& queue ) { queue.lock.enter(); try { tjp->proceed(); } catch(...) { queue.lock.leave(); throw; } queue.lock.leave(); }};

By calling tjp->proceed() the

original method is executed

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–64

Page 68: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: Thread Synchronization

LockingMutex – Lessons Learned

You have seen how to ...

➢ use named pointcuts – to increase readability of pointcut expressions

– to reuse pointcut expressions

➢ use around advice– to deal with exception safety

– to explicit invoke (or don't invoke) the original code by calling tjp->proceed()

➢ use wildcards in match expressions– "% util::Queue::%queue(...)" matches both

enqueue() and dequeue()

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–65

Page 69: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

Queue: A new Requirement

I. Element counting

II. Errorhandling (signaling of errors by exceptions)

III. Thread safety (synchronization by mutex variables)

IV. Interrupt safety (synchronization on interrupt level)

We need Queue to be

synchronized on

interrupt level!

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–66

Page 70: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

Interrupt Safety: The Idea

➢ Scenario– Queue is used to transport objects between

kernel code (interrupt handlers) and application code

– If application code accesses the queue, interrupts must be disabled first

– If kernel code accesses the queue, interrupts must not be disabled

➢ To implement this, we need to distinguish – if the call is made from kernel code, or

– if the call is made from application code

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–67

Page 71: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ1aspect LockingIRQ {

pointcut sync_methods() = "% util::Queue::%queue(...)"; pointcut kernel_code() = "% kernel::%(...)";

advice call(sync_methods()) && !within(kernel_code()) : around() { os::disable_int(); try { tjp->proceed(); } catch(...) { os::enable_int(); throw; } os::enable_int(); }};

LockingIRQ1.ah

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–68

Page 72: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ1 – Elements aspect LockingIRQ {

pointcut sync_methods() = "% util::Queue::%queue(...)"; pointcut kernel_code() = "% kernel::%(...)";

advice call(sync_methods()) && !within(kernel_code()) : around() { os::disable_int(); try { tjp->proceed(); } catch(...) { os::enable_int(); throw; } os::enable_int(); }};

LockingIRQ1.ah

We define two pointcuts. One for the

methods to be synchronized and

one for all kernel functions

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–69

Page 73: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ1 – Elements aspect LockingIRQ {

pointcut sync_methods() = "% util::Queue::%queue(...)"; pointcut kernel_code() = "% kernel::%(...)";

advice call(sync_methods()) && !within(kernel_code()) : around() { os::disable_int(); try { tjp->proceed(); } catch(...) { os::enable_int(); throw; } os::enable_int(); }};

LockingIRQ1.ah

This pointcut expression matches any

call to a sync_method that is not done

from kernel_code

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–70

Page 74: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ1 – Result

main.cc

util::Queue queue;void do_something() { printf("do_something()\n"); queue.enqueue( new util::Item );}

namespace kernel { void irq_handler() { printf("kernel::irq_handler()\n"); queue.enqueue(new util::Item); do_something(); }

} int main() { printf("main()\n"); queue.enqueue(new util::Item); kernel::irq_handler(); // irq printf("back in main()\n"); queue.dequeue();}

main()os::disable_int() > Queue::enqueue(00320FD0) < Queue::enqueue()os::enable_int()kernel::irq_handler() > Queue::enqueue(00321030) < Queue::enqueue()do_something()os::disable_int() > Queue::enqueue(00321060) < Queue::enqueue()os::enable_int()back in main()os::disable_int() > Queue::dequeue() < Queue::dequeue() returning 00320FD0os::enable_int()

<Output>

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–71

Page 75: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ1 – Problem

main.cc

util::Queue queue;void do_something() { printf("do_something()\n"); queue.enqueue( new util::Item );}

namespace kernel { void irq_handler() { printf("kernel::irq_handler()\n"); queue.enqueue(new util::Item); do_something(); }

} int main() { printf("main()\n"); queue.enqueue(new util::Item); kernel::irq_handler(); // irq printf("back in main()\n"); queue.dequeue();}

main()os::disable_int() > Queue::enqueue(00320FD0) < Queue::enqueue()os::enable_int()kernel::irq_handler() > Queue::enqueue(00321030) < Queue::enqueue()do_something()os::disable_int() > Queue::enqueue(00321060) < Queue::enqueue()os::enable_int()back in main()os::disable_int() > Queue::dequeue() < Queue::dequeue() returning 00320FD0os::enable_int()

<Output>

The pointcut within(kernel_code)

does not match any indirect calls

to sync_methods

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–72

Page 76: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ2aspect LockingIRQ {

pointcut sync_methods() = "% util::Queue::%queue(...)"; pointcut kernel_code() = "% kernel::%(...)";

advice execution(sync_methods()) && !cflow(execution(kernel_code())) : around() { os::disable_int(); try { tjp->proceed(); } catch(...) { os::enable_int(); throw; } os::enable_int(); }};

LockingIRQ2.ah

Solution

Using the cflow pointcut function

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–73

Page 77: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ2 – Elements aspect LockingIRQ {

pointcut sync_methods() = "% util::Queue::%queue(...)"; pointcut kernel_code() = "% kernel::%(...)";

advice execution(sync_methods()) && !cflow(execution(kernel_code())) : around() { os::disable_int(); try { tjp->proceed(); } catch(...) { os::enable_int(); throw; } os::enable_int(); }};

LockingIRQ2.ah

This pointcut expression matches the

execution of sync_methods if no

kernel_code is on the call stack.

cflow checks the call stack (control flow)

at runtime.

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–74

Page 78: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ2 – Result

main.cc

util::Queue queue;void do_something() { printf("do_something()\n"); queue.enqueue( new util::Item );}

namespace kernel { void irq_handler() { printf("kernel::irq_handler()\n"); queue.enqueue(new util::Item); do_something(); }

} int main() { printf("main()\n"); queue.enqueue(new util::Item); kernel::irq_handler(); // irq printf("back in main()\n"); queue.dequeue();}

main()os::disable_int() > Queue::enqueue(00320FD0) < Queue::enqueue()os::enable_int()kernel::irq_handler() > Queue::enqueue(00321030) < Queue::enqueue()do_something() > Queue::enqueue(00321060) < Queue::enqueue()back in main()os::disable_int() > Queue::dequeue() < Queue::dequeue() returning 00320FD0os::enable_int()

<Output>

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–75

Page 79: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Queue: IRQ Synchronization

LockingIRQ – Lessons Learned

You have seen how to ...

➢ restrict advice invocation to a specific calling context

➢ use the within(...) and cflow(...) pointcut functions

– within is evaluated at compile time and returns all code joinpoints of a class' or namespaces lexical scope

– cflow is evaluated at runtime and returns all joinpoints where the control flow is below a specific code joinpoint

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–76

Page 80: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

A First Summary

AspectC++: A First Summary

➢ The Queue example has presented the most important features of the AspectC++ language

aspect, advice, joinpoint, pointcut expression, pointcut function, ...

➢ Additionaly, AspectC++ provides some more advanced concepts and features

to increase the expressive power of aspectual code

to write broadly reusable aspects to deal with aspect interdependence and ordering

➢ In the following, we give a short overview on these advanced language elements

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–77

Page 81: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++Example Szenario

First Steps And Language Overview

Advanced Concepts

Weaver Transformations

Further Examples

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–78

Page 82: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

AspectC++: Advanced Concepts

➢ Join Point API provides a uniform interface to the aspect invocation context,

both at runtime and compile-time

➢ Abstract Aspects and Aspect Inheritance comparable to class inheritance, aspect inheritance allows to

reuse parts of an aspect and overwrite other parts

➢ Generic Advice exploits static type information in advice code

➢ Aspect Ordering allows to specify the invocation order of multiple aspects

➢ Aspect Instantiation allows to implement user-defined aspect instantiation models

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–79

Page 83: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

The Joinpoint API

➢ Inside an advice body, the current joinpoint context is available via the implicitly passed tjp variable:

advice ... {

struct JoinPoint {

...

} *tjp; // implicitly available in advice code

...

}

➢ You have already seen how to use tjp, to ... execute the original code in around advice with tjp->proceed()

➢ The joinpoint API provides a rich interface to expose context independently of the aspect target

this is especially useful in writing reusable aspect code

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–80

Page 84: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

The Join Point API (Excerpt)

Types (compile-time)

// object type (initiator) That

// object type (receiver) Target

// result type of the affected function Result

// type of the i'th argument of the affected // function (with 0 <= i < ARGS) Arg<i>::Type Arg<i>::ReferredType

Consts (compile-time)

// number of arguments ARGS

// unique numeric identifier for this join point JPID

// numeric identifier for the type of this join // point (AC::CALL, AC::EXECUTION, ...) JPTYPE

Values (runtime)

// pointer to the object initiating a call That* that()

// pointer to the object that is target of a call Target* target()

// pointer to the result value Result* result()

// typed pointer the i'th argument value of a // function call (compile-time index) Arg<i>::ReferredType* arg()

// pointer the i'th argument value of a // function call (runtime index) void* arg( int i )

// textual representation of the joinpoint // (function/class name, parameter types...) static const char* signature()

// executes the original joinpoint code // in an around advice void proceed()

// returns the runtime action object AC::Action& action()

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–81

Page 85: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Abstract Aspects and Inheritance

➢ Aspects can inherit from other aspects... Reuse aspect definitions

Override methods and pointcuts

➢ Pointcuts can be pure virtual Postpone the concrete definition to derived aspects

An aspect with a pure virtual pointcut is called abstract aspect

➢ Common usage: Reusable aspect implementations Abstract aspect defines advice code, but pure virtual pointcuts

Aspect code uses the joinpoint API to expose context Concrete aspect inherits the advice code and overrides pointcuts

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–82

Page 86: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Abstract Aspects and Inheritance

LockingA.ah

#include "mutex.h"

aspect LockingA { pointcut virtual sync_classes() = 0; pointcut virtual sync_methods() = 0;

advice sync_classes() : slice class {

os::Mutex lock; }; advice execution(sync_methods()) : around() {

tjp->that()->lock.enter(); try { tjp->proceed();

} catch(...) { tjp->that()->lock.leave();

throw; } tjp->that()->lock.leave();

}};

#include "LockingA.ah"

aspect LockingQueue : public LockingA { pointcut sync_classes() = "util::Queue";

pointcut sync_methods() = "% util::Queue::%queue(...)";};

LockingQueue.ah

The abstract locking aspect declares

two pure virtual pointcuts and uses

the joinpoint API for an context-

independent advice implementation.

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–83

Page 87: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Abstract Aspects and Inheritance

LockingA.ah

#include "mutex.h"

aspect LockingA { pointcut virtual sync_classes() = 0; pointcut virtual sync_methods() = 0;

advice sync_classes() : slice class {

os::Mutex lock; }; advice execution(sync_methods()) : around() {

tjp->that()->lock.enter(); try { tjp->proceed();

} catch(...) { tjp->that()->lock.leave();

throw; } tjp->that()->lock.leave();

}};

#include "LockingA.ah"

aspect LockingQueue : public LockingA { pointcut sync_classes() = "util::Queue";

pointcut sync_methods() = "% util::Queue::%queue(...)";};

LockingQueue.ah

The concrete locking aspect

derives from the abstract aspect

and overrides the pointcuts.

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–84

Page 88: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Generic Advice

Uses static JP-specific type information in advice code in combination with C++ overloading

to instantiate C++ templates and template meta-programs

aspect TraceService { advice call(...) : after() { ... cout << *tjp->result(); }};

... operator <<(..., int)... operator <<(..., int)

... operator <<(..., bool)... operator <<(..., bool)

... operator <<(..., long)... operator <<(..., long)

... operator <<(..., Foo)... operator <<(..., Foo)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–85

Page 89: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Generic Advice

Uses static JP-specific type information in advice code in combination with C++ overloading

to instantiate C++ templates and template meta-programs

aspect TraceService { advice call(...) : after() { ... cout << *tjp->result(); }};

... operator <<(..., int)... operator <<(..., int)

... operator <<(..., bool)... operator <<(..., bool)

... operator <<(..., long)... operator <<(..., long)

... operator <<(..., Foo)... operator <<(..., Foo)

Resolves to the statically typed return value

no runtime type checks are needed unhandled types are detected at compile-time functions can be inlined

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–86

Page 90: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Aspect Ordering

➢ Aspects should be independent of other aspects However, sometimes inter-aspect dependencies are unavoidable

Example: Locking should be activated before any other aspects

➢ Order advice The aspect order can be defined by order advice

advice pointcut-expr : order(high, ..., low)

Different aspect orders can be defined for different pointcuts

➢ Example

advice "% util::Queue::%queue(...)" : order( "LockingIRQ", "%" && !"LockingIRQ" );

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–87

Page 91: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Advanced Concepts

Aspect Instantiation

➢ Aspects are singletons by default aspectof() returns pointer to the one-and-only aspect instance

➢ By overriding aspectof() this can be changed e.g. one instance per client or one instance per thread

aspect MyAspect { // .... static MyAspect* aspectof() { static __declspec(thread) MyAspect* theAspect;

if( theAspect == 0 ) theAspect = new MyAspect; return theAspect; }};

MyAspect.ah

Example of an user-

defined aspectof()

implementation for

per-thread aspect

instantiation by using

thread-local storage.

(Visual C++)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–88

Page 92: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++Example Szenario

First Steps And Language Overview

Advanced Concepts

Weaver Transformations

Further Examples

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–89

Page 93: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Aspect Transformation

Transform.ah

Transform.ah'

aspect Transform { advice call("% foo()") : before() { printf("before foo call\n"); } advice execution("% C::%()") : after() { printf(tjp->signature ()); }};

class Transform { static Transform __instance; // ... void __a0_before () { printf ("before foo call\n"); } template<class JoinPoint> void __a1_after (JoinPoint *tjp) { printf (tjp->signature ()); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–90

Page 94: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

aspect Transform { advice call("% foo()") : before() { printf("before foo call\n"); } advice execution("% C::%()") : after() { printf(tjp->signature ()); }};

Aspect Transformation

Transform.ah

Transform.ah'

Aspects are transformed

into ordinary classes

class Transform { static Transform __instance; // ... void __a0_before () { printf ("before foo call\n"); } template<class JoinPoint> void __a1_after (JoinPoint *tjp) { printf (tjp->signature ()); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–91

Page 95: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Aspect Transformation

Transform.ah

Transform.ah'

One global aspect

instance is created by

default

aspect Transform { advice call("% foo()") : before() { printf("before foo call\n"); } advice execution("% C::%()") : after() { printf(tjp->signature ()); }};

class Transform { static Transform __instance; // ... void __a0_before () { printf ("before foo call\n"); } template<class JoinPoint> void __a1_after (JoinPoint *tjp) { printf (tjp->signature ()); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–92

Page 96: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Aspect Transformation

Transform.ah

aspect Transform { advice call("% foo()") : before() { printf("before foo call\n"); } advice execution("% C::%()") : after() { printf(tjp->signature ()); }};

Transform.ah'

Advice becomes a

member function

class Transform { static Transform __instance; // ... void __a0_before () { printf ("before foo call\n"); } template<class JoinPoint> void __a1_after (JoinPoint *tjp) { printf (tjp->signature ()); }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–93

Page 97: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Aspect Transformation

Transform.ah

aspect Transform { advice call("% foo()") : before() { printf("before foo call\n"); } advice execution("% C::%()") : after() { printf(tjp->signature ()); }};

class Transform { static Transform __instance; // ... void __a0_before () { printf ("before foo call\n"); } template<class JoinPoint> void __a1_after (JoinPoint *tjp) { printf (tjp->signature ()); }};

Transform.ah'

“Generic Advice”

becomes a template

member function

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–94

Page 98: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Joinpoint Transformation

main.cc

int main() { foo(); return 0;}

main.cc'

int main() { struct __call_main_0_0 { static inline void invoke (){ AC::..._a0_before (); ::foo(); } }; __call_main_0_0::invoke (); return 0;}

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–95

Page 99: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Joinpoint Transformation

the function call is replaced by

a call to a wrapper function

main.cc

int main() { foo(); return 0;}

main.cc'

int main() { struct __call_main_0_0 { static inline void invoke (){ AC::..._a0_before (); ::foo(); } }; __call_main_0_0::invoke (); return 0;}

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–96

Page 100: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Joinpoint Transformation

main.cc

int main() { foo(); return 0;}

main.cc'

a local class invokes the advice

code for this joinpoint

int main() { struct __call_main_0_0 { static inline void invoke (){ AC::..._a0_before (); ::foo(); } }; __call_main_0_0::invoke (); return 0;}

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–97

Page 101: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Weaver Transformations

Translation Modes

➢ Whole Program Transformation-Mode

– e.g. ac++ -p src -d gen -e cpp -Iinc -DDEBUG

– transforms whole directory trees

– generates manipulated headers, e.g. for libraries

– can be chained with other whole program transformation tools

➢ Single Translation Unit-Mode

– e.g. ac++ -c a.cc -o a-gen.cc -p .

– easier integration into build processes

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–98

Page 102: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++Example Szenario

First Steps And Language Overview

Advanced Concepts

Weaver Transformations

Further Examples

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–99

Page 103: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Observer Pattern: Scenario

Draw()

AnalogClock

Draw()

DigitalClock

GetHour() : int

SetTime (in h : int , in m : int, in s : int )

Tick()

ClockTimer

update on

change

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–100

Page 104: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Observer Pattern: Implementation

Draw()

AnalogClock

Draw()

DigitalClock

GetHour() : int

SetTime (in h : int , in m : int, in s : int )

Tick()

ClockTimer

update (in s : ISubject)

IObserver

updateAll ()

ISubjectobservers

update (in s)update (in s)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–101

Page 105: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Observer Pattern: Problem

The 'Observer Protocol' Concern...

...crosscuts the module structure

Draw()

update (in s)

AnalogClock

Draw()

update (in s)

DigitalClock

GetHour() : int

SetTime (in h : int , in m : int, in s : int )

Tick()

ClockTimer

update (in s : ISubject)

IObserver

updateAll ()

ISubjectobservers

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–102

Page 106: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspect

aspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–103

Page 107: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspect

aspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

Interfaces for the

subject/observer roles

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–104

Page 108: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspect

aspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

abstract pointcuts that

define subjects/observers

(need to be overridden by a

derived aspect)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–105

Page 109: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspect

aspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

virtual pointcut defining all

state-changing methods.

(Defaults to the execution of any

non-const method in subjects)

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–106

Page 110: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspectaspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

Introduction of the role

interface as additional

baseclass into

subjects / observers

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–107

Page 111: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Generic Observer Aspect

aspect ObserverPattern { ... public: struct ISubject {}; struct IObserver { virtual void update (ISubject *) = 0; };

pointcut virtual observers() = 0; pointcut virtual subjects() = 0;

pointcut virtual subjectChange() = execution( "% ...::%(...)" && !"% ...::%(...) const" ) && within( subjects() );

advice observers () : slice class : public ObserverPattern::IObserver; advice subjects() : slice class : public ObserverPattern::ISubject;

advice subjectChange() : after () { ISubject* subject = tjp->that(); updateObservers( subject ); }

void updateObservers( ISubject* subject ) { ... } void addObserver( ISubject* subject, IObserver* observer ) { ... } void remObserver( ISubject* subject, IObserver* observer ) { ... }};

After advice to update

observers after

execution of a state-

changing method

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–108

Page 112: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Solution: Putting Everything Together

aspect ClockObserver : public ObserverPattern { // define the participants pointcut subjects() = "ClockTimer"; pointcut observers() = "DigitalClock"||"AnalogClock";

public: // define what to do in case of a notification advice observers() : slice class { public: void update( ObserverPattern::ISubject* s ) { Draw(); } };};

Applying the Generic Observer Aspect to the clock example

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–109

Page 113: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Errorhandling in Legacy Code: Scenario

LRESULT WINAPI WndProc( HWND hWnd, UINT nMsg, WPARAM wParam, LPARAM lParam ) { HDC dc = NULL; PAINTSTRUCT ps = {0};

switch( nMsg ) { case WM_PAINT:

dc = BeginPaint( hWnd, &ps ); ... EndPaint(hWnd, &ps);

break; ...}}

int WINAPI WinMain( ... ) { HANDLE hConfigFile = CreateFile( "example.config", GENERIC_READ, ... );

WNDCLASS wc = {0, WndProc, 0, 0, ... , "Example_Class"}; RegisterClass( &wc );

HWND hwndMain = CreateWindowEx( 0, "Example_Class", "Example", ... ); UpdateWindow( hwndMain );

MSG msg; while( GetMessage( &msg, NULL, 0, 0 ) ) {

TranslateMessage( &msg ); DispatchMessage( &msg ); }

return 0;}

A typical Win32

application

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–110

Page 114: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

LRESULT WINAPI WndProc( HWND hWnd, UINT nMsg, WPARAM wParam, LPARAM lParam ) { HDC dc = NULL; PAINTSTRUCT ps = {0};

switch( nMsg ) { case WM_PAINT:

dc = BeginPaint( hWnd, &ps ); ... EndPaint(hWnd, &ps);

break; ...}}

int WINAPI WinMain( ... ) { HANDLE hConfigFile = CreateFile( "example.config", GENERIC_READ, ... );

WNDCLASS wc = {0, WndProc, 0, 0, ... , "Example_Class"}; RegisterClass( &wc );

HWND hwndMain = CreateWindowEx( 0, "Example_Class", "Example", ... ); UpdateWindow( hwndMain );

MSG msg; while( GetMessage( &msg, NULL, 0, 0 ) ) {

TranslateMessage( &msg ); DispatchMessage( &msg ); }

return 0;}

These Win32 API

functions may fail!

Errorhandling in Legacy Code: Scenario

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–111

Page 115: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Win32 Errorhandling: Goals

➢ Detect failed calls of Win32 API functions by giving after advice for any call to a Win32 function

➢ Throw a helpful exception in case of a failure describing the exact circumstances and reason of the failure

Problem: Win32 failures are indicated by a “magic” return value magic value to compare against depends on the return type of the function

error reason (GetLastError()) only valid in case of a failure

return type magic value

BOOL FALSE

ATOM (ATOM) 0

HANDLE

HWND NULL

INVALID_HANDLE_VALUE or NULL

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–112

Page 116: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Detecting the failure: Generic Advice

advice call(win32API ()) :

after () {

if (isError (*tjp->result()))

// throw an exception

}

advice call(win32API ()) :

after () {

if (isError (*tjp->result()))

// throw an exception

}

bool isError(ATOM);bool isError(ATOM);

bool isError(BOOL);bool isError(BOOL);

bool isError(HANDLE);bool isError(HANDLE);

bool isError(HWND);bool isError(HWND);

...

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–113

Page 117: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Describing the failure: Generative Advice

advice call(win32API ()) : after () {

// throw an exception

ostringstream s;

DWORD code = GetLastError();

s << “WIN32 ERROR ” << code << ...

<< win32::GetErrorText( code ) << ... <<

<< tjp->signature() << “WITH: ” << ...;

ArgPrinter<JoinPoint::ARGS>::work (*tjp, s);

throw win32::Exception( s.str() );

}

advice call(win32API ()) : after () {

// throw an exception

ostringstream s;

DWORD code = GetLastError();

s << “WIN32 ERROR ” << code << ...

<< win32::GetErrorText( code ) << ... <<

<< tjp->signature() << “WITH: ” << ...;

ArgPrinter<JoinPoint::ARGS>::work (*tjp, s);

throw win32::Exception( s.str() );

}

template <int I> struct ArgPrinter {

template <class JP> static void work (JP &tjp, ostream &s) {

ArgPrinter<I–1>::work (tjp, s);

s << “, “ << *tjp. template arg<I-1>();

}

};

template <int I> struct ArgPrinter {

template <class JP> static void work (JP &tjp, ostream &s) {

ArgPrinter<I–1>::work (tjp, s);

s << “, “ << *tjp. template arg<I-1>();

}

};

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–114

Page 118: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Further Examples

Reporting the Error

LRESULT WINAPI WndProc( HWND hWnd, UINT nMsg, WPARAM wParam, LPARAM lParam ) { HDC dc = NULL; PAINTSTRUCT ps = {0};

switch( nMsg ) { case WM_PAINT:

dc = BeginPaint( hWnd, &ps ); ... EndPaint(hWnd, &ps);

break; ...}}

int WINAPI WinMain( ... ) { HANDLE hConfigFile = CreateFile( "example.config", GENERIC_READ, ... );

WNDCLASS wc = {0, WndProc, 0, 0, ... , "Example_Class"}; RegisterClass( &wc );

HWND hwndMain = CreateWindowEx( 0, "Example_Class", "Example", ... ); UpdateWindow( hwndMain );

MSG msg; while( GetMessage( &msg, NULL, 0, 0 ) ) {

TranslateMessage( &msg ); DispatchMessage( &msg ); }

return 0;}

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.2 Tutorial: AspectC++ 3–115

Page 119: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Agenda

3.1 Motivation: Separation of Concerns

3.2 Tutorial: AspectC++

3.3 Summary and Outlook

3.4 References

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.3 Summary and Outlook 3–116

Page 120: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Aspect-Oriented Programming: Summary

AOP aims at a better separation of crosscutting concerns

Avoidance of code tangling7→ implementation of optional featuresAvoidance of code scattering7→ implementation of nonfunctional features

Basic idea: separation of what from where

Join Points 7→ where

positions in the static structure or dynamic control flow (event)

given declaratively by pointcut expressions

Advice 7→ what

additional elements (members, ...) to introduce at join points

additional behavior (code) to superimpose at join points

AspectC++ brings AOP concepts to the C++ world

Static source-to-source transformation approach

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.3 Summary and Outlook 3–117

Page 121: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Aspect-Oriented Programming: Summary

AOP aims at a better separation of crosscutting concerns

Avoidance of code tangling7→ implementation of optional featuresAvoidance of code scattering7→ implementation of nonfunctional features

Basic idea: separation of what from where

Join Points 7→ where

positions in the static structure or dynamic control flow (event)

given declaratively by pointcut expressions

Advice 7→ what

additional elements (members, ...) to introduce at join points

additional behavior (code) to superimpose at join points

AspectC++ brings AOP concepts to the C++ world

Static source-to-source transformation approach

Next Lecture:

How to use AOP to achieve

loose coupling, granularity and

variability for feature implemen-

tations in configurable system

software

; aspect-aware design

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.3 Summary and Outlook 3–117

Page 122: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Referenzen

[1] The British Standards Institute. The C++ Standard (Incorporating TechnicalCorrigendum No. 1). second. Printed version of the ISO/IEC 14882:2003standard. John Wiley & Sons, Inc., 2003. ISBN: 0-470-84674-7.

[2] Gregor Kiczales, John Lamping, Anurag Mendhekar, et al. “Aspect-OrientedProgramming”. In: Proceedings of the 11th European Conference onObject-Oriented Programming (ECOOP ’97). (Finland). Ed. by Mehmet Aksitand Satoshi Matsuoka. Vol. 1241. Lecture Notes in Computer Science.Springer-Verlag, June 1997, pp. 220–242.

[3] Daniel Lohmann, Georg Blaschke, and Olaf Spinczyk. “Generic Advice: On theCombination of AOP with Generative Programming in AspectC++”. In:Proceedings of the 3rd International Conference on Generative Programming andComponent Engineering (GPCE ’04). Ed. by G. Karsai and E. Visser. Vol. 3286.Lecture Notes in Computer Science. Springer-Verlag, Oct. 2004, pp. 55–74.ISBN: 978-3-540-23580-4. DOI: 10.1007/978-3-540-30175-2_4.

[4] Daniel Lohmann, Fabian Scheler, Reinhard Tartler, et al. “A Quantitative Analysisof Aspects in the eCos Kernel”. In: Proceedings of the ACM SIGOPS/EuroSysEuropean Conference on Computer Systems 2006 (EuroSys ’06). (Leuven,Belgium). Ed. by Yolande Berbers and Willy Zwaenepoel. New York, NY, USA:ACM Press, Apr. 2006, pp. 191–204. ISBN: 1-59593-322-0. DOI:10.1145/1218063.1217954.

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.4 References 3–118

Page 123: Konfigurierbare Systemsoftware (KSS) · Konfigurierbare Systemsoftware (KSS) VL 3 – Aspect-Oriented Programming (AOP) Daniel Lohmann Lehrstuhl für Informatik 4 Verteilte Systeme

Referenzen (Cont’d)

[5] Olaf Spinczyk and Daniel Lohmann. “The Design and Implementation ofAspectC++”. In: Knowledge-Based Systems, Special Issue on Techniques toProduce Intelligent Secure Software 20.7 (2007), pp. 636–651. DOI:10.1016/j.knosys.2007.05.004.

[6] Olaf Spinczyk, Daniel Lohmann, and Matthias Urban. “AspectC++: An AOPExtension for C++”. In: Software Developers Journal 5 (May 2005), pp. 68–76.URL: http://www.aspectc.org/fileadmin/publications/sdj-2005-en.pdf.

c© dl KSS (VL 3 | SS 15) 3 AOP | 3.4 References 3–119