Skip to contentSkip to conversation

Set retain attribute on C identifier name sections referenced by __start_/__stop_

PATCH Applied Fangrui Song 2 participants 2 messages Nov 11, 2021

lore
Share & tools
lore

Fangrui Song

author
#0 lore raw

PATCH 1/1 Set retain attribute on C identifier name sections referenced by __start_/__stop_

LLD 13 and GNU ld 2.37 support -z start-stop-gc which allows garbage collection of C identifier name sections despite the __start_/__stop_ references. GNU ld before 2015-10 had the behavior as well. Simply set the retain attribute so that GCC 11 (if configure-time binutils is 2.36 or newer)/Clang 13 will set the SHF_GNU_RETAIN section attribute to prevent garbage collection.

Without the patch, there are linker errors with -z start-stop-gc (LLD default) when -Wl,--gc-sections is used:

```
ld.lld: error: undefined symbol: __start___eap
>>> referenced by eap.c
>>>               src/eap.o:(eap_init)
```

The remain attribute will not be needed if the metadata sections are referenced by code directly.

---
 client/command.h    | 12 +++++++-----
 client/dbus-proxy.h | 13 ++++++++-----
 src/eap-private.h   |  6 +++++-
 src/module.h        | 20 +++++++++++++-------
 4 files changed, 33 insertions(+), 18 deletions(-)
client/command.h +7 -5
index d906dc9b..5d5df7fe 100644
@@ -82,11 +82,13 @@ struct command_family_desc {
 	void (*exit)(void);
 } __attribute__((aligned(8)));
 
-#define COMMAND_FAMILY(name, init, exit)				\
-	static struct command_family_desc __command_family_ ## name	\
-		__attribute__((used, section("__command"), aligned(8))) = {\
-			#name, init, exit				\
-		};							\
+#define COMMAND_FAMILY(name, init, exit)                                       \
+	_Pragma("GCC diagnostic push")                                         \
+	_Pragma("GCC diagnostic ignored \"-Wattributes\"")                     \
+        static struct command_family_desc __command_family_##name              \
+	__attribute__((used, retain, section("__command"), aligned(8))) = {    \
+		#name, init, exit};                                            \
+	_Pragma("GCC diagnostic pop")
 
 bool command_init(char **argv, int argc);
 void command_exit(void);
client/dbus-proxy.h +8 -5
index 6852a378..54e95746 100644
@@ -117,11 +117,14 @@ struct interface_type_desc {
 	void (*exit)(void);
 } __attribute__((aligned(8)));
 
-#define INTERFACE_TYPE(interface, init, exit)				\
-	static struct interface_type_desc __interface_type_ ## interface\
-		__attribute__((used, section("__interface"), aligned(8))) = {\
-			#interface, init, exit				\
-		};							\
+#define INTERFACE_TYPE(interface, init, exit)				              \
+	_Pragma("GCC diagnostic push")                                                \
+	_Pragma("GCC diagnostic ignored \"-Wattributes\"")                            \
+	static struct interface_type_desc __interface_type_ ## interface              \
+		__attribute__((used, retain, section("__interface"), aligned(8))) = { \
+			#interface, init, exit				              \
+		};								      \
+	_Pragma("GCC diagnostic pop")
 
 bool dbus_proxy_init(void);
 bool dbus_proxy_exit(void);
src/eap-private.h +5 -1
index 5121a330..1eef6bf4 100644
@@ -94,10 +94,14 @@ struct eap_method_desc {
 } __attribute__((aligned(8)));
 
 #define EAP_METHOD_BUILTIN(name, init, exit)				\
+	_Pragma("GCC diagnostic push")					\
+	_Pragma("GCC diagnostic ignored \"-Wattributes\"")		\
 	static struct eap_method_desc __eap_builtin_ ## name		\
-		__attribute__((used, section("__eap"), aligned(8))) = {	\
+		__attribute__((used, retain, section("__eap"),		\
+			       aligned(8))) = {				\
 			#name, init, exit				\
 		};							\
+	_Pragma("GCC diagnostic pop")
 
 int eap_register_method(struct eap_method *method);
 int eap_unregister_method(struct eap_method *method);
src/module.h +13 -7
index 8e1a9904..b4ec1284 100644
@@ -33,19 +33,25 @@ struct iwd_module_depends {
 };
 
 #define IWD_MODULE(name, init, exit)					\
+	_Pragma("GCC diagnostic push")				  	\
+	_Pragma("GCC diagnostic ignored \"-Wattributes\"")	        \
 	static struct iwd_module_desc __iwd_module_ ## name		\
-		__attribute__((used, section("__iwd_module"), aligned(8))) = {\
+		__attribute__((used, retain, section("__iwd_module"),   \
+			       aligned(8))) = {			 	\
 			#name, init, exit				\
-		};
+		};							\
+	_Pragma("GCC diagnostic pop")
 
 #define IWD_MODULE_DEPENDS(name, dep)					\
-	static struct iwd_module_depends				\
-				__iwd_module__##name##_##dep		\
-		__attribute__((used, section("__iwd_module_dep"),       \
-					aligned(8))) = {		\
+	_Pragma("GCC diagnostic push")                                  \
+	_Pragma("GCC diagnostic ignored \"-Wattributes\"")              \
+	static struct iwd_module_depends __iwd_module__##name##_##dep	\
+		__attribute__((used, retain,				\
+			section("__iwd_module_dep"), aligned(8))) = {	\
 			.self = #name,					\
 			.target = #dep,					\
-		};
+		};						        \
+	_Pragma("GCC diagnostic pop")
 
 int iwd_modules_init(void);
 void iwd_modules_exit(void);
Signature · 1 line
2.34
Applied
#1 lore raw

Hi Fangrui,

Quoted 16 lines · Fangrui Song

LLD 13 and GNU ld 2.37 support -z start-stop-gc which allows garbage collection of C identifier name sections despite the __start_/__stop_ references. GNU ld before 2015-10 had the behavior as well. Simply set the retain attribute so that GCC 11 (if configure-time binutils is 2.36 or newer)/Clang 13 will set the SHF_GNU_RETAIN section attribute to prevent garbage collection.

Without the patch, there are linker errors with -z start-stop-gc (LLD default) when -Wl,--gc-sections is used:

```
ld.lld: error: undefined symbol: __start___eap
>>> referenced by eap.c
>>>                src/eap.o:(eap_init)
```
Quoted 9 lines

The remain attribute will not be needed if the metadata sections are referenced by code directly.

---
  client/command.h    | 12 +++++++-----
  client/dbus-proxy.h | 13 ++++++++-----
  src/eap-private.h   |  6 +++++-
  src/module.h        | 20 +++++++++++++-------
  4 files changed, 33 insertions(+), 18 deletions(-)

I changed some whitespace formatting slightly to make the diff slightly more compact and to use tabs instead of spaces in some places.

Applied, thanks!

Regards,
-Denis