frodovdr/log2ram
1
0
Fork 0
mirror of https://github.com/azlux/log2ram.git synced 2023-10-10 13:37:24 +02:00
Code Issues Projects Releases Wiki Activity

Reformatted and refactored some files

Browse Source
This commit is contained in:
Andreas Fendt 2022-12-01 13:58:54 +01:00
parent c21abf6994
commit e16ea0a4dd
6 changed files with 131 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build-packages.sh
View File

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

18
install.sh
View File

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

191
log2ram
View File

@ -9,18 +9,17 @@ fi
LOG_NAME='log2ram.log' LOG_NAME='log2ram.log'
NO_RSYNC=${USE_RSYNC#true} NO_RSYNC=${USE_RSYNC#true}
isSafe () { ## @fn is_safe()
## @brief Check if hdd log exists
is_safe() {
[ -d "$HDD_LOG" ] || echo "ERROR: $HDD_LOG/ doesn't exist! Can't sync." [ -d "$HDD_LOG" ] || echo "ERROR: $HDD_LOG/ doesn't exist! Can't sync."
[ -d "$HDD_LOG" ] || exit 1 [ -d "$HDD_LOG" ] || exit 1
} }
remountOriginal() { ## @fn sync_to_disk()
OPTION="$1" ## @brief Sync memory back to hard disk
mount -o remount,"$OPTION" "$HDD_LOG" sync_to_disk() {
} is_safe
syncToDisk () {
isSafe
if [ -z "${NO_RSYNC}" -a -x "$(command -v rsync)" ]; then 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" rsync -aXv --inplace --no-whole-file --delete-after "$RAM_LOG"/ "$HDD_LOG"/ 2>&1 | tee -a "$LOG2RAM_LOG"
@ -29,8 +28,10 @@ syncToDisk () {
fi fi
} }
syncFromDisk () { ## @fn sync_from_disk()
isSafe ## @brief Sync hard disk to memory
sync_from_disk() {
is_safe
TP_SIZE=$SIZE TP_SIZE=$SIZE
if [ "$ZL2R" = true ]; then if [ "$ZL2R" = true ]; then
@ -42,7 +43,7 @@ syncFromDisk () {
umount -l "$RAM_LOG"/ umount -l "$RAM_LOG"/
umount -l "$HDD_LOG"/ umount -l "$HDD_LOG"/
if [ "$MAIL" = true ]; then 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 fi
exit 1 exit 1
fi fi
@ -55,103 +56,105 @@ syncFromDisk () {
} }
wait_for () { ## @fn wait_for()
while ! findmnt "$1" > /dev/null; do ## @brief Wait for directory and create test file to make sure the directory exists
sleep 0.1 ## @param param1 path to the directory
done wait_for() {
WAIT_PATH="$1"
while [ ! -f "$1/log2ram.test" ]; do while ! findmnt "$WAIT_PATH" >/dev/null; do
touch "$1/log2ram.test"
sleep 0.1 sleep 0.1
done done
rm "$1/log2ram.test"
while [ ! -f "$WAIT_PATH/log2ram.test" ]; do
touch "$WAIT_PATH/log2ram.test"
sleep 0.1
done
rm "$WAIT_PATH/log2ram.test"
} }
createZramLogDrive () { ## @fn create_zram_log_drive()
# Check Zram Class created ## @brief Create zram log device
if [ ! -d "/sys/class/zram-control" ]; then create_zram_log_drive() {
modprobe zram # Check Zram Class created
RAM_DEV='0' if [ ! -d "/sys/class/zram-control" ]; then
else modprobe zram
RAM_DEV=$(cat /sys/class/zram-control/hot_add) RAM_DEV='0'
fi else
echo "$COMP_ALG" > "/sys/block/zram${RAM_DEV}/comp_algorithm" RAM_DEV=$(cat /sys/class/zram-control/hot_add)
echo "$LOG_DISK_SIZE" > "/sys/block/zram${RAM_DEV}/disksize" fi
echo "$SIZE" > "/sys/block/zram${RAM_DEV}/mem_limit" echo "$COMP_ALG" >"/sys/block/zram${RAM_DEV}/comp_algorithm"
mke2fs -t ext4 "/dev/zram${RAM_DEV}" echo "$LOG_DISK_SIZE" >"/sys/block/zram${RAM_DEV}/disksize"
} 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 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}"
make_log_dir [ -d "$HDD_LOG" ] || mkdir "$HDD_LOG"
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
createZramLogDrive create_zram_log_drive
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"
syncFromDisk sync_from_disk
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}"
syncToDisk sync_to_disk
#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}"
syncToDisk sync_to_disk
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 esac

1
log2ram.conf
View File

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

6
log2ram.service
View File

@ -9,9 +9,9 @@ IgnoreOnIsolate=yes
[Service] [Service]
Type=oneshot 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 TimeoutStartSec=120
RemainAfterExit=yes RemainAfterExit=yes

37
uninstall.sh
View File

@ -1,26 +1,25 @@
#!/usr/bin/env sh #!/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 fi
if [ "$(id -u)" -eq 0 ] if [ "$(id -u)" -eq 0 ]; then
then echo "Not apt installed. Remove will continue with this script..."
echo "Not apt installed. Remove will continue with this script..." systemctl stop log2ram.service log2ram-daily.timer
systemctl stop log2ram.service log2ram-daily.timer systemctl disable log2ram.service log2ram-daily.timer
systemctl disable log2ram.service log2ram-daily.timer rm -rf /etc/systemd/system/log2ram*
rm -rf /etc/systemd/system/log2ram* rm /usr/local/bin/log2ram
rm /usr/local/bin/log2ram rm /etc/log2ram.conf
rm /etc/log2ram.conf rm -f /etc/logrotate.d/log2ram
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 else
echo "You need to be ROOT (sudo can be used)" echo "You need to be ROOT (sudo can be used)"
fi fi