Skip to contentSkip to conversation

-freg-struct-return?

PATCH In review Jeremy Fitzhardinge 8 participants 20 messages Feb 22, 2007 – Feb 23, 2007

lore
Share & tools
lore
#0 lore raw

We have a number of functions which return small structures (such as pte_t). It seems that the kernel is not compiled with -freg-struct-return, so all these small structures are being returned via the stack, even though they would fit into registers.

Is there a reason for this? Would -freg-struct-return be preferred? It would make a good compliment to -mregparm.

J

#1 lore raw
Quoted 7 lines · Jeremy Fitzhardinge

We have a number of functions which return small structures (such as pte_t). It seems that the kernel is not compiled with -freg-struct-return, so all these small structures are being returned via the stack, even though they would fit into registers.

Is there a reason for this? Would -freg-struct-return be preferred? It would make a good compliment to -mregparm.

Do we know how many gcc bugs this has? (regparm used to have many) other than that.. sounds like a win...

Signature · 2 lines
if you want to mail me at work (you don't), use arjan (at) linux.intel.com
Test the interaction between Linux and your BIOS via http://www.linuxfirmwarekit.org
#2 lore raw
Quoted 3 lines · Arjan van de Ven

Do we know how many gcc bugs this has? (regparm used to have many) other than that.. sounds like a win...

The documentation suggests that its the preferred mode of operation, and that its the default on platforms where gcc is the primary compiler. So the fact that it isn't for Linux suggests either an oversight or that it is actually broken...

Do we have much assembler which cares about the struct return calling convention? If not, it should be a fairly easy test.

J

#3 lore raw
Quoted 3 lines

Do we have much assembler which cares about the struct return calling convention? If not, it should be a fairly easy test.

is there an attribute to turn it off? because if so we should just make that part of "asmlinkage".... (not that I know much code using structs in asm)

Signature · 2 lines
if you want to mail me at work (you don't), use arjan (at) linux.intel.com
Test the interaction between Linux and your BIOS via http://www.linuxfirmwarekit.org
#4 lore raw
Quoted 8 lines · Arjan van de Ven
Quoted 3 lines

Do we have much assembler which cares about the struct return calling convention? If not, it should be a fairly easy test.

is there an attribute to turn it off? because if so we should just make that part of "asmlinkage".... (not that I know much code using structs in asm)

There doesn't appear to be; just -freg-struct-return and -fpcc-struct-return.

J

#5 lore raw
In reply to Arjan van de Ven
Quoted 6 lines · Arjan van de Ven
Quoted 2 lines

Do we have much assembler which cares about the struct return calling convention? If not, it should be a fairly easy test.

is there an attribute to turn it off? because if so we should just make that part of "asmlinkage".... (not that I know much code using structs in asm)

i dont know of any such code - asmlinkage is 'long' or pointer based.

Ingo

#6 lore raw

PATCH 1/1 x86: add -freg-struct-return to CFLAGS

In reply to Jeremy Fitzhardinge

Subject: [patch] x86: add -freg-struct-return to CFLAGS
From: Ingo Molnar <[email protected]>

Jeremy Fitzhardinge suggested the use of -freg-struct-return, which does structure-returns (such as when using pte_t) in registers instead of on the stack.

that is indeed so, and this option reduced the kernel size a bit:

text data bss dec hex filename

 4799506  543456 3760128 9103090  8ae6f2 vmlinux.before
 4798117  543456 3760128 9101701  8ae185 vmlinux.after

the resulting kernel booted fine on my testbox. Lets go for it.

---
 arch/i386/Makefile |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/i386/Makefile +1 -1
Index: linux/arch/i386/Makefile
===================================================================
@@ -31,7 +31,7 @@ LDFLAGS_vmlinux := --emit-relocs
 endif
 CHECKFLAGS	+= -D__i386__
 
-CFLAGS += -pipe -msoft-float -mregparm=3
+CFLAGS += -pipe -msoft-float -mregparm=3 -freg-struct-return
 
 # prevent gcc from keeping the stack 16 byte aligned
 CFLAGS += $(call cc-option,-mpreferred-stack-boundary=2)
#11 lore raw
In reply to Jeremy Fitzhardinge
Quoted 9 lines · Jeremy Fitzhardinge
Quoted 3 lines · Arjan van de Ven

Do we know how many gcc bugs this has? (regparm used to have many) other than that.. sounds like a win...

The documentation suggests that its the preferred mode of operation, and that its the default on platforms where gcc is the primary compiler. So the fact that it isn't for Linux suggests either an oversight or that it is actually broken...

It is used for Linux on many architectures (x86_64, sparc64, ia64, ppc{,64}, arm, sh, m68k to name just a few), but it is an ABI decision, so e.g. on i386 is not used by default as the ABI mandates structs/unions are returned in memory.

Jakub

#12 lore raw
In reply to Jeremy Fitzhardinge
Quoted 5 lines · Jeremy Fitzhardinge
Quoted 3 lines · Arjan van de Ven

Do we know how many gcc bugs this has? (regparm used to have many) other than that.. sounds like a win...

Quoted 7 lines

The documentation suggests that its the preferred mode of operation, and that its the default on platforms where gcc is the primary compiler. So the fact that it isn't for Linux suggests either an oversight or that it is actually broken...

Do we have much assembler which cares about the struct return calling convention? If not, it should be a fairly easy test.

I didn't think we had any that returned structures.

-Andi

#7 lore raw

Re: [patch] x86: add -freg-struct-return to CFLAGS

In reply to Ingo Molnar
Quoted 7 lines · Ingo Molnar

Subject: [patch] x86: add -freg-struct-return to CFLAGS
From: Ingo Molnar <[email protected]>

Jeremy Fitzhardinge suggested the use of -freg-struct-return, which does structure-returns (such as when using pte_t) in registers instead of on the stack.

Quoted 7 lines

that is indeed so, and this option reduced the kernel size a bit:

text data bss dec hex filename

 4799506  543456 3760128 9103090  8ae6f2 vmlinux.before
 4798117  543456 3760128 9101701  8ae185 vmlinux.after

the resulting kernel booted fine on my testbox. Lets go for it.

Ok I added it for now. Let's see what happens.

I guess people maintaining external Makefiles without Kbuild are in for a nasty surprise again though. Cannot be avoided unfortunately.

-Andi

#8 lore raw

Re: [patch] x86: add -freg-struct-return to CFLAGS

Quoted 3 lines

I guess people maintaining external Makefiles without Kbuild are in for a nasty surprise again though.

that 1) shouldn't be needed at all for 2.6 and 2) is fragile as heck no matter, I don't think anyone still is doing that... I sure hope that if anyone still does it that they have no users at all, for the sake of the users :)

