Merge branch 'sysprog21:master' into master

.ci/check-newline.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -e -u -o pipefail
+
+ret=0
+show=0
+# Reference: https://medium.com/@alexey.inkin/how-to-force-newline-at-end-of-files-and-why-you-should-do-it-fdf76d1d090e
+while IFS= read -rd '' f; do
+    if file --mime-encoding "$f" | grep -qv binary; then
+        tail -c1 < "$f" | read -r _ || show=1
+        if [ $show -eq 1 ]; then
+            echo "Warning: No newline at end of file $f"
+            ret=1
+            show=0
+        fi
+    fi
+done < <(git ls-files -z src tests/arch-test-target)
+
+exit $ret

.github/workflows/main.yml

@@ -37,5 +37,6 @@ jobs:
     - name: coding convention
       run: |
             sudo apt-get install -q -y clang-format-14
-            sh .ci/check-format.sh
+            .ci/check-newline.sh
+            .ci/check-format.sh
       shell: bash

LICENSE

@@ -1,7 +1,7 @@
 lab0-c is freely redistributable under the two-clause BSD License:
 
 Copyright (C) 2017 Carnegie Mellon University.
-Copyright (C) 2018-2023 National Cheng Kung University, Taiwan.
+Copyright (C) 2018-2024 National Cheng Kung University, Taiwan.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -76,7 +76,7 @@ $ make valgrind
 * Use `$ make clean` or `$ rm /tmp/qtest.*` to clean the temporary files created by target valgrind
 
 Extra options can be recognized by make:
-* `VERBOSE`: control the build verbosity. If `VERBOSE=1`, echo eacho command in build process.
+* `VERBOSE`: control the build verbosity. If `VERBOSE=1`, echo each command in build process.
 * `SANITIZER`: enable sanitizer(s) directed build. At the moment, AddressSanitizer is supported.
 
 ## Using `qtest`
@@ -116,7 +116,7 @@ Trace files
 ## Debugging Facilities
 
 Before using GDB debug `qtest`, there are some routine instructions need to do. The script `scripts/debug.py` covers these instructions and provides basic debug function. 
-```
+```shell
 $ scripts/debug.py -h
 usage: debug.py [-h] [-d | -a]
 
@@ -126,7 +126,7 @@ optional arguments:
   -a, --analyze  Analyze the core dump file
 ```
 * Enter GDB without interruption by **SIGALRM**.
-```
+```shell
 $ scripts/debug.py -d
 Reading symbols from lab0-c/qtest...done.
 Signal        Stop	Print	Pass to program	Description
@@ -138,13 +138,13 @@ cmd>
 
   The core dump file was created in the working directory of the `qtest`.
   * Allow the core dumps by using shell built-in command **ulimit** to set core file size.
-  ```
+  ```shell
   $ ulimit -c unlimited
   $ ulimit -c
   unlimited
   ```
   * Enter GDB and analyze
-  ```
+  ```shell
   $ scripts/debug.py -a
   Reading symbols from lab0-c/qtest...done.
   [New LWP 9424]
@@ -167,7 +167,7 @@ cmd>
 
 A small web server is already integrated within the `qtest` command line interpreter,
 and you may use it by running the `web` command in its prompt.
-```
+```shell
 $ ./qtest
 cmd> web
 listen on port 9999, fd is 3

queue.c

@@ -18,7 +18,7 @@ struct list_head *q_new()
 }
 
 /* Free all storage used by queue */
-void q_free(struct list_head *l) {}
+void q_free(struct list_head *head) {}
 
 /* Insert an element at head of queue */
 bool q_insert_head(struct list_head *head, char *s)

report.c

@@ -45,7 +45,7 @@ void set_verblevel(int level)
     verblevel = level;
 }
 
