PortingNotes modified by Joseph Koshy

Joseph Koshy — Sat, 28 Dec 2013 17:44:28 -0000

--- v1
+++ v2
@@ -12,7 +12,7 @@
   * [FreeBSD](http://www.freebsd.org/) and [DragonFlyBSD](http://www.dragonflybsd.org/) have a related rule set called `bsd.incs.mk` which is not compatible with `bsd.inc.mk`. 
   * The rule set is missing entirely in [OpenBSD](http://www.openbsd.org/).

-We use a wrapper [source:trunk/mk/elftoolchain.inc.mk](/apps/trac/elftoolchain/browser/trunk/mk/elftoolchain.inc.mk), to work around these differences. 
+We use a wrapper [trunk/mk/elftoolchain.inc.mk](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/mk/elftoolchain.inc.mk), to work around these differences. 

 ## Char Signedness

@@ -24,11 +24,11 @@

 ## mktemp(1)

-  * On Ubuntu 10.04, `mktemp` has a bug ([589408](https://bugs.launchpad.net/ubuntu/+source/coreutils/+bug/589408)) that affects [source:trunk/common/native-elf-format](/apps/trac/elftoolchain/browser/trunk/common/native-elf-format). Changeset [[1124]](/apps/trac/elftoolchain/changeset/1124) has a work-around. 
+  * On Ubuntu 10.04, `mktemp` has a bug ([589408](https://bugs.launchpad.net/ubuntu/+source/coreutils/+bug/589408)) that affects [trunk/common/native-elf-format](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/common/native-elf-format). Changeset [r1124] has a work-around. 

 ## mmap(2)

-  * Some systems (such as [Minix3](http://www.minix3.org/), a BSD-licensed microkernel) do not implement the `mmap()` API. We fall back to a combination of `read()`/`write()` for this case. See: ticket [#366](/apps/trac/elftoolchain/ticket/366). 
+  * Some systems (such as [Minix3](http://www.minix3.org/), a BSD-licensed microkernel) do not implement the `mmap()` API. We fall back to a combination of `read()`/`write()` for this case. See: ticket [#366]. 

 ## strmode(3)

@@ -37,8 +37,8 @@

 ## Variances in ELF Types

-  * On 64-bit platforms, NetBSD 5 defines the `Elf64_Half` type as being [4 bytes wide](http://fxr.watson.org/fxr/source/sys/exec_elf.h?v=NETBSD5#L96). This is at variance with the [ELF ABI definition for 64-bit platforms](http://www.sco.com/developers/gabi/latest/ch4.intro.html#data_representation), and breaks assumptions in our [libelf](/apps/trac/elftoolchain/browser/trunk/libelf) library about structure layout. On 64-bit platforms, NetBSD 5 defines a (non-standard) [Elf64_Quarter](http://fxr.watson.org/fxr/source/sys/exec_elf.h?v=NETBSD5#L98) type that is 2 bytes wide. Reducing our reliance on system headers (see [#265](/apps/trac/elftoolchain/ticket/265)) could be a possible solution to deal with such issues. 
+  * On 64-bit platforms, NetBSD 5 defines the `Elf64_Half` type as being [4 bytes wide](http://fxr.watson.org/fxr/source/sys/exec_elf.h?v=NETBSD5#L96). This is at variance with the [ELF ABI definition for 64-bit platforms](http://www.sco.com/developers/gabi/latest/ch4.intro.html#data_representation), and breaks assumptions in our [libelf](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/libelf) library about structure layout. On 64-bit platforms, NetBSD 5 defines a (non-standard) [Elf64_Quarter](http://fxr.watson.org/fxr/source/sys/exec_elf.h?v=NETBSD5#L98) type that is 2 bytes wide. Reducing our reliance on system headers (see [#265]) could be a possible solution to deal with such issues. 

 ## Yacc

-  * NetBSD's default rules for handling YACC input uses the `-o` option. This causes the generated header file to have a different name than the standard "y.tab.h". See [[999]](/apps/trac/elftoolchain/changeset/999) for the current solution to this issue. 
+  * NetBSD's default rules for handling YACC input uses the `-o` option. This causes the generated header file to have a different name than the standard "y.tab.h". See [r999] for the current solution to this issue.

PortingNotes modified by Joseph Koshy

Joseph Koshy — Wed, 25 Dec 2013 07:30:47 -0000

Porting Notes

Porting Notes

This wiki page documents various issues encountered while keeping our code base portable.

bsd.inc.mk

This make ruleset handles include files. It is not present in all the operating systems we are interested in.

The file is named bsd.inc.mk in NetBSD and in the pmake package in Ubuntu GNU/Linux.
FreeBSD and DragonFlyBSD have a related rule set called bsd.incs.mk which is not compatible with bsd.inc.mk.
The rule set is missing entirely in OpenBSD.

We use a wrapper source:trunk/mk/elftoolchain.inc.mk, to work around these differences.

Char Signedness

NetBSD/i386 uses signed characters. FreeBSD and Ubuntu GNU/Linux use unsigned characters. Code needs to be written to explicitly mention the desired signedness of char sized values.

isdigit(3)

On NetBSD 5, isdigit(3) is a macro that expands inline to an array access. The compiler will warn if a char sized quantity is passed in as a parameter to isdigit().

mktemp(1)

On Ubuntu 10.04, mktemp has a bug (589408) that affects source:trunk/common/native-elf-format. Changeset [[1124]](/apps/trac/elftoolchain/changeset/1124) has a work-around.

mmap(2)

Some systems (such as Minix3, a BSD-licensed microkernel) do not implement the mmap() API. We fall back to a combination of read()/write() for this case. See: ticket #366.

strmode(3)

On NetBSD the prototype for this BSD function is present in <unistd.h>.
FreeBSD places the prototype in <string.h>

Variances in ELF Types

On 64-bit platforms, NetBSD 5 defines the Elf64_Half type as being 4 bytes wide. This is at variance with the ELF ABI definition for 64-bit platforms, and breaks assumptions in our libelf library about structure layout. On 64-bit platforms, NetBSD 5 defines a (non-standard) Elf64_Quarter type that is 2 bytes wide. Reducing our reliance on system headers (see #265) could be a possible solution to deal with such issues.

Yacc

NetBSD's default rules for handling YACC input uses the -o option. This causes the generated header file to have a different name than the standard "y.tab.h". See [[999]](/apps/trac/elftoolchain/changeset/999) for the current solution to this issue.

Recent changes to PortingNotes

PortingNotes modified by Joseph Koshy

PortingNotes modified by Joseph Koshy

Porting Notes

bsd.inc.mk

Char Signedness

isdigit(3)

mktemp(1)

mmap(2)

strmode(3)

Variances in ELF Types

Yacc