[patch 00/03] kbuild, asm-values: not only offsets, not only for $ARCH

[patch 00/03] kbuild, asm-values: not only offsets, not only for $ARCH

[Oleg Verych]

 Version number zer0.
--
-o--=O`C
 #oo'L O
<___=E M

[patch 01/03] kbuild, asm-values: infrastructure

[Oleg Verych]

[-- Attachment #1: kbuild-asm-values-infrastructure.patch --]
[-- Type: text/plain, Size: 3954 bytes --]

	* header with widely used value definitions
	* handle all asm-related things in one file (Makefile.asm)
	* move some asm bits from Makefile.build there
	  (rule %.s:%.c)
	* add script to generate headers from assembles output
	  (hopefully better output, MIPS testing/joining to all arch
	   probably needed)

rfc-by: Oleg Verych
---
 See next patches, to know how to use it

 include/asm-generic/asm-values.h |    7 ++++
 scripts/Makefile.asm             |   26 ++++++++++++++++++
 scripts/Makefile.build           |    6 ----
 scripts/mkasm-values.sh          |   55 +++++++++++++++++++++++++++++++++++++
 4 files changed, 88 insertions(+), 6 deletions(-)

Index: linux-2.6.22-rc4-mm2/scripts/Makefile.asm
===================================================================
--- /dev/null	1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6.22-rc4-mm2/scripts/Makefile.asm	2007-06-12 23:43:41.070624500 +0200
@@ -0,0 +1,26 @@
+#
+# Help generate definitions needed by assembly language modules.
+#
+ifndef asm-values_h
+    asm-values := $(shell test -e $(srctree)/$(src)/asm-values.c && echo ok)
+    ifneq ($(asm-values),)
+	asm-values_h := asm-values.h
+	asm-values   := asm-values.s
+    endif
+endif
+
+always		+= $(asm-values_h)
+targets		+= $(asm-values_h) $(asm-values)
+mkasm-values	:= $(srctree)/scripts/mkasm-values.sh
+
+quiet_cmd_mkasm-values = GEN     $@
+      cmd_mkasm-values = $(CONFIG_SHELL) $(mkasm-values) $< $@ $(2)
+
+quiet_cmd_cc_s_c = CC $(quiet_modtag)  $@
+      cmd_cc_s_c = $(CC) $(c_flags) -fverbose-asm -S -o $@ $<
+
+$(obj)/asm-values.h: $(obj)/asm-values.s
+	$(call cmd,mkasm-values,$(ASM_NS))
+
+$(obj)/%.s: $(src)/%.c FORCE
+	$(call if_changed_dep,cc_s_c)
Index: linux-2.6.22-rc4-mm2/scripts/Makefile.build
===================================================================
--- linux-2.6.22-rc4-mm2.orig/scripts/Makefile.build	2007-06-13 00:45:54.195930250 +0200
+++ linux-2.6.22-rc4-mm2/scripts/Makefile.build	2007-06-12 22:10:31.481297000 +0200
@@ -145,10 +145,4 @@ $(multi-objs-y:.o=.s)   : modname = $(mo
 $(multi-objs-y:.o=.lst) : modname = $(modname-multi)
 
-quiet_cmd_cc_s_c = CC $(quiet_modtag)  $@
-cmd_cc_s_c       = $(CC) $(c_flags) -fverbose-asm -S -o $@ $<
-
-$(obj)/%.s: $(src)/%.c FORCE
-	$(call if_changed_dep,cc_s_c)
-
 quiet_cmd_cc_i_c = CPP $(quiet_modtag) $@
 cmd_cc_i_c       = $(CPP) $(c_flags)   -o $@ $<
Index: linux-2.6.22-rc4-mm2/scripts/mkasm-values.sh
===================================================================
--- /dev/null	1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6.22-rc4-mm2/scripts/mkasm-values.sh	2007-06-12 21:49:05.096903000 +0200
@@ -0,0 +1,55 @@
+#!/bin/sh
+
+# Input file "*.s", made by Kbuild from a "*.c" source, where values of
+# interest are calculated, is processed in a suitable output header file.
+#
+# $1 - input filename;
+# $2 - output filename;
+# $3 - generate (private) file with given namespace (optional)
+
+set -e
+
+[ -z "$1" ] || [ -z "$2" ] && {
+	echo "$0:
+
+Two parameters needed. Exiting.
+"
+	exit 1
+}
+
+NS=`echo $3 | tr a-z A-Z`
+case $NS in
+	MIPS)
+SED_SCRIPT='
+/^@@@/{
+s|^@@@||;
+s| #.*$||;
+p;
+}'	;;
+	*)
+TAB="`printf '\t'`"
+SED_SCRIPT="
+/^->/{
+s|^->||;
+s|^\([^ ]*\) [\$#]*\([^ ]*\) \([^$TAB]*\).*|#define \1 \2$TAB/* \3 */|;
+p;
+}"	;;
+esac
+
+NS=__ASM_VALUES_${NS:=H}__
+
+exec 1>$2
+echo "\
+#if !defined($NS)
+#define $NS
+
+/*
+ * $2
+ * was generated from
+ * $1
+ */
+"
+sed -ne "$SED_SCRIPT" $1
+
+echo "
+#endif"
Index: linux-2.6.22-rc4-mm2/include/asm-generic/asm-values.h
===================================================================
--- /dev/null	1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6.22-rc4-mm2/include/asm-generic/asm-values.h	2007-06-12 23:33:34.176696000 +0200
@@ -0,0 +1,7 @@
+#define DEFINE(sym, val) \
+	asm volatile("\n->" #sym " %0 " #val : : "i" (val))
+
+#define BLANK() asm volatile("\n->" : : )
+
+#define OFFSET(sym, str, mem) \
+	DEFINE(sym, offsetof(struct str, mem));

--

[patch 02/03] kbuild, asm-values: successor of asm-offsets

[Oleg Verych]

[-- Attachment #1: kbuild-asm-values-successor-of-asm-offsets.patch --]
[-- Type: text/plain, Size: 3035 bytes --]

	Some asm-offsets files define not only offsets, thus make it clear.
	Legacy files are supported, but may be freely changed to new scheme.

rfc-by: Oleg Verych
---
 If somebody agrees, of course.

 Kbuild |   68 ++++++++++++++++++++-------------------------------------------
 1 file changed, 24 insertions(+), 44 deletions(-)

Index: linux-2.6.22-rc4-mm2/Kbuild
===================================================================
--- linux-2.6.22-rc4-mm2.orig/Kbuild	2007-06-13 01:25:27.696264750 +0200
+++ linux-2.6.22-rc4-mm2/Kbuild	2007-06-13 01:28:10.306427250 +0200
@@ -1,60 +1,40 @@
 #
-# Kbuild for top-level directory of the kernel
-# This file takes care of the following:
-# 1) Generate asm-offsets.h
-# 2) Check for missing system calls
-
-#####
-# 1) Generate asm-offsets.h
+# Kbuild for top-level directory of the Linux
 #
+# 1) Generate (if needed) asm-values.h (former asm-offsets) for ARCH
+# 2) Check for missing system calls
 
-offsets-file := include/asm-$(ARCH)/asm-offsets.h
+####
+# 1)
 
-always  := $(offsets-file)
-targets := $(offsets-file)
-targets += arch/$(ARCH)/kernel/asm-offsets.s
-clean-files := $(addprefix $(objtree)/,$(targets))
-
-# Default sed regexp - multiline due to syntax constraints
-define sed-y
-	"/^->/{s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; s:->::; p;}"
-endef
-# Override default regexp for specific architectures
-sed-$(CONFIG_MIPS) := "/^@@@/{s/^@@@//; s/ \#.*\$$//; p;}"
-
-quiet_cmd_offsets = GEN     $@
-define cmd_offsets
-	(set -e; \
-	 echo "#ifndef __ASM_OFFSETS_H__"; \
-	 echo "#define __ASM_OFFSETS_H__"; \
-	 echo "/*"; \
-	 echo " * DO NOT MODIFY."; \
-	 echo " *"; \
-	 echo " * This file was generated by Kbuild"; \
-	 echo " *"; \
-	 echo " */"; \
-	 echo ""; \
-	 sed -ne $(sed-y) $<; \
-	 echo ""; \
-	 echo "#endif" ) > $@
-endef
+# legacy asm-offsets support (FIXME: convert all archs and remove this)
+old = $(shell test -e $(srctree)/arch/$(ARCH)/kernel/asm-offsets.c && echo yes)
+ifeq ($(old),yes)
+    asm-values	=asm-offsets
+else
+    asm-values	=asm-values
+endif
+asm-values_c	:= $(src)/arch/$(ARCH)/kernel/$(asm-values).c
+asm-values_h	:= $(obj)/include/asm-$(ARCH)/$(asm-values).h
+asm-values	:= $(obj)/arch/$(ARCH)/kernel/$(asm-values).s
+include $(srctree)/scripts/Makefile.asm
 
-# We use internal kbuild rules to avoid the "is up to date" message from make
-arch/$(ARCH)/kernel/asm-offsets.s: arch/$(ARCH)/kernel/asm-offsets.c FORCE
+$(asm-values): $(asm-values_c) FORCE
 	$(Q)mkdir -p $(dir $@)
 	$(call if_changed_dep,cc_s_c)
 
-$(obj)/$(offsets-file): arch/$(ARCH)/kernel/asm-offsets.s Kbuild
+$(asm-values_h): $(asm-values) Kbuild
 	$(Q)mkdir -p $(dir $@)
-	$(call cmd,offsets)
+	$(call cmd,mkasm-values,$(ARCH))
 
-#####
-# 2) Check for missing system calls
-#
+####
+# 2)
 
 quiet_cmd_syscalls = CALL    $<
       cmd_syscalls = $(CONFIG_SHELL) $< $(CC) $(c_flags)
 
-PHONY += missing-syscalls
 missing-syscalls: scripts/checksyscalls.sh FORCE
 	$(call cmd,syscalls)
+
+PHONY += missing-syscalls
+.PHONY: $(PHONY)

--

[patch 03/03] kbuild, asm-values: private for lguest

[Oleg Verych]

[-- Attachment #1: kbuild-asm-values-lguest-private.patch --]
[-- Type: text/plain, Size: 2016 bytes --]

	A small example of how it can be used privately.

rfc-by: Oleg Verych
---
 TODO: change lguest files to use it.

 drivers/lguest/Makefile     |    4 ++++
 drivers/lguest/asm-values.c |   24 ++++++++++++++++++++++++
 2 files changed, 28 insertions(+)

Index: linux-2.6.22-rc4-mm2/drivers/lguest/Makefile
===================================================================
--- linux-2.6.22-rc4-mm2.orig/drivers/lguest/Makefile	2007-06-13 01:25:17.931654500 +0200
+++ linux-2.6.22-rc4-mm2/drivers/lguest/Makefile	2007-06-13 01:29:01.337616500 +0200
@@ -1,2 +1,6 @@
+# Generate private asm-values.h
+ASM_NS = LGUEST
+include $(srctree)/scripts/Makefile.asm
+
 # Guest requires the paravirt_ops replacement and the bus driver.
 obj-$(CONFIG_LGUEST_GUEST) += lguest.o lguest_asm.o lguest_bus.o
Index: linux-2.6.22-rc4-mm2/drivers/lguest/asm-values.c
===================================================================
--- /dev/null	1970-01-01 00:00:00.000000000 +0000
+++ linux-2.6.22-rc4-mm2/drivers/lguest/asm-values.c	2007-06-13 01:29:01.337616500 +0200
@@ -0,0 +1,24 @@
+/*
+ * Private definitions needed by lguest's assembly language modules.
+ */
+
+#include <linux/lguest.h>
+#include "lg.h"
+#include <asm-generic/asm-values.h>
+
+void fell_guest(void);
+
+void fell_guest(void)
+{
+	OFFSET(LGUEST_DATA_irq_enabled, lguest_data, irq_enabled);
+	OFFSET(LGUEST_PAGES_host_gdt_desc, lguest_pages, state.host_gdt_desc);
+	OFFSET(LGUEST_PAGES_host_idt_desc, lguest_pages, state.host_idt_desc);
+	OFFSET(LGUEST_PAGES_host_cr3, lguest_pages, state.host_cr3);
+	OFFSET(LGUEST_PAGES_host_sp, lguest_pages, state.host_sp);
+	OFFSET(LGUEST_PAGES_guest_gdt_desc, lguest_pages,state.guest_gdt_desc);
+	OFFSET(LGUEST_PAGES_guest_idt_desc, lguest_pages,state.guest_idt_desc);
+	OFFSET(LGUEST_PAGES_guest_gdt, lguest_pages, state.guest_gdt);
+	OFFSET(LGUEST_PAGES_regs_trapnum, lguest_pages, regs.trapnum);
+	OFFSET(LGUEST_PAGES_regs_errcode, lguest_pages, regs.errcode);
+	OFFSET(LGUEST_PAGES_regs, lguest_pages, regs);
+}

--

Removing of dummy asm-offset files (Re: [patch 02/03] kbuild, asm-values: successor of asm-offsets)

[Oleg Verych]

[]
> +# legacy asm-offsets support (FIXME: convert all archs and remove this)
> +old = $(shell test -e $(srctree)/arch/$(ARCH)/kernel/asm-offsets.c && echo yes)
> +ifeq ($(old),yes)
> +    asm-values	=asm-offsets
> +else
> +    asm-values	=asm-values

One more test here, and files like
|-*-
olecom@flower:/mnt/work/pc/kernel.org/linux-2.6.22-rc4-mm2$ <
arch/sparc64/kernel/asm-offsets.c dd
/* Dummy asm-offsets.c file. Required by kbuild and ready to be used - hint! */
|-*-
can be removed.
____

Re: [patch 01/03] kbuild, asm-values: infrastructure

[Oleg Verych]

Jun 13, 2007 at 01:36:51AM +0200, asm-values patch set:
> 	* header with widely used value definitions
> 	* handle all asm-related things in one file (Makefile.asm)
> 	* move some asm bits from Makefile.build there
> 	  (rule %.s:%.c)
> 	* add script to generate headers from assembles output
> 	  (hopefully better output, MIPS testing/joining to all arch
> 	   probably needed)
> 
> rfc-by: Oleg Verych
> ---

So, is it another not so juicy lets-break-it-all stuff from me, or it just
doesn't apply for you?

I thought update all that asm-offsets stuff just like that. I want to
know, why it does not fit.

Thanks.
____

Re: [patch 01/03] kbuild, asm-values: infrastructure

[Sam Ravnborg]

On Thu, Jun 14, 2007 at 09:41:43AM +0200, Oleg Verych wrote:
> Jun 13, 2007 at 01:36:51AM +0200, asm-values patch set:
> > 	* header with widely used value definitions
> > 	* handle all asm-related things in one file (Makefile.asm)
> > 	* move some asm bits from Makefile.build there
> > 	  (rule %.s:%.c)
> > 	* add script to generate headers from assembles output
> > 	  (hopefully better output, MIPS testing/joining to all arch
> > 	   probably needed)
> > 
> > rfc-by: Oleg Verych
> > ---
> 
> So, is it another not so juicy lets-break-it-all stuff from me, or it just
> doesn't apply for you?

I have not yet looked at it. A few other items pending that I need to finish
off before next merge window has priority.

	Sam

Need opinions on asm-offsets cleanup (Re: [patch 01/03] kbuild, asm-values: infrastructure)

[Oleg Verych]

On Thu, Jun 14, 2007 at 11:12:25AM +0200, Sam Ravnborg wrote:
> On Thu, Jun 14, 2007 at 09:41:43AM +0200, Oleg Verych wrote:
> > Jun 13, 2007 at 01:36:51AM +0200, asm-values patch set:
> > > 	* header with widely used value definitions
> > > 	* handle all asm-related things in one file (Makefile.asm)
> > > 	* move some asm bits from Makefile.build there
> > > 	  (rule %.s:%.c)
> > > 	* add script to generate headers from assembles output
> > > 	  (hopefully better output, MIPS testing/joining to all arch
> > > 	   probably needed)
> > > 
> > > rfc-by: Oleg Verych
> > > ---
> > 
> > So, is it another not so juicy lets-break-it-all stuff from me, or it just
> > doesn't apply for you?
> 
> I have not yet looked at it. A few other items pending that I need to finish
> off before next merge window has priority.
 
That's my view about asm-offsets cleanup/generalizing. I just need ack or
nack from, for example arch maintainers if this is acceptable at all or
anybody, actually interested in this kind of things. Not cool stuff, but
still quite straight and easy to finish and merge.
____

Re: Need opinions on asm-offsets cleanup (Re: [patch 01/03] kbuild, asm-values: infrastructure)

[Sam Ravnborg]

On Thu, Jun 14, 2007 at 01:16:21PM +0200, Oleg Verych wrote:
> On Thu, Jun 14, 2007 at 11:12:25AM +0200, Sam Ravnborg wrote:
> > On Thu, Jun 14, 2007 at 09:41:43AM +0200, Oleg Verych wrote:
> > > Jun 13, 2007 at 01:36:51AM +0200, asm-values patch set:
> > > > 	* header with widely used value definitions
> > > > 	* handle all asm-related things in one file (Makefile.asm)
> > > > 	* move some asm bits from Makefile.build there
> > > > 	  (rule %.s:%.c)
> > > > 	* add script to generate headers from assembles output
> > > > 	  (hopefully better output, MIPS testing/joining to all arch
> > > > 	   probably needed)
> > > > 
> > > > rfc-by: Oleg Verych
> > > > ---
> > > 
> > > So, is it another not so juicy lets-break-it-all stuff from me, or it just
> > > doesn't apply for you?
> > 
> > I have not yet looked at it. A few other items pending that I need to finish
> > off before next merge window has priority.
>  
> That's my view about asm-offsets cleanup/generalizing. I just need ack or
> nack from, for example arch maintainers if this is acceptable at all or
> anybody, actually interested in this kind of things. Not cool stuff, but
> still quite straight and easy to finish and merge.
I will for sure take a look.
But with less than 1 hour/day for Linux stuff this has been scheduled after
other stuff I need to do before next merge window.

	Sam

Re: [patch 01/03] kbuild, asm-values: infrastructure

[Sam Ravnborg]

Hi Oleg.

On Wed, Jun 13, 2007 at 01:36:51AM +0200, Oleg Verych wrote:
> 	* header with widely used value definitions
> 	* handle all asm-related things in one file (Makefile.asm)
> 	* move some asm bits from Makefile.build there
> 	  (rule %.s:%.c)
> 	* add script to generate headers from assembles output
> 	  (hopefully better output, MIPS testing/joining to all arch
> 	   probably needed)
> 

Took a look at this patch at last.
Your patch moves everything to Makefile.asm and uses a script
to generate the offset file.

Now where we go the step to use a script to generate the offset file
a much simpler approach would be to move both steps to the shell script.
So the script are called with the input file as one of the
arguments and it spits out the resulting file to stdout.

Doing it this way would allow the caller to have full control
on the filenames and the current call-site in top-level Kbuild
would still be much simpler than today.

Moving the bits from Makefile.build that is only used for asm-offset is
a nice cleanup and this should the script version support too.

I see no value in renaming from asm_offset to asm_value - please drop it.
Introducing the generic asm-values.h should wait and when you do
you should be preapred to update all architectures (ecasue otherwise it
will not happen).

Sorry for the late feedback.

	Sam

Rename asm-offsets tool or not? (Re: [patch 01/03] kbuild, asm-values: infrastructure)

[Oleg Verych]

On Sun, Sep 16, 2007 at 08:29:12PM +0200, Sam Ravnborg wrote:
> Hi Oleg.

Hallo. Nice, you are bringing it back. I'll try to have LKML-like
output this time, not a makefile mess and stuff:

[]
> I see no value in renaming from asm_offset to asm_value - please drop it.
> Introducing the generic asm-values.h should wait and when you do
> you should be preapred to update all architectures (ecasue otherwise it
> will not happen).

All archs, are using same syntax. But.

Interesting exception is MIPS, where tokens are organized and implemented
more nicely, that is where *asm-values* name coming from, actually. One
can see all that text, size, constant tokens in addition to just offsets.

So, if name change isn't worth, then OK; filename compatibility check, as
one in `linux/Kbuild', is easy to hack as well to remove.

