linux/inotify-info
1
0
Fork 0
Code Activity

Adding upstream version 0~20240209.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-05 15:16:24 +01:00
parent 19c5159728
commit d4f1a29c25
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
12 changed files with 2158 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
.github/workflows/ci.yaml vendored Normal file
View file

@ -0,0 +1,48 @@
---
name: test
on:
push:
pull_request:
concurrency:
# Cancels pending runs when a PR gets updated.
group: ${{ github.head_ref || github.run_id }}-${{ github.actor }}
cancel-in-progress: true
jobs:
build-with-gcc:
strategy:
matrix:
cfg: [debug, release]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: sudo apt-get install -y build-essential
- run: make CFG=${{ matrix.cfg}} -j$(nproc)
- run: _${{ matrix.cfg }}/inotify-info
build-with-zig:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/cache@v4
with:
key: zig-sdk-and-cache-${{ hashFiles('.github/workflows/ci.yaml') }}
path: ~/.cache/zig
- run: |
wget --progress=dot:mega \
https://ziglang.org/download/0.11.0/zig-linux-$(uname -m)-0.11.0.tar.xz
tar -xJf zig-linux-*.tar.xz
rm zig-linux-*.xz
mv zig-linux-* zig-sdk
- run: |
make -j$(nproc) \
CC="zig-sdk/zig cc -target $(uname -m)-linux-musl" \
CXX="zig-sdk/zig c++ -target $(uname -m)-linux-musl"
- run: _release/inotify-info
build-with-docker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: docker build -t inotify-info .
- run: docker run --rm --privileged -v /proc:/proc inotify-info

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
_debug/
_release/

25
Dockerfile Normal file
View file

@ -0,0 +1,25 @@
FROM alpine
# zig is installed from the upstream tarball, because:
# - as of writing, alpine has zig only in testing (which is cumbersome to use)
# - apk get zig pulls in libllvm, which is huge.
#
# Upstream tarball is statically linked, making it small and convenient to use.
RUN apk add make \
&& wget https://ziglang.org/download/0.11.0/zig-linux-$(uname -m)-0.11.0.tar.xz \
&& tar -xJf zig-linux-*.tar.xz \
&& rm zig-linux-*.xz \
&& mv zig-linux-* zig
WORKDIR inotify-info
COPY . .
RUN CC="/zig/zig cc -target $(uname -m)-linux-musl" \
CXX="/zig/zig c++ -target $(uname -m)-linux-musl" \
make
FROM scratch
COPY --from=0 /inotify-info/_release/inotify-info /inotify-info
ENTRYPOINT ["/inotify-info"]

23
LICENSE Normal file
View file

@ -0,0 +1,23 @@
The MIT License (MIT)
Copyright 2021 Michael Sartain
All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

111
Makefile Normal file
View file

