Skip to contentSkip to conversation

include/image.h: Use explicit function definitions instead of macro trickery

PATCH New Petri Lehtinen 3 participants 7 messages Jan 28, 2009 – Feb 17, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 include/image.h: Use explicit function definitions instead of macro trickery

---

I got frustrated while grepping through the sources, trying to find the definitions of these functions. Thinking back, the obvious place to look in the first place would of course have been include/image.h, but it didn't even cross my mind that there could be some macro trickery behind these functions.

Anyway, I think that explicit is better than implicit and that this kind of macro usage is ugly.

 include/image.h |  154 +++++++++++++++++++++++++++++++++++++++----------------
 1 files changed, 110 insertions(+), 44 deletions(-)
include/image.h +110 -44
index 4609200..e3c33ca 100644
@@ -333,28 +333,60 @@ static inline uint32_t image_get_header_size (void)
 	return (sizeof (image_header_t));
 }
 
-#define image_get_hdr_l(f) \
-	static inline uint32_t image_get_##f(image_header_t *hdr) \
-	{ \
-		return uimage_to_cpu (hdr->ih_##f); \
-	}
-image_get_hdr_l (magic);
-image_get_hdr_l (hcrc);
-image_get_hdr_l (time);
-image_get_hdr_l (size);
-image_get_hdr_l (load);
-image_get_hdr_l (ep);
-image_get_hdr_l (dcrc);
-
-#define image_get_hdr_b(f) \
-	static inline uint8_t image_get_##f(image_header_t *hdr) \
-	{ \
-		return hdr->ih_##f; \
-	}
-image_get_hdr_b (os);
-image_get_hdr_b (arch);
-image_get_hdr_b (type);
-image_get_hdr_b (comp);
+static inline uint32_t image_get_magic (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_magic);
+}
+
+static inline uint32_t image_get_hcrc (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_hcrc);
+}
+
+static inline uint32_t image_get_time (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_time);
+}
+
+static inline uint32_t image_get_size (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_size);
+}
+
+static inline uint32_t image_get_load (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_load);
+}
+
+static inline uint32_t image_get_ep (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_ep);
+}
+
+static inline uint32_t image_get_dcrc (image_header_t *hdr)
+{
+	return uimage_to_cpu (hdr->ih_dcrc);
+}
+
+static inline uint8_t image_get_os (image_header_t *hdr)
+{
+	return hdr->ih_os;
+}
+
+static inline uint8_t image_get_arch (image_header_t *hdr)
+{
+	return hdr->ih_arch;
+}
+
+static inline uint8_t image_get_type (image_header_t *hdr)
+{
+	return hdr->ih_type;
+}
+
+static inline uint8_t image_get_comp (image_header_t *hdr)
+{
+	return hdr->ih_comp;
+}
 
 static inline char *image_get_name (image_header_t *hdr)
 {
@@ -386,33 +418,67 @@ static inline uint32_t image_get_image_size (image_header_t *hdr)
 {
 	return (image_get_size (hdr) + image_get_header_size ());
 }
+
 static inline ulong image_get_image_end (image_header_t *hdr)
 {
 	return ((ulong)hdr + image_get_image_size (hdr));
 }
 
-#define image_set_hdr_l(f) \
-	static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
-	{ \
-		hdr->ih_##f = cpu_to_uimage (val); \
-	}
-image_set_hdr_l (magic);
-image_set_hdr_l (hcrc);
-image_set_hdr_l (time);
-image_set_hdr_l (size);
-image_set_hdr_l (load);
-image_set_hdr_l (ep);
-image_set_hdr_l (dcrc);
-
-#define image_set_hdr_b(f) \
-	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
-	{ \
-		hdr->ih_##f = val; \
-	}
-image_set_hdr_b (os);
-image_set_hdr_b (arch);
-image_set_hdr_b (type);
-image_set_hdr_b (comp);
+
+static inline void image_set_magic (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_magic = cpu_to_uimage (val);
+}
+
+static inline void image_set_hcrc (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_hcrc = cpu_to_uimage (val);
+}
+
+static inline void image_set_time (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_time = cpu_to_uimage (val);
+}
+
+static inline void image_set_size (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_size = cpu_to_uimage (val);
+}
+
+static inline void image_set_load (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_load = cpu_to_uimage (val);
+}
+
+static inline void image_set_ep (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_ep = cpu_to_uimage (val);
+}
+
+static inline void image_set_dcrc (image_header_t *hdr, uint32_t val)
+{
+	hdr->ih_dcrc = cpu_to_uimage (val);
+}
+
+static inline void image_set_os (image_header_t *hdr, uint8_t val)
+{
+	hdr->ih_os = val;
+}
+
+static inline void image_set_arch (image_header_t *hdr, uint8_t val)
+{
+	hdr->ih_arch = val;
+}
+
+static inline void image_set_type (image_header_t *hdr, uint8_t val)
+{
+	hdr->ih_type = val;
+}
+
+static inline void image_set_comp (image_header_t *hdr, uint8_t val)
+{
+	hdr->ih_comp = val;
+}
 
 static inline void image_set_name (image_header_t *hdr, const char *name)
 {
Signature · 1 line
1.6.0.4
#1 lore raw

PATCH 1/1 include/image.h: Use explicit function definitions instead of macro trickery

Dear Petri Lehtinen,

Quoted 11 lines · In message <[email protected]> you wrote:

---

I got frustrated while grepping through the sources, trying to find the definitions of these functions. Thinking back, the obvious place to look in the first place would of course have been include/image.h, but it didn't even cross my mind that there could be some macro trickery behind these functions.

Anyway, I think that explicit is better than implicit and that this kind of macro usage is ugly.

I am not really sure, but I tend to leave the code as it was.

include/image.h static inline uint32_t image_get_header_size (void) · line 347

Quoted 12 lines
include/image.h +0 -12
-#define image_get_hdr_l(f) \
-	static inline uint32_t image_get_##f(image_header_t *hdr) \
-	{ \
-		return uimage_to_cpu (hdr->ih_##f); \
-	}
-image_get_hdr_l (magic);
-image_get_hdr_l (hcrc);
-image_get_hdr_l (time);
-image_get_hdr_l (size);
-image_get_hdr_l (load);
-image_get_hdr_l (ep);
-image_get_hdr_l (dcrc);

The macro here has the advantages of being compact, and that you need to change one location only to get a consistent set of function declarations.

Best regards,

Wolfgang Denk

Signature · 7 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
There are two ways of constructing a software design. One way  is  to
make  it  so  simple that there are obviously no deficiencies and the
other is to make it so complicated that there are  no  obvious  defi-
ciencies.                             - Charles Anthony Richard Hoare
#2 lore raw

PATCH 1/1 include/image.h: Use explicit function definitions instead of macro trickery

Quoted 12 lines · On Wednesday 28 January 2009 16:20:13 Wolfgang Denk wrote:
Quoted 8 lines · Petri Lehtinen

I got frustrated while grepping through the sources, trying to find the definitions of these functions. Thinking back, the obvious place to look in the first place would of course have been include/image.h, but it didn't even cross my mind that there could be some macro trickery behind these functions.

Anyway, I think that explicit is better than implicit and that this kind of macro usage is ugly.

I am not really sure, but I tend to leave the code as it was.

Quoted 16 lines

include/image.h static inline uint32_t image_get_header_size (void) · line 347

Quoted 12 lines
include/image.h +0 -12
-#define image_get_hdr_l(f) \
-	static inline uint32_t image_get_##f(image_header_t *hdr) \
-	{ \
-		return uimage_to_cpu (hdr->ih_##f); \
-	}
-image_get_hdr_l (magic);
-image_get_hdr_l (hcrc);
-image_get_hdr_l (time);
-image_get_hdr_l (size);
-image_get_hdr_l (load);
-image_get_hdr_l (ep);
-image_get_hdr_l (dcrc);

The macro here has the advantages of being compact, and that you need to change one location only to get a consistent set of function declarations.

agree completely.

Petri:
if you're worried about grepping, then perhaps you'd post a patch like so:
-image_get_hdr_l (dcrc);
+image_get_hdr_l (dcrc); /* image_get_dcrc() */
-mike
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: This is a digitally signed message part.
Url : http://lists.denx.de/pipermail/u-boot/attachments/20090128/919c7321/attachment.pgp

#3 lore raw

PATCH 1/1 include/image.h: Use explicit function definitions instead of macro trickery

Dear Mike Frysinger,

Review

Quoted 5 lines · In message <[email protected]> you wrote:

Petri:
if you're worried about grepping, then perhaps you'd post a patch like so:

(quoted diff) +1 -1
-image_get_hdr_l (dcrc);
+image_get_hdr_l (dcrc); /* image_get_dcrc() */

Excellent idea!

Best regards,

Wolfgang Denk

Signature · 5 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Vor allem kein Gedanke! Nichts ist kompromittierender als ein  Gedan-
ke!            - Friedrich Wilhelm Nietzsche _Der Fall Wagner_ (1888)
#4 lore raw

PATCH 1/1 include/image.h: Ease grepping of image_* functions

Because the functions have been defined using macros, grepping for their definitions is not possible. This patch adds the real function names in comments.

---
 include/image.h |   44 ++++++++++++++++++++++----------------------
 1 files changed, 22 insertions(+), 22 deletions(-)
include/image.h +22 -22
index 4609200..74a1240 100644
@@ -338,23 +338,23 @@ static inline uint32_t image_get_header_size (void)
 	{ \
 		return uimage_to_cpu (hdr->ih_##f); \
 	}
-image_get_hdr_l (magic);
-image_get_hdr_l (hcrc);
-image_get_hdr_l (time);
-image_get_hdr_l (size);
-image_get_hdr_l (load);
-image_get_hdr_l (ep);
-image_get_hdr_l (dcrc);
+image_get_hdr_l (magic);	/* image_get_magic */
+image_get_hdr_l (hcrc);		/* image_get_hcrc */
+image_get_hdr_l (time);		/* image_get_time */
+image_get_hdr_l (size);		/* image_get_size */
+image_get_hdr_l (load);		/* image_get_load */
+image_get_hdr_l (ep);		/* image_get_ep */
+image_get_hdr_l (dcrc);		/* image_get_dcrc */
 
 #define image_get_hdr_b(f) \
 	static inline uint8_t image_get_##f(image_header_t *hdr) \
 	{ \
 		return hdr->ih_##f; \
 	}
-image_get_hdr_b (os);
-image_get_hdr_b (arch);
-image_get_hdr_b (type);
-image_get_hdr_b (comp);
+image_get_hdr_b (os);		/* image_get_os */
+image_get_hdr_b (arch);		/* image_get_arch */
+image_get_hdr_b (type);		/* image_get_type */
+image_get_hdr_b (comp);		/* image_get_comp */
 
 static inline char *image_get_name (image_header_t *hdr)
 {
@@ -396,23 +396,23 @@ static inline ulong image_get_image_end (image_header_t *hdr)
 	{ \
 		hdr->ih_##f = cpu_to_uimage (val); \
 	}
-image_set_hdr_l (magic);
-image_set_hdr_l (hcrc);
-image_set_hdr_l (time);
-image_set_hdr_l (size);
-image_set_hdr_l (load);
-image_set_hdr_l (ep);
-image_set_hdr_l (dcrc);
+image_set_hdr_l (magic);	/* image_set_magic */
+image_set_hdr_l (hcrc);		/* image_set_hcrc */
+image_set_hdr_l (time);		/* image_set_time */
+image_set_hdr_l (size);		/* image_set_size */
+image_set_hdr_l (load);		/* image_set_load */
+image_set_hdr_l (ep);		/* image_set_ep */
+image_set_hdr_l (dcrc);		/* image_set_dcrc */
 
 #define image_set_hdr_b(f) \
 	static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
 	{ \
 		hdr->ih_##f = val; \
 	}
-image_set_hdr_b (os);
-image_set_hdr_b (arch);
-image_set_hdr_b (type);
-image_set_hdr_b (comp);
+image_set_hdr_b (os);		/* image_set_os */
+image_set_hdr_b (arch);		/* image_set_arch */
+image_set_hdr_b (type);		/* image_set_type */
+image_set_hdr_b (comp);		/* image_set_comp */
 
 static inline void image_set_name (image_header_t *hdr, const char *name)
 {
Signature · 1 line
1.6.0.4
#6 lore raw

PATCH 1/1 include/image.h: Ease grepping of image_* functions

In reply to Petri Lehtinen

Dear Petri Lehtinen,

Quoted 8 lines · In message <[email protected]> you wrote:

Because the functions have been defined using macros, grepping for their definitions is not possible. This patch adds the real function names in comments.

---
 include/image.h |   44 ++++++++++++++++++++++----------------------
 1 files changed, 22 insertions(+), 22 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 6 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
"What terrible way to die."
"There are no good ways."
	-- Sulu and Kirk, "That Which Survives", stardate unknown