hashlib: only include in one place

YosysHQ · Oct 18, 2024 · 6a570b3 · 6a570b3
1 parent 1bfddea
commit 6a570b3
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/kernel/hashlib.h b/kernel/hashlib.h
@@ -34,6 +34,8 @@ namespace hashlib {
  * Hashlib doesn't know how to hash silly Yosys-specific types.
  * Hashlib doesn't depend on Yosys and can be used standalone.
  * Please don't use hashlib standalone for new projects.
+ * Never directly include kernel/hashlib.h in Yosys code.
+ * Instead include kernel/yosys_common.h
  *
  * The hash_ops type is now always left to its default value, derived
  * from templated functions through SFINAE. Providing custom ops is

diff --git a/kernel/yosys_common.h b/kernel/yosys_common.h
@@ -157,8 +157,7 @@ YOSYS_NAMESPACE_BEGIN
 // Note: All headers included in hashlib.h must be included
 // outside of YOSYS_NAMESPACE before this or bad things will happen.
 #ifdef HASHLIB_H
-#  undef HASHLIB_H
-#  include "kernel/hashlib.h"
+#  error You've probably included hashlib.h under two namespace paths. Bad idea.
 #else
 #  include "kernel/hashlib.h"
 #  undef HASHLIB_H

diff --git a/passes/cmds/rename.cc b/passes/cmds/rename.cc
@@ -20,7 +20,6 @@
 #include "kernel/register.h"
 #include "kernel/rtlil.h"
 #include "kernel/log.h"
-#include "kernel/hashlib.h"
 
 USING_YOSYS_NAMESPACE
 PRIVATE_NAMESPACE_BEGIN