[v0.98] Print OS in debug mode. Closes #86

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# cpufetch contributing guidelines
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Creating a pull request](#creating-a-pull-request)
+  - [Case 1: I found a bug in cpufetch](#case-1-i-found-a-bug-in-cpufetch)
+  - [Case 2: I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch](#case-2-i-have-an-idea-for-a-new-feature-in-cpufetch--i-want-to-suggest-a-change-in-cpufetch)
+  - [Case 3: I want to make changes to the Makefile](#case-3-i-want-to-make-changes-to-the-makefile)
+- [Creating an issue](#creating-an-issue)
+  - [cpufetch fails / crashes with a segmentation fault / ends without any output](#cpufetch-fails--crashes-with-a-segmentation-fault--ends-without-any-output)
+    - [Option 1 (best)](#option-1-best)
+    - [Option 2 (use this option if you can't work with option 1)](#option-2-use-this-option-if-you-cant-work-with-option-1)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Creating a pull request
+
+Thanks for your interest in contributing to cpufetch!
+
+What kind of contribution are you going to propose?
+
+### Case 1: I found a bug in cpufetch
+If you found a bug, please don't open a pull request; open an issue instead, even if you know the solution. I appreciate people finding bugs, but I generally prefer to fix them myself.
+
+### Case 2: I have an idea for a new feature in cpufetch / I want to suggest a change in cpufetch
+Great! Make a PR and make sure to explain how did you implement your new feature on the github conversation page.
+
+### Case 3: I want to make changes to the Makefile
+Don't open a pull request; open an issue instead and suggest your changes in the Makefile there. Except for extraordinary cases, I will not accept changes in the Makefile.
+
+## Creating an issue
+
+If you are going to report a bug or problem, always report the CPU model and OS. If possible, also paste the output of `cpufetch` and `cpufetch --debug`.
+
+### cpufetch fails / crashes with a segmentation fault / ends without any output
+You need to provide additional information in the github issue:
+
+#### Option 1 (best)
+1. Build cpufetch with debug symbols (`make clean; make debug`).
+2. Install valgrind (if it is not already installed)
+3. Run cpufetch with valgrind (`valgrind ./cpufetch`)
+4. Paste the complete output (preferably on a platform like pastebin)
+
+#### Option 2 (use this option if you can't work with option 1)
+1. Build cpufetch with debug symbols (`make clean; make debug`).
+2. Install gdb (if it is not already installed)
+3. Debug cpufetch with gdb (`gdb cpufetch`)
+3. Run cpufetch (just r inside gdb console)
+4. Paste the complete output (preferably on a platform like pastebin)

Makefile

@@ -1,6 +1,6 @@
-CC=gcc
+CC ?= gcc
 
-CFLAGS=-Wall -Wextra -Werror -pedantic -fstack-protector-all -pedantic -std=c99
+CFLAGS+=-Wall -Wextra -pedantic -fstack-protector-all -pedantic -std=c99
 SANITY_FLAGS=-Wfloat-equal -Wshadow -Wpointer-arith
 
 PREFIX ?= /usr
@@ -35,13 +35,14 @@ else
 	OUTPUT=cpufetch.exe
 endif
 
+all: CFLAGS += -O3
 all: $(OUTPUT)
 
 debug: CFLAGS += -g -O0
 debug: $(OUTPUT)
 
-release: CFLAGS += -static -O3
+static: CFLAGS += -static -O3
-release: $(OUTPUT)
+static: $(OUTPUT)
 
 $(OUTPUT): Makefile $(SOURCE) $(HEADERS)
 	$(CC) $(CFLAGS) $(SANITY_FLAGS) $(SOURCE) -o $(OUTPUT)
@@ -50,14 +51,14 @@ run: $(OUTPUT)
 	./$(OUTPUT)
 
 clean:
-	@rm $(OUTPUT)
+	@rm -f $(OUTPUT)
 
 install: $(OUTPUT)
-	install -Dm755 "cpufetch"   "$(PREFIX)/bin/cpufetch"
+	install -Dm755 "cpufetch"   "$(DESTDIR)$(PREFIX)/bin/cpufetch"
-	install -Dm644 "LICENSE"    "$(PREFIX)/share/licenses/cpufetch-git/LICENSE"
+	install -Dm644 "LICENSE"    "$(DESTDIR)$(PREFIX)/share/licenses/cpufetch-git/LICENSE"
-	install -Dm644 "cpufetch.8" "$(PREFIX)/share/man/man8/cpufetch.8.gz"
+	install -Dm644 "cpufetch.1" "$(DESTDIR)$(PREFIX)/share/man/man1/cpufetch.1.gz"
 
 uninstall:
-	rm -f "$(PREFIX)/bin/cpufetch"
+	rm -f "$(DESTDIR)$(PREFIX)/bin/cpufetch"
-	rm -f "$(PREFIX)/share/licenses/cpufetch-git/LICENSE"
+	rm -f "$(DESTDIR)$(PREFIX)/share/licenses/cpufetch-git/LICENSE"
-	rm -f "$(PREFIX)/share/man/man8/cpufetch.8.gz"
+	rm -f "$(DESTDIR)$(PREFIX)/share/man/man1/cpufetch.1.gz"

README.md

@@ -3,10 +3,10 @@
 <div align="center">
 
 ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Dr-Noob/cpufetch?label=cpufetch)
-![GitHub Repo stars](https://img.shields.io/github/stars/Dr-Noob/cpufetch?color=4CC61F)
+[![GitHub Repo stars](https://img.shields.io/github/stars/Dr-Noob/cpufetch?color=4CC61F)](https://github.com/Dr-Noob/cpufetch/stargazers)
-![GitHub issues](https://img.shields.io/github/issues/Dr-Noob/cpufetch)
+[![GitHub issues](https://img.shields.io/github/issues/Dr-Noob/cpufetch)](https://github.com/Dr-Noob/cpufetch/issues)
-![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)
+[![Packaging status](https://repology.org/badge/tiny-repos/cpufetch.svg)](https://repology.org/project/cpufetch/versions)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![License](https://img.shields.io/github/license/Dr-Noob/cpufetch?color=orange)](https://github.com/Dr-Noob/cpufetch/blob/master/LICENSE)
 
 <h4 align="center">Simple yet fancy CPU architecture fetching tool</h4>
 &nbsp;
@@ -23,11 +23,9 @@
 
 - [1. Support](#1-support)
 - [2. Installation](#2-installation)
-  - [2.1 Building from source](#21-building-from-source)
+  - [2.1 Available packages](#21-available-packages)
-  - [2.2 Linux](#22-linux)
+  - [2.2 Building from source (Linux/Windows/macOS)](#22-building-from-source-linuxwindowsmacos)
-  - [2.2 Windows](#22-windows)
+  - [2.3 Android](#23-android)
-  - [2.3 macOS](#23-macos)
-  - [2.4 Android](#24-android)
 - [3. Examples](#3-examples)
   - [3.1 x86_64 CPUs](#31-x86_64-cpus)
   - [3.2 ARM CPUs](#32-arm-cpus)
@@ -48,7 +46,14 @@ cpufetch supports x86, x86_64 (Intel and AMD) and ARM.
 | macOS     | :heavy_check_mark:        | :x:                | Some information may be missing. <br> Apple M1 support may be added <br> in the future (see [#47](https://github.com/Dr-Noob/cpufetch/issues/47))|
 
 # 2. Installation
-## 2.1 Building from source
+## 2.1 Installing from a package
+Choose the right package for your operating system:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/cpufetch.svg)](https://repology.org/project/cpufetch/versions)
+
+If there is no available package for your OS, you can download the cpufetch binary from [the releases page](https://github.com/Dr-Noob/cpufetch/releases), or [build cpufetch from source](#22-building-from-source-linuxwindowsmacos) (see below).
+
+## 2.2 Building from source (Linux/Windows/macOS)
 Just clone the repo and use `make` to compile it
 
 ```
@@ -60,16 +65,7 @@ make
 
 The Makefile is designed to work on Linux, Windows and macOS.
 
-## 2.2 Linux
+## 2.3 Android
-There is a cpufetch package available in Arch Linux ([cpufetch-git](https://aur.archlinux.org/packages/cpufetch-git)). If you are in another distribution, you can build `cpufetch` from source.
-
-## 2.2 Windows
-In the [releases](https://github.com/Dr-Noob/cpufetch/releases) section you will find some cpufetch executables compiled for Windows. Just download and run it from Windows CMD. You can also build `cpufetch` from source.
-
-## 2.3 macOS
-You need to build `cpufetch` from source.
-
-## 2.4 Android
 1. Install `termux` app (terminal emulator)
 2. Run `pkg install -y git make clang` inside termux.
 3. Build from source normally:

cpufetch.1

@@ -1,12 +1,12 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.2.
-.TH CPUFETCH "1" "March 2021" "cpufetch v0.97 (x86_64 build)" "User Commands"
+.TH CPUFETCH "1" "June 2021" "cpufetch v0.97 (x86_64 build)" "User Commands"
 .SH NAME
-cpufetch \- manual page for cpufetch v0.97 (x86_64 build)
+cpufetch \- Simple yet fancy CPU architecture fetching tool
 .SH SYNOPSIS
 .B cpufetch
 [\fI\,OPTION\/\fR]...
 .SH DESCRIPTION
-Simple yet fancy CPU architecture fetching tool
+Print detailed information about the CPU architecture. cpufetch displays information like the number of cores, microarchitecture, frequency, cache and peak performance. The program supports x86, x86_64 and ARM architectures and runs on GNU/Linux, Windows, Android and macOS (see https://github.com/Dr-Noob/cpufetch#1-support for more information)
 .SH OPTIONS
 .TP
 \fB\-c\fR, \fB\-\-color\fR
@@ -55,13 +55,16 @@ Old cpufetch style
 Fallback style for terminals that do not support colors
 .SH "EXAMPLES:"
 Run cpufetch with Intel color scheme:
+.PP
 \&./cpufetch \fB\-\-color\fR intel
+.PP
 Run cpufetch with a custom color scheme:
+.PP
 \&./cpufetch \fB\-\-color\fR 239,90,45:210,200,200:100,200,45:0,200,200
 .SH "BUGS:"
 Report bugs to https://github.com/Dr\-Noob/cpufetch/issues
 .SH "NOTE:"
-Peak performance information is NOT accurate. cpufetch computes peak performance using the max frequency. However, to properly compute peak performance, you need to know the frequency of the CPU running AVX code, which is not be fetched by cpufetch since it depends on each specific CPU. For peak performance measurement see: https://github.com/Dr\-Noob/peakperf
+Peak performance information is NOT accurate. cpufetch computes peak performance using the max frequency. However, to properly compute peak performance, you need to know the frequency of the CPU running AVX code, which is not be fetched by cpufetch since it depends on each specific CPU. For peak performance measurement see peakperf (https://github.com/Dr\-Noob/peakperf)
 .SH "AUTHOR:"
 Dr-Noob (https://github.com/Dr-Noob)
 

src/arm/uarch.c

@@ -24,6 +24,10 @@ struct uarch {
 };
 
 enum {
+  ISA_ARMv6,
+  ISA_ARMv6_T2,
+  ISA_ARMv6_KZ,
+  ISA_ARMv6_K,
   ISA_ARMv7_A,
   ISA_ARMv8_A,
   ISA_ARMv8_A_AArch32,
@@ -37,7 +41,10 @@ enum {
   // ARM
   UARCH_ARM7,
   UARCH_ARM9,
-  UARCH_ARM11,       // ARM 1136, ARM 1156, ARM 1176, or ARM 11MPCore.
+  UARCH_ARM1136,
+  UARCH_ARM1156,
+  UARCH_ARM1176,
+  UARCH_ARM11MPCORE,
   UARCH_CORTEX_A5,  
   UARCH_CORTEX_A7,  
   UARCH_CORTEX_A8,    
@@ -98,6 +105,10 @@ enum {
 };
 
 static const ISA isas_uarch[] = {
+  [UARCH_ARM1136]      = ISA_ARMv6,
+  [UARCH_ARM1156]      = ISA_ARMv6_T2,
+  [UARCH_ARM1176]      = ISA_ARMv6_KZ,
+  [UARCH_ARM11MPCORE]  = ISA_ARMv6_K,
   [UARCH_CORTEX_A5]    = ISA_ARMv7_A,
   [UARCH_CORTEX_A7]    = ISA_ARMv7_A,
   [UARCH_CORTEX_A8]    = ISA_ARMv7_A,
@@ -143,6 +154,10 @@ static const ISA isas_uarch[] = {
 };
 
 static char* isas_string[] = {
+  [ISA_ARMv6]  = "ARMv6",
+  [ISA_ARMv6_T2] = "ARMv6T2",
+  [ISA_ARMv6_KZ] = "ARMv6KZ",
+  [ISA_ARMv6_K] = "ARMv6K",
   [ISA_ARMv7_A] = "ARMv7",
   [ISA_ARMv8_A] = "ARMv8",
   [ISA_ARMv8_A_AArch32] = "ARMv8 AArch32",
@@ -190,6 +205,10 @@ struct uarch* get_uarch_from_midr(uint32_t midr, struct cpuInfo* cpu) {
   // ----------------------------------------------------------------------- //
   //                     IM   P      V   R                                   //
   UARCH_START
+  CHECK_UARCH(arch, cpu, 'A', 0xB36, NA, NA, "ARM1136",               UARCH_ARM1136,      CPU_VENDOR_ARM)
+  CHECK_UARCH(arch, cpu, 'A', 0xB56, NA, NA, "ARM1156",               UARCH_ARM1156,      CPU_VENDOR_ARM)
+  CHECK_UARCH(arch, cpu, 'A', 0xB76, NA, NA, "ARM1176",               UARCH_ARM1176,      CPU_VENDOR_ARM)
+  CHECK_UARCH(arch, cpu, 'A', 0xB02, NA, NA, "ARM11 MPCore",          UARCH_ARM11MPCORE,  CPU_VENDOR_ARM)
   CHECK_UARCH(arch, cpu, 'A', 0xC05, NA, NA, "Cortex-A5",             UARCH_CORTEX_A5,    CPU_VENDOR_ARM)
   CHECK_UARCH(arch, cpu, 'A', 0xC07, NA, NA, "Cortex-A7",             UARCH_CORTEX_A7,    CPU_VENDOR_ARM)
   CHECK_UARCH(arch, cpu, 'A', 0xC08, NA, NA, "Cortex-A8",             UARCH_CORTEX_A8,    CPU_VENDOR_ARM)

src/arm/udev.c

@@ -18,8 +18,9 @@
 int get_ncores_from_cpuinfo() {
   // Examples:
   // 0-271
-  // 0-5
   // 0-7
+  // 0
+
   int filelen;
   char* buf;
   if((buf = read_file(_PATH_CPUS_PRESENT, &filelen)) == NULL) {
@@ -27,8 +28,16 @@ int get_ncores_from_cpuinfo() {
     return UNKNOWN;
   }
 
-  int ncores = 0;
+  int ncores;
-  char* tmp1 = strstr(buf, "-") + 1;
+  char* tmp1;
+  if((tmp1 = strstr(buf, "-")) == NULL) {
+    // file contains no - character, we assume that it contains 0,
+    // which means that the CPU contains only one core
+    return 1;
+  }
+  else {
+    tmp1++;
+  }
   char* tmp2 = strstr(buf, "\n");
   char ncores_str[filelen];
   memset(ncores_str, 0, sizeof(char) * filelen);

src/common/main.c

@@ -14,7 +14,21 @@
   #include "../arm/midr.h"
 #endif
 
-static const char* VERSION = "0.97";
+#ifdef __linux__
+  #ifdef __ANDROID__
+    static const char* OS_STR = "Android";
+  #else
+    static const char* OS_STR = "Linux";
+  #endif
+#elif _WIN32
+  static const char* OS_STR = "Windows";
+#elif defined __APPLE__ || __MACH__
+  static const char* OS_STR = "macOS";
+#else
+  static const char* OS_STR = "Unknown OS";
+#endif
+
+static const char* VERSION = "0.98";
 
 void print_help(char *argv[]) {
   const char **t = args_str;
@@ -69,7 +83,7 @@ void print_help(char *argv[]) {
 }
 
 void print_version() {
-  printf("cpufetch v%s (%s)\n",VERSION, ARCH_STR);
+  printf("cpufetch v%s (%s %s)\n",VERSION, OS_STR, ARCH_STR);
 }
 
 int main(int argc, char* argv[]) {

src/common/printer.c

@@ -227,6 +227,11 @@ struct ascii* set_ascii(VENDOR vendor, STYLE style, struct colors* cs) {
   art->ascii_chars[1] = '#';
 
   #ifdef _WIN32
+    // Old Windows do not define the flag
+    #ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
+      #define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x0004
+    #endif
+
     HANDLE std_handle = GetStdHandle(STD_OUTPUT_HANDLE);
     DWORD console_mode;
 

src/x86/cpuid.c

@@ -581,6 +581,7 @@ struct cache* get_cache_info_general(struct cache* cach, uint32_t level) {
           }
           else {
             printWarn("Found unknown unified cache at level %d (size is %d bytes)", cache_level, cache_total_size);
+            cach->max_cache_level--;
           }
           break;
           
@@ -649,12 +650,7 @@ struct frequency* get_frequency_info(struct cpuInfo* cpu) {
       freq->max = get_max_freq_from_file(0, cpu->hv->present);
 
       if(freq->max == 0) {
-        if(cpu->hv->present) {
+        printWarn("Read max CPU frequency from udev and got 0 MHz");
-          printWarn("Read max CPU frequency and got 0 MHz");
-        }
-        else {
-          printBug("Read max CPU frequency and got 0 MHz");
-        }
         freq->max = UNKNOWN_FREQ;
       }
     #endif
@@ -671,24 +667,19 @@ struct frequency* get_frequency_info(struct cpuInfo* cpu) {
     freq->max = ebx;
 
     if(freq->base == 0) {
-      if(cpu->hv->present) {
+      printWarn("Read base CPU frequency from CPUID and got 0 MHz");
-        printWarn("Read base CPU frequency and got 0 MHz");
-      }
-      else {
-        printBug("Read base CPU frequency and got 0 MHz");    
-      }
       freq->base = UNKNOWN_FREQ;
     }
     if(freq->max == 0) {
-      if(cpu->hv->present) {
+      printWarn("Read max CPU frequency from CPUID and got 0 MHz. Using udev");
-        printWarn("Read max CPU frequency and got 0 MHz");
+      freq->max = get_max_freq_from_file(0, cpu->hv->present);
-      }
+
-      else {
+      if(freq->max == 0) {
-        printBug("Read max CPU frequency and got 0 MHz");    
+        printWarn("Read max CPU frequency from udev and got 0 MHz");
-      }
         freq->max = UNKNOWN_FREQ;
       }
     }
+  }
 
   return freq;
 }

src/x86/uarch.c

@@ -38,6 +38,8 @@
 
 typedef uint32_t MICROARCH;
 
+#define STRING_UNKNOWN    "Unknown"
+
 // Data not available
 #define NA                   -1
 
@@ -402,13 +404,22 @@ char* get_str_uarch(struct cpuInfo* cpu) {
 }
 
 char* get_str_process(struct cpuInfo* cpu) {
-  char* str = malloc(sizeof(char) * (4+2+1));
+  char* str = malloc(sizeof(char) * (strlen(STRING_UNKNOWN)+1));
-  uint32_t process = cpu->arch->process;
+  int32_t process = cpu->arch->process;
 
-  if(process > 100)    
+  if(process == UNK) {
+    snprintf(str, strlen(STRING_UNKNOWN)+1, STRING_UNKNOWN);
+  }
+  else if(process > 100) {
     sprintf(str, "%.2fum", (double)process/100);
-  else
+  }
+  else if(process > 0){
     sprintf(str, "%dnm", process);
+  }
+  else {
+    snprintf(str, strlen(STRING_UNKNOWN)+1, STRING_UNKNOWN);
+    printBug("Found invalid process: '%d'", process);
+  }
 
   return str;
 }