Signature · 2 lines
if you want to mail me at work (you don't), use arjan (at) linux.intel.com
Test the interaction between Linux and your BIOS via http://www.linuxfirmwarekit.org
#13 lore raw
In reply to Andi Kleen
Quoted 3 lines · Andi Kleen

I didn't think we had any that returned structures.

Sometimes returning small structures is really nice. If you can pass them in registers, it's often generates the fastest possible code; much better than using a pointer.

-hpa

#14 lore raw
Quoted 3 lines · H. Peter Anvin

Sometimes returning small structures is really nice. If you can pass them in registers, it's often generates the fastest possible code; much better than using a pointer.

Yes, but specifically, are there any pieces of assembler which return structures? It appears there are none (since Ingo got a booting kernel), but there might be something obscure in some corner.

J

#9 lore raw

Re: [patch] x86: add -freg-struct-return to CFLAGS

In reply to Ingo Molnar

arch/i386/Makefile LDFLAGS_vmlinux := --emit-relocs · line 37

Quoted 12 lines · Ingo Molnar

...

arch/i386/Makefile +1 -1
@@ -31,7 +31,7 @@ LDFLAGS_vmlinux := --emit-relocs
 endif
 CHECKFLAGS	+= -D__i386__
 
-CFLAGS += -pipe -msoft-float -mregparm=3
+CFLAGS += -pipe -msoft-float -mregparm=3 -freg-struct-return
 
 # prevent gcc from keeping the stack 16 byte aligned
 CFLAGS += $(call cc-option,-mpreferred-stack-boundary=2)

Why is this i386 specific?

cu
Adrian

Signature · 4 lines
       "Is there not promise of rain?" Ling Tan asked suddenly out
        of the darkness. There had been need of rain for many days.
       "Only a promise," Lao Er said.
                                       Pearl S. Buck - Dragon Seed
#15 lore raw
In reply to Jeremy Fitzhardinge
Quoted 8 lines · Jeremy Fitzhardinge
Quoted 3 lines · H. Peter Anvin

Sometimes returning small structures is really nice. If you can pass them in registers, it's often generates the fastest possible code; much better than using a pointer.

Yes, but specifically, are there any pieces of assembler which return structures? It appears there are none (since Ingo got a booting kernel), but there might be something obscure in some corner.

When I did the x86-64 port I went over all assembler and I can't remember anything that did that. Of course there might be out of tree drivers that do, but they just have to fix it up.

BTW would it make sense to have a special announcement list for such changes?

-Andi

#16 lore raw
Quoted 9 lines · Andi Kleen
Quoted 7 lines · Jeremy Fitzhardinge
Quoted 3 lines · H. Peter Anvin

Sometimes returning small structures is really nice. If you can pass them in registers, it's often generates the fastest possible code; much better than using a pointer.

Yes, but specifically, are there any pieces of assembler which return structures? It appears there are none (since Ingo got a booting kernel), but there might be something obscure in some corner.

Quoted 6 lines

When I did the x86-64 port I went over all assembler and I can't remember anything that did that. Of course there might be out of tree drivers that do, but they just have to fix it up.

BTW would it make sense to have a special announcement list for such changes?

To some degree linux-arch would be a good list for it, but it's closed, even to monitor.

-hpa

#18 lore raw
In reply to Andi Kleen
Quoted 2 lines · Andi Kleen

BTW would it make sense to have a special announcement list for such changes?

A changelog in the kernel tree would be helpful. A real changelog that is, not that info blob located at /Documentation/Changes.

Jan

#19 lore raw
Quoted 6 lines · Jan Engelhardt
Quoted 1 line · Andi Kleen

BTW would it make sense to have a special announcement list for such changes?

A changelog in the kernel tree would be helpful. A real changelog that is, not that info blob located at /Documentation/Changes.

I presume you're talking about a BSD-style ChangeLog. I've always found those utterly useless, since they're basically the equivalent of SCM history but without any of the abilities to sort, filter, etc, thus making it utterly impossible to find anything. They're a pain to maintain (they inherently *always* cause merge failures) and add very little.

-hpa

#10 lore raw

Re: [patch] x86: add -freg-struct-return to CFLAGS

In reply to Adrian Bunk
Quoted 8 lines · Adrian Bunk
Quoted 7 lines · Ingo Molnar

...

arch/i386/Makefile +0 -0
@@ -31,7 +31,7 @@ LDFLAGS_vmlinux := --emit-relocs
 endif
 CHECKFLAGS	+= -D__i386__
 
Quoted 8 lines

arch/i386/Makefile LDFLAGS_vmlinux := --emit-relocs · line 37

Quoted 5 lines
arch/i386/Makefile +1 -1
-CFLAGS += -pipe -msoft-float -mregparm=3
+CFLAGS += -pipe -msoft-float -mregparm=3 -freg-struct-return
 
 # prevent gcc from keeping the stack 16 byte aligned
 CFLAGS += $(call cc-option,-mpreferred-stack-boundary=2)

Why is this i386 specific?

Because virtually all other architectures have it as their ABI default, anyway, and ABI selection should be per architecture.

-hpa

#17 lore raw
In reply to H. Peter Anvin
Quoted 2 lines

To some degree linux-arch would be a good list for it, but it's closed, even to monitor.

linux-arch is only for architecture code, but yes it serves a similar purpose. But it's very specialized. What is discussed there is unlikely to be of much interest to most people.

I was thinking of a relatively low volume list where quick notes for any general interfaces changes that likely needs adaptions in a wide range of code could be sent. Then even people who cannot follow l-k or git due to volume could subscribe to that and adapt their code as needed.

-Andi