@ -0,0 +1,111 @@
# $@: name of the target file (one before colon)
# $<: name of first prerequisite file (first one after colon)
# $^: names of all prerequisite files (space separated)
# $*: stem (bit which matches the % wildcard in rule definition)
#
# VAR = val: Normal setting - values within are recursively expand when var used.
# VAR := val: Setting of var with simple expansion of values inside - values are expanded at decl time.
# VAR ?= val: Set var only if it doesn't have a value.
# VAR += val: Append val to existing value (or set if var didn't exist).
# To use static analyzer:
# http://clang-analyzer.llvm.org/scan-build.html
# Ie:
# scan-build -k -V --use-analyzer ~/bin/clang make
NAME = inotify-info
CFG ?= release
ifeq ($(CFG), debug)
ASAN ?= 1
endif
LD = $(CC)
RM = rm -f
MKDIR = mkdir -p
VERBOSE ?= 0
COMPILER = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)
WARNINGS = -Wall -Wextra -Wpedantic -Wmissing-include-dirs -Wformat=2 -Wshadow
ifneq ($(COMPILER),clang)
# https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
WARNINGS += -Wsuggest-attribute=format -Wall
endif
CFLAGS = $(WARNINGS) -march=native -fno-exceptions -gdwarf-4 -g2 -ggnu-pubnames -gsplit-dwarf
CFLAGS += -D_LARGEFILE64_SOURCE=1 -D_FILE_OFFSET_BITS=64
CXXFLAGS = -fno-rtti -Woverloaded-virtual
LDFLAGS = -march=native -gdwarf-4 -g2 -Wl,--build-id=sha1
LIBS = -Wl,--no-as-needed -lm -ldl -lpthread -lstdc++
CFILES = \
inotify-info.cpp \
lfqueue/lfqueue.c
# Useful GCC address sanitizer checks not enabled by default
# https://kristerw.blogspot.com/2018/06/useful-gcc-address-sanitizer-checks-not.html
ifeq ($(ASAN), 1)
# https://gcc.gnu.org/gcc-5/changes.html
# -fsanitize=float-cast-overflow: check that the result of floating-point type to integer conversions do not overflow;
# -fsanitize=vptr: enable checking of C++ member function calls, member accesses and some conversions between pointers to base and derived classes, detect if the referenced object does not have the correct dynamic type.
ASAN_FLAGS = -fno-omit-frame-pointer -fno-optimize-sibling-calls
ASAN_FLAGS += -fsanitize=address # fast memory error detector (heap, stack, global buffer overflow, and use-after free)
ASAN_FLAGS += -fsanitize=leak # detect leaks
ASAN_FLAGS += -fsanitize=undefined # fast undefined behavior detector
ASAN_FLAGS += -fsanitize=float-divide-by-zero # detect floating-point division by zero;
ASAN_FLAGS += -fsanitize=bounds # enable instrumentation of array bounds and detect out-of-bounds accesses;
ASAN_FLAGS += -fsanitize=object-size # enable object size checking, detect various out-of-bounds accesses.
ASAN_FLAGS += -fsanitize=alignment # enable alignment checking, detect various misaligned objects;
CFLAGS += $(ASAN_FLAGS)
LDFLAGS += $(ASAN_FLAGS)
endif
ifeq ($(CFG), debug)
ODIR=_debug
CFLAGS += -O0 -DDEBUG
CFLAGS += -D_GLIBCXX_DEBUG -D_GLIBCXX_DEBUG_PEDANTIC -D_GLIBCXX_SANITIZE_VECTOR -D_LIBCPP_DEBUG=1 -D_LIBCPP_ENABLE_DEBUG_MODE=1
else
ODIR=_release
CFLAGS += -O2 -DNDEBUG
endif
PROJ = $(ODIR)/$(NAME)
$(info Building $(ODIR)/$(NAME)...)
ifeq ($(VERBOSE), 1)
VERBOSE_PREFIX=
else
VERBOSE_PREFIX=@
endif
C_OBJS = ${CFILES:%.c=${ODIR}/%.o}
OBJS = ${C_OBJS:%.cpp=${ODIR}/%.o}
all: $(PROJ)
$(ODIR)/$(NAME): $(OBJS)
@echo "Linking $@...";
$(VERBOSE_PREFIX)$(LD) $(LDFLAGS) $^ $(LIBS) -o $@
-include $(OBJS:.o=.d)
$(ODIR)/%.o: %.c Makefile
$(VERBOSE_PREFIX)echo "---- $< ----";
@$(MKDIR) $(dir $@)
$(VERBOSE_PREFIX)$(CC) -MMD -MP -std=gnu99 $(CFLAGS) -o $@ -c $<
$(ODIR)/%.o: %.cpp Makefile
$(VERBOSE_PREFIX)echo "---- $< ----";
@$(MKDIR) $(dir $@)
$(VERBOSE_PREFIX)$(CXX) -MMD -MP -std=c++11 $(CFLAGS) $(CXXFLAGS) -o $@ -c $<
.PHONY: clean
clean:
@echo Cleaning...
$(VERBOSE_PREFIX)$(RM) $(PROJ)
$(VERBOSE_PREFIX)$(RM) $(OBJS)
$(VERBOSE_PREFIX)$(RM) $(OBJS:.o=.d)
$(VERBOSE_PREFIX)$(RM) $(OBJS:.o=.dwo)