-bool set_logfile(char *file_name)
+bool set_logfile(const char *file_name)
 {
     logfile = fopen(file_name, "w");
     return logfile != NULL;
@@ -161,7 +161,7 @@ void report_noreturn(int level, char *fmt, ...)
 /* Functions denoting failures */
 
 /* Need to be able to print without using malloc */
-static void fail_fun(char *format, char *msg)
+static void fail_fun(const char *format, const char *msg)
 {
     snprintf(fail_buf, sizeof(fail_buf), format, msg);
     /* Tack on return */
@@ -209,7 +209,7 @@ static void check_exceed(size_t new_bytes)
 }
 
 /* Call malloc & exit if fails */
-void *malloc_or_fail(size_t bytes, char *fun_name)
+void *malloc_or_fail(size_t bytes, const char *fun_name)
 {
     check_exceed(bytes);
     void *p = malloc(bytes);
@@ -228,7 +228,7 @@ void *malloc_or_fail(size_t bytes, char *fun_name)
 }
 
 /* Call calloc returns NULL & exit if fails */
-void *calloc_or_fail(size_t cnt, size_t bytes, char *fun_name)
+void *calloc_or_fail(size_t cnt, size_t bytes, const char *fun_name)
 {
     check_exceed(cnt * bytes);
     void *p = calloc(cnt, bytes);
@@ -246,7 +246,7 @@ void *calloc_or_fail(size_t cnt, size_t bytes, char *fun_name)
     return p;
 }
 
-char *strsave_or_fail(char *s, char *fun_name)
+char *strsave_or_fail(const char *s, const char *fun_name)
 {
     if (!s)
         return NULL;

report.h

@@ -12,7 +12,7 @@ typedef enum { MSG_WARN, MSG_ERROR, MSG_FATAL, N_MSG } message_t;
 /* Buffer sizes */
 #define MAX_CHAR 512
 
-bool set_logfile(char *file_name);
+bool set_logfile(const char *file_name);
 
 extern int verblevel;
 void set_verblevel(int level);
@@ -27,13 +27,13 @@ void report(int verblevel, char *fmt, ...);
 void report_noreturn(int verblevel, char *fmt, ...);
 
 /* Attempt to call malloc.  Fail when returns NULL */
-void *malloc_or_fail(size_t bytes, char *fun_name);
+void *malloc_or_fail(size_t bytes, const char *fun_name);
 
 /* Attempt to call calloc.  Fail when returns NULL */
-void *calloc_or_fail(size_t cnt, size_t bytes, char *fun_name);
+void *calloc_or_fail(size_t cnt, size_t bytes, const char *fun_name);
 
 /* Attempt to save string.  Fail when malloc returns NULL */
-char *strsave_or_fail(char *s, char *fun_name);
+char *strsave_or_fail(const char *s, const char *fun_name);
 
 /* Free block, as from malloc, or strsave */
 void free_block(void *b, size_t len);

scripts/debug.py

@@ -80,4 +80,4 @@ def main(argv):
         print("ERROR: qtest is not exist")
         exit(1)
 
-    main(args)
+    main(args)

scripts/kirby.raw

@@ -22,4 +22,4 @@
                  ⎺⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽                            
                    ⎺⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎺                            
                       ⎽⎼⎽⎽⎽⎽⎽⎺                             
-[?25h
+[?25h

scripts/pre-commit.hook

@@ -13,7 +13,10 @@ CPPCHECK_suppresses="--inline-suppr harness.c \
 --suppress=nullPointerRedundantCheck:report.c \
 --suppress=nullPointerRedundantCheck:harness.c \
 --suppress=nullPointer:queue.c \
---suppress=nullPointer:qtest.c"
+--suppress=nullPointer:qtest.c \
+--suppress=returnDanglingLifetime:report.c \
+--suppress=constParameterCallback:console.c \
+--suppress=constParameterPointer:console.c"
 CPPCHECK_OPTS="-I. --enable=all --error-exitcode=1 --force $CPPCHECK_suppresses $CPPCHECK_unmatched ."
 
 RETURN=0

scripts/pre-push.hook

@@ -8,12 +8,12 @@ YELLOW='\033[1;33m'
 NC='\033[0m' # No Color
 
 # Validate repository
-# commit c2084e68866b7eaabd95f671319d3ee01e923b32 (HEAD -> master)
-# Author: Jim Huang <jserv[email protected]>
-# Date:   Tue Jan 24 14:59:36 2023 +0800
+# commit 3ed17237af5b1ead6c394df5099bc2bc1f8392df (HEAD -> bump-copyright-year)
+# Author: Jim Huang <jserv@ccns.ncku.edu.tw>
+# Date:   Tue Feb 20 03:59:49 2024 +0800
 #     Bump copyright year
-commit=$(git rev-list -n 1 --grep '^Bump copyright' 0e922a9b7da49726c91f1d7176bd5fa0cada97be...HEAD)
-if [ x"$commit" != x"c2084e68866b7eaabd95f671319d3ee01e923b32" ] ; then
+commit=$(git rev-list --skip 1 --grep '^Bump copyright' 1aca5b98471765db50c91e03298e49bf7c08cdbc...HEAD)
+if [ x"$commit" != x"3ed17237af5b1ead6c394df5099bc2bc1f8392df" ] ; then
     echo -e "${RED}ERROR${NC}: This repository is insane."
     echo -e "Make sure you did fork from https://github.com/sysprog21/lab0-c recently."
     echo ""

traces/trace-03-ops.cmd

@@ -21,4 +21,4 @@ reverse
 rh z
 rh r
 rh r
-rh n
+rh n

traces/trace-06-ops.cmd

@@ -34,4 +34,4 @@ rh a
 rh b
 rh c
 rh a
-rh a
+rh a