build-packages.sh

@@ -19,6 +19,7 @@ new=$(echo $api | grep -Po '"tag_name": "\K.*?(?=")')
 # Remove potential leftovers from a previous build
 rm -rf "$DESTDIR" "$OUTDIR"
 
+
 ## log2ram
 # Create directory
 install -Dm 644 "$STARTDIR/log2ram.service" "$DESTDIR/etc/systemd/system/log2ram.service"

install.sh

@@ -1,13 +1,7 @@
 #!/usr/bin/env sh
 
-systemctl -q is-active log2ram && {
+systemctl -q is-active log2ram  && { echo "ERROR: log2ram service is still running. Please run \"sudo service log2ram stop\" to stop it."; exit 1; }
-    echo "ERROR: log2ram service is still running. Please run \"sudo service log2ram stop\" to stop it."
+[ "$(id -u)" -eq 0 ] || { echo "You need to be ROOT (sudo can be used)"; exit 1; }
-    exit 1
-}
-[ "$(id -u)" -eq 0 ] || {
-    echo "You need to be ROOT (sudo can be used)"
-    exit 1
-}
 
 # log2ram
 mkdir -p /usr/local/bin/
@@ -16,17 +10,17 @@ install -m 644 log2ram-daily.service /etc/systemd/system/log2ram-daily.service
 install -m 644 log2ram-daily.timer /etc/systemd/system/log2ram-daily.timer
 install -m 755 log2ram /usr/local/bin/log2ram
 if [ ! -f /etc/log2ram.conf ]; then
-    install -m 644 log2ram.conf /etc/log2ram.conf
+	install -m 644 log2ram.conf /etc/log2ram.conf
 fi
 install -m 644 uninstall.sh /usr/local/bin/uninstall-log2ram.sh
 systemctl enable log2ram.service log2ram-daily.timer
 
 # logrotate
 if [ -d /etc/logrotate.d ]; then
-    install -m 644 log2ram.logrotate /etc/logrotate.d/log2ram
+	install -m 644 log2ram.logrotate /etc/logrotate.d/log2ram
 else
-    echo "##### Directory /etc/logrotate.d does not exist. #####"
+	echo "##### Directory /etc/logrotate.d does not exist. #####"
-    echo "#####  Skipping log2ram.logrotate installation.  #####"
+	echo "#####  Skipping log2ram.logrotate installation.  #####"
 fi
 
 # Remove a previous log2ram version

log2ram