183
README.md Normal file
View file

@ -0,0 +1,183 @@
# inotify-info
> Easily track down the number of inotify watches, instances, and which files are being watched.
The Linux inotify system has a few issues [1][problem1][2][problem2] and it can be difficult to debug when you for instance run out of watches. Using this app should hopefully aid you in tracking down how many inotify watches, instances, and what files are being watched.
## Screenshot
![Alt text](images/inotify-info.png?raw=true "inotify-info")
## Build
```
$ make
Building _release/inotify-info...
---- inotify-info.cpp ----
---- lfqueue/lfqueue.c ----
Linking _release/inotify-info...
```
```
$ CFG=debug make
Building _debug/inotify-info...
---- inotify-info.cpp ----
---- lfqueue/lfqueue.c ----
Linking _debug/inotify-info...
```
Or you can build Docker image.
```sh
docker build . -t inotify-info
```
## Install
You are free to copy the resulting executable to any suitable location in your `$PATH`.
```
cp _release/inotify-info /usr/local/bin/
```
## Run (Prints Summary)
```
$ _release/inotify-info
------------------------------------------------------------------------------
INotify Limits:
max_queued_events: 16384
max_user_instances: 128
max_user_watches: 65536
------------------------------------------------------------------------------
Pid App Watches Instances
2632 systemd 23 3
2653 pulseaudio 2 2
2656 dbus-daemon 2 1
2987 dbus-daemon 1 1
3056 xfsettingsd 56 1
3068 xfdesktop 10 1
3072 wrapper-2.0 6 1
3091 xfce4-clipman 1 1
3099 xiccd 1 1
3343 xfce4-terminal 1 1
3997 xfce4-appfinder 11 1
4048 xdg-desktop-portal 1 1
4086 xdg-desktop-portal-gtk 56 1
205668 vivaldi-bin 8 1
205705 vivaldi-bin 2 1
------------------------------------------------------------------------------
Total inotify Watches: 181
Total inotify Instances: 18
------------------------------------------------------------------------------
```
## Run with Appname Filter
```
$ _release/inotify-info xfce4
------------------------------------------------------------------------------
INotify Limits:
max_queued_events: 16384
max_user_instances: 128
max_user_watches: 65536
------------------------------------------------------------------------------
Pid App Watches Instances
2632 systemd 23 3
2653 pulseaudio 2 2
2656 dbus-daemon 2 1
2987 dbus-daemon 1 1
3056 xfsettingsd 56 1
3068 xfdesktop 10 1
3072 wrapper-2.0 6 1
3091 xfce4-clipman 1 1
94111050 [10304h]
3099 xiccd 1 1
3343 xfce4-terminal 1 1
71048655 [10304h]
3997 xfce4-appfinder 11 1
94111468 [10304h] 15339430 [10304h] 14554799 [10304h] 70254617 [10304h] 70254684 [10304h] 16786993 [10304h] 14551253 [10304h] 14550430 [10304h] 70254647 [10304h] 70254646 [10304h]
92275589 [10304h]
4048 xdg-desktop-portal 1 1
4086 xdg-desktop-portal-gtk 56 1
205668 vivaldi-bin 8 1
205705 vivaldi-bin 2 1
------------------------------------------------------------------------------
Total inotify Watches: 181
Total inotify Instances: 18
------------------------------------------------------------------------------
Searching '/' for listed inodes... (8 threads)
14550430 [10304h] /usr/share/applications/
14551253 [10304h] /usr/local/share/
14554799 [10304h] /usr/share/xfce4/
15339430 [10304h] /usr/share/desktop-directories/
16786993 [10304h] /usr/share/xfce4/applications/
70254617 [10304h] /home/mikesart/.local/share/
70254646 [10304h] /home/mikesart/.config/menus/
70254647 [10304h] /home/mikesart/.config/menus/applications-merged/
70254684 [10304h] /home/mikesart/.local/share/applications/
71048655 [10304h] /home/mikesart/.config/xfce4/terminal/
92275589 [10304h] /etc/xdg/menus/
94111050 [10304h] /home/mikesart/.config/xfce4/panel/
94111468 [10304h] /home/mikesart/.cache/xfce4/xfce4-appfinder/
```
## Run with Specific Pid(s)
```
$ _release/inotify-info 3997
------------------------------------------------------------------------------
INotify Limits:
max_queued_events: 16384
max_user_instances: 128
max_user_watches: 65536
------------------------------------------------------------------------------
Pid App Watches Instances
2632 systemd 23 3
2653 pulseaudio 2 2
2656 dbus-daemon 2 1
2987 dbus-daemon 1 1
3056 xfsettingsd 56 1
3068 xfdesktop 10 1
3072 wrapper-2.0 6 1
3091 xfce4-clipman 1 1
3099 xiccd 1 1
3343 xfce4-terminal 1 1
3997 xfce4-appfinder 11 1
94111468 [10304h] 15339430 [10304h] 14554799 [10304h] 70254617 [10304h] 70254684 [10304h] 16786993 [10304h] 14551253 [10304h] 14550430 [10304h] 70254647 [10304h] 70254646 [10304h]
92275589 [10304h]
4048 xdg-desktop-portal 1 1
4086 xdg-desktop-portal-gtk 56 1
205668 vivaldi-bin 8 1
205705 vivaldi-bin 2 1
------------------------------------------------------------------------------
Total inotify Watches: 181
Total inotify Instances: 18
------------------------------------------------------------------------------
Searching '/' for listed inodes... (8 threads)
14550430 [10304h] /usr/share/applications/
14551253 [10304h] /usr/local/share/
14554799 [10304h] /usr/share/xfce4/
15339430 [10304h] /usr/share/desktop-directories/
16786993 [10304h] /usr/share/xfce4/applications/
70254617 [10304h] /home/mikesart/.local/share/
70254646 [10304h] /home/mikesart/.config/menus/
70254647 [10304h] /home/mikesart/.config/menus/applications-merged/
70254684 [10304h] /home/mikesart/.local/share/applications/
92275589 [10304h] /etc/xdg/menus/
94111468 [10304h] /home/mikesart/.cache/xfce4/xfce4-appfinder/
```
## Run on Docker
```sh
docker run --rm --privileged -v /proc:/proc inotify-info
```
## Run on Nix(OS)
```
nix run nixpkgs#inotify-info
```
## Credits
[lfqueue][lfqueue] is [BSD-2-Clause License][bsd]
[problem1]: https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc
[problem2]: https://unix.stackexchange.com/questions/15509/whos-consuming-my-inotify-resources
[lfqueue]: https://github.com/Taymindis/lfqueue
[bsd]: https://github.com/Taymindis/lfqueue/blob/master/LICENSE

