LINX Files

README

Enea MCAPI Compatibility Library for LINX

1. Introduction
2. Licenses
3. Description and Main Features
4. Contacts
5. Build instructions
6. Trademarks


1. Introduction

MCAPI is a specification published by the Multicore Association that
provides an API and a semantic for communication and synchronization
in distributed embedded systems. It is intended to provide source-code
compatibility, so that applications can easily be ported from one
operating environment to another. 

Enea LINX is an open technology for distributed system interprocess
communication which is platform and interconnect independent, scales
well to large systems with any topology, but that still has the
performance needed for high traffic bearing components of the
system.


2. Licenses

The Enea MCAPI Compatibility Library for LINX source code is released
under a BSD licence.


3. Description and Main Features

The Enea MCAPI Compatibility Library for LINX provides the MCAPI
API for messaging on top of the Enea LINX message passing API,
enabling MCAPI communication using the LINX protocol stack.

The MCAPI node concept is mapped to a Linux process, which means an
MCAPI node may be multi-threaded. Multiple MCAPI nodes may exist in
the same Linux OS instance (LINX node).

The application programmer must make sure that the same MCAPI node
IDs are not used on multiple OS instances. MCAPI node IDs shall be
assigned in the range 0 to MAX_NUM_NODES as defined in mcapi_config.h.

When the system spans multiple OS instances, MCAPI to LINX address
translation must be provided in /etc/mcapi_addr.conf. This file maps
remote MCAPI domain and node ID pairs to the corresponding LINX links
to reach the OS instance. The library uses these mappings when searching
for an MCAPI endpoint (as a result of MCAPI get or get_i operations).
For example, the entry "0:1 link" means that any MCAPI endpoint with
domain ID 0 and node ID 1 is located on the other side of the LINX link
called "link". If no matching entry is found in the address translation
file, the MCAPI endpoint is assumed to be located on the local OS instance.
See mcapi_addr.conf.example for more information.

The Enea MCAPI Compatibility Library requires pthread support.


4. Contacts

www.enea.com

linx@enea.com


5. Build instructions

See the LINX documentation for information on how to build, install
and configure LINX.

Untar the MCAPI for LINX archive in the top level LINX directory:
$ cd /path/to/linx
$ tar xzf linx-mcapi-1.0.0.tar.gz

Go to the MCAPI directory and build the library and example:
$ cd /path/to/linx/linx-mcapi-1.0.0
$ ./configure
$ make


6. Trademarks

LINX is a registered trademark of Enea Software AB.
MCAPI is a registered trademark of the Multicore Association.
Linux is a registered trademark of Linus Torvalds.
All other trademarks, trade names or copyrights used in files in the
Enea MCAPI Compatibility Library for LINX distribution are the property
of their respective owners and are used for identification purposes only.