Skip to contentSkip to conversation

document alignment and byteorder macros

PATCH In review Ed L Cashin 2 participants 2 messages Sep 19, 2005

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 document alignment and byteorder macros

Quoted 17 lines · David S. Miller

From: Ed L Cashin <[email protected]>
Date: Mon, 19 Sep 2005 10:24:00 -0400

Quoted 7 lines

1) Passing le64_to_cpup an unaligned pointer is "OK" and within the intended use of the function. I'm having trouble finding whether this is documented somewhere.

2) These new changes to the sparc64 unaligned access fault handling will make it OK to leave the aoe driver the way it is in the mainline kernel.

Both #1 and #2 are true.

Although it's very much discouraged to dereference unaligned pointers, especially in performance critical code (which this AOE case is not, thankfully), because performance will be really bad as the trap handler has to fix up the access on RISC platforms.

Quoted 6 lines · Roland Dreier

David> Although it's very much discouraged to dereference David> unaligned pointers, especially in performance critical code David> (which this AOE case is not, thankfully), because David> performance will be really bad as the trap handler has to David> fix up the access on RISC platforms.

Quoted 6 lines

Also, ia64 has a tendency to print an ugly message in the kernel log for unaligned accesses. Has anyone tried AoE on ia64?

It might be better to change the AoE code to use get_unaligned(), just to document what's going on. Although clearly the sparc64 patch is correct as well -- we should never silently return the wrong data.

This patch comments the fact that although passing le64_to_cpup et al. is within the intended use of the byteorder macros, using get_unaligned is the recommended way to go.

Please speak up if there's a better place for this documentation to go or a better way to say it.

document alignment and byteorder macros

include/linux/byteorder/generic.h +4 -0
Index: linux-2.6.13/include/linux/byteorder/generic.h
===================================================================
@@ -5,6 +5,10 @@
  * linux/byteorder_generic.h
  * Generic Byte-reordering support
  *
+ * The "... p" macros, like le64_to_cpup, can be used with pointers
+ * to unaligned data, but there will be a performance penalty on 
+ * some architectures.  Use get_unaligned for unaligned data.
+ *
  * Francois-Rene Rideau <[email protected]> 19970707
  *    gathered all the good ideas from all asm-foo/byteorder.h into one file,
  *    cleaned them up.
Signature · 2 lines
-- 
  Ed L Cashin <[email protected]>
#1 lore raw

From: Ed L Cashin <[email protected]>
Date: Mon, 19 Sep 2005 15:22:01 -0400

Quoted 11 lines

This patch comments the fact that although passing le64_to_cpup et al. is within the intended use of the byteorder macros, using get_unaligned is the recommended way to go.

Please speak up if there's a better place for this documentation to go or a better way to say it.

document alignment and byteorder macros

I think this is fine, I'll merge this in with my sparc64 fix when I send that upstream.

Please merge the AOE change to use get_unaligned() when you get a chance.

Thanks a lot.