@@ -9,17 +9,18 @@ fi
 LOG_NAME='log2ram.log'
 NO_RSYNC=${USE_RSYNC#true}
 
-## @fn is_safe()
+isSafe () {
-## @brief Check if hdd log exists
-is_safe() {
     [ -d "$HDD_LOG" ] || echo "ERROR: $HDD_LOG/ doesn't exist! Can't sync."
     [ -d "$HDD_LOG" ] || exit 1
 }
 
-## @fn sync_to_disk()
+remountOriginal() {
-## @brief Sync memory back to hard disk
+    OPTION="$1"
-sync_to_disk() {
+    mount -o remount,"$OPTION" "$HDD_LOG"
-    is_safe
+}
+
+syncToDisk () {
+    isSafe
 
     if [ -z "${NO_RSYNC}" -a -x "$(command -v rsync)" ]; then
         rsync -aXv --inplace --no-whole-file --delete-after "$RAM_LOG"/ "$HDD_LOG"/ 2>&1 | tee -a "$LOG2RAM_LOG"
@@ -28,10 +29,8 @@ sync_to_disk() {
     fi
 }
 
-## @fn sync_from_disk()
+syncFromDisk () {
-## @brief Sync hard disk to memory
+    isSafe
-sync_from_disk() {
-    is_safe
 
     TP_SIZE=$SIZE
     if [ "$ZL2R" = true ]; then
@@ -43,7 +42,7 @@ sync_from_disk() {
         umount -l "$RAM_LOG"/
         umount -l "$HDD_LOG"/
         if [ "$MAIL" = true ]; then
-            echo "LOG2RAM : No place on RAM for \"$HDD_LOG/\" anymore, fallback on the disk" | mail -s 'Log2Ram Error' root
+            echo "LOG2RAM : No place on RAM for \"$HDD_LOG/\" anymore, fallback on the disk" | mail -s 'Log2Ram Error' root;
         fi
         exit 1
     fi
@@ -56,105 +55,103 @@ sync_from_disk() {
 
 }
 
-## @fn wait_for()
+wait_for () {
-## @brief Wait for directory and create test file to make sure the directory exists
+    while ! findmnt "$1" > /dev/null; do
-## @param param1 path to the directory
+      sleep 0.1
-wait_for() {
-    WAIT_PATH="$1"
-    while ! findmnt "$WAIT_PATH" >/dev/null; do
-        sleep 0.1
     done
     
-    while [ ! -f "$WAIT_PATH/log2ram.test" ]; do
+    while [ ! -f "$1/log2ram.test" ]; do
-        touch "$WAIT_PATH/log2ram.test"
+        touch "$1/log2ram.test"
         sleep 0.1
     done
-    rm "$WAIT_PATH/log2ram.test"
+    rm "$1/log2ram.test"
 }
 
-## @fn create_zram_log_drive()
+createZramLogDrive () {
-## @brief Create zram log device
+	# Check Zram Class created
-create_zram_log_drive() {
+	if [ ! -d "/sys/class/zram-control" ]; then
-    # Check Zram Class created
+		modprobe zram
-    if [ ! -d "/sys/class/zram-control" ]; then
+		RAM_DEV='0'
-        modprobe zram
+	else
-        RAM_DEV='0'
+		RAM_DEV=$(cat /sys/class/zram-control/hot_add)
-    else
+	fi
-        RAM_DEV=$(cat /sys/class/zram-control/hot_add)
+	echo "$COMP_ALG" > "/sys/block/zram${RAM_DEV}/comp_algorithm"
-    fi
+	echo "$LOG_DISK_SIZE" > "/sys/block/zram${RAM_DEV}/disksize"
-    echo "$COMP_ALG" >"/sys/block/zram${RAM_DEV}/comp_algorithm"
+	echo "$SIZE" > "/sys/block/zram${RAM_DEV}/mem_limit"
-    echo "$LOG_DISK_SIZE" >"/sys/block/zram${RAM_DEV}/disksize"
+	mke2fs -t ext4 "/dev/zram${RAM_DEV}"
-    echo "$SIZE" >"/sys/block/zram${RAM_DEV}/mem_limit"
+}
-    mke2fs -t ext4 "/dev/zram${RAM_DEV}"
+
+make_log_dir () {
+    [ -d "$HDD_LOG" ] || mkdir "$HDD_LOG"
 }
 
 case "$1" in
-start)
+    start)
-    IFS=';'
+        IFS=';'
-    for i in $PATH_DISK; do
+        for i in $PATH_DISK; do
-        # Skip the path if the folder doesn't exist
+            # Skip the path if the folder doesn't exist
-        [ ! -d "$i" ] && continue
+            [ ! -d "$i" ] && continue
             
-        PATH_FIRST_PART="${i%/*}"
+            PATH_FIRST_PART="${i%/*}"
-        PATH_LAST_PART="${i##/*/}"
+            PATH_LAST_PART="${i##/*/}"
-        RAM_LOG="$i"
+            RAM_LOG="$i"
-        HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
+            HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
-        LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
+            LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
 
-        [ -d "$HDD_LOG" ] || mkdir "$HDD_LOG"
+            make_log_dir
 
-        mount --bind "$RAM_LOG"/ "$HDD_LOG"/
+            mount --bind "$RAM_LOG"/ "$HDD_LOG"/
-        mount --make-private "$HDD_LOG"/
+            mount --make-private "$HDD_LOG"/
-        wait_for "$HDD_LOG"
+            wait_for "$HDD_LOG"
 
-        if [ "$ZL2R" = true ]; then
+            if [ "$ZL2R" = true ]; then
-            create_zram_log_drive
+                createZramLogDrive
-            mount -t ext4 -o nosuid,noexec,noatime,nodev,user=log2ram "/dev/zram${RAM_DEV}" "$RAM_LOG"/
+                mount -t ext4 -o nosuid,noexec,noatime,nodev,user=log2ram "/dev/zram${RAM_DEV}" "$RAM_LOG"/
-        else
+            else
-            mount -t tmpfs -o "nosuid,noexec,noatime,nodev,mode=0755,size=${SIZE}" log2ram "$RAM_LOG"/
+                mount -t tmpfs -o "nosuid,noexec,noatime,nodev,mode=0755,size=${SIZE}" log2ram "$RAM_LOG"/
-        fi
+            fi
-        wait_for "$RAM_LOG"
+            wait_for "$RAM_LOG"
-        sync_from_disk
+            syncFromDisk
-    done
+        done
-    exit 0
+        exit 0
-    ;;
+        ;;
 
-stop)
+    stop)
-    IFS=';'
+        IFS=';'
-    for i in $PATH_DISK; do
+        for i in $PATH_DISK; do
-        PATH_FIRST_PART="${i%/*}"
+            PATH_FIRST_PART="${i%/*}"
-        PATH_LAST_PART="${i##/*/}"
+            PATH_LAST_PART="${i##/*/}"
-        RAM_LOG="$i"
+            RAM_LOG="$i"
-        HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
+            HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
-        LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
+            LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
 
-        sync_to_disk
+            syncToDisk
-        #ZRAM_LOG=$(awk '$2 == "/var/log" {print $1}' /proc/mounts)
+            #ZRAM_LOG=$(awk '$2 == "/var/log" {print $1}' /proc/mounts)
-        #ZRAM_LOG=$(echo ${ZRAM_LOG} | grep -o -E '[0-9]+')
+            #ZRAM_LOG=$(echo ${ZRAM_LOG} | grep -o -E '[0-9]+')
-        umount -l "$RAM_LOG"/
+            umount -l "$RAM_LOG"/
-        umount -l "$HDD_LOG"/
+            umount -l "$HDD_LOG"/
-        # Unsure as even with Root permision denied
+            # Unsure as even with Root permision denied
-        #echo ${ZRAM_LOG} > /sys/class/zram-control/hot_remove
+            #echo ${ZRAM_LOG} > /sys/class/zram-control/hot_remove
-    done
+        done
-    exit 0
+        exit 0
-    ;;
+        ;;
 
-write)
+    write)
-    IFS=';'
+        IFS=';'
-    for i in $PATH_DISK; do
+        for i in $PATH_DISK; do
-        PATH_FIRST_PART="${i%/*}"
+            PATH_FIRST_PART="${i%/*}"
-        PATH_LAST_PART="${i##/*/}"
+            PATH_LAST_PART="${i##/*/}"
-        RAM_LOG="$i"
+            RAM_LOG="$i"
-        HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
+            HDD_LOG="${PATH_FIRST_PART}/hdd.${PATH_LAST_PART}"
-        LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
+            LOG2RAM_LOG="${RAM_LOG}/${LOG_NAME}"
 
-        sync_to_disk
+            syncToDisk
-    done
+        done
-    exit 0
+        exit 0
-    ;;
+        ;;
 
-*)
+    *)
-    echo 'Usage: log2ram {start|stop|write}' >&2
+        echo 'Usage: log2ram {start|stop|write}' >&2
-    exit 1
+        exit 1
-    ;;
+        ;;
 esac

log2ram.conf

@@ -36,3 +36,4 @@ COMP_ALG=lz4
 # lzo/lz4=2.1:1 compression ratio zlib=2.7:1 zstandard=2.9:1
 # Really a guestimate of a bit bigger than compression ratio whilst minimising 0.1% mem usage of disk size
 LOG_DISK_SIZE=100M
+

log2ram.service

@@ -9,9 +9,9 @@ IgnoreOnIsolate=yes
 
 [Service]
 Type=oneshot
-ExecStart=/usr/local/bin/log2ram start
+ExecStart= /usr/local/bin/log2ram start
-ExecStop=/usr/local/bin/log2ram stop
+ExecStop= /usr/local/bin/log2ram stop
-ExecReload=/usr/local/bin/log2ram write
+ExecReload= /usr/local/bin/log2ram write
 TimeoutStartSec=120
 RemainAfterExit=yes
 

uninstall.sh

@@ -1,25 +1,26 @@
 #!/usr/bin/env sh
 
-if dpkg -l log2ram 2>/dev/null; then
+if dpkg -l log2ram 2> /dev/null; then
-    echo "Please run : apt remove log2ram"
+  echo "Please run : apt remove log2ram"
-    exit 1
+  exit 1
 fi
 
-if [ "$(id -u)" -eq 0 ]; then
+if [ "$(id -u)" -eq 0 ]
-    echo "Not apt installed. Remove will continue with this script..."
+then
-    systemctl stop log2ram.service log2ram-daily.timer
+  echo "Not apt installed. Remove will continue with this script..."
-    systemctl disable log2ram.service log2ram-daily.timer
+  systemctl stop log2ram.service log2ram-daily.timer
-    rm -rf /etc/systemd/system/log2ram*
+  systemctl disable log2ram.service log2ram-daily.timer
-    rm /usr/local/bin/log2ram
+  rm -rf /etc/systemd/system/log2ram*
-    rm /etc/log2ram.conf
+  rm /usr/local/bin/log2ram
-    rm -f /etc/logrotate.d/log2ram
+  rm /etc/log2ram.conf
+  rm -f /etc/logrotate.d/log2ram
 
-    if [ -d /var/hdd.log ]; then
+  if [ -d /var/hdd.log ]; then
-        rm -r /var/hdd.log
+    rm -r /var/hdd.log
-    fi
+  fi
-    echo "Log2Ram is uninstalled, removing the uninstaller in progress"
+  echo "Log2Ram is uninstalled, removing the uninstaller in progress"
-    rm /usr/local/bin/uninstall-log2ram.sh
+  rm /usr/local/bin/uninstall-log2ram.sh
-    echo "##### Reboot isn't needed #####"
+  echo "##### Reboot isn't needed #####"
 else
-    echo "You need to be ROOT (sudo can be used)"
+  echo "You need to be ROOT (sudo can be used)"
 fi