Skip to contentSkip to conversation

random: do not export add_vmfork_randomness() unless needed

PATCH Superseded Jason A. Donenfeld 2 participants 4 messages Mar 1, 2022 Random number driver

lore
Share & tools
lore

Jason A. Donenfeld

author maintainer
#0 lore raw

PATCH 1/1 random: do not export add_vmfork_randomness() unless needed

Since add_vmfork_randomness() is only called from vmgenid.o, we can guard it in CONFIG_VMGENID, similarly to how we do with add_disk_randomness() and CONFIG_BLOCK. If we ever have multiple things calling into add_vmfork_randomness(), we can add another shared Kconfig symbol for that, but for now, this is good enough. Even though add_vmfork_randomess() is a pretty small function, removing it means that there are only calls to crng_reseed(false) and none to crng_reseed(true), which means the compiler can constant propagate it and simply crng_reseed().

---
 drivers/char/random.c  | 2 ++
 include/linux/random.h | 2 ++
 2 files changed, 4 insertions(+)
drivers/char/random.c +2 -0
index 99cf9e829d1e..662b7edb3b7a 100644
@@ -1169,6 +1169,7 @@ void add_bootloader_randomness(const void *buf, size_t size)
 }
 EXPORT_SYMBOL_GPL(add_bootloader_randomness);
 
+#ifdef CONFIG_VMGENID
 /*
  * Handle a new unique VM ID, which is unique, not secret, so we
  * don't credit it, but we do immediately force a reseed after so
@@ -1183,6 +1184,7 @@ void add_vmfork_randomness(const void *unique_vm_id, size_t size)
 	}
 }
 EXPORT_SYMBOL_GPL(add_vmfork_randomness);
+#endif
 
 struct fast_pool {
 	union {
include/linux/random.h +2 -0
index 117468f3a92e..e6225ac98572 100644
@@ -34,7 +34,9 @@ extern void add_input_randomness(unsigned int type, unsigned int code,
 extern void add_interrupt_randomness(int irq) __latent_entropy;
 extern void add_hwgenerator_randomness(const void *buffer, size_t count,
 				       size_t entropy);
+#ifdef CONFIG_VMGENID
 extern void add_vmfork_randomness(const void *unique_vm_id, size_t size);
+#endif
 
 extern void get_random_bytes(void *buf, size_t nbytes);
 extern int wait_for_random_bytes(void);
Signature · 1 line
2.35.1
maintainer
#1 lore raw
Quoted 9 lines · Jason A. Donenfeld

Since add_vmfork_randomness() is only called from vmgenid.o, we can guard it in CONFIG_VMGENID, similarly to how we do with add_disk_randomness() and CONFIG_BLOCK. If we ever have multiple things calling into add_vmfork_randomness(), we can add another shared Kconfig symbol for that, but for now, this is good enough. Even though add_vmfork_randomess() is a pretty small function, removing it means that there are only calls to crng_reseed(false) and none to crng_reseed(true), which means the compiler can constant propagate it and simply crng_reseed().

How about only exporting add_vmfork_randomness if VMGENID is compiled as a module? If it's built-in to the kernel, no need to export the symbol.

- Ted

author maintainer
#2 lore raw

Hi Ted,

Quoted 3 lines · Theodore Ts'o

How about only exporting add_vmfork_randomness if VMGENID is compiled as a module? If it's built-in to the kernel, no need to export the symbol.

Sure, good idea. I'll send a v2.

Jason

author maintainer
#3 lore raw

PATCH v2 1/1 random: do not export add_vmfork_randomness() unless needed

Since add_vmfork_randomness() is only called from vmgenid.o, we can guard it in CONFIG_VMGENID, similarly to how we do with add_disk_randomness() and CONFIG_BLOCK. If we ever have multiple things calling into add_vmfork_randomness(), we can add another shared Kconfig symbol for that, but for now, this is good enough. Even though add_vmfork_randomess() is a pretty small function, removing it means that there are only calls to crng_reseed(false) and none to crng_reseed(true), which means the compiler can constant propagate the false, removing branches from crng_reseed() and its descendants.

Additionally, we don't even need the symbol to be exported if CONFIG_VMGENID is not a module, so conditionalize that too.

Cc Dominik Brodowski <[email protected]>
Cc Theodore Ts'o <[email protected]>

---
Changes v1->v2:
- [Ted] Do not export symbol if we're a built-in.

 drivers/char/random.c  | 4 ++++
 include/linux/random.h | 2 ++
 2 files changed, 6 insertions(+)
drivers/char/random.c +4 -0
index 99cf9e829d1e..fe477a12c1ad 100644
@@ -1169,6 +1169,7 @@ void add_bootloader_randomness(const void *buf, size_t size)
 }
 EXPORT_SYMBOL_GPL(add_bootloader_randomness);
 
+#if IS_ENABLED(CONFIG_VMGENID)
 /*
  * Handle a new unique VM ID, which is unique, not secret, so we
  * don't credit it, but we do immediately force a reseed after so
@@ -1182,7 +1183,10 @@ void add_vmfork_randomness(const void *unique_vm_id, size_t size)
 		pr_notice("crng reseeded due to virtual machine fork\n");
 	}
 }
+#if IS_MODULE(CONFIG_VMGENID)
 EXPORT_SYMBOL_GPL(add_vmfork_randomness);
+#endif
+#endif
 
 struct fast_pool {
 	union {
include/linux/random.h +2 -0
index 117468f3a92e..f209f1a78899 100644
@@ -34,7 +34,9 @@ extern void add_input_randomness(unsigned int type, unsigned int code,
 extern void add_interrupt_randomness(int irq) __latent_entropy;
 extern void add_hwgenerator_randomness(const void *buffer, size_t count,
 				       size_t entropy);
+#if IS_ENABLED(CONFIG_VMGENID)
 extern void add_vmfork_randomness(const void *unique_vm_id, size_t size);
+#endif
 
 extern void get_random_bytes(void *buf, size_t nbytes);
 extern int wait_for_random_bytes(void);
Signature · 1 line
2.35.1