Add a clang-format configuration and reformat C code (riscv#261)

* Add a clang-format configuration and reformat C code

From my testing it turns out the built-in WebKit style is the closest to
the current style. I added a few config options to further reduce the
diff and I think the current output looks reasonable.
In the future it would be good to add a CI and pre-commit check to enforce
that all C code is consistently formatted to reduce the need for reviewers
to look for formatting issues.

* Fix formatting of commented-out reservation debug code

Use an empty-by-default macro instead of commented-out fprintf calls.
This way clang-format can format the calls sensibly and it's easier
to enable the debug prints.

* Improve formatting of fprintf call in set_config_print()

Clang-format does not like long string literals, so split this manually
to format the call sensibly.

* Fix formatting of function pointer typedef

Clang-format gets this wrong `*` is part of the typedef.

* Improve formatting of getopt_long call

* Fix odd fprintf continuation by splitting long string literal

Author: arichardson

.clang-format

@@ -0,0 +1,11 @@
+Language: Cpp
+BasedOnStyle: WebKit
+AlignArrayOfStructures: Left
+AlignAfterOpenBracket: Align
+AllowShortFunctionsOnASingleLine: Empty
+ColumnLimit: 80
+Cpp11BracedListStyle: true
+IndentWidth: 2
+PointerAlignment: Right
+SortIncludes: Never
+AlignTrailingComments: true

c_emulator/SoftFloat-3e/.clang-format

@@ -0,0 +1,3 @@
+# This is third-party code and should not be reformatted
+DisableFormat: true
+SortIncludes: Never

c_emulator/riscv_platform.c

@@ -4,70 +4,112 @@
 #include "riscv_platform_impl.h"
 #include "riscv_sail.h"
 
+#ifdef DEBUG_RESERVATION
+#include <stdio.h>
+#include <inttypes.h>
+#define RESERVATION_DBG(args...) fprintf(stderr, args)
+#else
+#define RESERVATION_DBG(args...)
+#endif
+
 /* This file contains the definitions of the C externs of Sail model. */
 
 static mach_bits reservation = 0;
 static bool reservation_valid = false;
 
 bool sys_enable_rvc(unit u)
-{ return rv_enable_rvc; }
+{
+  return rv_enable_rvc;
+}
 
 bool sys_enable_next(unit u)
-{ return rv_enable_next; }
+{
+  return rv_enable_next;
+}
 
 bool sys_enable_fdext(unit u)
-{ return rv_enable_fdext; }
+{
+  return rv_enable_fdext;
+}
 
 bool sys_enable_zfinx(unit u)
-{ return rv_enable_zfinx; }
+{
+  return rv_enable_zfinx;
+}
 
 bool sys_enable_writable_misa(unit u)
-{ return rv_enable_writable_misa; }
+{
+  return rv_enable_writable_misa;
+}
 
 bool plat_enable_dirty_update(unit u)
-{ return rv_enable_dirty_update; }
+{
+  return rv_enable_dirty_update;
+}
 
 bool plat_enable_misaligned_access(unit u)
-{ return rv_enable_misaligned; }
+{
+  return rv_enable_misaligned;
+}
 
 bool plat_mtval_has_illegal_inst_bits(unit u)
-{ return rv_mtval_has_illegal_inst_bits; }
+{
+  return rv_mtval_has_illegal_inst_bits;
+}
 
 bool plat_enable_pmp(unit u)
-{ return rv_enable_pmp; }
+{
+  return rv_enable_pmp;
+}
 
 mach_bits plat_ram_base(unit u)
-{ return rv_ram_base; }
+{
+  return rv_ram_base;
+}
 
 mach_bits plat_ram_size(unit u)
-{ return rv_ram_size; }
+{
+  return rv_ram_size;
+}
 
 mach_bits plat_rom_base(unit u)
-{ return rv_rom_base; }
+{
+  return rv_rom_base;
+}
 
 mach_bits plat_rom_size(unit u)
-{ return rv_rom_size; }
+{
+  return rv_rom_size;
+}
 
 // Provides entropy for the scalar cryptography extension.
 mach_bits plat_get_16_random_bits()
-{ return rv_16_random_bits(); }
+{
+  return rv_16_random_bits();
+}
 
 mach_bits plat_clint_base(unit u)
-{ return rv_clint_base; }
+{
+  return rv_clint_base;
+}
 
 mach_bits plat_clint_size(unit u)
-{ return rv_clint_size; }
+{
+  return rv_clint_size;
+}
 
 unit load_reservation(mach_bits addr)
 {
   reservation = addr;
   reservation_valid = true;
-  /* fprintf(stderr, "reservation <- %0" PRIx64 "\n", reservation); */
+  RESERVATION_DBG("reservation <- %0" PRIx64 "\n", reservation);
   return UNIT;
 }
 
 bool speculate_conditional(unit u)
-{ return true; }
+{
+  return true;
+}
 
 static mach_bits check_mask(void)
 {
@@ -78,28 +120,27 @@ bool match_reservation(mach_bits addr)
 {
   mach_bits mask = check_mask();
   bool ret = reservation_valid && (reservation & mask) == (addr & mask);
-  /*
-  fprintf(stderr, "reservation(%c): %0" PRIx64 ", key=%0" PRIx64 ": %s\n",
-	  reservation_valid ? 'v' : 'i', reservation, addr, ret ? "ok" : "fail");
-  */
-
+  RESERVATION_DBG("reservation(%c): %0" PRIx64 ", key=%0" PRIx64 ": %s\n",
+                  reservation_valid ? 'v' : 'i', reservation, addr,
+                  ret ? "ok" : "fail");
   return ret;
 }
 
 unit cancel_reservation(unit u)
-{ /* fprintf(stderr, "reservation <- none\n"); */
+{
+  RESERVATION_DBG("reservation <- none\n");
   reservation_valid = false;
   return UNIT;
 }
 
 unit plat_term_write(mach_bits s)
-{ char c = s & 0xff;
+{
+  char c = s & 0xff;
   plat_term_write_impl(c);
   return UNIT;
 }
 
-void plat_insns_per_tick(sail_int *rop, unit u)
-{ }
+void plat_insns_per_tick(sail_int *rop, unit u) { }
 
 mach_bits plat_htif_tohost(unit u)
 {

c_emulator/riscv_platform.h

@@ -36,4 +36,3 @@ unit plat_term_write(mach_bits);
 mach_bits plat_htif_tohost(unit);
 
 unit memea(mach_bits, sail_int);
-

c_emulator/riscv_platform_impl.c

@@ -3,15 +3,15 @@
 #include <stdio.h>
 
 /* Settings of the platform implementation, with common defaults. */
-bool rv_enable_pmp                  = false;
-bool rv_enable_zfinx                = false;
-bool rv_enable_rvc                  = true;
-bool rv_enable_next                 = false;
-bool rv_enable_writable_misa        = true;
-bool rv_enable_fdext                = true;
-
-bool rv_enable_dirty_update         = false;
-bool rv_enable_misaligned           = false;
+bool rv_enable_pmp = false;
+bool rv_enable_zfinx = false;
+bool rv_enable_rvc = true;
+bool rv_enable_next = false;
+bool rv_enable_writable_misa = true;
+bool rv_enable_fdext = true;
+
+bool rv_enable_dirty_update = false;
+bool rv_enable_misaligned = false;
 bool rv_mtval_has_illegal_inst_bits = false;
 
 uint64_t rv_ram_base = UINT64_C(0x80000000);
@@ -21,7 +21,8 @@ uint64_t rv_rom_base = UINT64_C(0x1000);
 uint64_t rv_rom_size = UINT64_C(0x100);
 
 // Provides entropy for the scalar cryptography extension.
-uint64_t rv_16_random_bits(void) {
+uint64_t rv_16_random_bits(void)
+{
   // This function can be changed to support deterministic sequences of
   // pseudo-random bytes. This is useful for testing.
   const char *name = "/dev/urandom";

c_emulator/riscv_platform_impl.h

@@ -5,7 +5,7 @@
 
 /* Settings of the platform implementation. */
 
-#define DEFAULT_RSTVEC     0x00001000
+#define DEFAULT_RSTVEC 0x00001000
 
 extern bool rv_enable_pmp;
 extern bool rv_enable_zfinx;

c_emulator/riscv_prelude.c

@@ -9,25 +9,29 @@ unit print_string(sail_string prefix, sail_string msg)
 
 unit print_instr(sail_string s)
 {
-  if (config_print_instr) printf("%s\n", s);
+  if (config_print_instr)
+    printf("%s\n", s);
   return UNIT;
 }
 
 unit print_reg(sail_string s)
 {
-  if (config_print_reg) printf("%s\n", s);
+  if (config_print_reg)
+    printf("%s\n", s);
   return UNIT;
 }
 
 unit print_mem_access(sail_string s)
 {
-  if (config_print_mem_access) printf("%s\n", s);
+  if (config_print_mem_access)
+    printf("%s\n", s);
   return UNIT;
 }
 
 unit print_platform(sail_string s)
 {
-  if (config_print_platform) printf("%s\n", s);
+  if (config_print_platform)
+    printf("%s\n", s);
   return UNIT;
 }
 

c_emulator/riscv_sail.h

@@ -6,7 +6,9 @@ typedef int unit;
 #define UNIT 0
 typedef uint64_t mach_bits;
 
-struct zMisa {mach_bits zMisa_chunk_0;};
+struct zMisa {
+  mach_bits zMisa_chunk_0;
+};
 extern struct zMisa zmisa;
 
 void model_init(void);
@@ -17,9 +19,9 @@ bool zstep(sail_int);
 unit ztick_clock(unit);
 unit ztick_platform(unit);
 
-unit z_set_Misa_C(struct zMisa*, mach_bits);
-unit z_set_Misa_D(struct zMisa*, mach_bits);
-unit z_set_Misa_F(struct zMisa*, mach_bits);
+unit z_set_Misa_C(struct zMisa *, mach_bits);
+unit z_set_Misa_D(struct zMisa *, mach_bits);
+unit z_set_Misa_F(struct zMisa *, mach_bits);
 
 #ifdef RVFI_DII
 unit zext_rvfi_init(unit);
@@ -54,19 +56,19 @@ extern uint32_t zcur_privilege;
 
 extern mach_bits zPC;
 
-extern mach_bits
-        zx1,  zx2,  zx3,  zx4,  zx5,  zx6,  zx7,
-  zx8,  zx9,  zx10, zx11, zx12, zx13, zx14, zx15,
-  zx16, zx17, zx18, zx19, zx20, zx21, zx22, zx23,
-  zx24, zx25, zx26, zx27, zx28, zx29, zx30, zx31;
+extern mach_bits zx1, zx2, zx3, zx4, zx5, zx6, zx7, zx8, zx9, zx10, zx11, zx12,
+    zx13, zx14, zx15, zx16, zx17, zx18, zx19, zx20, zx21, zx22, zx23, zx24,
+    zx25, zx26, zx27, zx28, zx29, zx30, zx31;
 
 extern mach_bits zmstatus;
 extern mach_bits zmepc, zmtval;
 extern mach_bits zsepc, zstval;
 
 extern mach_bits zfloat_result, zfloat_fflags;
 
-struct zMcause {mach_bits zMcause_chunk_0;};
+struct zMcause {
+  mach_bits zMcause_chunk_0;
+};
 extern struct zMcause zmcause, zscause;
 
 extern mach_bits zminstret;