BIN
images/inotify-info.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 52 KiB

1218
inotify-info.cpp Normal file
View file

File diff suppressed because it is too large Load diff

60
inotify-info.h Normal file
View file

@ -0,0 +1,60 @@
/*
* Copyright 2021 Michael Sartain
*
* All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#define RESET "\x1b[0m"
#define GRAY "\x1b[0;30m"
#define RED "\x1b[0;31m"
#define GREEN "\x1b[0;32m"
#define YELLOW "\x1b[0;33m"
#define BLUE "\x1b[0;34m"
#define MAGENTA "\x1b[0;35m"
#define CYAN "\x1b[0;36m"
#define WHITE "\x1b[0;37m"
#define BGRAY "\x1b[1;30m"
#define BRED "\x1b[1;31m"
#define BGREEN "\x1b[1;32m"
#define BYELLOW "\x1b[1;33m"
#define BBLUE "\x1b[1;34m"
#define BMAGENTA "\x1b[1;35m"
#define BCYAN "\x1b[1;36m"
#define BWHITE "\x1b[1;37m"
#define TO_STR( x ) #x
#define TO_STR_VALUE( x ) TO_STR( x )
#define ATTRIBUTE_PRINTF( _x, _y ) __attribute__( ( __format__( __printf__, _x, _y ) ) )
#define GCC_DIAG_STR( s ) #s
#define GCC_DIAG_JOINSTR( x, y ) GCC_DIAG_STR( x##y )
#define GCC_DIAG_DO_PRAGMA( x ) _Pragma( #x )
#define GCC_DIAG_PRAGMA( x ) GCC_DIAG_DO_PRAGMA( GCC diagnostic x )
#define GCC_DIAG_PUSH_OFF( x ) \
GCC_DIAG_PRAGMA( push ) \
GCC_DIAG_PRAGMA( ignored GCC_DIAG_JOINSTR( -W, x ) )
#define GCC_DIAG_POP() GCC_DIAG_PRAGMA( pop )
std::string string_formatv(const char *fmt, va_list ap) ATTRIBUTE_PRINTF(1, 0);
std::string string_format(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2);

25
lfqueue/LICENSE Normal file
View file

@ -0,0 +1,25 @@
BSD 2-Clause License
Copyright (c) 2018, Taymindis Woon
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

379
lfqueue/lfqueue.c Normal file
View file

@ -0,0 +1,379 @@
/*
*
* BSD 2-Clause License
*
* Copyright (c) 2018, Taymindis Woon
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#if defined __GNUC__ || defined __CYGWIN__ || defined __MINGW32__ || defined __APPLE__
#include <sys/time.h>
#include <unistd.h> // for usleep
#include <sched.h>
#define __LFQ_VAL_COMPARE_AND_SWAP __sync_val_compare_and_swap
#define __LFQ_BOOL_COMPARE_AND_SWAP __sync_bool_compare_and_swap
#define __LFQ_FETCH_AND_ADD __sync_fetch_and_add
#define __LFQ_ADD_AND_FETCH __sync_add_and_fetch
#define __LFQ_YIELD_THREAD sched_yield
#define __LFQ_SYNC_MEMORY __sync_synchronize
#else
#include <Windows.h>
#include <time.h>
#ifdef _WIN64
inline BOOL __SYNC_BOOL_CAS(LONG64 volatile *dest, LONG64 input, LONG64 comparand) {
return InterlockedCompareExchangeNoFence64(dest, input, comparand) == comparand;
}
#define __LFQ_VAL_COMPARE_AND_SWAP(dest, comparand, input) \
InterlockedCompareExchangeNoFence64((LONG64 volatile *)dest, (LONG64)input, (LONG64)comparand)
#define __LFQ_BOOL_COMPARE_AND_SWAP(dest, comparand, input) \
__SYNC_BOOL_CAS((LONG64 volatile *)dest, (LONG64)input, (LONG64)comparand)
#define __LFQ_FETCH_AND_ADD InterlockedExchangeAddNoFence64
#define __LFQ_ADD_AND_FETCH InterlockedAddNoFence64
#define __LFQ_SYNC_MEMORY MemoryBarrier
#else
#ifndef asm
#define asm __asm
#endif
inline BOOL __SYNC_BOOL_CAS(LONG volatile *dest, LONG input, LONG comparand) {
return InterlockedCompareExchangeNoFence(dest, input, comparand) == comparand;
}
#define __LFQ_VAL_COMPARE_AND_SWAP(dest, comparand, input) \
InterlockedCompareExchangeNoFence((LONG volatile *)dest, (LONG)input, (LONG)comparand)
#define __LFQ_BOOL_COMPARE_AND_SWAP(dest, comparand, input) \
__SYNC_BOOL_CAS((LONG volatile *)dest, (LONG)input, (LONG)comparand)
#define __LFQ_FETCH_AND_ADD InterlockedExchangeAddNoFence
#define __LFQ_ADD_AND_FETCH InterlockedAddNoFence
#define __LFQ_SYNC_MEMORY() asm mfence
#endif
#include <windows.h>
#define __LFQ_YIELD_THREAD SwitchToThread
#endif
#include "lfqueue.h"
#define DEF_LFQ_ASSIGNED_SPIN 2048
#if defined __GNUC__ || defined __CYGWIN__ || defined __MINGW32__ || defined __APPLE__
#define lfq_time_t long
#define lfq_get_curr_time(_time_sec) \
struct timeval _time_; \
gettimeofday(&_time_, NULL); \
*_time_sec = _time_.tv_sec
#define lfq_diff_time(_etime_, _stime_) _etime_ - _stime_
#else
#define lfq_time_t time_t
#define lfq_get_curr_time(_time_sec) time(_time_sec)
#define lfq_diff_time(_etime_, _stime_) difftime(_etime_, _stime_)
#endif
struct lfqueue_cas_node_s {
void * value;
struct lfqueue_cas_node_s *next, *nextfree;
lfq_time_t _deactivate_tm;
};
//static lfqueue_cas_node_t* __lfq_assigned(lfqueue_t *);
static void __lfq_recycle_free(lfqueue_t *, lfqueue_cas_node_t*);
static void __lfq_check_free(lfqueue_t *);
static void *_dequeue(lfqueue_t *);
static void *_single_dequeue(lfqueue_t *);
static int _enqueue(lfqueue_t *, void* );
static inline void* _lfqueue_malloc(__attribute__ ((unused)) void* pl, size_t sz) {
return malloc(sz);
}
static inline void _lfqueue_free(__attribute__ ((unused)) void* pl, void* ptr) {
free(ptr);
}
static void *
_dequeue(lfqueue_t *lfqueue) {
lfqueue_cas_node_t *head, *next;
void *val;
for (;;) {
head = lfqueue->head;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->head, head, head)) {
next = head->next;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->tail, head, head)) {
if (next == NULL) {
val = NULL;
goto _done;
}
}
else {
if (next) {
val = next->value;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->head, head, next)) {
break;
}
} else {
val = NULL;
goto _done;
}
}
}
}
__lfq_recycle_free(lfqueue, head);
_done:
// __asm volatile("" ::: "memory");
__LFQ_SYNC_MEMORY();
__lfq_check_free(lfqueue);
return val;
}
static void *
_single_dequeue(lfqueue_t *lfqueue) {
lfqueue_cas_node_t *head, *next;
void *val;
for (;;) {
head = lfqueue->head;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->head, head, head)) {
next = head->next;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->tail, head, head)) {
if (next == NULL) {
return NULL;
}
}
else {
if (next) {
val = next->value;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->head, head, next)) {
lfqueue->_free(lfqueue->pl, head);
break;
}
} else {
return NULL;
}
}
}
}
return val;
}
static int
_enqueue(lfqueue_t *lfqueue, void* value) {
lfqueue_cas_node_t *tail, *node;
node = (lfqueue_cas_node_t*) lfqueue->_malloc(lfqueue->pl, sizeof(lfqueue_cas_node_t));
if (node == NULL) {
perror("malloc");
return errno;
}
node->value = value;
node->next = NULL;
node->nextfree = NULL;
for (;;) {
__LFQ_SYNC_MEMORY();
tail = lfqueue->tail;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&tail->next, NULL, node)) {
// compulsory swap as tail->next is no NULL anymore, it has fenced on other thread
__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->tail, tail, node);
__lfq_check_free(lfqueue);
return 0;
}
}
/*It never be here*/
return -1;
}
static void
__lfq_recycle_free(lfqueue_t *lfqueue, lfqueue_cas_node_t* freenode) {
lfqueue_cas_node_t *freed;
do {
freed = lfqueue->move_free;
} while (!__LFQ_BOOL_COMPARE_AND_SWAP(&freed->nextfree, NULL, freenode) );
lfq_get_curr_time(&freenode->_deactivate_tm);
__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->move_free, freed, freenode);
}
static void
__lfq_check_free(lfqueue_t *lfqueue) {
lfq_time_t curr_time;
if (__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->in_free_mode, 0, 1)) {
lfq_get_curr_time(&curr_time);
lfqueue_cas_node_t *rtfree = lfqueue->root_free, *nextfree;
while ( rtfree && (rtfree != lfqueue->move_free) ) {
nextfree = rtfree->nextfree;
if ( lfq_diff_time(curr_time, rtfree->_deactivate_tm) > 2) {
// printf("%p\n", rtfree);
lfqueue->_free(lfqueue->pl, rtfree);
rtfree = nextfree;
} else {
break;
}
}
lfqueue->root_free = rtfree;
__LFQ_BOOL_COMPARE_AND_SWAP(&lfqueue->in_free_mode, 1, 0);
}
__LFQ_SYNC_MEMORY();
}
int
lfqueue_init(lfqueue_t *lfqueue) {
return lfqueue_init_mf(lfqueue, NULL, _lfqueue_malloc, _lfqueue_free);
}
int
lfqueue_init_mf(lfqueue_t *lfqueue, void* pl, lfqueue_malloc_fn lfqueue_malloc, lfqueue_free_fn lfqueue_free) {
lfqueue->_malloc = lfqueue_malloc;
lfqueue->_free = lfqueue_free;
lfqueue->pl = pl;
lfqueue_cas_node_t *base = lfqueue_malloc(pl, sizeof(lfqueue_cas_node_t));
lfqueue_cas_node_t *freebase = lfqueue_malloc(pl, sizeof(lfqueue_cas_node_t));
if (base == NULL || freebase == NULL) {
perror("malloc");
return errno;
}
base->value = NULL;
base->next = NULL;
base->nextfree = NULL;
base->_deactivate_tm = 0;
freebase->value = NULL;
freebase->next = NULL;
freebase->nextfree = NULL;
freebase->_deactivate_tm = 0;
lfqueue->head = lfqueue->tail = base; // Not yet to be free for first node only
lfqueue->root_free = lfqueue->move_free = freebase; // Not yet to be free for first node only
lfqueue->size = 0;
lfqueue->in_free_mode = 0;
return 0;
}
void
lfqueue_destroy(lfqueue_t *lfqueue) {
void* p;
while ((p = lfqueue_deq(lfqueue))) {
lfqueue->_free(lfqueue->pl, p);
}
// Clear the recycle chain nodes
lfqueue_cas_node_t *rtfree = lfqueue->root_free, *nextfree;
while (rtfree && (rtfree != lfqueue->move_free) ) {
nextfree = rtfree->nextfree;
lfqueue->_free(lfqueue->pl, rtfree);
rtfree = nextfree;
}
if (rtfree) {
lfqueue->_free(lfqueue->pl, rtfree);
}
lfqueue->_free(lfqueue->pl, lfqueue->tail); // Last free
lfqueue->size = 0;
}
int
lfqueue_enq(lfqueue_t *lfqueue, void *value) {
if (_enqueue(lfqueue, value)) {
return -1;
}
__LFQ_ADD_AND_FETCH(&lfqueue->size, 1);
return 0;
}
void*
lfqueue_deq(lfqueue_t *lfqueue) {
void *v;
if (//__LFQ_ADD_AND_FETCH(&lfqueue->size, 0) &&
(v = _dequeue(lfqueue))
) {
__LFQ_FETCH_AND_ADD(&lfqueue->size, -1);
return v;
}
return NULL;
}
void*
lfqueue_deq_must(lfqueue_t *lfqueue) {
void *v;
while ( !(v = _dequeue(lfqueue)) ) {
// Rest the thread for other thread, to avoid keep looping force
lfqueue_sleep(1);
}
__LFQ_FETCH_AND_ADD(&lfqueue->size, -1);
return v;
}
/**This is only applicable when only single thread consume only**/
void*
lfqueue_single_deq(lfqueue_t *lfqueue) {
void *v;
if (//__LFQ_ADD_AND_FETCH(&lfqueue->size, 0) &&
(v = _single_dequeue(lfqueue))
) {
__LFQ_FETCH_AND_ADD(&lfqueue->size, -1);
return v;
}
return NULL;
}
/**This is only applicable when only single thread consume only**/
void*
lfqueue_single_deq_must(lfqueue_t *lfqueue) {
void *v;
while ( !(v = _single_dequeue(lfqueue)) ) {
// Rest the thread for other thread, to avoid keep looping force
lfqueue_sleep(1);
}
__LFQ_FETCH_AND_ADD(&lfqueue->size, -1);
return v;
}
size_t
lfqueue_size(lfqueue_t *lfqueue) {
return __LFQ_ADD_AND_FETCH(&lfqueue->size, 0);
}
void
lfqueue_sleep(unsigned int milisec) {
#if defined __GNUC__ || defined __CYGWIN__ || defined __MINGW32__ || defined __APPLE__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wimplicit-function-declaration"
usleep(milisec * 1000);
#pragma GCC diagnostic pop
#else
Sleep(milisec);
#endif
}
#ifdef __cplusplus
}
#endif