But nice feature/tool with meaningful name and functionality is just
another thing.

Opinions?
____

Re: Rename asm-offsets tool or not? (Re: [patch 01/03] kbuild, asm-values: infrastructure)

[Sam Ravnborg]

On Sun, Sep 16, 2007 at 09:32:58PM +0200, Oleg Verych wrote:
> On Sun, Sep 16, 2007 at 08:29:12PM +0200, Sam Ravnborg wrote:
> > Hi Oleg.
> 
> Hallo. Nice, you are bringing it back. I'll try to have LKML-like
> output this time, not a makefile mess and stuff:
> 
> []
> > I see no value in renaming from asm_offset to asm_value - please drop it.
> > Introducing the generic asm-values.h should wait and when you do
> > you should be preapred to update all architectures (ecasue otherwise it
> > will not happen).
> 
> All archs, are using same syntax. But.
> 
> Interesting exception is MIPS, where tokens are organized and implemented
> more nicely, that is where *asm-values* name coming from, actually. One
> can see all that text, size, constant tokens in addition to just offsets.
> 
> So, if name change isn't worth, then OK; filename compatibility check, as
> one in `linux/Kbuild', is easy to hack as well to remove.
> 
> But nice feature/tool with meaningful name and functionality is just
> another thing.
> 
> Opinions?
Everyone and their cousin these days knows that asm-offset is constants
generated from C and used in assembler.
If we benefit from more values in the asm-offset file - let's do it.
But there is no reason to change a name that has been used for this purpose
for as long as I can remember.

	Sam