84
lfqueue/lfqueue.h Normal file
View file

@ -0,0 +1,84 @@
/*
*
* BSD 2-Clause License
*
* Copyright (c) 2018, Taymindis Woon
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef LFQUEUE_H
#define LFQUEUE_H
#include <stdlib.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct lfqueue_cas_node_s lfqueue_cas_node_t;
typedef void* (*lfqueue_malloc_fn)(void*, size_t);
typedef void (*lfqueue_free_fn)(void*, void*);
#if defined __GNUC__ || defined __CYGWIN__ || defined __MINGW32__ || defined __APPLE__
#define lfq_bool_t int
#else
#ifdef _WIN64
#define lfq_bool_t int64_t
#else
#define lfq_bool_t int
#endif
#endif
typedef struct {
lfqueue_cas_node_t *head, *tail, *root_free, *move_free;
volatile size_t size;
volatile lfq_bool_t in_free_mode;
lfqueue_malloc_fn _malloc;
lfqueue_free_fn _free;
void *pl;
} lfqueue_t;
extern int lfqueue_init(lfqueue_t *lfqueue);
extern int lfqueue_init_mf(lfqueue_t *lfqueue, void* pl, lfqueue_malloc_fn lfqueue_malloc, lfqueue_free_fn lfqueue_free);
extern int lfqueue_enq(lfqueue_t *lfqueue, void *value);
extern void* lfqueue_deq(lfqueue_t *lfqueue);
extern void* lfqueue_single_deq(lfqueue_t *lfqueue);
/** loop until value been dequeue, it sleeps 1ms if not found to reduce cpu high usage **/
extern void* lfqueue_deq_must(lfqueue_t *lfqueue);
extern void* lfqueue_single_deq_must(lfqueue_t *lfqueue);
extern void lfqueue_destroy(lfqueue_t *lfqueue);
extern size_t lfqueue_size(lfqueue_t *lfqueue);
extern void lfqueue_sleep(unsigned int milisec);
#ifdef __cplusplus
}
#endif
#endif