diff --git a/.gitignore b/.gitignore index 2f28caf..7f42aa0 100644 --- a/.gitignore +++ b/.gitignore @@ -8,9 +8,3 @@ raytracer # Actual output image image.ppm - -# Profiler data -perf.* - -# Core dumps -core diff --git a/Makefile b/Makefile index c983530..a88ac5c 100644 --- a/Makefile +++ b/Makefile @@ -1,14 +1,8 @@ -INCLUDE=./include -LIBS=-pthread -lm -FLAGS=-Ofast -march=native -g -Wall -Wextra -Wpedantic - -raytracer: camera.hpp color.hpp hittable.hpp hittable_list.hpp main.cpp material.hpp random.h ray.hpp rtweekend.hpp sphere.hpp vec3.hpp $(INCLUDE)/Remotery.c $(INCLUDE)/Remotery.h - g++ $(FLAGS) -I$(INCLUDE) $(LIBS) main.cpp -o raytracer - -make debug: +raytracer: main.cpp vec3.hpp color.hpp ray.hpp + @g++ -g -Wall -Wextra -Wpedantic main.cpp -o raytracer image: raytracer - @./raytracer -o image.ppm - @if [ $$TERM = "xterm-kitty" ]; then\ + @./raytracer > image.ppm + @if [[ $$TERM = "xterm-kitty" ]]; then\ kitty icat image.ppm;\ fi diff --git a/camera.hpp b/camera.hpp deleted file mode 100644 index 5de6d7d..0000000 --- a/camera.hpp +++ /dev/null @@ -1,52 +0,0 @@ -#ifndef CAMERA_H -#define CAMERA_H - -#include "rtweekend.hpp" - -struct camera { - /* Attributes */ - point3 origin; - point3 lower_left_corner; - vec3 horizontal; - vec3 vertical; - vec3 u,v,w; - float lens_radius; - - /* Constructors */ - camera(point3 lookfrom, - point3 lookat, - vec3 vup, - float vfov, - float aspect_ratio, - float aperture, - float focus_dist) - { - float theta = degrees_to_radians(vfov); - float h = tan(theta/2); - float viewport_height = 2.0 * h; - float viewport_width = aspect_ratio * viewport_height; - - w = normalize(lookfrom - lookat); - u = normalize(cross(vup,w)); - v = cross(w, u); - - origin = lookfrom; - horizontal = focus_dist * viewport_width * u; - vertical = focus_dist * viewport_height * v; - lower_left_corner = origin - horizontal/2 - vertical/2 - focus_dist*w; - - lens_radius = aperture/2; - } - - /* Methods */ - - ray get_ray(float s, float t, int32_t thread_id = 0) const - { - vec3 rd = lens_radius * random_in_unit_disk(thread_id); - vec3 offset = u * rd.x + v * rd.y; - - return ray(origin + offset, lower_left_corner + s*horizontal + t*vertical - origin - offset); - }; -}; - -#endif diff --git a/color.hpp b/color.hpp index 3f940a6..2fdc497 100644 --- a/color.hpp +++ b/color.hpp @@ -1,35 +1,18 @@ #ifndef COLOR_H #define COLOR_H +#include "vec3.hpp" + #include #include -#include "rtweekend.hpp" - /* Writes color components as a space-delimited string of numbers in the range [0,255] */ -void write_color(FILE *fp, color c, uint32_t samples_per_pixel) +void write_color(FILE *fp, color c) { - float scale = 1.0 / samples_per_pixel; - - // Divide the color by the number of samples - float r = sqrt(c.x * scale); - float g = sqrt(c.y * scale); - float b = sqrt(c.z * scale); - - /* Write output */ - fprintf(fp, - "%d %d %d\n", - (uint8_t) (255 * clamp(r, 0, 1)), - (uint8_t) (255 * clamp(g, 0, 1)), - (uint8_t) (255 * clamp(b, 0, 1))); -} - -void write_image(color *image, uint64_t n, FILE *fp, uint32_t samples_per_pixel) -{ - for (int64_t i = n-1; i >= 0; --i) - { - write_color(fp, image[i], samples_per_pixel); - } + fprintf(fp, "%d %d %d\n", + (uint8_t) (255 * c.x), + (uint8_t) (255 * c.y), + (uint8_t) (255 * c.z)); } #endif diff --git a/hittable.hpp b/hittable.hpp deleted file mode 100644 index 7edb7c9..0000000 --- a/hittable.hpp +++ /dev/null @@ -1,12 +0,0 @@ -#ifndef HITTABLE_H -#define HITTABLE_H - -#include "rtweekend.hpp" -#include "material.hpp" - -/* Virtual class that represents objects who could collide against a ray */ -struct hittable { - virtual bool hit(const ray& r, float t_min, float t_max, hit_record& rec) const = 0; -}; - -#endif diff --git a/hittable_list.hpp b/hittable_list.hpp deleted file mode 100644 index 9c3366e..0000000 --- a/hittable_list.hpp +++ /dev/null @@ -1,52 +0,0 @@ -#ifndef HITTABLE_LIST_H -#define HITTABLE_LIST_H - -#include "hittable.hpp" -#include "sphere.hpp" - -#include -#include - -using std::shared_ptr; -using std::make_shared; - -template -struct hittable_list { - /* Attributes */ - std::vector objects; - - /* Constructors */ - hittable_list () {} - hittable_list(T object) { add(object); } - - /* Methods */ - void clear() { objects.clear(); } - void add (T h) { objects.push_back(h); } - - bool hit(const ray& r, float t_min, float t_max, hit_record& rec); -}; - -template -bool hittable_list::hit(const ray& r, float t_min, float t_max, hit_record& rec) -{ - rmt_ScopedCPUSample(HittableList_Hit, RMTSF_Aggregate); - hit_record temp_rec; - bool hit_anything = false; - float closest_so_far = t_max; - - uint32_t s = objects.size(); - for (uint32_t i = 0; i < s; ++i) - { - T *object = &objects[i]; - if (object->hit(r, t_min, closest_so_far, temp_rec)) - { - hit_anything = true; - closest_so_far = temp_rec.t; - rec = temp_rec; - } - } - - return hit_anything; -} - -#endif diff --git a/include/Remotery.c b/include/Remotery.c deleted file mode 100644 index 477ff38..0000000 --- a/include/Remotery.c +++ /dev/null @@ -1,8809 +0,0 @@ -// -// Copyright 2014-2018 Celtoys Ltd -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// - -/* -@Contents: - - @DEPS: External Dependencies - @TIMERS: Platform-specific timers - @TLS: Thread-Local Storage - @ATOMIC: Atomic Operations - @RNG: Random Number Generator - @LFSR: Galois Linear-feedback Shift Register - @VMBUFFER: Mirror Buffer using Virtual Memory for auto-wrap - @NEW: New/Delete operators with error values for simplifying object create/destroy - @SAFEC: Safe C Library excerpts - @OSTHREADS: Wrappers around OS-specific thread functions - @THREADS: Cross-platform thread object - @OBJALLOC: Reusable Object Allocator - @DYNBUF: Dynamic Buffer - @HASHTABLE: Integer pair hash map for inserts/finds. No removes for added simplicity. - @STRINGTABLE: Map from string hash to string offset in local buffer - @SOCKETS: Sockets TCP/IP Wrapper - @SHA1: SHA-1 Cryptographic Hash Function - @BASE64: Base-64 encoder - @MURMURHASH: Murmur-Hash 3 - @WEBSOCKETS: WebSockets - @MESSAGEQ: Multiple producer, single consumer message queue - @NETWORK: Network Server - @SAMPLE: Base Sample Description (CPU by default) - @SAMPLETREE: A tree of samples with their allocator - @TPROFILER: Thread Profiler data, storing both sampling and instrumentation results - @TGATHER: Thread Gatherer, periodically polling for newly created threads - @TSAMPLER: Sampling thread contexts - @REMOTERY: Remotery - @CUDA: CUDA event sampling - @D3D11: Direct3D 11 event sampling - @OPENGL: OpenGL event sampling - @METAL: Metal event sampling -*/ - -#define RMT_IMPL -#include "Remotery.h" - -#ifdef RMT_PLATFORM_WINDOWS -#pragma comment(lib, "ws2_32.lib") -#pragma comment(lib, "winmm.lib") -#endif - -#if RMT_ENABLED - -// Global settings -static rmtSettings g_Settings; -static rmtBool g_SettingsInitialized = RMT_FALSE; - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @DEPS: External Dependencies ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// clang-format off - -// -// Required CRT dependencies -// -#if RMT_USE_TINYCRT - - #include - #include - #include - - #define CreateFileMapping CreateFileMappingA - -#else - - #ifdef RMT_PLATFORM_MACOS - #include - #include - #include - #include - #else - #if !defined(__FreeBSD__) && !defined(__OpenBSD__) - #include - #endif - #endif - - #include - #include - #include - #include - #include - - #ifdef RMT_PLATFORM_WINDOWS - #include - #ifndef __MINGW32__ - #include - #endif - #undef min - #undef max - #include - #include - #include - #ifdef _XBOX_ONE - #include "xmem.h" - #endif - typedef long NTSTATUS; // winternl.h - #endif - - #ifdef RMT_PLATFORM_LINUX - #if defined(__FreeBSD__) || defined(__OpenBSD__) - #include - #else - #include - #endif - #endif - - #if defined(RMT_PLATFORM_POSIX) - #include - #include - #include - #include - #include - #include - #include - #include - #include - #endif - - #ifdef __MINGW32__ - #include - #endif - -#endif - -#if RMT_USE_CUDA - #include -#endif - -// clang-format on - -#if defined(_MSC_VER) && !defined(__clang__) - #define RMT_UNREFERENCED_PARAMETER(i) (i) -#else - #define RMT_UNREFERENCED_PARAMETER(i) (void)(1 ? (void)0 : ((void)i)) -#endif - -static rmtU8 minU8(rmtU8 a, rmtU8 b) -{ - return a < b ? a : b; -} -static rmtU16 maxU16(rmtU16 a, rmtU16 b) -{ - return a > b ? a : b; -} -static rmtU32 minU32(rmtU32 a, rmtU32 b) -{ - return a < b ? a : b; -} -static rmtS64 maxS64(rmtS64 a, rmtS64 b) -{ - return a > b ? a : b; -} - -// Memory management functions -static void* rmtMalloc(rmtU32 size) -{ - return g_Settings.malloc(g_Settings.mm_context, size); -} - -static void* rmtRealloc(void* ptr, rmtU32 size) -{ - return g_Settings.realloc(g_Settings.mm_context, ptr, size); -} - -static void rmtFree(void* ptr) -{ - g_Settings.free(g_Settings.mm_context, ptr); -} - -// File system functions -static FILE* rmtOpenFile(const char* filename, const char* mode) -{ -#if defined(RMT_PLATFORM_WINDOWS) && !RMT_USE_TINYCRT - FILE* fp; - return fopen_s(&fp, filename, mode) == 0 ? fp : NULL; -#else - return fopen(filename, mode); -#endif -} - -void rmtCloseFile(FILE* fp) -{ - if (fp != NULL) - { - fclose(fp); - } -} - -rmtBool rmtWriteFile(FILE* fp, const void* data, rmtU32 size) -{ - assert(fp != NULL); - return fwrite(data, size, 1, fp) == size ? RMT_TRUE : RMT_FALSE; -} - -#if RMT_USE_OPENGL -// DLL/Shared Library functions - -static void* rmtLoadLibrary(const char* path) -{ -#if defined(RMT_PLATFORM_WINDOWS) - return (void*)LoadLibraryA(path); -#elif defined(RMT_PLATFORM_POSIX) - return dlopen(path, RTLD_LOCAL | RTLD_LAZY); -#else - return NULL; -#endif -} - -static void rmtFreeLibrary(void* handle) -{ -#if defined(RMT_PLATFORM_WINDOWS) - FreeLibrary((HMODULE)handle); -#elif defined(RMT_PLATFORM_POSIX) - dlclose(handle); -#endif -} - -#if defined(RMT_PLATFORM_WINDOWS) -typedef FARPROC ProcReturnType; -#else -typedef void* ProcReturnType; -#endif - -static ProcReturnType rmtGetProcAddress(void* handle, const char* symbol) -{ -#if defined(RMT_PLATFORM_WINDOWS) - return GetProcAddress((HMODULE)handle, (LPCSTR)symbol); -#elif defined(RMT_PLATFORM_POSIX) - return dlsym(handle, symbol); -#endif -} - -#endif - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @TIMERS: Platform-specific timers ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// -// Get millisecond timer value that has only one guarantee: multiple calls are consistently comparable. -// On some platforms, even though this returns milliseconds, the timer may be far less accurate. -// -static rmtU32 msTimer_Get() -{ -#ifdef RMT_PLATFORM_WINDOWS - - return (rmtU32)GetTickCount(); - -#else - - clock_t time = clock(); - -// CLOCKS_PER_SEC is 128 on FreeBSD, causing div/0 -#if defined(__FreeBSD__) || defined(__OpenBSD__) - rmtU32 msTime = (rmtU32)(time * 1000 / CLOCKS_PER_SEC); -#else - rmtU32 msTime = (rmtU32)(time / (CLOCKS_PER_SEC / 1000)); -#endif - - return msTime; - -#endif -} - -// -// Micro-second accuracy high performance counter -// -#ifndef RMT_PLATFORM_WINDOWS -typedef rmtU64 LARGE_INTEGER; -#endif -typedef struct -{ - LARGE_INTEGER counter_start; - double counter_scale; -} usTimer; - -static void usTimer_Init(usTimer* timer) -{ -#if defined(RMT_PLATFORM_WINDOWS) - LARGE_INTEGER performance_frequency; - - assert(timer != NULL); - - // Calculate the scale from performance counter to microseconds - QueryPerformanceFrequency(&performance_frequency); - timer->counter_scale = 1000000.0 / performance_frequency.QuadPart; - - // Record the offset for each read of the counter - QueryPerformanceCounter(&timer->counter_start); - -#elif defined(RMT_PLATFORM_MACOS) - - mach_timebase_info_data_t nsScale; - mach_timebase_info(&nsScale); - const double ns_per_us = 1.0e3; - timer->counter_scale = (double)(nsScale.numer) / ((double)nsScale.denom * ns_per_us); - - timer->counter_start = mach_absolute_time(); - -#elif defined(RMT_PLATFORM_LINUX) - - struct timespec tv; - clock_gettime(CLOCK_REALTIME, &tv); - timer->counter_start = (rmtU64)(tv.tv_sec * (rmtU64)1000000) + (rmtU64)(tv.tv_nsec * 0.001); - -#endif -} - -static rmtU64 usTimer_Get(usTimer* timer) -{ -#if defined(RMT_PLATFORM_WINDOWS) - LARGE_INTEGER performance_count; - - assert(timer != NULL); - - // Read counter and convert to microseconds - QueryPerformanceCounter(&performance_count); - return (rmtU64)((performance_count.QuadPart - timer->counter_start.QuadPart) * timer->counter_scale); - -#elif defined(RMT_PLATFORM_MACOS) - - rmtU64 curr_time = mach_absolute_time(); - return (rmtU64)((curr_time - timer->counter_start) * timer->counter_scale); - -#elif defined(RMT_PLATFORM_LINUX) - - struct timespec tv; - clock_gettime(CLOCK_REALTIME, &tv); - return ((rmtU64)(tv.tv_sec * (rmtU64)1000000) + (rmtU64)(tv.tv_nsec * 0.001)) - timer->counter_start; - -#endif -} - -static void msSleep(rmtU32 time_ms) -{ -#ifdef RMT_PLATFORM_WINDOWS - Sleep(time_ms); -#elif defined(RMT_PLATFORM_POSIX) - usleep(time_ms * 1000); -#endif -} - -static struct tm* TimeDateNow() -{ - time_t time_now = time(NULL); - -#if defined(RMT_PLATFORM_WINDOWS) && !RMT_USE_TINYCRT - // Discard the thread-safety benefit of gmtime_s - static struct tm tm_now; - gmtime_s(&tm_now, &time_now); - return &tm_now; -#else - return gmtime(&time_now); -#endif -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @TLS: Thread-Local Storage ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#define TLS_INVALID_HANDLE 0xFFFFFFFF - -#if defined(RMT_PLATFORM_WINDOWS) -typedef rmtU32 rmtTLS; -#else -typedef pthread_key_t rmtTLS; -#endif - -static rmtError tlsAlloc(rmtTLS* handle) -{ - assert(handle != NULL); - -#if defined(RMT_PLATFORM_WINDOWS) - *handle = (rmtTLS)TlsAlloc(); - if (*handle == TLS_OUT_OF_INDEXES) - { - *handle = TLS_INVALID_HANDLE; - return RMT_ERROR_TLS_ALLOC_FAIL; - } -#elif defined(RMT_PLATFORM_POSIX) - if (pthread_key_create(handle, NULL) != 0) - { - *handle = TLS_INVALID_HANDLE; - return RMT_ERROR_TLS_ALLOC_FAIL; - } -#endif - - return RMT_ERROR_NONE; -} - -static void tlsFree(rmtTLS handle) -{ - assert(handle != TLS_INVALID_HANDLE); -#if defined(RMT_PLATFORM_WINDOWS) - TlsFree(handle); -#elif defined(RMT_PLATFORM_POSIX) - pthread_key_delete((pthread_key_t)handle); -#endif -} - -static void tlsSet(rmtTLS handle, void* value) -{ - assert(handle != TLS_INVALID_HANDLE); -#if defined(RMT_PLATFORM_WINDOWS) - TlsSetValue(handle, value); -#elif defined(RMT_PLATFORM_POSIX) - pthread_setspecific((pthread_key_t)handle, value); -#endif -} - -static void* tlsGet(rmtTLS handle) -{ - assert(handle != TLS_INVALID_HANDLE); -#if defined(RMT_PLATFORM_WINDOWS) - return TlsGetValue(handle); -#elif defined(RMT_PLATFORM_POSIX) - return pthread_getspecific((pthread_key_t)handle); -#endif -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @MUTEX: Mutexes ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#ifdef RMT_PLATFORM_WINDOWS -typedef CRITICAL_SECTION rmtMutex; -#else -typedef pthread_mutex_t rmtMutex; -#endif - -static void mtxInit(rmtMutex* mutex) -{ - assert(mutex != NULL); -#if defined(RMT_PLATFORM_WINDOWS) - InitializeCriticalSection(mutex); -#elif defined(RMT_PLATFORM_POSIX) - pthread_mutex_init(mutex, NULL); -#endif -} - -static void mtxLock(rmtMutex* mutex) -{ - assert(mutex != NULL); -#if defined(RMT_PLATFORM_WINDOWS) - EnterCriticalSection(mutex); -#elif defined(RMT_PLATFORM_POSIX) - pthread_mutex_lock(mutex); -#endif -} - -static void mtxUnlock(rmtMutex* mutex) -{ - assert(mutex != NULL); -#if defined(RMT_PLATFORM_WINDOWS) - LeaveCriticalSection(mutex); -#elif defined(RMT_PLATFORM_POSIX) - pthread_mutex_unlock(mutex); -#endif -} - -static void mtxDelete(rmtMutex* mutex) -{ - assert(mutex != NULL); -#if defined(RMT_PLATFORM_WINDOWS) - DeleteCriticalSection(mutex); -#elif defined(RMT_PLATFORM_POSIX) - pthread_mutex_destroy(mutex); -#endif -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @ATOMIC: Atomic Operations ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -static rmtBool AtomicCompareAndSwap(rmtU32 volatile* val, long old_val, long new_val) -{ -#if defined(RMT_PLATFORM_WINDOWS) && !defined(__MINGW32__) - return _InterlockedCompareExchange((long volatile*)val, new_val, old_val) == old_val ? RMT_TRUE : RMT_FALSE; -#elif defined(RMT_PLATFORM_POSIX) || defined(__MINGW32__) - return __sync_bool_compare_and_swap(val, old_val, new_val) ? RMT_TRUE : RMT_FALSE; -#endif -} - -static rmtBool AtomicCompareAndSwapPointer(long* volatile* ptr, long* old_ptr, long* new_ptr) -{ -#if defined(RMT_PLATFORM_WINDOWS) && !defined(__MINGW32__) -#ifdef _WIN64 - return _InterlockedCompareExchange64((__int64 volatile*)ptr, (__int64)new_ptr, (__int64)old_ptr) == (__int64)old_ptr - ? RMT_TRUE - : RMT_FALSE; -#else - return _InterlockedCompareExchange((long volatile*)ptr, (long)new_ptr, (long)old_ptr) == (long)old_ptr ? RMT_TRUE - : RMT_FALSE; -#endif -#elif defined(RMT_PLATFORM_POSIX) || defined(__MINGW32__) - return __sync_bool_compare_and_swap(ptr, old_ptr, new_ptr) ? RMT_TRUE : RMT_FALSE; -#endif -} - -// -// NOTE: Does not guarantee a memory barrier -// TODO: Make sure all platforms don't insert a memory barrier as this is only for stats -// Alternatively, add strong/weak memory order equivalents -// -static rmtS32 AtomicAdd(rmtS32 volatile* value, rmtS32 add) -{ -#if defined(RMT_PLATFORM_WINDOWS) && !defined(__MINGW32__) - return _InterlockedExchangeAdd((long volatile*)value, (long)add); -#elif defined(RMT_PLATFORM_POSIX) || defined(__MINGW32__) - return __sync_fetch_and_add(value, add); -#endif -} - -static void AtomicSub(rmtS32 volatile* value, rmtS32 sub) -{ - // Not all platforms have an implementation so just negate and add - AtomicAdd(value, -sub); -} - -static void CompilerWriteFence() -{ -#if defined(__clang__) - __asm__ volatile("" : : : "memory"); -#elif defined(RMT_PLATFORM_WINDOWS) && !defined(__MINGW32__) - _WriteBarrier(); -#else - asm volatile("" : : : "memory"); -#endif -} - -static void CompilerReadFence() -{ -#if defined(__clang__) - __asm__ volatile("" : : : "memory"); -#elif defined(RMT_PLATFORM_WINDOWS) && !defined(__MINGW32__) - _ReadBarrier(); -#else - asm volatile("" : : : "memory"); -#endif -} - -static rmtU32 LoadAcquire(rmtU32* volatile address) -{ - rmtU32 value = *address; - CompilerReadFence(); - return value; -} - -static long* LoadAcquirePointer(long* volatile* ptr) -{ - long* value = *ptr; - CompilerReadFence(); - return value; -} - -static void StoreRelease(rmtU32* volatile address, rmtU32 value) -{ - CompilerWriteFence(); - *address = value; -} - -static void StoreReleasePointer(long* volatile* ptr, long* value) -{ - CompilerWriteFence(); - *ptr = value; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @RNG: Random Number Generator ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// -// WELL: Well Equidistributed Long-period Linear -// These algorithms produce numbers with better equidistrib ution than MT19937 and improve upon “bit-mixing” properties. They are -// fast, come in many sizes, and produce higher quality random numbers. -// -// This implementation has a period of 2^512, or 10^154. -// -// Implementation from: Game Programming Gems 7, Random Number Generation Chris Lomont -// Documentation: http://www.lomont.org/Math/Papers/2008/Lomont_PRNG_2008.pdf -// - -// Global RNG state for now -// Far better than interfering with the user's rand() -#define Well512_StateSize 16 -static rmtU32 Well512_State[Well512_StateSize]; -static rmtU32 Well512_Index; - -static void Well512_Init(rmtU32 seed) -{ - rmtU32 i; - - // Generate initial state from seed - Well512_State[0] = seed; - for (i = 1; i < Well512_StateSize; i++) - { - rmtU32 prev = Well512_State[i - 1]; - Well512_State[i] = (1812433253 * (prev ^ (prev >> 30)) + i); - } - Well512_Index = 0; -} - -static rmtU32 Well512_RandomU32() -{ - rmtU32 a, b, c, d; - - a = Well512_State[Well512_Index]; - c = Well512_State[(Well512_Index + 13) & 15]; - b = a ^ c ^ (a << 16) ^ (c << 15); - c = Well512_State[(Well512_Index + 9) & 15]; - c ^= (c >> 11); - a = Well512_State[Well512_Index] = b ^ c; - d = a ^ ((a << 5) & 0xDA442D24UL); - Well512_Index = (Well512_Index + 15) & 15; - a = Well512_State[Well512_Index]; - Well512_State[Well512_Index] = a ^ b ^ d ^ (a << 2) ^ (b << 18) ^ (c << 28); - return Well512_State[Well512_Index]; -} - -static rmtU32 Well512_RandomOpenLimit(rmtU32 limit) -{ - // Using % to modulo with range is just masking out the higher bits, leaving a result that's objectively biased. - // Dividing by RAND_MAX is better but leads to increased repetition at low ranges due to very large bucket sizes. - // Instead use multiple passes with smaller bucket sizes, rejecting results that don't fit into this smaller range. - rmtU32 bucket_size = UINT_MAX / limit; - rmtU32 bucket_limit = bucket_size * limit; - rmtU32 r; - do - { - r = Well512_RandomU32(); - } while(r >= bucket_limit); - - return r / bucket_size; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @LFSR: Galois Linear-feedback Shift Register ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -static rmtU32 Log2i(rmtU32 x) -{ - static const rmtU32 MultiplyDeBruijnBitPosition[32] = - { - 0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, - 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31 - }; - - // First round down to one less than a power of two - x |= x >> 1; - x |= x >> 2; - x |= x >> 4; - x |= x >> 8; - x |= x >> 16; - - return MultiplyDeBruijnBitPosition[(rmtU32)(x * 0x07C4ACDDU) >> 27]; -} - -static rmtU32 GaloisLFSRMask(rmtU32 table_size_log2) -{ - // Taps for 4 to 8 bit ranges - static const rmtU32 XORMasks[] = - { - ((1 << 0) | (1 << 1)), // 2 - ((1 << 1) | (1 << 2)), // 3 - ((1 << 2) | (1 << 3)), // 4 - ((1 << 2) | (1 << 4)), // 5 - ((1 << 4) | (1 << 5)), // 6 - ((1 << 5) | (1 << 6)), // 7 - ((1 << 3) | (1 << 4) | (1 << 5) | (1 << 7)), // 8 - }; - - // Map table size to required XOR mask - assert(table_size_log2 >= 2); - assert(table_size_log2 <= 8); - return XORMasks[table_size_log2 - 2]; -} - -static rmtU32 GaloisLFSRNext(rmtU32 value, rmtU32 xor_mask) -{ - // Output bit - rmtU32 lsb = value & 1; - - // Apply the register shift - value >>= 1; - - // Apply toggle mask if the output bit is set - if (lsb != 0) - { - value ^= xor_mask; - } - - return value; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @NEW: New/Delete operators with error values for simplifying object create/destroy ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// Ensures the pointer is non-NULL, calls the destructor, frees memory and sets the pointer to NULL -#define Delete(type, obj) \ - if (obj != NULL) \ - { \ - type##_Destructor(obj); \ - rmtFree(obj); \ - obj = NULL; \ - } - -// New is implemented in terms of two begin/end macros -// New will allocate enough space for the object and call the constructor -// If allocation fails the constructor won't be called -// If the constructor fails, the destructor is called and memory is released -// NOTE: Use of sizeof() requires that the type be defined at the point of call -// This is a disadvantage over requiring only a custom Create function -#define BeginNew(type, obj) \ - { \ - obj = (type*)rmtMalloc(sizeof(type)); \ - if (obj == NULL) \ - { \ - error = RMT_ERROR_MALLOC_FAIL; \ - } \ - else \ - { - -#define EndNew(type, obj) \ - if (error != RMT_ERROR_NONE) \ - Delete(type, obj); \ - } \ - } - -// Specialisations for New with varying constructor parameter counts -#define New_0(type, obj) \ - BeginNew(type, obj); \ - error = type##_Constructor(obj); \ - EndNew(type, obj) -#define New_1(type, obj, a0) \ - BeginNew(type, obj); \ - error = type##_Constructor(obj, a0); \ - EndNew(type, obj) -#define New_2(type, obj, a0, a1) \ - BeginNew(type, obj); \ - error = type##_Constructor(obj, a0, a1); \ - EndNew(type, obj) -#define New_3(type, obj, a0, a1, a2) \ - BeginNew(type, obj); \ - error = type##_Constructor(obj, a0, a1, a2); \ - EndNew(type, obj) - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @VMBUFFER: Mirror Buffer using Virtual Memory for auto-wrap ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct VirtualMirrorBuffer -{ - // Page-rounded size of the buffer without mirroring - rmtU32 size; - - // Pointer to the first part of the mirror - // The second part comes directly after at ptr+size bytes - rmtU8* ptr; - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef _XBOX_ONE - size_t page_count; - size_t* page_mapping; -#else - HANDLE file_map_handle; -#endif -#endif - -} VirtualMirrorBuffer; - -#ifdef __ANDROID__ -/* - * Copyright (C) 2008 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#include -#include -#include -#include -#include -#include -#define ASHMEM_DEVICE "/dev/ashmem" - -/* - * ashmem_create_region - creates a new ashmem region and returns the file - * descriptor, or <0 on error - * - * `name' is an optional label to give the region (visible in /proc/pid/maps) - * `size' is the size of the region, in page-aligned bytes - */ -int ashmem_create_region(const char* name, size_t size) -{ - int fd, ret; - - fd = open(ASHMEM_DEVICE, O_RDWR); - if (fd < 0) - return fd; - - if (name) - { - char buf[ASHMEM_NAME_LEN] = {0}; - - strncpy(buf, name, sizeof(buf)); - buf[sizeof(buf) - 1] = 0; - ret = ioctl(fd, ASHMEM_SET_NAME, buf); - if (ret < 0) - goto error; - } - - ret = ioctl(fd, ASHMEM_SET_SIZE, size); - if (ret < 0) - goto error; - - return fd; - -error: - close(fd); - return ret; -} -#endif // __ANDROID__ - -static rmtError VirtualMirrorBuffer_Constructor(VirtualMirrorBuffer* buffer, rmtU32 size, int nb_attempts) -{ - static const rmtU32 k_64 = 64 * 1024; - RMT_UNREFERENCED_PARAMETER(nb_attempts); - -#ifdef RMT_PLATFORM_LINUX -#if defined(__FreeBSD__) || defined(__OpenBSD__) - char path[] = "/tmp/ring-buffer-XXXXXX"; -#else - char path[] = "/dev/shm/ring-buffer-XXXXXX"; -#endif - int file_descriptor; -#endif - - // Round up to page-granulation; the nearest 64k boundary for now - size = (size + k_64 - 1) / k_64 * k_64; - - // Set defaults - buffer->size = size; - buffer->ptr = NULL; -#ifdef RMT_PLATFORM_WINDOWS -#ifdef _XBOX_ONE - buffer->page_count = 0; - buffer->page_mapping = NULL; -#else - buffer->file_map_handle = INVALID_HANDLE_VALUE; -#endif -#endif - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef _XBOX_ONE - - // Xbox version based on Windows version and XDK reference - - buffer->page_count = size / k_64; - if (buffer->page_mapping) - { - free(buffer->page_mapping); - } - buffer->page_mapping = (size_t*)malloc(sizeof(ULONG) * buffer->page_count); - - while (nb_attempts-- > 0) - { - rmtU8* desired_addr; - - // Create a page mapping for pointing to its physical address with multiple virtual pages - if (!AllocateTitlePhysicalPages(GetCurrentProcess(), MEM_LARGE_PAGES, &buffer->page_count, - buffer->page_mapping)) - { - free(buffer->page_mapping); - buffer->page_mapping = NULL; - break; - } - - // Reserve two contiguous pages of virtual memory - desired_addr = (rmtU8*)VirtualAlloc(0, size * 2, MEM_RESERVE, PAGE_NOACCESS); - if (desired_addr == NULL) - break; - - // Release the range immediately but retain the address for the next sequence of code to - // try and map to it. In the mean-time some other OS thread may come along and allocate this - // address range from underneath us so multiple attempts need to be made. - VirtualFree(desired_addr, 0, MEM_RELEASE); - - // Immediately try to point both pages at the file mapping - if (MapTitlePhysicalPages(desired_addr, buffer->page_count, MEM_LARGE_PAGES, PAGE_READWRITE, - buffer->page_mapping) == desired_addr && - MapTitlePhysicalPages(desired_addr + size, buffer->page_count, MEM_LARGE_PAGES, PAGE_READWRITE, - buffer->page_mapping) == desired_addr + size) - { - buffer->ptr = desired_addr; - break; - } - - // Failed to map the virtual pages; cleanup and try again - FreeTitlePhysicalPages(GetCurrentProcess(), buffer->page_count, buffer->page_mapping); - buffer->page_mapping = NULL; - } - -#else - - // Windows version based on https://gist.github.com/rygorous/3158316 - - while (nb_attempts-- > 0) - { - rmtU8* desired_addr; - - // Create a file mapping for pointing to its physical address with multiple virtual pages - buffer->file_map_handle = CreateFileMapping(INVALID_HANDLE_VALUE, 0, PAGE_READWRITE, 0, size, 0); - if (buffer->file_map_handle == NULL) - break; - -#ifndef _UWP // NON-UWP Windows Desktop Version - - // Reserve two contiguous pages of virtual memory - desired_addr = (rmtU8*)VirtualAlloc(0, size * 2, MEM_RESERVE, PAGE_NOACCESS); - if (desired_addr == NULL) - break; - - // Release the range immediately but retain the address for the next sequence of code to - // try and map to it. In the mean-time some other OS thread may come along and allocate this - // address range from underneath us so multiple attempts need to be made. - VirtualFree(desired_addr, 0, MEM_RELEASE); - - // Immediately try to point both pages at the file mapping - if (MapViewOfFileEx(buffer->file_map_handle, FILE_MAP_ALL_ACCESS, 0, 0, size, desired_addr) == desired_addr && - MapViewOfFileEx(buffer->file_map_handle, FILE_MAP_ALL_ACCESS, 0, 0, size, desired_addr + size) == - desired_addr + size) - { - buffer->ptr = desired_addr; - break; - } - -#else // UWP - - // Implementation based on example from: - // https://docs.microsoft.com/en-us/windows/desktop/api/memoryapi/nf-memoryapi-virtualalloc2 - // - // Notes - // - just replaced the non-uwp functions by the uwp variants. - // - Both versions could be rewritten to not need the try-loop, see the example mentioned above. I just keep it - // as is for now. - // - Successfully tested on Hololens - desired_addr = (rmtU8*)VirtualAlloc2FromApp(NULL, NULL, 2 * size, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, - PAGE_NOACCESS, NULL, 0); - - // Split the placeholder region into two regions of equal size. - VirtualFree(desired_addr, size, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER); - - // Immediately try to point both pages at the file mapping. - if (MapViewOfFile3FromApp(buffer->file_map_handle, NULL, desired_addr, 0, size, MEM_REPLACE_PLACEHOLDER, - PAGE_READWRITE, NULL, 0) == desired_addr && - MapViewOfFile3FromApp(buffer->file_map_handle, NULL, desired_addr + size, 0, size, MEM_REPLACE_PLACEHOLDER, - PAGE_READWRITE, NULL, 0) == desired_addr + size) - { - buffer->ptr = desired_addr; - break; - } -#endif - // Failed to map the virtual pages; cleanup and try again - CloseHandle(buffer->file_map_handle); - buffer->file_map_handle = NULL; - } - -#endif // _XBOX_ONE - -#endif - -#ifdef RMT_PLATFORM_MACOS - - // - // Mac version based on https://github.com/mikeash/MAMirroredQueue - // - // Copyright (c) 2010, Michael Ash - // 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. - // Neither the name of Michael Ash nor the names of its contributors may be used to endorse or promote products - // derived from this software without specific prior written permission. - // - // 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. - // - - while (nb_attempts-- > 0) - { - vm_prot_t cur_prot, max_prot; - kern_return_t mach_error; - rmtU8* ptr = NULL; - rmtU8* target = NULL; - - // Allocate 2 contiguous pages of virtual memory - if (vm_allocate(mach_task_self(), (vm_address_t*)&ptr, size * 2, VM_FLAGS_ANYWHERE) != KERN_SUCCESS) - break; - - // Try to deallocate the last page, leaving its virtual memory address free - target = ptr + size; - if (vm_deallocate(mach_task_self(), (vm_address_t)target, size) != KERN_SUCCESS) - { - vm_deallocate(mach_task_self(), (vm_address_t)ptr, size * 2); - break; - } - - // Attempt to remap the page just deallocated to the buffer again - mach_error = vm_remap(mach_task_self(), (vm_address_t*)&target, size, - 0, // mask - 0, // anywhere - mach_task_self(), (vm_address_t)ptr, - 0, // copy - &cur_prot, &max_prot, VM_INHERIT_COPY); - - if (mach_error == KERN_NO_SPACE) - { - // Failed on this pass, cleanup and make another attempt - if (vm_deallocate(mach_task_self(), (vm_address_t)ptr, size) != KERN_SUCCESS) - break; - } - - else if (mach_error == KERN_SUCCESS) - { - // Leave the loop on success - buffer->ptr = ptr; - break; - } - - else - { - // Unknown error, can't recover - vm_deallocate(mach_task_self(), (vm_address_t)ptr, size); - break; - } - } - -#endif - -#ifdef RMT_PLATFORM_LINUX - - // Linux version based on now-defunct Wikipedia section - // http://en.wikipedia.org/w/index.php?title=Circular_buffer&oldid=600431497 - -#ifdef __ANDROID__ - file_descriptor = ashmem_create_region("remotery_shm", size * 2); - if (file_descriptor < 0) - { - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - } -#else - // Create a unique temporary filename in the shared memory folder - file_descriptor = mkstemp(path); - if (file_descriptor < 0) - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - - // Delete the name - if (unlink(path)) - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - - // Set the file size to twice the buffer size - // TODO: this 2x behaviour can be avoided with similar solution to Win/Mac - if (ftruncate(file_descriptor, size * 2)) - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - -#endif - // Map 2 contiguous pages - buffer->ptr = (rmtU8*)mmap(NULL, size * 2, PROT_NONE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0); - if (buffer->ptr == MAP_FAILED) - { - buffer->ptr = NULL; - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - } - - // Point both pages to the same memory file - if (mmap(buffer->ptr, size, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED, file_descriptor, 0) != buffer->ptr || - mmap(buffer->ptr + size, size, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED, file_descriptor, 0) != - buffer->ptr + size) - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - -#endif - - // Cleanup if exceeded number of attempts or failed - if (buffer->ptr == NULL) - return RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL; - - return RMT_ERROR_NONE; -} - -static void VirtualMirrorBuffer_Destructor(VirtualMirrorBuffer* buffer) -{ - assert(buffer != 0); - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef _XBOX_ONE - if (buffer->page_mapping != NULL) - { - VirtualFree(buffer->ptr, 0, MEM_DECOMMIT); // needed in conjunction with FreeTitlePhysicalPages - FreeTitlePhysicalPages(GetCurrentProcess(), buffer->page_count, buffer->page_mapping); - free(buffer->page_mapping); - buffer->page_mapping = NULL; - } -#else - if (buffer->file_map_handle != NULL) - { - // FIXME, don't we need to unmap the file views obtained in VirtualMirrorBuffer_Constructor, both for - // uwp/non-uwp See example - // https://docs.microsoft.com/en-us/windows/desktop/api/memoryapi/nf-memoryapi-virtualalloc2 - - CloseHandle(buffer->file_map_handle); - buffer->file_map_handle = NULL; - } -#endif -#endif - -#ifdef RMT_PLATFORM_MACOS - if (buffer->ptr != NULL) - vm_deallocate(mach_task_self(), (vm_address_t)buffer->ptr, buffer->size * 2); -#endif - -#ifdef RMT_PLATFORM_LINUX - if (buffer->ptr != NULL) - munmap(buffer->ptr, buffer->size * 2); -#endif - - buffer->ptr = NULL; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @SAFEC: Safe C Library excerpts - http://sourceforge.net/projects/safeclib/ ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -/*------------------------------------------------------------------ - * - * November 2008, Bo Berry - * - * Copyright (c) 2008-2011 by Cisco Systems, Inc - * 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. - *------------------------------------------------------------------ - */ - -// NOTE: Microsoft also has its own version of these functions so I'm do some hacky PP to remove them -#define strnlen_s strnlen_s_safe_c -#define strncat_s strncat_s_safe_c -#define strcpy_s strcpy_s_safe_c - -#define RSIZE_MAX_STR (4UL << 10) /* 4KB */ -#define RCNEGATE(x) x - -#define EOK (0) -#define ESNULLP (400) /* null ptr */ -#define ESZEROL (401) /* length is zero */ -#define ESLEMAX (403) /* length exceeds max */ -#define ESOVRLP (404) /* overlap undefined */ -#define ESNOSPC (406) /* not enough space for s2 */ -#define ESUNTERM (407) /* unterminated string */ -#define ESNOTFND (409) /* not found */ - -#ifndef _ERRNO_T_DEFINED -#define _ERRNO_T_DEFINED -typedef int errno_t; -#endif - -// rsize_t equivalent without going to the hassle of detecting if a platform has implemented C11/K3.2 -typedef unsigned int r_size_t; - -static r_size_t strnlen_s(const char* dest, r_size_t dmax) -{ - r_size_t count; - - if (dest == NULL) - { - return RCNEGATE(0); - } - - if (dmax == 0) - { - return RCNEGATE(0); - } - - if (dmax > RSIZE_MAX_STR) - { - return RCNEGATE(0); - } - - count = 0; - while (*dest && dmax) - { - count++; - dmax--; - dest++; - } - - return RCNEGATE(count); -} - -static errno_t strstr_s(char* dest, r_size_t dmax, const char* src, r_size_t slen, char** substring) -{ - r_size_t len; - r_size_t dlen; - int i; - - if (substring == NULL) - { - return RCNEGATE(ESNULLP); - } - *substring = NULL; - - if (dest == NULL) - { - return RCNEGATE(ESNULLP); - } - - if (dmax == 0) - { - return RCNEGATE(ESZEROL); - } - - if (dmax > RSIZE_MAX_STR) - { - return RCNEGATE(ESLEMAX); - } - - if (src == NULL) - { - return RCNEGATE(ESNULLP); - } - - if (slen == 0) - { - return RCNEGATE(ESZEROL); - } - - if (slen > RSIZE_MAX_STR) - { - return RCNEGATE(ESLEMAX); - } - - /* - * src points to a string with zero length, or - * src equals dest, return dest - */ - if (*src == '\0' || dest == src) - { - *substring = dest; - return RCNEGATE(EOK); - } - - while (*dest && dmax) - { - i = 0; - len = slen; - dlen = dmax; - - while (src[i] && dlen) - { - - /* not a match, not a substring */ - if (dest[i] != src[i]) - { - break; - } - - /* move to the next char */ - i++; - len--; - dlen--; - - if (src[i] == '\0' || !len) - { - *substring = dest; - return RCNEGATE(EOK); - } - } - dest++; - dmax--; - } - - /* - * substring was not found, return NULL - */ - *substring = NULL; - return RCNEGATE(ESNOTFND); -} - -static errno_t strncat_s(char* dest, r_size_t dmax, const char* src, r_size_t slen) -{ - const char* overlap_bumper; - - if (dest == NULL) - { - return RCNEGATE(ESNULLP); - } - - if (src == NULL) - { - return RCNEGATE(ESNULLP); - } - - if (slen > RSIZE_MAX_STR) - { - return RCNEGATE(ESLEMAX); - } - - if (dmax == 0) - { - return RCNEGATE(ESZEROL); - } - - if (dmax > RSIZE_MAX_STR) - { - return RCNEGATE(ESLEMAX); - } - - /* hold base of dest in case src was not copied */ - - if (dest < src) - { - overlap_bumper = src; - - /* Find the end of dest */ - while (*dest != '\0') - { - - if (dest == overlap_bumper) - { - return RCNEGATE(ESOVRLP); - } - - dest++; - dmax--; - if (dmax == 0) - { - return RCNEGATE(ESUNTERM); - } - } - - while (dmax > 0) - { - if (dest == overlap_bumper) - { - return RCNEGATE(ESOVRLP); - } - - /* - * Copying truncated before the source null is encountered - */ - if (slen == 0) - { - *dest = '\0'; - return RCNEGATE(EOK); - } - - *dest = *src; - if (*dest == '\0') - { - return RCNEGATE(EOK); - } - - dmax--; - slen--; - dest++; - src++; - } - } - else - { - overlap_bumper = dest; - - /* Find the end of dest */ - while (*dest != '\0') - { - - /* - * NOTE: no need to check for overlap here since src comes first - * in memory and we're not incrementing src here. - */ - dest++; - dmax--; - if (dmax == 0) - { - return RCNEGATE(ESUNTERM); - } - } - - while (dmax > 0) - { - if (src == overlap_bumper) - { - return RCNEGATE(ESOVRLP); - } - - /* - * Copying truncated - */ - if (slen == 0) - { - *dest = '\0'; - return RCNEGATE(EOK); - } - - *dest = *src; - if (*dest == '\0') - { - return RCNEGATE(EOK); - } - - dmax--; - slen--; - dest++; - src++; - } - } - - /* - * the entire src was not copied, so the string will be nulled. - */ - return RCNEGATE(ESNOSPC); -} - -errno_t strcpy_s(char* dest, r_size_t dmax, const char* src) -{ - const char* overlap_bumper; - - if (dest == NULL) - { - return RCNEGATE(ESNULLP); - } - - if (dmax == 0) - { - return RCNEGATE(ESZEROL); - } - - if (dmax > RSIZE_MAX_STR) - { - return RCNEGATE(ESLEMAX); - } - - if (src == NULL) - { - *dest = '\0'; - return RCNEGATE(ESNULLP); - } - - if (dest == src) - { - return RCNEGATE(EOK); - } - - if (dest < src) - { - overlap_bumper = src; - - while (dmax > 0) - { - if (dest == overlap_bumper) - { - return RCNEGATE(ESOVRLP); - } - - *dest = *src; - if (*dest == '\0') - { - return RCNEGATE(EOK); - } - - dmax--; - dest++; - src++; - } - } - else - { - overlap_bumper = dest; - - while (dmax > 0) - { - if (src == overlap_bumper) - { - return RCNEGATE(ESOVRLP); - } - - *dest = *src; - if (*dest == '\0') - { - return RCNEGATE(EOK); - } - - dmax--; - dest++; - src++; - } - } - - /* - * the entire src must have been copied, if not reset dest - * to null the string. - */ - return RCNEGATE(ESNOSPC); -} - -#if !(defined(RMT_PLATFORM_LINUX) && RMT_USE_POSIX_THREADNAMES) - -/* very simple integer to hex */ -static const char* hex_encoding_table = "0123456789ABCDEF"; - -static void itoahex_s(char* dest, r_size_t dmax, rmtS32 value) -{ - r_size_t len; - rmtS32 halfbytepos; - - halfbytepos = 8; - - /* strip leading 0's */ - while (halfbytepos > 1) - { - --halfbytepos; - if (value >> (4 * halfbytepos) & 0xF) - { - ++halfbytepos; - break; - } - } - - len = 0; - while (len + 1 < dmax && halfbytepos > 0) - { - --halfbytepos; - dest[len] = hex_encoding_table[value >> (4 * halfbytepos) & 0xF]; - ++len; - } - - if (len < dmax) - { - dest[len] = 0; - } -} - -static const char* itoa_s(rmtS32 value) -{ - static char temp_dest[12] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }; - int pos = 10; - - // Work back with the absolute value - rmtS32 abs_value = abs(value); - while (abs_value > 0) - { - temp_dest[pos--] = '0' + (abs_value % 10); - abs_value /= 10; - } - - // Place the negative - if (value < 0) - { - temp_dest[pos--] = '-'; - } - - return temp_dest + pos + 1; -} - -#endif - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @OSTHREADS: Wrappers around OS-specific thread functions ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef rmtU64 rmtThreadId; - -#ifdef RMT_PLATFORM_WINDOWS -typedef HANDLE rmtThreadHandle; -#else -typedef pthread_t rmtThreadHandle; -#endif - -#ifdef RMT_PLATFORM_WINDOWS -typedef CONTEXT rmtCpuContext; -#else -typedef int rmtCpuContext; -#endif - -static rmtU32 rmtGetNbProcessors() -{ -#ifdef RMT_PLATFORM_WINDOWS - SYSTEM_INFO system_info; - GetSystemInfo(&system_info); - return system_info.dwNumberOfProcessors; -#else - // TODO: get_nprocs_conf / get_nprocs - return 0; -#endif -} - -static rmtThreadId rmtGetCurrentThreadId() -{ -#ifdef RMT_PLATFORM_WINDOWS - return GetCurrentThreadId(); -#else - return (rmtThreadId)pthread_self(); -#endif -} - -static rmtBool rmtSuspendThread(rmtThreadHandle thread_handle) -{ -#ifdef RMT_PLATFORM_WINDOWS - // SuspendThread is an async call to the scheduler and upon return the thread is not guaranteed to be suspended. - // Calling GetThreadContext will serialise that. - // See: https://github.com/mono/mono/blob/master/mono/utils/mono-threads-windows.c#L203 - return SuspendThread(thread_handle) == 0 ? RMT_TRUE : RMT_FALSE; -#else - return RMT_FALSE; -#endif -} - -static void rmtResumeThread(rmtThreadHandle thread_handle) -{ -#ifdef RMT_PLATFORM_WINDOWS - ResumeThread(thread_handle); -#endif -} - -#ifdef RMT_PLATFORM_WINDOWS -#ifndef CONTEXT_EXCEPTION_REQUEST -// These seem to be guarded by a _AMD64_ macro in winnt.h, which doesn't seem to be defined in older MSVC compilers. -// Which makes sense given this was a post-Vista/Windows 7 patch around errors in the WoW64 context switch. -// This bug was never fixed in the OS so defining these will only get this code to compile on Old Windows systems, with no -// guarantee of being stable at runtime. -#define CONTEXT_EXCEPTION_ACTIVE 0x8000000L -#define CONTEXT_SERVICE_ACTIVE 0x10000000L -#define CONTEXT_EXCEPTION_REQUEST 0x40000000L -#define CONTEXT_EXCEPTION_REPORTING 0x80000000L -#endif -#endif - -static rmtBool rmtGetUserModeThreadContext(rmtThreadHandle thread, rmtCpuContext* context) -{ -#ifdef RMT_PLATFORM_WINDOWS - DWORD kernel_mode_mask; - - // Request thread context with exception reporting - context->ContextFlags = CONTEXT_CONTROL | CONTEXT_INTEGER | CONTEXT_EXCEPTION_REQUEST; - if (GetThreadContext(thread, context) == 0) - { - return RMT_FALSE; - } - - // Context on WoW64 is only valid and can only be set if the thread isn't in kernel mode - // Typical reference to this appears to be: http://zachsaw.blogspot.com/2010/11/wow64-bug-getthreadcontext-may-return.html - // Confirmed by MS here: https://social.msdn.microsoft.com/Forums/vstudio/en-US/aa176c36-6624-4776-9380-1c9cf37a314e/getthreadcontext-returns-stale-register-values-on-wow64?forum=windowscompatibility - kernel_mode_mask = CONTEXT_EXCEPTION_REPORTING | CONTEXT_EXCEPTION_ACTIVE | CONTEXT_SERVICE_ACTIVE; - return (context->ContextFlags & kernel_mode_mask) == CONTEXT_EXCEPTION_REPORTING ? RMT_TRUE : RMT_FALSE; -#else - return RMT_FALSE; -#endif -} - -static void rmtSetThreadContext(rmtThreadHandle thread_handle, rmtCpuContext* context) -{ -#ifdef RMT_PLATFORM_WINDOWS - SetThreadContext(thread_handle, context); -#endif -} - -static rmtError rmtOpenThreadHandle(rmtThreadId thread_id, rmtThreadHandle* out_thread_handle) -{ -#ifdef RMT_PLATFORM_WINDOWS - // Open the thread with required access rights to get the thread handle - *out_thread_handle = OpenThread(THREAD_QUERY_INFORMATION | THREAD_SUSPEND_RESUME | THREAD_SET_CONTEXT | THREAD_GET_CONTEXT, FALSE, thread_id); - if (*out_thread_handle == NULL) - { - return RMT_ERROR_OPEN_THREAD_HANDLE_FAIL; - } -#endif - - return RMT_ERROR_NONE; -} - -static void rmtCloseThreadHandle(rmtThreadHandle thread_handle) -{ -#ifdef RMT_PLATFORM_WINDOWS - if (thread_handle != NULL) - { - CloseHandle(thread_handle); - } -#endif -} - -#ifdef RMT_PLATFORM_WINDOWS -DWORD_PTR GetThreadStartAddress(rmtThreadHandle thread_handle) -{ - // Get NtQueryInformationThread from ntdll - HMODULE ntdll = GetModuleHandleA("ntdll.dll"); - if (ntdll != NULL) - { - typedef NTSTATUS (WINAPI *NTQUERYINFOMATIONTHREAD)(HANDLE, LONG, PVOID, ULONG, PULONG); - NTQUERYINFOMATIONTHREAD NtQueryInformationThread = (NTQUERYINFOMATIONTHREAD)GetProcAddress(ntdll, "NtQueryInformationThread"); - - // Use it to query the start address - DWORD_PTR start_address; - NTSTATUS status = NtQueryInformationThread(thread_handle, 9, &start_address, sizeof(DWORD), NULL); - if (status == 0) - { - return start_address; - } - } - - return 0; -} - -const char* GetStartAddressModuleName(DWORD_PTR start_address) -{ - BOOL success; - MODULEENTRY32 module_entry; - - // Snapshot the modules - HANDLE handle = CreateToolhelp32Snapshot(TH32CS_SNAPMODULE, 0); - if (handle == INVALID_HANDLE_VALUE) - { - return NULL; - } - - module_entry.dwSize = sizeof(MODULEENTRY32); - module_entry.th32ModuleID = 1; - - // Enumerate modules checking start address against their loaded address range - success = Module32First(handle, &module_entry); - while (success == TRUE) - { - if (start_address >= (DWORD_PTR)module_entry.modBaseAddr && start_address <= ((DWORD_PTR)module_entry.modBaseAddr + module_entry.modBaseSize)) - { - static char name[MAX_MODULE_NAME32 + 1]; -#ifdef UNICODE - int size = WideCharToMultiByte(CP_ACP, 0, module_entry.szModule, -1, name, MAX_MODULE_NAME32, NULL, NULL); - if (size < 1) - { - name[0] = '\0'; - } -#else - strcpy_s(name, sizeof(name), module_entry.szModule); -#endif - CloseHandle(handle); - return name; - } - - success = Module32Next(handle, &module_entry); - } - - CloseHandle(handle); - - return NULL; -} -#endif - -static void rmtGetThreadNameFallback(char* out_thread_name, rmtU32 thread_name_size) -{ - // In cases where we can't get a thread name from the OS - static rmtS32 countThreads = 0; - out_thread_name[0] = 0; - strncat_s(out_thread_name, thread_name_size, "Thread", 6); - itoahex_s(out_thread_name + 6, thread_name_size - 6, AtomicAdd(&countThreads, 1)); -} - -static void rmtGetThreadName(rmtThreadId thread_id, rmtThreadHandle thread_handle, char* out_thread_name, rmtU32 thread_name_size) -{ -#ifdef RMT_PLATFORM_WINDOWS - DWORD_PTR address; - const char* module_name; - rmtU32 len; - - // Use the new Windows 10 GetThreadDescription function - HMODULE kernel32 = GetModuleHandleA("Kernel32.dll"); - if (kernel32 != NULL) - { - typedef HRESULT(WINAPI* GETTHREADDESCRIPTION)(HANDLE hThread, PWSTR *ppszThreadDescription); - GETTHREADDESCRIPTION GetThreadDescription = (GETTHREADDESCRIPTION)GetProcAddress(kernel32, "GetThreadDescription"); - if (GetThreadDescription != NULL) - { - int size; - - WCHAR* thread_name_w; - GetThreadDescription(thread_handle, &thread_name_w); - - // Returned size is the byte size, so will be 1 for a null-terminated strings - size = WideCharToMultiByte(CP_ACP, 0, thread_name_w, -1, out_thread_name, thread_name_size, NULL, NULL); - if (size > 1) - { - return; - } - } - } - - // At this point GetThreadDescription hasn't returned anything so let's get the thread module name and use that - address = GetThreadStartAddress(thread_handle); - if (address == 0) - { - rmtGetThreadNameFallback(out_thread_name, thread_name_size); - return; - } - module_name = GetStartAddressModuleName(address); - if (module_name == NULL) - { - rmtGetThreadNameFallback(out_thread_name, thread_name_size); - return; - } - - // Concatenate thread name with then thread ID as that will be unique, whereas the start address won't be - memset(out_thread_name, 0, thread_name_size); - strcpy_s(out_thread_name, thread_name_size, module_name); - strncat_s(out_thread_name, thread_name_size, "!", 1); - len = strnlen_s(out_thread_name, thread_name_size); - itoahex_s(out_thread_name + len, thread_name_size - len, thread_id); - -#elif defined(RMT_PLATFORM_LINUX) && RMT_USE_POSIX_THREADNAMES && !defined(__FreeBSD__) && !defined(__OpenBSD__) - - prctl(PR_GET_NAME, out_thread_name, 0, 0, 0); - -#else - - rmtGetThreadNameFallback(out_thread_name, thread_name_size); - -#endif -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @THREADS: Cross-platform thread object ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct Thread_t rmtThread; -typedef rmtError (*ThreadProc)(rmtThread* thread); - -struct Thread_t -{ - rmtThreadHandle handle; - - // Callback executed when the thread is created - ThreadProc callback; - - // Caller-specified parameter passed to Thread_Create - void* param; - - // Error state returned from callback - rmtError error; - - // External threads can set this to request an exit - volatile rmtBool request_exit; -}; - -#if defined(RMT_PLATFORM_WINDOWS) - -static DWORD WINAPI ThreadProcWindows(LPVOID lpParameter) -{ - rmtThread* thread = (rmtThread*)lpParameter; - assert(thread != NULL); - thread->error = thread->callback(thread); - return thread->error == RMT_ERROR_NONE ? 0 : 1; -} - -#else -static void* StartFunc(void* pArgs) -{ - rmtThread* thread = (rmtThread*)pArgs; - assert(thread != NULL); - thread->error = thread->callback(thread); - return NULL; // returned error not use, check thread->error. -} -#endif - -static int rmtThread_Valid(rmtThread* thread) -{ - assert(thread != NULL); - -#if defined(RMT_PLATFORM_WINDOWS) - return thread->handle != NULL; -#else - return !pthread_equal(thread->handle, pthread_self()); -#endif -} - -static rmtError rmtThread_Constructor(rmtThread* thread, ThreadProc callback, void* param) -{ - assert(thread != NULL); - - thread->callback = callback; - thread->param = param; - thread->error = RMT_ERROR_NONE; - thread->request_exit = RMT_FALSE; - - // OS-specific thread creation - -#if defined(RMT_PLATFORM_WINDOWS) - - thread->handle = CreateThread(NULL, // lpThreadAttributes - 0, // dwStackSize - ThreadProcWindows, // lpStartAddress - thread, // lpParameter - 0, // dwCreationFlags - NULL); // lpThreadId - - if (thread->handle == NULL) - return RMT_ERROR_CREATE_THREAD_FAIL; - -#else - - int32_t error = pthread_create(&thread->handle, NULL, StartFunc, thread); - if (error) - { - // Contents of 'thread' parameter to pthread_create() are undefined after - // failure call so can't pre-set to invalid value before hand. - thread->handle = pthread_self(); - return RMT_ERROR_CREATE_THREAD_FAIL; - } - -#endif - - return RMT_ERROR_NONE; -} - -static void rmtThread_RequestExit(rmtThread* thread) -{ - // Not really worried about memory barriers or delayed visibility to the target thread - assert(thread != NULL); - thread->request_exit = RMT_TRUE; -} - -static void rmtThread_Join(rmtThread* thread) -{ - assert(rmtThread_Valid(thread)); - -#if defined(RMT_PLATFORM_WINDOWS) - WaitForSingleObject(thread->handle, INFINITE); -#else - pthread_join(thread->handle, NULL); -#endif -} - -static void rmtThread_Destructor(rmtThread* thread) -{ - assert(thread != NULL); - - if (rmtThread_Valid(thread)) - { - // Shutdown the thread - rmtThread_RequestExit(thread); - rmtThread_Join(thread); - - // OS-specific release of thread resources - -#if defined(RMT_PLATFORM_WINDOWS) - CloseHandle(thread->handle); - thread->handle = NULL; -#endif - } -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @OBJALLOC: Reusable Object Allocator ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// -// All objects that require free-list-backed allocation need to inherit from this type. -// -typedef struct ObjectLink_s -{ - struct ObjectLink_s* volatile next; -} ObjectLink; - -static void ObjectLink_Constructor(ObjectLink* link) -{ - assert(link != NULL); - link->next = NULL; -} - -typedef rmtError (*ObjConstructor)(void*); -typedef void (*ObjDestructor)(void*); - -typedef struct -{ - // Object create/destroy parameters - rmtU32 object_size; - ObjConstructor constructor; - ObjDestructor destructor; - - // Number of objects in the free list - volatile rmtS32 nb_free; - - // Number of objects used by callers - volatile rmtS32 nb_inuse; - - // Total allocation count - volatile rmtS32 nb_allocated; - - ObjectLink* first_free; -} ObjectAllocator; - -static rmtError ObjectAllocator_Constructor(ObjectAllocator* allocator, rmtU32 object_size, ObjConstructor constructor, - ObjDestructor destructor) -{ - allocator->object_size = object_size; - allocator->constructor = constructor; - allocator->destructor = destructor; - allocator->nb_free = 0; - allocator->nb_inuse = 0; - allocator->nb_allocated = 0; - allocator->first_free = NULL; - return RMT_ERROR_NONE; -} - -static void ObjectAllocator_Destructor(ObjectAllocator* allocator) -{ - // Ensure everything has been released to the allocator - assert(allocator != NULL); - assert(allocator->nb_inuse == 0); - - // Destroy all objects released to the allocator - while (allocator->first_free != NULL) - { - ObjectLink* next = allocator->first_free->next; - assert(allocator->destructor != NULL); - allocator->destructor(allocator->first_free); - rmtFree(allocator->first_free); - allocator->first_free = next; - } -} - -static void ObjectAllocator_Push(ObjectAllocator* allocator, ObjectLink* start, ObjectLink* end) -{ - assert(allocator != NULL); - assert(start != NULL); - assert(end != NULL); - - // CAS pop add range to the front of the list - for (;;) - { - ObjectLink* old_link = (ObjectLink*)allocator->first_free; - end->next = old_link; - if (AtomicCompareAndSwapPointer((long* volatile*)&allocator->first_free, (long*)old_link, (long*)start) == - RMT_TRUE) - break; - } -} - -static ObjectLink* ObjectAllocator_Pop(ObjectAllocator* allocator) -{ - ObjectLink* link; - - assert(allocator != NULL); - - // CAS pop from the front of the list - for (;;) - { - ObjectLink* old_link = (ObjectLink*)allocator->first_free; - if (old_link == NULL) - { - return NULL; - } - ObjectLink* next_link = old_link->next; - if (AtomicCompareAndSwapPointer((long* volatile*)&allocator->first_free, (long*)old_link, (long*)next_link) == - RMT_TRUE) - { - link = old_link; - break; - } - } - - link->next = NULL; - - return link; -} - -static rmtError ObjectAllocator_Alloc(ObjectAllocator* allocator, void** object) -{ - // This function only calls the object constructor on initial malloc of an object - - assert(allocator != NULL); - assert(object != NULL); - - // Pull available objects from the free list - *object = ObjectAllocator_Pop(allocator); - - // Has the free list run out? - if (*object == NULL) - { - rmtError error; - - // Allocate/construct a new object - *object = rmtMalloc(allocator->object_size); - if (*object == NULL) - return RMT_ERROR_MALLOC_FAIL; - assert(allocator->constructor != NULL); - error = allocator->constructor(*object); - if (error != RMT_ERROR_NONE) - { - // Auto-teardown on failure - assert(allocator->destructor != NULL); - allocator->destructor(*object); - rmtFree(*object); - return error; - } - - AtomicAdd(&allocator->nb_allocated, 1); - } - else - { - AtomicSub(&allocator->nb_free, 1); - } - - AtomicAdd(&allocator->nb_inuse, 1); - - return RMT_ERROR_NONE; -} - -static void ObjectAllocator_Free(ObjectAllocator* allocator, void* object) -{ - // Add back to the free-list - assert(allocator != NULL); - ObjectAllocator_Push(allocator, (ObjectLink*)object, (ObjectLink*)object); - AtomicSub(&allocator->nb_inuse, 1); - AtomicAdd(&allocator->nb_free, 1); -} - -static void ObjectAllocator_FreeRange(ObjectAllocator* allocator, void* start, void* end, rmtU32 count) -{ - assert(allocator != NULL); - ObjectAllocator_Push(allocator, (ObjectLink*)start, (ObjectLink*)end); - AtomicSub(&allocator->nb_inuse, count); - AtomicAdd(&allocator->nb_free, count); -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @DYNBUF: Dynamic Buffer ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct -{ - rmtU32 alloc_granularity; - - rmtU32 bytes_allocated; - rmtU32 bytes_used; - - rmtU8* data; -} Buffer; - -static rmtError Buffer_Constructor(Buffer* buffer, rmtU32 alloc_granularity) -{ - assert(buffer != NULL); - buffer->alloc_granularity = alloc_granularity; - buffer->bytes_allocated = 0; - buffer->bytes_used = 0; - buffer->data = NULL; - return RMT_ERROR_NONE; -} - -static void Buffer_Destructor(Buffer* buffer) -{ - assert(buffer != NULL); - - if (buffer->data != NULL) - { - rmtFree(buffer->data); - buffer->data = NULL; - } -} - -static rmtError Buffer_Grow(Buffer* buffer, rmtU32 length) -{ - // Calculate size increase rounded up to the requested allocation granularity - rmtU32 granularity = buffer->alloc_granularity; - rmtU32 allocate = buffer->bytes_allocated + length; - allocate = allocate + ((granularity - 1) - ((allocate - 1) % granularity)); - - buffer->bytes_allocated = allocate; - buffer->data = (rmtU8*)rmtRealloc(buffer->data, buffer->bytes_allocated); - if (buffer->data == NULL) - return RMT_ERROR_MALLOC_FAIL; - - return RMT_ERROR_NONE; -} - -static rmtError Buffer_Write(Buffer* buffer, const void* data, rmtU32 length) -{ - assert(buffer != NULL); - - // Reallocate the buffer on overflow - if (buffer->bytes_used + length > buffer->bytes_allocated) - { - rmtError error = Buffer_Grow(buffer, length); - if (error != RMT_ERROR_NONE) - return error; - } - - // Copy all bytes - memcpy(buffer->data + buffer->bytes_used, data, length); - buffer->bytes_used += length; - - return RMT_ERROR_NONE; -} - -static rmtError Buffer_WriteStringZ(Buffer* buffer, rmtPStr string) -{ - assert(string != NULL); - return Buffer_Write(buffer, (void*)string, (rmtU32)strnlen_s(string, 2048) + 1); -} - -static void U32ToByteArray(rmtU8* dest, rmtU32 value) -{ - // Commit as little-endian - dest[0] = value & 255; - dest[1] = (value >> 8) & 255; - dest[2] = (value >> 16) & 255; - dest[3] = value >> 24; -} - -static rmtError Buffer_WriteU32(Buffer* buffer, rmtU32 value) -{ - assert(buffer != NULL); - - // Reallocate the buffer on overflow - if (buffer->bytes_used + sizeof(value) > buffer->bytes_allocated) - { - rmtError error = Buffer_Grow(buffer, sizeof(value)); - if (error != RMT_ERROR_NONE) - return error; - } - -// Copy all bytes -#if RMT_ASSUME_LITTLE_ENDIAN - *(rmtU32*)(buffer->data + buffer->bytes_used) = value; -#else - U32ToByteArray(buffer->data + buffer->bytes_used, value); -#endif - - buffer->bytes_used += sizeof(value); - - return RMT_ERROR_NONE; -} - -static rmtBool IsLittleEndian() -{ - // Not storing this in a global variable allows the compiler to more easily optimise - // this away altogether. - union { - unsigned int i; - unsigned char c[sizeof(unsigned int)]; - } u; - u.i = 1; - return u.c[0] == 1 ? RMT_TRUE : RMT_FALSE; -} - -static rmtError Buffer_WriteU64(Buffer* buffer, rmtU64 value) -{ - // Write as a double as Javascript DataView doesn't have a 64-bit integer read - - assert(buffer != NULL); - - // Reallocate the buffer on overflow - if (buffer->bytes_used + sizeof(value) > buffer->bytes_allocated) - { - rmtError error = Buffer_Grow(buffer, sizeof(value)); - if (error != RMT_ERROR_NONE) - return error; - } - -// Copy all bytes -#if RMT_ASSUME_LITTLE_ENDIAN - *(double*)(buffer->data + buffer->bytes_used) = (double)value; -#else - { - union { - double d; - unsigned char c[sizeof(double)]; - } u; - rmtU8* dest = buffer->data + buffer->bytes_used; - u.d = (double)value; - if (IsLittleEndian()) - { - dest[0] = u.c[0]; - dest[1] = u.c[1]; - dest[2] = u.c[2]; - dest[3] = u.c[3]; - dest[4] = u.c[4]; - dest[5] = u.c[5]; - dest[6] = u.c[6]; - dest[7] = u.c[7]; - } - else - { - dest[0] = u.c[7]; - dest[1] = u.c[6]; - dest[2] = u.c[5]; - dest[3] = u.c[4]; - dest[4] = u.c[3]; - dest[5] = u.c[2]; - dest[6] = u.c[1]; - dest[7] = u.c[0]; - } - } -#endif - - buffer->bytes_used += sizeof(value); - - return RMT_ERROR_NONE; -} - -static rmtError Buffer_WriteStringWithLength(Buffer* buffer, rmtPStr string) -{ - rmtU32 length = (rmtU32)strnlen_s(string, 2048); - rmtError error; - - error = Buffer_WriteU32(buffer, length); - if (error != RMT_ERROR_NONE) - return error; - - return Buffer_Write(buffer, (void*)string, length); -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @HASHTABLE: Integer pair hash map for inserts/finds. No removes for added simplicity. ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#define RMT_NOT_FOUND 0xffffffffffffffff - -typedef struct -{ - // Non-zero, pre-hashed key - rmtU32 key; - - // Value that's not equal to RMT_NOT_FOUND - rmtU64 value; -} HashSlot; - -typedef struct -{ - // Stats - rmtU32 maxNbSlots; - rmtU32 nbSlots; - - // Data - HashSlot* slots; -} rmtHashTable; - -static rmtError rmtHashTable_Constructor(rmtHashTable* table, rmtU32 max_nb_slots) -{ - // Default initialise - assert(table != NULL); - table->maxNbSlots = max_nb_slots; - table->nbSlots = 0; - - // Allocate and clear the hash slots - table->slots = (HashSlot*)rmtMalloc(table->maxNbSlots * sizeof(HashSlot)); - if (table->slots == NULL) - { - return RMT_ERROR_MALLOC_FAIL; - } - memset(table->slots, 0, table->maxNbSlots * sizeof(HashSlot)); - - return RMT_ERROR_NONE; -} - -static void rmtHashTable_Destructor(rmtHashTable* table) -{ - assert(table != NULL); - - if (table->slots != NULL) - { - rmtFree(table->slots); - table->slots = NULL; - } -} - -static rmtError rmtHashTable_Resize(rmtHashTable* table); - -static rmtError rmtHashTable_Insert(rmtHashTable* table, rmtU32 key, rmtU64 value) -{ - HashSlot* slot = NULL; - rmtError error = RMT_ERROR_NONE; - - // Calculate initial slot location for this key - rmtU32 index_mask = table->maxNbSlots - 1; - rmtU32 index = key & index_mask; - - assert(key != 0); - assert(value != RMT_NOT_FOUND); - - // Linear probe for free slot, reusing any existing key matches - // There will always be at least one free slot due to load factor management - while (table->slots[index].key) - { - if (table->slots[index].key == key) - { - // Counter occupied slot increments below - table->nbSlots--; - break; - } - - index = (index + 1) & index_mask; - } - - // Just verify that I've got no errors in the code above - assert(index < table->maxNbSlots); - - // Add to the table - slot = table->slots + index; - slot->key = key; - slot->value = value; - table->nbSlots++; - - // Resize when load factor is greater than 2/3 - if (table->nbSlots > (table->maxNbSlots * 2) / 3) - { - error = rmtHashTable_Resize(table); - } - - return error; -} - -static rmtError rmtHashTable_Resize(rmtHashTable* table) -{ - rmtU32 old_max_nb_slots = table->maxNbSlots; - HashSlot* new_slots = NULL; - HashSlot* old_slots = table->slots; - rmtU32 i; - - // Increase the table size - rmtU32 new_max_nb_slots = table->maxNbSlots; - if (new_max_nb_slots < 8192 * 4) - { - new_max_nb_slots *= 4; - } - else - { - new_max_nb_slots *= 2; - } - - // Allocate and clear a new table - new_slots = (HashSlot*)rmtMalloc(new_max_nb_slots * sizeof(HashSlot)); - if (new_slots == NULL) - { - return RMT_ERROR_MALLOC_FAIL; - } - memset(new_slots, 0, new_max_nb_slots * sizeof(HashSlot)); - - // Update fields of the table after successful allocation only - table->slots = new_slots; - table->maxNbSlots = new_max_nb_slots; - table->nbSlots = 0; - - // Reinsert all objects into the new table - for (i = 0; i < old_max_nb_slots; i++) - { - HashSlot* slot = old_slots + i; - if (slot->key != 0) - { - rmtHashTable_Insert(table, slot->key, slot->value); - } - } - - rmtFree(old_slots); - - return RMT_ERROR_NONE; -} - -static rmtU64 rmtHashTable_Find(rmtHashTable* table, rmtU32 key) -{ - // Calculate initial slot location for this key - rmtU32 index_mask = table->maxNbSlots - 1; - rmtU32 index = key & index_mask; - - // Linear probe for matching hash - while (table->slots[index].key) - { - HashSlot* slot = table->slots + index; - - if (slot->key == key) - { - return slot->value; - } - - index = (index + 1) & index_mask; - } - - return RMT_NOT_FOUND; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @STRINGTABLE: Map from string hash to string offset in local buffer ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct -{ - // Growable dynamic array of strings added so far - Buffer* text; - - // Map from text hash to text location in the buffer - rmtHashTable* text_map; -} StringTable; - -static rmtError StringTable_Constructor(StringTable* table) -{ - rmtError error; - - // Default initialise - assert(table != NULL); - table->text = NULL; - table->text_map = NULL; - - // Allocate reasonably storage for initial sample names - - New_1(Buffer, table->text, 8 * 1024); - if (error != RMT_ERROR_NONE) - return error; - - New_1(rmtHashTable, table->text_map, 1 * 1024); - if (error != RMT_ERROR_NONE) - return error; - - return RMT_ERROR_NONE; -} - -static void StringTable_Destructor(StringTable* table) -{ - assert(table != NULL); - - Delete(rmtHashTable, table->text_map); - Delete(Buffer, table->text); -} - -static rmtPStr StringTable_Find(StringTable* table, rmtU32 name_hash) -{ - rmtU64 text_offset = rmtHashTable_Find(table->text_map, name_hash); - if (text_offset != RMT_NOT_FOUND) - { - return (rmtPStr)(table->text->data + text_offset); - } - return NULL; -} - -static void StringTable_Insert(StringTable* table, rmtU32 name_hash, rmtPStr name) -{ - // Only add to the buffer if the string isn't already there - rmtU64 text_offset = rmtHashTable_Find(table->text_map, name_hash); - if (text_offset == RMT_NOT_FOUND) - { - // TODO: Allocation errors aren't being passed on to the caller - text_offset = table->text->bytes_used; - Buffer_WriteStringZ(table->text, name); - rmtHashTable_Insert(table->text_map, name_hash, text_offset); - } -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @SOCKETS: Sockets TCP/IP Wrapper ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#ifndef RMT_PLATFORM_WINDOWS -typedef int SOCKET; -#define INVALID_SOCKET -1 -#define SOCKET_ERROR -1 -#define SD_SEND SHUT_WR -#define closesocket close -#endif - -typedef struct -{ - SOCKET socket; -} TCPSocket; - -typedef struct -{ - rmtBool can_read; - rmtBool can_write; - rmtError error_state; -} SocketStatus; - -// -// Function prototypes -// -static void TCPSocket_Close(TCPSocket* tcp_socket); - -static rmtError InitialiseNetwork() -{ -#ifdef RMT_PLATFORM_WINDOWS - - WSADATA wsa_data; - if (WSAStartup(MAKEWORD(2, 2), &wsa_data)) - return RMT_ERROR_SOCKET_INIT_NETWORK_FAIL; - if (LOBYTE(wsa_data.wVersion) != 2 || HIBYTE(wsa_data.wVersion) != 2) - return RMT_ERROR_SOCKET_INIT_NETWORK_FAIL; - - return RMT_ERROR_NONE; - -#else - - return RMT_ERROR_NONE; - -#endif -} - -static void ShutdownNetwork() -{ -#ifdef RMT_PLATFORM_WINDOWS - WSACleanup(); -#endif -} - -static rmtError TCPSocket_Constructor(TCPSocket* tcp_socket) -{ - assert(tcp_socket != NULL); - tcp_socket->socket = INVALID_SOCKET; - return InitialiseNetwork(); -} - -static void TCPSocket_Destructor(TCPSocket* tcp_socket) -{ - assert(tcp_socket != NULL); - TCPSocket_Close(tcp_socket); - ShutdownNetwork(); -} - -static rmtError TCPSocket_RunServer(TCPSocket* tcp_socket, rmtU16 port, rmtBool reuse_open_port, - rmtBool limit_connections_to_localhost) -{ - SOCKET s = INVALID_SOCKET; - struct sockaddr_in sin; -#ifdef RMT_PLATFORM_WINDOWS - u_long nonblock = 1; -#endif - - memset(&sin, 0, sizeof(sin)); - assert(tcp_socket != NULL); - - // Try to create the socket - s = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); - if (s == SOCKET_ERROR) - return RMT_ERROR_SOCKET_CREATE_FAIL; - - if (reuse_open_port) - { - int enable = 1; - -// set SO_REUSEADDR so binding doesn't fail when restarting the application -// (otherwise the same port can't be reused within TIME_WAIT) -// I'm not checking for errors because if this fails (unlikely) we might still -// be able to bind to the socket anyway -#ifdef RMT_PLATFORM_POSIX - setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(enable)); -#elif defined(RMT_PLATFORM_WINDOWS) - // windows also needs SO_EXCLUSEIVEADDRUSE, - // see http://www.andy-pearce.com/blog/posts/2013/Feb/so_reuseaddr-on-windows/ - setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (char*)&enable, sizeof(enable)); - enable = 1; - setsockopt(s, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, (char*)&enable, sizeof(enable)); -#endif - } - - // Bind the socket to the incoming port - sin.sin_family = AF_INET; - sin.sin_addr.s_addr = htonl(limit_connections_to_localhost ? INADDR_LOOPBACK : INADDR_ANY); - sin.sin_port = htons(port); - if (bind(s, (struct sockaddr*)&sin, sizeof(sin)) == SOCKET_ERROR) - return RMT_ERROR_SOCKET_BIND_FAIL; - - // Connection is valid, remaining code is socket state modification - tcp_socket->socket = s; - - // Enter a listening state with a backlog of 1 connection - if (listen(s, 1) == SOCKET_ERROR) - return RMT_ERROR_SOCKET_LISTEN_FAIL; - -// Set as non-blocking -#ifdef RMT_PLATFORM_WINDOWS - if (ioctlsocket(tcp_socket->socket, FIONBIO, &nonblock) == SOCKET_ERROR) - return RMT_ERROR_SOCKET_SET_NON_BLOCKING_FAIL; -#else - if (fcntl(tcp_socket->socket, F_SETFL, O_NONBLOCK) == SOCKET_ERROR) - return RMT_ERROR_SOCKET_SET_NON_BLOCKING_FAIL; -#endif - - return RMT_ERROR_NONE; -} - -static void TCPSocket_Close(TCPSocket* tcp_socket) -{ - assert(tcp_socket != NULL); - - if (tcp_socket->socket != INVALID_SOCKET) - { - // Shutdown the connection, stopping all sends - int result = shutdown(tcp_socket->socket, SD_SEND); - if (result != SOCKET_ERROR) - { - // Keep receiving until the peer closes the connection - int total = 0; - char temp_buf[128]; - while (result > 0) - { - result = (int)recv(tcp_socket->socket, temp_buf, sizeof(temp_buf), 0); - total += result; - } - } - - // Close the socket and issue a network shutdown request - closesocket(tcp_socket->socket); - tcp_socket->socket = INVALID_SOCKET; - } -} - -static SocketStatus TCPSocket_PollStatus(TCPSocket* tcp_socket) -{ - SocketStatus status; - fd_set fd_read, fd_write, fd_errors; - struct timeval tv; - - status.can_read = RMT_FALSE; - status.can_write = RMT_FALSE; - status.error_state = RMT_ERROR_NONE; - - assert(tcp_socket != NULL); - if (tcp_socket->socket == INVALID_SOCKET) - { - status.error_state = RMT_ERROR_SOCKET_INVALID_POLL; - return status; - } - - // Set read/write/error markers for the socket - FD_ZERO(&fd_read); - FD_ZERO(&fd_write); - FD_ZERO(&fd_errors); -#ifdef _MSC_VER -#pragma warning(push) -#pragma warning(disable : 4127) // warning C4127: conditional expression is constant -#endif // _MSC_VER - FD_SET(tcp_socket->socket, &fd_read); - FD_SET(tcp_socket->socket, &fd_write); - FD_SET(tcp_socket->socket, &fd_errors); -#ifdef _MSC_VER -#pragma warning(pop) -#endif // _MSC_VER - - // Poll socket status without blocking - tv.tv_sec = 0; - tv.tv_usec = 0; - if (select(((int)tcp_socket->socket) + 1, &fd_read, &fd_write, &fd_errors, &tv) == SOCKET_ERROR) - { - status.error_state = RMT_ERROR_SOCKET_SELECT_FAIL; - return status; - } - - status.can_read = FD_ISSET(tcp_socket->socket, &fd_read) != 0 ? RMT_TRUE : RMT_FALSE; - status.can_write = FD_ISSET(tcp_socket->socket, &fd_write) != 0 ? RMT_TRUE : RMT_FALSE; - status.error_state = FD_ISSET(tcp_socket->socket, &fd_errors) != 0 ? RMT_ERROR_SOCKET_POLL_ERRORS : RMT_ERROR_NONE; - return status; -} - -static rmtError TCPSocket_AcceptConnection(TCPSocket* tcp_socket, TCPSocket** client_socket) -{ - SocketStatus status; - SOCKET s; - rmtError error; - - // Ensure there is an incoming connection - assert(tcp_socket != NULL); - status = TCPSocket_PollStatus(tcp_socket); - if (status.error_state != RMT_ERROR_NONE || !status.can_read) - return status.error_state; - - // Accept the connection - s = accept(tcp_socket->socket, 0, 0); - if (s == SOCKET_ERROR) - return RMT_ERROR_SOCKET_ACCEPT_FAIL; - -#ifdef SO_NOSIGPIPE - // On POSIX systems, send() may send a SIGPIPE signal when writing to an - // already closed connection. By setting this option, we prevent the - // signal from being emitted and send will instead return an error and set - // errno to EPIPE. - // - // This is supported on BSD platforms and not on Linux. - { - int flag = 1; - setsockopt(s, SOL_SOCKET, SO_NOSIGPIPE, &flag, sizeof(flag)); - } -#endif - // Create a client socket for the new connection - assert(client_socket != NULL); - New_0(TCPSocket, *client_socket); - if (error != RMT_ERROR_NONE) - return error; - (*client_socket)->socket = s; - - return RMT_ERROR_NONE; -} - -static int TCPTryAgain() -{ -#ifdef RMT_PLATFORM_WINDOWS - DWORD error = WSAGetLastError(); - return error == WSAEWOULDBLOCK; -#else -#if EAGAIN == EWOULDBLOCK - return errno == EAGAIN; -#else - return errno == EAGAIN || errno == EWOULDBLOCK; -#endif -#endif -} - -static rmtError TCPSocket_Send(TCPSocket* tcp_socket, const void* data, rmtU32 length, rmtU32 timeout_ms) -{ - SocketStatus status; - char* cur_data = NULL; - char* end_data = NULL; - rmtU32 start_ms = 0; - rmtU32 cur_ms = 0; - - assert(tcp_socket != NULL); - - start_ms = msTimer_Get(); - - // Loop until timeout checking whether data can be written - status.can_write = RMT_FALSE; - while (!status.can_write) - { - status = TCPSocket_PollStatus(tcp_socket); - if (status.error_state != RMT_ERROR_NONE) - return status.error_state; - - cur_ms = msTimer_Get(); - if (cur_ms - start_ms > timeout_ms) - return RMT_ERROR_SOCKET_SEND_TIMEOUT; - } - - cur_data = (char*)data; - end_data = cur_data + length; - - while (cur_data < end_data) - { - // Attempt to send the remaining chunk of data - int bytes_sent; - int send_flags = 0; -#ifdef MSG_NOSIGNAL - // On Linux this prevents send from emitting a SIGPIPE signal - // Equivalent on BSD to the SO_NOSIGPIPE option. - send_flags = MSG_NOSIGNAL; -#endif - bytes_sent = (int)send(tcp_socket->socket, cur_data, (int)(end_data - cur_data), send_flags); - - if (bytes_sent == SOCKET_ERROR || bytes_sent == 0) - { - // Close the connection if sending fails for any other reason other than blocking - if (bytes_sent != 0 && !TCPTryAgain()) - return RMT_ERROR_SOCKET_SEND_FAIL; - - // First check for tick-count overflow and reset, giving a slight hitch every 49.7 days - cur_ms = msTimer_Get(); - if (cur_ms < start_ms) - { - start_ms = cur_ms; - continue; - } - - // - // Timeout can happen when: - // - // 1) endpoint is no longer there - // 2) endpoint can't consume quick enough - // 3) local buffers overflow - // - // As none of these are actually errors, we have to pass this timeout back to the caller. - // - // TODO: This strategy breaks down if a send partially completes and then times out! - // - if (cur_ms - start_ms > timeout_ms) - { - return RMT_ERROR_SOCKET_SEND_TIMEOUT; - } - } - else - { - // Jump over the data sent - cur_data += bytes_sent; - } - } - - return RMT_ERROR_NONE; -} - -static rmtError TCPSocket_Receive(TCPSocket* tcp_socket, void* data, rmtU32 length, rmtU32 timeout_ms) -{ - SocketStatus status; - char* cur_data = NULL; - char* end_data = NULL; - rmtU32 start_ms = 0; - rmtU32 cur_ms = 0; - - assert(tcp_socket != NULL); - - // Ensure there is data to receive - status = TCPSocket_PollStatus(tcp_socket); - if (status.error_state != RMT_ERROR_NONE) - return status.error_state; - if (!status.can_read) - return RMT_ERROR_SOCKET_RECV_NO_DATA; - - cur_data = (char*)data; - end_data = cur_data + length; - - // Loop until all data has been received - start_ms = msTimer_Get(); - while (cur_data < end_data) - { - int bytes_received = (int)recv(tcp_socket->socket, cur_data, (int)(end_data - cur_data), 0); - - if (bytes_received == SOCKET_ERROR || bytes_received == 0) - { - // Close the connection if receiving fails for any other reason other than blocking - if (bytes_received != 0 && !TCPTryAgain()) - return RMT_ERROR_SOCKET_RECV_FAILED; - - // First check for tick-count overflow and reset, giving a slight hitch every 49.7 days - cur_ms = msTimer_Get(); - if (cur_ms < start_ms) - { - start_ms = cur_ms; - continue; - } - - // - // Timeout can happen when: - // - // 1) data is delayed by sender - // 2) sender fails to send a complete set of packets - // - // As not all of these scenarios are errors, we need to pass this information back to the caller. - // - // TODO: This strategy breaks down if a receive partially completes and then times out! - // - if (cur_ms - start_ms > timeout_ms) - { - return RMT_ERROR_SOCKET_RECV_TIMEOUT; - } - } - else - { - // Jump over the data received - cur_data += bytes_received; - } - } - - return RMT_ERROR_NONE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @SHA1: SHA-1 Cryptographic Hash Function ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -// -// Typed to allow enforced data size specification -// -typedef struct -{ - rmtU8 data[20]; -} SHA1; - -/* - Copyright (c) 2011, Micael Hildenborg - 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. - * Neither the name of Micael Hildenborg nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''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 Micael Hildenborg 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. - */ - -/* - Contributors: - Gustav - Several members in the gamedev.se forum. - Gregory Petrosyan - */ - -// Rotate an integer value to left. -static unsigned int rol(const unsigned int value, const unsigned int steps) -{ - return ((value << steps) | (value >> (32 - steps))); -} - -// Sets the first 16 integers in the buffert to zero. -// Used for clearing the W buffert. -static void clearWBuffert(unsigned int* buffert) -{ - int pos; - for (pos = 16; --pos >= 0;) - { - buffert[pos] = 0; - } -} - -static void innerHash(unsigned int* result, unsigned int* w) -{ - unsigned int a = result[0]; - unsigned int b = result[1]; - unsigned int c = result[2]; - unsigned int d = result[3]; - unsigned int e = result[4]; - - int round = 0; - -#define sha1macro(func, val) \ - { \ - const unsigned int t = rol(a, 5) + (func) + e + val + w[round]; \ - e = d; \ - d = c; \ - c = rol(b, 30); \ - b = a; \ - a = t; \ - } - - while (round < 16) - { - sha1macro((b & c) | (~b & d), 0x5a827999); - ++round; - } - while (round < 20) - { - w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1); - sha1macro((b & c) | (~b & d), 0x5a827999); - ++round; - } - while (round < 40) - { - w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1); - sha1macro(b ^ c ^ d, 0x6ed9eba1); - ++round; - } - while (round < 60) - { - w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1); - sha1macro((b & c) | (b & d) | (c & d), 0x8f1bbcdc); - ++round; - } - while (round < 80) - { - w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1); - sha1macro(b ^ c ^ d, 0xca62c1d6); - ++round; - } - -#undef sha1macro - - result[0] += a; - result[1] += b; - result[2] += c; - result[3] += d; - result[4] += e; -} - -static void calc(const void* src, const int bytelength, unsigned char* hash) -{ - int roundPos; - int lastBlockBytes; - int hashByte; - - // Init the result array. - unsigned int result[5] = {0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0}; - - // Cast the void src pointer to be the byte array we can work with. - const unsigned char* sarray = (const unsigned char*)src; - - // The reusable round buffer - unsigned int w[80]; - - // Loop through all complete 64byte blocks. - const int endOfFullBlocks = bytelength - 64; - int endCurrentBlock; - int currentBlock = 0; - - while (currentBlock <= endOfFullBlocks) - { - endCurrentBlock = currentBlock + 64; - - // Init the round buffer with the 64 byte block data. - for (roundPos = 0; currentBlock < endCurrentBlock; currentBlock += 4) - { - // This line will swap endian on big endian and keep endian on little endian. - w[roundPos++] = (unsigned int)sarray[currentBlock + 3] | (((unsigned int)sarray[currentBlock + 2]) << 8) | - (((unsigned int)sarray[currentBlock + 1]) << 16) | - (((unsigned int)sarray[currentBlock]) << 24); - } - innerHash(result, w); - } - - // Handle the last and not full 64 byte block if existing. - endCurrentBlock = bytelength - currentBlock; - clearWBuffert(w); - lastBlockBytes = 0; - for (; lastBlockBytes < endCurrentBlock; ++lastBlockBytes) - { - w[lastBlockBytes >> 2] |= (unsigned int)sarray[lastBlockBytes + currentBlock] - << ((3 - (lastBlockBytes & 3)) << 3); - } - w[lastBlockBytes >> 2] |= 0x80U << ((3 - (lastBlockBytes & 3)) << 3); - if (endCurrentBlock >= 56) - { - innerHash(result, w); - clearWBuffert(w); - } - w[15] = bytelength << 3; - innerHash(result, w); - - // Store hash in result pointer, and make sure we get in in the correct order on both endian models. - for (hashByte = 20; --hashByte >= 0;) - { - hash[hashByte] = (result[hashByte >> 2] >> (((3 - hashByte) & 0x3) << 3)) & 0xff; - } -} - -static SHA1 SHA1_Calculate(const void* src, unsigned int length) -{ - SHA1 hash; - assert((int)length >= 0); - calc(src, length, hash.data); - return hash; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @BASE64: Base-64 encoder ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -static const char* b64_encoding_table = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "abcdefghijklmnopqrstuvwxyz" - "0123456789+/"; - -static rmtU32 Base64_CalculateEncodedLength(rmtU32 length) -{ - // ceil(l * 4/3) - return 4 * ((length + 2) / 3); -} - -static void Base64_Encode(const rmtU8* in_bytes, rmtU32 length, rmtU8* out_bytes) -{ - rmtU32 i; - rmtU32 encoded_length; - rmtU32 remaining_bytes; - - rmtU8* optr = out_bytes; - - for (i = 0; i < length;) - { - // Read input 3 values at a time, null terminating - rmtU32 c0 = i < length ? in_bytes[i++] : 0; - rmtU32 c1 = i < length ? in_bytes[i++] : 0; - rmtU32 c2 = i < length ? in_bytes[i++] : 0; - - // Encode 4 bytes for ever 3 input bytes - rmtU32 triple = (c0 << 0x10) + (c1 << 0x08) + c2; - *optr++ = b64_encoding_table[(triple >> 3 * 6) & 0x3F]; - *optr++ = b64_encoding_table[(triple >> 2 * 6) & 0x3F]; - *optr++ = b64_encoding_table[(triple >> 1 * 6) & 0x3F]; - *optr++ = b64_encoding_table[(triple >> 0 * 6) & 0x3F]; - } - - // Pad output to multiple of 3 bytes with terminating '=' - encoded_length = Base64_CalculateEncodedLength(length); - remaining_bytes = (3 - ((length + 2) % 3)) - 1; - for (i = 0; i < remaining_bytes; i++) - out_bytes[encoded_length - 1 - i] = '='; - - // Null terminate - out_bytes[encoded_length] = 0; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @MURMURHASH: MurmurHash3 - https://code.google.com/p/smhasher ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -//----------------------------------------------------------------------------- -// MurmurHash3 was written by Austin Appleby, and is placed in the public -// domain. The author hereby disclaims copyright to this source code. -//----------------------------------------------------------------------------- - -static rmtU32 rotl32(rmtU32 x, rmtS8 r) -{ - return (x << r) | (x >> (32 - r)); -} - -// Block read - if your platform needs to do endian-swapping, do the conversion here -static rmtU32 getblock32(const rmtU32* p, int i) -{ - rmtU32 result; - const rmtU8* src = ((const rmtU8*)p) + i * sizeof(rmtU32); - memcpy(&result, src, sizeof(result)); - return result; -} - -// Finalization mix - force all bits of a hash block to avalanche -static rmtU32 fmix32(rmtU32 h) -{ - h ^= h >> 16; - h *= 0x85ebca6b; - h ^= h >> 13; - h *= 0xc2b2ae35; - h ^= h >> 16; - return h; -} - -static rmtU32 MurmurHash3_x86_32(const void* key, int len, rmtU32 seed) -{ - const rmtU8* data = (const rmtU8*)key; - const int nblocks = len / 4; - - rmtU32 h1 = seed; - - const rmtU32 c1 = 0xcc9e2d51; - const rmtU32 c2 = 0x1b873593; - - int i; - - const rmtU32* blocks = (const rmtU32*)(data + nblocks * 4); - const rmtU8* tail = (const rmtU8*)(data + nblocks * 4); - - rmtU32 k1 = 0; - - //---------- - // body - - for (i = -nblocks; i; i++) - { - rmtU32 k2 = getblock32(blocks, i); - - k2 *= c1; - k2 = rotl32(k2, 15); - k2 *= c2; - - h1 ^= k2; - h1 = rotl32(h1, 13); - h1 = h1 * 5 + 0xe6546b64; - } - - //---------- - // tail - - switch (len & 3) - { - case 3: - k1 ^= tail[2] << 16; // fallthrough - case 2: - k1 ^= tail[1] << 8; // fallthrough - case 1: - k1 ^= tail[0]; - k1 *= c1; - k1 = rotl32(k1, 15); - k1 *= c2; - h1 ^= k1; - }; - - //---------- - // finalization - - h1 ^= len; - - h1 = fmix32(h1); - - return h1; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @WEBSOCKETS: WebSockets ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -enum WebSocketMode -{ - WEBSOCKET_NONE = 0, - WEBSOCKET_TEXT = 1, - WEBSOCKET_BINARY = 2, -}; - -typedef struct -{ - TCPSocket* tcp_socket; - - enum WebSocketMode mode; - - rmtU32 frame_bytes_remaining; - rmtU32 mask_offset; - - union { - rmtU8 mask[4]; - rmtU32 mask_u32; - } data; - -} WebSocket; - -static void WebSocket_Close(WebSocket* web_socket); - -static char* GetField(char* buffer, r_size_t buffer_length, rmtPStr field_name) -{ - char* field = NULL; - char* buffer_end = buffer + buffer_length - 1; - - r_size_t field_length = strnlen_s(field_name, buffer_length); - if (field_length == 0) - return NULL; - - // Search for the start of the field - if (strstr_s(buffer, buffer_length, field_name, field_length, &field) != EOK) - return NULL; - - // Field name is now guaranteed to be in the buffer so its safe to jump over it without hitting the bounds - field += strlen(field_name); - - // Skip any trailing whitespace - while (*field == ' ') - { - if (field >= buffer_end) - return NULL; - field++; - } - - return field; -} - -static const char websocket_guid[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; -static const char websocket_response[] = "HTTP/1.1 101 Switching Protocols\r\n" - "Upgrade: websocket\r\n" - "Connection: Upgrade\r\n" - "Sec-WebSocket-Accept: "; - -static rmtError WebSocketHandshake(TCPSocket* tcp_socket, rmtPStr limit_host) -{ - rmtU32 start_ms, now_ms; - - // Parsing scratchpad - char buffer[1024]; - char* buffer_ptr = buffer; - int buffer_len = sizeof(buffer) - 1; - char* buffer_end = buffer + buffer_len; - - char response_buffer[256]; - int response_buffer_len = sizeof(response_buffer) - 1; - - char* version; - char* host; - char* key; - char* key_end; - SHA1 hash; - - assert(tcp_socket != NULL); - - start_ms = msTimer_Get(); - - // Really inefficient way of receiving the handshake data from the browser - // Not really sure how to do this any better, as the termination requirement is \r\n\r\n - while (buffer_ptr - buffer < buffer_len) - { - rmtError error = TCPSocket_Receive(tcp_socket, buffer_ptr, 1, 20); - if (error == RMT_ERROR_SOCKET_RECV_FAILED) - return error; - - // If there's a stall receiving the data, check for a handshake timeout - if (error == RMT_ERROR_SOCKET_RECV_NO_DATA || error == RMT_ERROR_SOCKET_RECV_TIMEOUT) - { - now_ms = msTimer_Get(); - if (now_ms - start_ms > 1000) - return RMT_ERROR_SOCKET_RECV_TIMEOUT; - - continue; - } - - // Just in case new enums are added... - assert(error == RMT_ERROR_NONE); - - if (buffer_ptr - buffer >= 4) - { - if (*(buffer_ptr - 3) == '\r' && *(buffer_ptr - 2) == '\n' && *(buffer_ptr - 1) == '\r' && - *(buffer_ptr - 0) == '\n') - break; - } - - buffer_ptr++; - } - *buffer_ptr = 0; - - // HTTP GET instruction - if (memcmp(buffer, "GET", 3) != 0) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_NOT_GET; - - // Look for the version number and verify that it's supported - version = GetField(buffer, buffer_len, "Sec-WebSocket-Version:"); - if (version == NULL) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_VERSION; - if (buffer_end - version < 2 || (version[0] != '8' && (version[0] != '1' || version[1] != '3'))) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_VERSION; - - // Make sure this connection comes from a known host - host = GetField(buffer, buffer_len, "Host:"); - if (host == NULL) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_HOST; - if (limit_host != NULL) - { - r_size_t limit_host_len = strnlen_s(limit_host, 128); - char* found = NULL; - if (strstr_s(host, buffer_end - host, limit_host, limit_host_len, &found) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_HOST; - } - - // Look for the key start and null-terminate it within the receive buffer - key = GetField(buffer, buffer_len, "Sec-WebSocket-Key:"); - if (key == NULL) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_KEY; - if (strstr_s(key, buffer_end - key, "\r\n", 2, &key_end) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_KEY; - *key_end = 0; - - // Concatenate the browser's key with the WebSocket Protocol GUID and base64 encode - // the hash, to prove to the browser that this is a bonafide WebSocket server - buffer[0] = 0; - if (strncat_s(buffer, buffer_len, key, key_end - key) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL; - if (strncat_s(buffer, buffer_len, websocket_guid, sizeof(websocket_guid)) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL; - hash = SHA1_Calculate(buffer, (rmtU32)strnlen_s(buffer, buffer_len)); - Base64_Encode(hash.data, sizeof(hash.data), (rmtU8*)buffer); - - // Send the response back to the server with a longer timeout than usual - response_buffer[0] = 0; - if (strncat_s(response_buffer, response_buffer_len, websocket_response, sizeof(websocket_response)) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL; - if (strncat_s(response_buffer, response_buffer_len, buffer, buffer_len) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL; - if (strncat_s(response_buffer, response_buffer_len, "\r\n\r\n", 4) != EOK) - return RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL; - - return TCPSocket_Send(tcp_socket, response_buffer, (rmtU32)strnlen_s(response_buffer, response_buffer_len), 1000); -} - -static rmtError WebSocket_Constructor(WebSocket* web_socket, TCPSocket* tcp_socket) -{ - rmtError error = RMT_ERROR_NONE; - - assert(web_socket != NULL); - web_socket->tcp_socket = tcp_socket; - web_socket->mode = WEBSOCKET_NONE; - web_socket->frame_bytes_remaining = 0; - web_socket->mask_offset = 0; - web_socket->data.mask[0] = 0; - web_socket->data.mask[1] = 0; - web_socket->data.mask[2] = 0; - web_socket->data.mask[3] = 0; - - // Caller can optionally specify which TCP socket to use - if (web_socket->tcp_socket == NULL) - New_0(TCPSocket, web_socket->tcp_socket); - - return error; -} - -static void WebSocket_Destructor(WebSocket* web_socket) -{ - WebSocket_Close(web_socket); -} - -static rmtError WebSocket_RunServer(WebSocket* web_socket, rmtU16 port, rmtBool reuse_open_port, - rmtBool limit_connections_to_localhost, enum WebSocketMode mode) -{ - // Create the server's listening socket - assert(web_socket != NULL); - web_socket->mode = mode; - return TCPSocket_RunServer(web_socket->tcp_socket, port, reuse_open_port, limit_connections_to_localhost); -} - -static void WebSocket_Close(WebSocket* web_socket) -{ - assert(web_socket != NULL); - Delete(TCPSocket, web_socket->tcp_socket); -} - -static SocketStatus WebSocket_PollStatus(WebSocket* web_socket) -{ - assert(web_socket != NULL); - return TCPSocket_PollStatus(web_socket->tcp_socket); -} - -static rmtError WebSocket_AcceptConnection(WebSocket* web_socket, WebSocket** client_socket) -{ - TCPSocket* tcp_socket = NULL; - rmtError error; - - // Is there a waiting connection? - assert(web_socket != NULL); - error = TCPSocket_AcceptConnection(web_socket->tcp_socket, &tcp_socket); - if (error != RMT_ERROR_NONE || tcp_socket == NULL) - return error; - - // Need a successful handshake between client/server before allowing the connection - // TODO: Specify limit_host - error = WebSocketHandshake(tcp_socket, NULL); - if (error != RMT_ERROR_NONE) - return error; - - // Allocate and return a new client socket - assert(client_socket != NULL); - New_1(WebSocket, *client_socket, tcp_socket); - if (error != RMT_ERROR_NONE) - return error; - - (*client_socket)->mode = web_socket->mode; - - return RMT_ERROR_NONE; -} - -static void WriteSize(rmtU32 size, rmtU8* dest, rmtU32 dest_size, rmtU32 dest_offset) -{ - int size_size = dest_size - dest_offset; - rmtU32 i; - for (i = 0; i < dest_size; i++) - { - int j = i - dest_offset; - dest[i] = (j < 0) ? 0 : (size >> ((size_size - j - 1) * 8)) & 0xFF; - } -} - -// For send buffers to preallocate -#define WEBSOCKET_MAX_FRAME_HEADER_SIZE 10 - -static void WebSocket_PrepareBuffer(Buffer* buffer) -{ - char empty_frame_header[WEBSOCKET_MAX_FRAME_HEADER_SIZE]; - - assert(buffer != NULL); - - // Reset to start - buffer->bytes_used = 0; - - // Allocate enough space for a maximum-sized frame header - Buffer_Write(buffer, empty_frame_header, sizeof(empty_frame_header)); -} - -static rmtU32 WebSocket_FrameHeaderSize(rmtU32 length) -{ - if (length <= 125) - return 2; - if (length <= 65535) - return 4; - return 10; -} - -static void WebSocket_WriteFrameHeader(WebSocket* web_socket, rmtU8* dest, rmtU32 length) -{ - rmtU8 final_fragment = 0x1 << 7; - rmtU8 frame_type = (rmtU8)web_socket->mode; - - dest[0] = final_fragment | frame_type; - - // Construct the frame header, correctly applying the narrowest size - if (length <= 125) - { - dest[1] = (rmtU8)length; - } - else if (length <= 65535) - { - dest[1] = 126; - WriteSize(length, dest + 2, 2, 0); - } - else - { - dest[1] = 127; - WriteSize(length, dest + 2, 8, 4); - } -} - -static rmtError WebSocket_Send(WebSocket* web_socket, const void* data, rmtU32 length, rmtU32 timeout_ms) -{ - rmtError error; - SocketStatus status; - rmtU32 payload_length, frame_header_size, delta; - - assert(web_socket != NULL); - assert(data != NULL); - - // Can't send if there are socket errors - status = WebSocket_PollStatus(web_socket); - if (status.error_state != RMT_ERROR_NONE) - return status.error_state; - - // Assume space for max frame header has been allocated in the incoming data - payload_length = length - WEBSOCKET_MAX_FRAME_HEADER_SIZE; - frame_header_size = WebSocket_FrameHeaderSize(payload_length); - delta = WEBSOCKET_MAX_FRAME_HEADER_SIZE - frame_header_size; - data = (void*)((rmtU8*)data + delta); - length -= delta; - WebSocket_WriteFrameHeader(web_socket, (rmtU8*)data, payload_length); - - // Send frame header and data together - error = TCPSocket_Send(web_socket->tcp_socket, data, length, timeout_ms); - return error; -} - -static rmtError ReceiveFrameHeader(WebSocket* web_socket) -{ - // TODO: Specify infinite timeout? - - rmtError error; - rmtU8 msg_header[2] = {0, 0}; - int msg_length, size_bytes_remaining, i; - rmtBool mask_present; - - assert(web_socket != NULL); - - // Get message header - error = TCPSocket_Receive(web_socket->tcp_socket, msg_header, 2, 20); - if (error != RMT_ERROR_NONE) - return error; - - // Check for WebSocket Protocol disconnect - if (msg_header[0] == 0x88) - return RMT_ERROR_WEBSOCKET_DISCONNECTED; - - // Check that the client isn't sending messages we don't understand - if (msg_header[0] != 0x81 && msg_header[0] != 0x82) - return RMT_ERROR_WEBSOCKET_BAD_FRAME_HEADER; - - // Get message length and check to see if it's a marker for a wider length - msg_length = msg_header[1] & 0x7F; - size_bytes_remaining = 0; - switch (msg_length) - { - case 126: - size_bytes_remaining = 2; - break; - case 127: - size_bytes_remaining = 8; - break; - } - - if (size_bytes_remaining > 0) - { - // Receive the wider bytes of the length - rmtU8 size_bytes[8]; - error = TCPSocket_Receive(web_socket->tcp_socket, size_bytes, size_bytes_remaining, 20); - if (error != RMT_ERROR_NONE) - return RMT_ERROR_WEBSOCKET_BAD_FRAME_HEADER_SIZE; - - // Calculate new length, MSB first - msg_length = 0; - for (i = 0; i < size_bytes_remaining; i++) - msg_length |= size_bytes[i] << ((size_bytes_remaining - 1 - i) * 8); - } - - // Receive any message data masks - mask_present = (msg_header[1] & 0x80) != 0 ? RMT_TRUE : RMT_FALSE; - if (mask_present) - { - error = TCPSocket_Receive(web_socket->tcp_socket, web_socket->data.mask, 4, 20); - if (error != RMT_ERROR_NONE) - return error; - } - - web_socket->frame_bytes_remaining = msg_length; - web_socket->mask_offset = 0; - - return RMT_ERROR_NONE; -} - -static rmtError WebSocket_Receive(WebSocket* web_socket, void* data, rmtU32* msg_len, rmtU32 length, rmtU32 timeout_ms) -{ - SocketStatus status; - char* cur_data; - char* end_data; - rmtU32 start_ms, now_ms; - rmtU32 bytes_to_read; - rmtError error; - - assert(web_socket != NULL); - - // Can't read with any socket errors - status = WebSocket_PollStatus(web_socket); - if (status.error_state != RMT_ERROR_NONE) - return status.error_state; - - cur_data = (char*)data; - end_data = cur_data + length; - - start_ms = msTimer_Get(); - while (cur_data < end_data) - { - // Get next WebSocket frame if we've run out of data to read from the socket - if (web_socket->frame_bytes_remaining == 0) - { - error = ReceiveFrameHeader(web_socket); - if (error != RMT_ERROR_NONE) - return error; - - // Set output message length only on initial receive - if (msg_len != NULL) - *msg_len = web_socket->frame_bytes_remaining; - } - - // Read as much required data as possible - bytes_to_read = web_socket->frame_bytes_remaining < length ? web_socket->frame_bytes_remaining : length; - error = TCPSocket_Receive(web_socket->tcp_socket, cur_data, bytes_to_read, 20); - if (error == RMT_ERROR_SOCKET_RECV_FAILED) - return error; - - // If there's a stall receiving the data, check for timeout - if (error == RMT_ERROR_SOCKET_RECV_NO_DATA || error == RMT_ERROR_SOCKET_RECV_TIMEOUT) - { - now_ms = msTimer_Get(); - if (now_ms - start_ms > timeout_ms) - return RMT_ERROR_SOCKET_RECV_TIMEOUT; - continue; - } - - // Apply data mask - if (web_socket->data.mask_u32 != 0) - { - rmtU32 i; - for (i = 0; i < bytes_to_read; i++) - { - *((rmtU8*)cur_data + i) ^= web_socket->data.mask[web_socket->mask_offset & 3]; - web_socket->mask_offset++; - } - } - - cur_data += bytes_to_read; - web_socket->frame_bytes_remaining -= bytes_to_read; - } - - return RMT_ERROR_NONE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @MESSAGEQ: Multiple producer, single consumer message queue ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef enum MessageID -{ - MsgID_NotReady, - MsgID_AddToStringTable, - MsgID_LogText, - MsgID_SampleTree, - MsgID_ProcessorThreads, - MsgID_ThreadName, - MsgID_None, - MsgID_Force32Bits = 0xFFFFFFFF, -} MessageID; - -typedef struct Message -{ - MessageID id; - - rmtU32 payload_size; - - // For telling which thread the message came from in the debugger - struct ThreadProfiler* threadProfiler; - - rmtU8 payload[1]; -} Message; - -// Multiple producer, single consumer message queue that uses its own data buffer -// to store the message data. -typedef struct rmtMessageQueue -{ - rmtU32 size; - - // The physical address of this data buffer is pointed to by two sequential - // virtual memory pages, allowing automatic wrap-around of any reads or writes - // that exceed the limits of the buffer. - VirtualMirrorBuffer* data; - - // Read/write position never wrap allowing trivial overflow checks - // with easier debugging - rmtU32 read_pos; - rmtU32 write_pos; - -} rmtMessageQueue; - -static rmtError rmtMessageQueue_Constructor(rmtMessageQueue* queue, rmtU32 size) -{ - rmtError error; - - assert(queue != NULL); - - // Set defaults - queue->size = 0; - queue->data = NULL; - queue->read_pos = 0; - queue->write_pos = 0; - - New_2(VirtualMirrorBuffer, queue->data, size, 10); - if (error != RMT_ERROR_NONE) - return error; - - // The mirror buffer needs to be page-aligned and will change the requested - // size to match that. - queue->size = queue->data->size; - - // Set the entire buffer to not ready message - memset(queue->data->ptr, MsgID_NotReady, queue->size); - - return RMT_ERROR_NONE; -} - -static void rmtMessageQueue_Destructor(rmtMessageQueue* queue) -{ - assert(queue != NULL); - Delete(VirtualMirrorBuffer, queue->data); -} - -static rmtU32 rmtMessageQueue_SizeForPayload(rmtU32 payload_size) -{ - // Add message header and align for ARM platforms - rmtU32 size = sizeof(Message) + payload_size; - size = (size + 3) & ~3U; - return size; -} - -static Message* rmtMessageQueue_AllocMessage(rmtMessageQueue* queue, rmtU32 payload_size, - struct ThreadProfiler* thread_profiler) -{ - Message* msg; - - rmtU32 write_size = rmtMessageQueue_SizeForPayload(payload_size); - - assert(queue != NULL); - - for (;;) - { - // Check for potential overflow - // Order of loads means allocation failure can happen when enough space has just been freed - // However, incorrect overflows are not possible - rmtU32 s = queue->size; - rmtU32 w = LoadAcquire(&queue->write_pos); - rmtU32 r = LoadAcquire(&queue->read_pos); - if ((int)(w - r) > ((int)(s - write_size))) - return NULL; - - // Point to the newly allocated space - msg = (Message*)(queue->data->ptr + (w & (s - 1))); - - // Increment the write position, leaving the loop if this is the thread that succeeded - if (AtomicCompareAndSwap(&queue->write_pos, w, w + write_size) == RMT_TRUE) - { - // Safe to set payload size after thread claims ownership of this allocated range - msg->payload_size = payload_size; - msg->threadProfiler = thread_profiler; - break; - } - } - - return msg; -} - -static void rmtMessageQueue_CommitMessage(Message* message, MessageID id) -{ - assert(message != NULL); - - // Setting the message ID signals to the consumer that the message is ready - assert(LoadAcquire((rmtU32*)&message->id) == MsgID_NotReady); - StoreRelease((rmtU32*)&message->id, id); -} - -Message* rmtMessageQueue_PeekNextMessage(rmtMessageQueue* queue) -{ - Message* ptr; - rmtU32 r, w; - MessageID id; - - assert(queue != NULL); - - // First check that there are bytes queued - w = LoadAcquire(&queue->write_pos); - r = queue->read_pos; - if (w - r == 0) - return NULL; - - // Messages are in the queue but may not have been commit yet - // Messages behind this one may have been commit but it's not reachable until - // the next one in the queue is ready. - r = r & (queue->size - 1); - ptr = (Message*)(queue->data->ptr + r); - id = (MessageID)LoadAcquire((rmtU32*)&ptr->id); - if (id != MsgID_NotReady) - return ptr; - - return NULL; -} - -static void rmtMessageQueue_ConsumeNextMessage(rmtMessageQueue* queue, Message* message) -{ - rmtU32 message_size, read_pos; - - assert(queue != NULL); - assert(message != NULL); - - // Setting the message ID to "not ready" serves as a marker to the consumer that even though - // space has been allocated for a message, the message isn't ready to be consumed - // yet. - // - // We can't do that when allocating the message because multiple threads will be fighting for - // the same location. Instead, clear out any messages just read by the consumer before advancing - // the read position so that a winning thread's allocation will inherit the "not ready" state. - // - // This costs some write bandwidth and has the potential to flush cache to other cores. - message_size = rmtMessageQueue_SizeForPayload(message->payload_size); - memset(message, MsgID_NotReady, message_size); - - // Advance read position - read_pos = queue->read_pos + message_size; - StoreRelease(&queue->read_pos, read_pos); -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @NETWORK: Network Server ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef rmtError (*Server_ReceiveHandler)(void*, char*, rmtU32); - -typedef struct -{ - WebSocket* listen_socket; - - WebSocket* client_socket; - - rmtU32 last_ping_time; - - rmtU16 port; - - rmtBool reuse_open_port; - rmtBool limit_connections_to_localhost; - - // A dynamically-sized buffer used for binary-encoding messages and sending to the client - Buffer* bin_buf; - - // Handler for receiving messages from the client - Server_ReceiveHandler receive_handler; - void* receive_handler_context; -} Server; - -static rmtError Server_CreateListenSocket(Server* server, rmtU16 port, rmtBool reuse_open_port, - rmtBool limit_connections_to_localhost) -{ - rmtError error = RMT_ERROR_NONE; - - New_1(WebSocket, server->listen_socket, NULL); - if (error == RMT_ERROR_NONE) - error = WebSocket_RunServer(server->listen_socket, port, reuse_open_port, limit_connections_to_localhost, - WEBSOCKET_BINARY); - - return error; -} - -static rmtError Server_Constructor(Server* server, rmtU16 port, rmtBool reuse_open_port, - rmtBool limit_connections_to_localhost) -{ - rmtError error; - - assert(server != NULL); - server->listen_socket = NULL; - server->client_socket = NULL; - server->last_ping_time = 0; - server->port = port; - server->reuse_open_port = reuse_open_port; - server->limit_connections_to_localhost = limit_connections_to_localhost; - server->bin_buf = NULL; - server->receive_handler = NULL; - server->receive_handler_context = NULL; - - // Create the binary serialisation buffer - New_1(Buffer, server->bin_buf, 4096); - if (error != RMT_ERROR_NONE) - return error; - - // Create the listening WebSocket - return Server_CreateListenSocket(server, port, reuse_open_port, limit_connections_to_localhost); -} - -static void Server_Destructor(Server* server) -{ - assert(server != NULL); - Delete(WebSocket, server->client_socket); - Delete(WebSocket, server->listen_socket); - Delete(Buffer, server->bin_buf); -} - -static rmtBool Server_IsClientConnected(Server* server) -{ - assert(server != NULL); - return server->client_socket != NULL ? RMT_TRUE : RMT_FALSE; -} - -static void Server_DisconnectClient(Server* server) -{ - WebSocket* client_socket; - - assert(server != NULL); - - // NULL the variable before destroying the socket - client_socket = server->client_socket; - server->client_socket = NULL; - CompilerWriteFence(); - Delete(WebSocket, client_socket); -} - -static rmtError Server_Send(Server* server, const void* data, rmtU32 length, rmtU32 timeout) -{ - assert(server != NULL); - if (Server_IsClientConnected(server)) - { - rmtError error = WebSocket_Send(server->client_socket, data, length, timeout); - if (error == RMT_ERROR_SOCKET_SEND_FAIL) - Server_DisconnectClient(server); - - return error; - } - - return RMT_ERROR_NONE; -} - -static rmtError Server_ReceiveMessage(Server* server, char message_first_byte, rmtU32 message_length) -{ - char message_data[1024]; - rmtError error; - - // Check for potential message data overflow - if (message_length >= sizeof(message_data) - 1) - { - rmt_LogText("Ignoring console input bigger than internal receive buffer (1024 bytes)"); - return RMT_ERROR_NONE; - } - - // Receive the rest of the message - message_data[0] = message_first_byte; - error = WebSocket_Receive(server->client_socket, message_data + 1, NULL, message_length - 1, 100); - if (error != RMT_ERROR_NONE) - return error; - message_data[message_length] = 0; - - // Each message must have a descriptive 4 byte header - if (message_length < 4) - return RMT_ERROR_NONE; - - // Dispatch to handler - if (server->receive_handler) - error = server->receive_handler(server->receive_handler_context, message_data, message_length); - - return error; -} - -static void Server_Update(Server* server) -{ - rmtU32 cur_time; - - assert(server != NULL); - - // Recreate the listening socket if it's been destroyed earlier - if (server->listen_socket == NULL) - Server_CreateListenSocket(server, server->port, server->reuse_open_port, - server->limit_connections_to_localhost); - - if (server->listen_socket != NULL && server->client_socket == NULL) - { - // Accept connections as long as there is no client connected - WebSocket* client_socket = NULL; - rmtError error = WebSocket_AcceptConnection(server->listen_socket, &client_socket); - if (error == RMT_ERROR_NONE) - { - server->client_socket = client_socket; - } - else - { - // Destroy the listen socket on failure to accept - // It will get recreated in another update - Delete(WebSocket, server->listen_socket); - } - } - - else - { - // Loop checking for incoming messages - for (;;) - { - // Inspect first byte to see if a message is there - char message_first_byte; - rmtU32 message_length; - rmtError error = WebSocket_Receive(server->client_socket, &message_first_byte, &message_length, 1, 0); - if (error == RMT_ERROR_NONE) - { - // Parse remaining message - error = Server_ReceiveMessage(server, message_first_byte, message_length); - if (error != RMT_ERROR_NONE) - { - Server_DisconnectClient(server); - break; - } - - // Check for more... - continue; - } - - // Passable errors... - if (error == RMT_ERROR_SOCKET_RECV_NO_DATA) - { - // No data available - break; - } - - if (error == RMT_ERROR_SOCKET_RECV_TIMEOUT) - { - // Data not available yet, can afford to ignore as we're only reading the first byte - break; - } - - // Anything else is an error that may have closed the connection - Server_DisconnectClient(server); - break; - } - } - - // Send pings to the client every second - cur_time = msTimer_Get(); - if (cur_time - server->last_ping_time > 1000) - { - Buffer* bin_buf = server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - Buffer_WriteStringZ(bin_buf, "PING"); - Server_Send(server, bin_buf->data, bin_buf->bytes_used, 10); - server->last_ping_time = cur_time; - } -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @SAMPLE: Base Sample Description for CPU by default ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#define SAMPLE_NAME_LEN 128 - -typedef enum SampleType -{ - SampleType_CPU, - SampleType_CUDA, - SampleType_D3D11, - SampleType_OpenGL, - SampleType_Metal, - SampleType_Count, -} SampleType; - -typedef struct Sample -{ - // Inherit so that samples can be quickly allocated - ObjectLink Link; - - enum SampleType type; - - // Hash generated from sample name - rmtU32 name_hash; - - // Unique, persistent ID among all samples - rmtU32 unique_id; - - // Null-terminated string storing the hash-prefixed 6-digit colour - rmtU8 unique_id_html_colour[8]; - - // Links to related samples in the tree - struct Sample* parent; - struct Sample* first_child; - struct Sample* last_child; - struct Sample* next_sibling; - - // Keep track of child count to distinguish from repeated calls to the same function at the same stack level - // This is also mixed with the callstack hash to allow consistent addressing of any point in the tree - rmtU32 nb_children; - - // Sample end points and length in microseconds - rmtU64 us_start; - rmtU64 us_end; - rmtU64 us_length; - - // Total sampled length of all children - rmtU64 us_sampled_length; - - // Number of times this sample was used in a call in aggregate mode, 1 otherwise - rmtU32 call_count; - - // Current and maximum sample recursion depths - rmtU16 recurse_depth; - rmtU16 max_recurse_depth; - -} Sample; - -static rmtError Sample_Constructor(Sample* sample) -{ - assert(sample != NULL); - - ObjectLink_Constructor((ObjectLink*)sample); - - sample->type = SampleType_CPU; - sample->name_hash = 0; - sample->unique_id = 0; - sample->unique_id_html_colour[0] = '#'; - sample->unique_id_html_colour[1] = 0; - sample->unique_id_html_colour[7] = 0; - sample->parent = NULL; - sample->first_child = NULL; - sample->last_child = NULL; - sample->next_sibling = NULL; - sample->nb_children = 0; - sample->us_start = 0; - sample->us_end = 0; - sample->us_length = 0; - sample->us_sampled_length = 0; - sample->call_count = 0; - sample->recurse_depth = 0; - sample->max_recurse_depth = 0; - - return RMT_ERROR_NONE; -} - -static void Sample_Destructor(Sample* sample) -{ - RMT_UNREFERENCED_PARAMETER(sample); -} - -static void Sample_Prepare(Sample* sample, rmtU32 name_hash, Sample* parent) -{ - sample->name_hash = name_hash; - sample->unique_id = 0; - sample->parent = parent; - sample->first_child = NULL; - sample->last_child = NULL; - sample->next_sibling = NULL; - sample->nb_children = 0; - sample->us_start = 0; - sample->us_end = 0; - sample->us_length = 0; - sample->us_sampled_length = 0; - sample->call_count = 1; - sample->recurse_depth = 0; - sample->max_recurse_depth = 0; -} - -static void Sample_Close(Sample* sample, rmtU64 us_end) -{ - // Aggregate samples use us_end to store start so that us_start is preserved - rmtU64 us_length = 0; - if (sample->call_count > 1 && sample->max_recurse_depth == 0) - { - us_length = (us_end - sample->us_end); - } - else - { - us_length = (us_end - sample->us_start); - } - - sample->us_length += us_length; - - // Sum length on the parent to track un-sampled time in the parent - if (sample->parent != NULL) - { - sample->parent->us_sampled_length += us_length; - } -} - -static void Sample_CopyState(Sample* dst_sample, const Sample* src_sample) -{ - // Copy fields that don't override destination allocator links or transfer source sample tree positioning - // Also ignoring unique_id_html_colour as that's calculated in the Remotery thread - dst_sample->type = src_sample->type; - dst_sample->name_hash = src_sample->name_hash; - dst_sample->unique_id = src_sample->unique_id; - dst_sample->nb_children = src_sample->nb_children; - dst_sample->us_start = src_sample->us_start; - dst_sample->us_end = src_sample->us_end; - dst_sample->us_length = src_sample->us_length; - dst_sample->us_sampled_length = src_sample->us_sampled_length; - dst_sample->call_count = src_sample->call_count; - dst_sample->recurse_depth = src_sample->recurse_depth; - dst_sample->max_recurse_depth = src_sample->max_recurse_depth; - - // Prepare empty tree links - dst_sample->parent = NULL; - dst_sample->first_child = NULL; - dst_sample->last_child = NULL; - dst_sample->next_sibling = NULL; -} - -#define BIN_ERROR_CHECK(stmt) \ - { \ - error = stmt; \ - if (error != RMT_ERROR_NONE) \ - return error; \ - } - -static rmtError bin_SampleArray(Buffer* buffer, Sample* parent_sample); - -static rmtError bin_Sample(Buffer* buffer, Sample* sample) -{ - rmtError error; - - assert(sample != NULL); - - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, sample->name_hash)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, sample->unique_id)); - BIN_ERROR_CHECK(Buffer_Write(buffer, sample->unique_id_html_colour, 7)); - BIN_ERROR_CHECK(Buffer_WriteU64(buffer, sample->us_start)); - BIN_ERROR_CHECK(Buffer_WriteU64(buffer, sample->us_length)); - BIN_ERROR_CHECK(Buffer_WriteU64(buffer, maxS64(sample->us_length - sample->us_sampled_length, 0))); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, sample->call_count)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, sample->max_recurse_depth)); - BIN_ERROR_CHECK(bin_SampleArray(buffer, sample)); - - return RMT_ERROR_NONE; -} - -static rmtError bin_SampleArray(Buffer* buffer, Sample* parent_sample) -{ - rmtError error; - Sample* sample; - - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, parent_sample->nb_children)); - for (sample = parent_sample->first_child; sample != NULL; sample = sample->next_sibling) - BIN_ERROR_CHECK(bin_Sample(buffer, sample)); - - return RMT_ERROR_NONE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @SAMPLETREE: A tree of samples with their allocator ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct SampleTree -{ - // Allocator for all samples - ObjectAllocator* allocator; - - // Root sample for all samples created by this thread - Sample* root; - - // Most recently pushed sample - Sample* currentParent; - - // Last time this sample tree was completed and sent to listeners, for stall detection - rmtU32 msLastTreeSendTime; - - // Lightweight flag, changed with release/acquire semantics to inform the stall detector the state of the tree is unreliable - rmtU32 treeBeingModified; - -} SampleTree; - -// Notify tree watchers that its structure is in the process of being changed -#define ModifySampleTree(tree, statements) \ - StoreRelease(&tree->treeBeingModified, 1); \ - statements; \ - StoreRelease(&tree->treeBeingModified, 0); - -static rmtError SampleTree_Constructor(SampleTree* tree, rmtU32 sample_size, ObjConstructor constructor, - ObjDestructor destructor) -{ - rmtError error; - - assert(tree != NULL); - - tree->allocator = NULL; - tree->root = NULL; - tree->currentParent = NULL; - StoreRelease(&tree->msLastTreeSendTime, 0); - StoreRelease(&tree->treeBeingModified, 0); - - // Create the sample allocator - New_3(ObjectAllocator, tree->allocator, sample_size, constructor, destructor); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Create a root sample that's around for the lifetime of the thread - error = ObjectAllocator_Alloc(tree->allocator, (void**)&tree->root); - if (error != RMT_ERROR_NONE) - { - return error; - } - Sample_Prepare(tree->root, 0, NULL); - tree->currentParent = tree->root; - - return RMT_ERROR_NONE; -} - -static void SampleTree_Destructor(SampleTree* tree) -{ - assert(tree != NULL); - - if (tree->root != NULL) - { - ObjectAllocator_Free(tree->allocator, tree->root); - tree->root = NULL; - } - - Delete(ObjectAllocator, tree->allocator); -} - -static rmtU32 HashCombine(rmtU32 hash_a, rmtU32 hash_b) -{ - // A sequence of 32 uniformly random bits so that each bit of the combined hash is changed on application - // Derived from the golden ratio: UINT_MAX / ((1 + sqrt(5)) / 2) - // In reality it's just an arbitrary value which happens to work well, avoiding mapping all zeros to zeros. - // http://burtleburtle.net/bob/hash/doobs.html - static rmtU32 random_bits = 0x9E3779B9; - hash_a ^= hash_b + random_bits + (hash_a << 6) + (hash_a >> 2); - return hash_a; -} - -static rmtError SampleTree_Push(SampleTree* tree, rmtU32 name_hash, rmtU32 flags, Sample** sample) -{ - Sample* parent; - rmtError error; - rmtU32 unique_id; - - // As each tree has a root sample node allocated, a parent must always be present - assert(tree != NULL); - assert(tree->currentParent != NULL); - parent = tree->currentParent; - - // Assume no flags is the common case and predicate branch checks - if (flags != 0) - { - // Check root status - if ((flags & RMTSF_Root) != 0) - { - assert(parent->parent == NULL); - } - - if ((flags & RMTSF_Aggregate) != 0) - { - // Linear search for previous instance of this sample name - Sample* sibling; - for (sibling = parent->first_child; sibling != NULL; sibling = sibling->next_sibling) - { - if (sibling->name_hash == name_hash) - { - tree->currentParent = sibling; - sibling->call_count++; - *sample = sibling; - return RMT_ERROR_NONE; - } - } - } - - // Collapse sample on recursion - if ((flags & RMTSF_Recursive) != 0 && parent->name_hash == name_hash) - { - parent->recurse_depth++; - parent->max_recurse_depth = maxU16(parent->max_recurse_depth, parent->recurse_depth); - parent->call_count++; - *sample = parent; - return RMT_ERROR_RECURSIVE_SAMPLE; - } - } - - // Allocate a new sample - error = ObjectAllocator_Alloc(tree->allocator, (void**)sample); - if (error != RMT_ERROR_NONE) - { - return error; - } - Sample_Prepare(*sample, name_hash, parent); - - // Generate a unique ID for this sample in the tree - unique_id = parent->unique_id; - unique_id = HashCombine(unique_id, (*sample)->name_hash); - unique_id = HashCombine(unique_id, parent->nb_children); - (*sample)->unique_id = unique_id; - - // Add sample to its parent - parent->nb_children++; - if (parent->first_child == NULL) - { - parent->first_child = *sample; - parent->last_child = *sample; - } - else - { - assert(parent->last_child != NULL); - parent->last_child->next_sibling = *sample; - parent->last_child = *sample; - } - - // Make this sample the new parent of any newly created samples - tree->currentParent = *sample; - - return RMT_ERROR_NONE; -} - -static void SampleTree_Pop(SampleTree* tree, Sample* sample) -{ - assert(tree != NULL); - assert(sample != NULL); - assert(sample != tree->root); - tree->currentParent = sample->parent; -} - -static ObjectLink* FlattenSamples(Sample* sample, rmtU32* nb_samples) -{ - Sample* child; - ObjectLink* cur_link = &sample->Link; - - assert(sample != NULL); - assert(nb_samples != NULL); - - *nb_samples += 1; - sample->Link.next = (ObjectLink*)sample->first_child; - - // Link all children together - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - ObjectLink* last_link = FlattenSamples(child, nb_samples); - last_link->next = (ObjectLink*)child->next_sibling; - cur_link = last_link; - } - - // Clear child info - sample->first_child = NULL; - sample->last_child = NULL; - sample->nb_children = 0; - - return cur_link; -} - -static void FreeSamples(Sample* sample, ObjectAllocator* allocator) -{ - // Chain all samples together in a flat list - rmtU32 nb_cleared_samples = 0; - ObjectLink* last_link = FlattenSamples(sample, &nb_cleared_samples); - - // Release the complete sample memory range - if (sample->Link.next != NULL) - { - ObjectAllocator_FreeRange(allocator, sample, last_link, nb_cleared_samples); - } - else - { - ObjectAllocator_Free(allocator, sample); - } -} - -static rmtError SampleTree_CopySample(Sample** out_dst_sample, Sample* dst_parent_sample, ObjectAllocator* allocator, const Sample* src_sample) -{ - Sample* src_child; - - // Allocate a copy of the sample - Sample* dst_sample; - rmtError error = ObjectAllocator_Alloc(allocator, (void**)&dst_sample); - if (error != RMT_ERROR_NONE) - { - return error; - } - Sample_CopyState(dst_sample, src_sample); - - // Link the newly created/copied sample to its parent - // Note that metrics including nb_children have already been copied by the Sample_CopyState call - if (dst_parent_sample != NULL) - { - if (dst_parent_sample->first_child == NULL) - { - dst_parent_sample->first_child = dst_sample; - dst_parent_sample->last_child = dst_sample; - } - else - { - assert(dst_parent_sample->last_child != NULL); - dst_parent_sample->last_child->next_sibling = dst_sample; - dst_parent_sample->last_child = dst_sample; - } - } - - // Copy all children - for (src_child = src_sample->first_child; src_child != NULL; src_child = src_child->next_sibling) - { - Sample* dst_child; - error = SampleTree_CopySample(&dst_child, dst_sample, allocator, src_child); - if (error != RMT_ERROR_NONE) - { - return error; - } - } - - *out_dst_sample = dst_sample; - - return RMT_ERROR_NONE; -} - -static rmtError SampleTree_Copy(SampleTree* dst_tree, const SampleTree* src_tree) -{ - rmtError error; - - // Sample trees are allocated at startup and their allocators are persistent for the lifetime of the Remotery object. - // It's safe to reference the allocator and use it for sample lifetime. - ObjectAllocator* allocator = src_tree->allocator; - dst_tree->allocator = allocator; - - // Copy from the root - error = SampleTree_CopySample(&dst_tree->root, NULL, allocator, src_tree->root); - if (error != RMT_ERROR_NONE) - { - return error; - } - dst_tree->currentParent = dst_tree->root; - - return RMT_ERROR_NONE; -} - -typedef struct Msg_SampleTree -{ - Sample* rootSample; - - ObjectAllocator* allocator; - - rmtPStr threadName; - - rmtBool partialTree; -} Msg_SampleTree; - -static void QueueSampleTree(rmtMessageQueue* queue, Sample* sample, ObjectAllocator* allocator, rmtPStr thread_name, - struct ThreadProfiler* thread_profiler, rmtBool partial_tree) -{ - Msg_SampleTree* payload; - - // Attempt to allocate a message for sending the tree to the viewer - Message* message = rmtMessageQueue_AllocMessage(queue, sizeof(Msg_SampleTree), thread_profiler); - if (message == NULL) - { - // Discard tree samples on failure - FreeSamples(sample, allocator); - return; - } - - // Populate and commit - payload = (Msg_SampleTree*)message->payload; - payload->rootSample = sample; - payload->allocator = allocator; - payload->threadName = thread_name; - payload->partialTree = partial_tree; - rmtMessageQueue_CommitMessage(message, MsgID_SampleTree); -} - -typedef struct Msg_AddToStringTable -{ - rmtU32 hash; - rmtU32 length; -} Msg_AddToStringTable; - -static rmtBool QueueAddToStringTable(rmtMessageQueue* queue, rmtU32 hash, const char* string, size_t length, struct ThreadProfiler* thread_profiler) -{ - Msg_AddToStringTable* payload; - - // Attempt to allocate a message om the queue - size_t nb_string_bytes = length + 1; - Message* message = rmtMessageQueue_AllocMessage(queue, sizeof(Msg_AddToStringTable) + nb_string_bytes, thread_profiler); - if (message == NULL) - { - return RMT_FALSE; - } - - // Populate and commit - payload = (Msg_AddToStringTable*)message->payload; - payload->hash = hash; - payload->length = length; - memcpy(payload + 1, string, nb_string_bytes); - rmtMessageQueue_CommitMessage(message, MsgID_AddToStringTable); - - return RMT_TRUE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @TPROFILER: Thread Profiler data, storing both sampling and instrumentation results ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#if RMT_USE_D3D11 -typedef struct D3D11 D3D11; -static rmtError D3D11_Create(D3D11** d3d11); -static void D3D11_Destructor(D3D11* d3d11); -#endif - -typedef struct ThreadProfiler -{ - // Storage for backing up initial register values when modifying a thread's context - rmtU64 registerBackup0; // 0 - rmtU64 registerBackup1; // 8 - rmtU64 registerBackup2; // 16 - - // Used to schedule callbacks taking into account some threads may be sleeping - rmtS32 nbSamplesWithoutCallback; // 24 - - // Index of the processor the thread was last seen running on - rmtU32 processorIndex; // 28 - rmtU32 lastProcessorIndex; - - // OS thread ID/handle - rmtThreadId threadId; - rmtThreadHandle threadHandle; - - // Thread name stored for sending to the viewer - char threadName[64]; - rmtU32 threadNameHash; - - // Store a unique sample tree for each type - SampleTree* sampleTrees[SampleType_Count]; - -#if RMT_USE_D3D11 - D3D11* d3d11; -#endif -} ThreadProfiler; - -static rmtError QueueThreadName(rmtMessageQueue* queue, const char* name, ThreadProfiler* thread_profiler) -{ - Message* message; - rmtU32 name_length; - - assert(queue != NULL); - - // Allocate some space for the message - name_length = strnlen_s(name, 64); - message = rmtMessageQueue_AllocMessage(queue, sizeof(rmtU32) * 2 + name_length, thread_profiler); - if (message == NULL) - { - return RMT_ERROR_UNKNOWN; - } - - // Copy and commit - U32ToByteArray(message->payload, MurmurHash3_x86_32(name, name_length, 0)); - U32ToByteArray(message->payload + sizeof(rmtU32), name_length); - memcpy(message->payload + sizeof(rmtU32) * 2, name, name_length); - rmtMessageQueue_CommitMessage(message, MsgID_ThreadName); - - return RMT_ERROR_NONE; -} - -static rmtError ThreadProfiler_Constructor(rmtMessageQueue* mq_to_rmt, ThreadProfiler* thread_profiler, rmtThreadId thread_id) -{ - rmtU32 name_length; - rmtError error; - - // Set defaults - thread_profiler->nbSamplesWithoutCallback = 0; - thread_profiler->processorIndex = (rmtU32)-1; - thread_profiler->lastProcessorIndex = (rmtU32)-1; - thread_profiler->threadId = thread_id; - memset(thread_profiler->sampleTrees, 0, sizeof(thread_profiler->sampleTrees)); - -#if RMT_USE_D3D11 - thread_profiler->d3d11 = NULL; -#endif - - // Pre-open the thread handle - error = rmtOpenThreadHandle(thread_id, &thread_profiler->threadHandle); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Name the thread and send a thread name notification immediately - // Users can override this at a later point with the Remotery thread name API - rmtGetThreadName(thread_id, thread_profiler->threadHandle, thread_profiler->threadName, sizeof(thread_profiler->threadName)); - name_length = strnlen_s(thread_profiler->threadName, 64); - thread_profiler->threadNameHash = MurmurHash3_x86_32(thread_profiler->threadName, name_length, 0); - QueueThreadName(mq_to_rmt, thread_profiler->threadName, thread_profiler); - - // Create the CPU sample tree only. The rest are created on-demand as they need extra context to function correctly. - New_3(SampleTree, thread_profiler->sampleTrees[SampleType_CPU], sizeof(Sample), (ObjConstructor)Sample_Constructor, - (ObjDestructor)Sample_Destructor); - if (error != RMT_ERROR_NONE) - { - return error; - } - -#if RMT_USE_D3D11 - error = D3D11_Create(&thread_profiler->d3d11); - if (error != RMT_ERROR_NONE) - { - return error; - } -#endif - - return RMT_ERROR_NONE; -} - -static void ThreadProfiler_Destructor(ThreadProfiler* thread_profiler) -{ - rmtU32 index; - -#if RMT_USE_D3D11 - Delete(D3D11, thread_profiler->d3d11); -#endif - - for (index = 0; index < SampleType_Count; index++) - { - Delete(SampleTree, thread_profiler->sampleTrees[index]); - } - - rmtCloseThreadHandle(thread_profiler->threadHandle); -} - -static rmtError ThreadProfiler_Push(SampleTree* tree, rmtU32 name_hash, rmtU32 flags, Sample** sample) -{ - rmtError error; - ModifySampleTree(tree, - error = SampleTree_Push(tree, name_hash, flags, sample); - ); - return error; -} - -static rmtBool ThreadProfiler_Pop(ThreadProfiler* thread_profiler, rmtMessageQueue* queue, Sample* sample) -{ - SampleTree* tree = thread_profiler->sampleTrees[sample->type]; - SampleTree_Pop(tree, sample); - - // Are we back at the root? - if (tree->currentParent == tree->root) - { - Sample* root; - - // Disconnect all samples from the root and pack in the chosen message queue - ModifySampleTree(tree, - root = tree->root; - root->first_child = NULL; - root->last_child = NULL; - root->nb_children = 0; - ); - QueueSampleTree(queue, sample, tree->allocator, thread_profiler->threadName, thread_profiler, RMT_FALSE); - - // Update the last send time for this tree, for stall detection - StoreRelease(&tree->msLastTreeSendTime, (rmtU32)(sample->us_end / 1000)); - - return RMT_TRUE; - } - - return RMT_FALSE; -} - -static rmtU32 ThreadProfiler_GetNameHash(ThreadProfiler* thread_profiler, rmtMessageQueue* queue, rmtPStr name, rmtU32* hash_cache) -{ - size_t name_len; - rmtU32 name_hash; - - // Hash cache provided? - if (hash_cache != NULL) - { - // Calculate the hash first time round only - name_hash = *hash_cache; - if (name_hash == 0) - { - assert(name != NULL); - name_len = strnlen_s(name, 256); - name_hash = MurmurHash3_x86_32(name, name_len, 0); - - // Queue the string for the string table and only cache the hash if it succeeds - if (QueueAddToStringTable(queue, name_hash, name, name_len, thread_profiler) == RMT_TRUE) - { - *hash_cache = name_hash; - } - } - - return name_hash; - } - - // Have to recalculate and speculatively insert the name every time when no cache storage exists - name_len = strnlen_s(name, 256); - name_hash = MurmurHash3_x86_32(name, name_len, 0); - QueueAddToStringTable(queue, name_hash, name, name_len, thread_profiler); - return name_hash; -} - -typedef struct ThreadProfilers -{ - // Timer shared with Remotery threads - usTimer* timer; - - // Queue between clients and main remotery thread - rmtMessageQueue* mqToRmtThread; - - // On x64 machines this points to the sample function - void* compiledSampleFn; - rmtU32 compiledSampleFnSize; - - // Used to store thread profilers bound to an OS thread - rmtTLS threadProfilerTlsHandle; - - // Array of preallocated ThreadProfiler objects - // Read iteration is safe given that no incomplete ThreadProfiler objects will be encountered during iteration. - // The ThreadProfiler count is only incremented once a new ThreadProfiler is fully defined and ready to be used. - // Do not use this list to verify if a ThreadProfiler exists for a given thread. Use the mutex-guarded Get functions instead. - ThreadProfiler threadProfilers[256]; - rmtU32 nbThreadProfilers; - rmtU32 maxNbThreadProfilers; - - // Guards creation and existence-testing of the ThreadProfiler list - rmtMutex threadProfilerMutex; - - // Periodic thread sampling thread - rmtThread* threadSampleThread; - - // Periodic thread to processor gatherer - rmtThread* threadGatherThread; -} ThreadProfilers; - -static rmtError SampleThreadsLoop(rmtThread* rmt_thread); - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef RMT_ARCH_64BIT -static void* CreateSampleCallback(rmtU32* out_size); -#endif -#endif - -static rmtError ThreadProfilers_Constructor(ThreadProfilers* thread_profilers, usTimer* timer, rmtMessageQueue* mq_to_rmt_thread) -{ - rmtError error; - - // Set to default - thread_profilers->timer = timer; - thread_profilers->mqToRmtThread = mq_to_rmt_thread; - thread_profilers->compiledSampleFn = NULL; - thread_profilers->compiledSampleFnSize = 0; - thread_profilers->threadProfilerTlsHandle = TLS_INVALID_HANDLE; - thread_profilers->nbThreadProfilers = 0; - thread_profilers->maxNbThreadProfilers = sizeof(thread_profilers->threadProfilers) / sizeof(thread_profilers->threadProfilers[0]); - mtxInit(&thread_profilers->threadProfilerMutex); - thread_profilers->threadSampleThread = NULL; - thread_profilers->threadGatherThread = NULL; - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef RMT_ARCH_64BIT - thread_profilers->compiledSampleFn = CreateSampleCallback(&thread_profilers->compiledSampleFnSize); - if (thread_profilers->compiledSampleFn == NULL) - { - return RMT_ERROR_MALLOC_FAIL; - } -#endif -#endif - - // Allocate a TLS handle for the thread profilers - error = tlsAlloc(&thread_profilers->threadProfilerTlsHandle); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Kick-off the thread sampler - if (g_Settings.enableThreadSampler == RMT_TRUE) - { - New_2(rmtThread, thread_profilers->threadSampleThread, SampleThreadsLoop, thread_profilers); - if (error != RMT_ERROR_NONE) - { - return error; - } - } - - return RMT_ERROR_NONE; -} - -static void ThreadProfilers_Destructor(ThreadProfilers* thread_profilers) -{ - rmtU32 thread_index; - - Delete(rmtThread, thread_profilers->threadGatherThread); - Delete(rmtThread, thread_profilers->threadSampleThread); - - // Delete all profilers - for (thread_index = 0; thread_index < thread_profilers->nbThreadProfilers; thread_index++) - { - ThreadProfiler* thread_profiler = thread_profilers->threadProfilers + thread_index; - ThreadProfiler_Destructor(thread_profiler); - } - - if (thread_profilers->threadProfilerTlsHandle != TLS_INVALID_HANDLE) - { - tlsFree(thread_profilers->threadProfilerTlsHandle); - } - -#ifdef RMT_PLATFORM_WINDOWS -#ifdef RMT_ARCH_64BIT - if (thread_profilers->compiledSampleFn != NULL) - { - VirtualFree(thread_profilers->compiledSampleFn, 0, MEM_RELEASE); - } -#endif -#endif - - mtxDelete(&thread_profilers->threadProfilerMutex); -} - -static rmtError ThreadProfilers_GetThreadProfiler(ThreadProfilers* thread_profilers, rmtThreadId thread_id, ThreadProfiler** out_thread_profiler) -{ - rmtU32 profiler_index; - ThreadProfiler* thread_profiler; - rmtError error; - - mtxLock(&thread_profilers->threadProfilerMutex); - - // Linear search for a matching thread id - for (profiler_index = 0; profiler_index < thread_profilers->nbThreadProfilers; profiler_index++) - { - thread_profiler = thread_profilers->threadProfilers + profiler_index; - if (thread_profiler->threadId == thread_id) - { - *out_thread_profiler = thread_profiler; - mtxUnlock(&thread_profilers->threadProfilerMutex); - return RMT_ERROR_NONE; - } - } - - // Thread info not found so create a new one at the end - thread_profiler = thread_profilers->threadProfilers + thread_profilers->nbThreadProfilers; - error = ThreadProfiler_Constructor(thread_profilers->mqToRmtThread, thread_profiler, thread_id); - if (error != RMT_ERROR_NONE) - { - ThreadProfiler_Destructor(thread_profiler); - mtxUnlock(&thread_profilers->threadProfilerMutex); - return error; - } - *out_thread_profiler = thread_profiler; - - // Increment count for consume by read iterators - // Within the mutex so that there are no race conditions creating thread profilers - // Using release semantics to ensure a memory barrier for read iterators - StoreRelease(&thread_profilers->nbThreadProfilers, thread_profilers->nbThreadProfilers + 1); - - mtxUnlock(&thread_profilers->threadProfilerMutex); - - return RMT_ERROR_NONE; -} - -static rmtError ThreadProfilers_GetCurrentThreadProfiler(ThreadProfilers* thread_profilers, ThreadProfiler** out_thread_profiler) -{ - // Is there a thread profiler associated with this thread yet? - *out_thread_profiler = (ThreadProfiler*)tlsGet(thread_profilers->threadProfilerTlsHandle); - if (*out_thread_profiler == NULL) - { - // Allocate on-demand - rmtError error = ThreadProfilers_GetThreadProfiler(thread_profilers, rmtGetCurrentThreadId(), out_thread_profiler); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Bind to the curren thread - tlsSet(thread_profilers->threadProfilerTlsHandle, *out_thread_profiler); - } - - return RMT_ERROR_NONE; -} - -static rmtBool ThreadProfilers_ThreadInCallback(ThreadProfilers* thread_profilers, rmtCpuContext* context) -{ -#ifdef RMT_PLATFORM_WINDOWS -#ifdef RMT_ARCH_32BIT - if (context->Eip >= (DWORD)thread_profilers->compiledSampleFn && - context->Eip < (DWORD)((char*)thread_profilers->compiledSampleFn + thread_profilers->compiledSampleFnSize)) - { - return RMT_TRUE; - } -#else - if (context->Rip >= (DWORD64)thread_profilers->compiledSampleFn && - context->Rip < (DWORD64)((char*)thread_profilers->compiledSampleFn + thread_profilers->compiledSampleFnSize)) - { - return RMT_TRUE; - } -#endif -#endif - return RMT_FALSE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @TGATHER: Thread Gatherer, periodically polling for newly created threads ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -static void GatherThreads(ThreadProfilers* thread_profilers) -{ - rmtThreadHandle handle; - - assert(thread_profilers != NULL); - -#ifdef RMT_PLATFORM_WINDOWS - - // Create the snapshot - this is a slow call - handle = CreateToolhelp32Snapshot(TH32CS_SNAPTHREAD, 0); - if (handle != INVALID_HANDLE_VALUE) - { - BOOL success; - - THREADENTRY32 thread_entry; - thread_entry.dwSize = sizeof(thread_entry); - - // Loop through all threads owned by this process - success = Thread32First(handle, &thread_entry); - while (success == TRUE) - { - if (thread_entry.th32OwnerProcessID == GetCurrentProcessId()) - { - // Create thread profilers on-demand if there're not already there - ThreadProfiler* thread_profiler; - rmtError error = ThreadProfilers_GetThreadProfiler(thread_profilers, thread_entry.th32ThreadID, &thread_profiler); - if (error != RMT_ERROR_NONE) - { - // Not really worth bringing the whole profiler down here - rmt_LogText("REMOTERY ERROR: Failed to create Thread Profiler"); - } - } - - success = Thread32Next(handle, &thread_entry); - } - - CloseHandle(handle); - } - -#endif -} - -static rmtError GatherThreadsLoop(rmtThread* thread) -{ - ThreadProfilers* thread_profilers = (ThreadProfilers*)thread->param; - rmtU32 sleep_time = 100; - - assert(thread_profilers != NULL); - - rmt_SetCurrentThreadName("RemoteryGatherThreads"); - - while (thread->request_exit == RMT_FALSE) - { - // We want a long period of time between scanning for new threads as the process is a little expensive (~30ms here). - // However not too long so as to miss potentially detailed process startup data. - // Use reduced sleep time at startup to catch as many early thread creations as possible. - // TODO(don): We could get processes to register themselves to ensure no startup data is lost but the scan must still - // be present, to catch threads in a process that the user doesn't create (e.g. graphics driver threads). - GatherThreads(thread_profilers); - msSleep(sleep_time); - sleep_time = minU32(sleep_time * 2, 2000); - } - - return RMT_ERROR_NONE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @TSAMPLER: Sampling thread contexts ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -typedef struct Processor -{ - // Current thread profiler sampling this processor - ThreadProfiler* threadProfiler; - - rmtU32 sampleCount; - rmtU64 sampleTime; -} Processor; - -typedef struct Msg_ProcessorThreads -{ - // Running index of processor messages - rmtU64 messageIndex; - - // Processor array, leaking into the memory behind the struct - rmtU32 nbProcessors; - Processor processors[1]; -} Msg_ProcessorThreads; - -static void QueueProcessorThreads(rmtMessageQueue* queue, rmtU64 message_index, rmtU32 nb_processors, Processor* processors) -{ - Msg_ProcessorThreads* payload; - - // Attempt to allocate a message for sending processors to the viewer - rmtU32 array_size = (nb_processors - 1) * sizeof(Processor); - Message* message = rmtMessageQueue_AllocMessage(queue, sizeof(Msg_ProcessorThreads) + array_size, NULL); - if (message == NULL) - { - return; - } - - // Populate and commit - payload = (Msg_ProcessorThreads*)message->payload; - payload->messageIndex = message_index; - payload->nbProcessors = nb_processors; - memcpy(payload->processors, processors, nb_processors * sizeof(Processor)); - rmtMessageQueue_CommitMessage(message, MsgID_ProcessorThreads); -} - -#ifdef RMT_ARCH_32BIT -__declspec(naked) static void SampleCallback() -{ - // - // It's important to realise that this call can be pre-empted by the scheduler and shifted to another processor *while we are - // sampling which processor this thread is on*. - // - // This has two very important implications: - // - // * What we are sampling here is an *approximation* of the path of threads across processors. - // * These samples can't be used to "open" and "close" sample periods on a processor as it's highly likely you'll get many - // open events without a close, or vice versa. - // - // As such, we can only choose a sampling period and for each sample register which threads are on which processor. - // - // This is very different to hooking up the Event Tracing API (requiring Administrator elevation), which raises events for - // each context switch, directly from the kernel. - // - - __asm - { - // Push the EIP return address used by the final ret instruction - push ebx - - // We might be in the middle of something like a cmp/jmp instruction pair so preserve EFLAGS - // (Classic example which seems to pop up regularly is _RTC_CheckESP, with cmp/call/jne) - pushfd - - // Push all volatile registers as we don't know what the function calls below will destroy - push eax - push ecx - push edx - - // Retrieve and store the current processor index - call esi - mov [edi].processorIndex, eax - - // Mark as ready for scheduling another callback - // Intel x86 store release - mov [edi].nbSamplesWithoutCallback, 0 - - // Restore preserved register state - pop edx - pop ecx - pop eax - - // Restore registers used to provide parameters to the callback - mov ebx, dword ptr [edi].registerBackup0 - mov esi, dword ptr [edi].registerBackup1 - mov edi, dword ptr [edi].registerBackup2 - - // Restore EFLAGS - popfd - - // Pops the original EIP off the stack and jmps to origin suspend point in the thread - ret - } -} -#elif defined(RMT_ARCH_64BIT) -// Generated with https://defuse.ca/online-x86-assembler.htm -static rmtU8 SampleCallbackBytes[] = -{ - // Push the RIP return address used by the final ret instruction - 0x53, // push rbx - - // We might be in the middle of something like a cmp/jmp instruction pair so preserve RFLAGS - // (Classic example which seems to pop up regularly is _RTC_CheckESP, with cmp/call/jne) - 0x9C, // pushfq - - // Push all volatile registers as we don't know what the function calls below will destroy - 0x50, // push rax - 0x51, // push rcx - 0x52, // push rdx - 0x41, 0x50, // push r8 - 0x41, 0x51, // push r9 - 0x41, 0x52, // push r10 - 0x41, 0x53, // push r11 - - // Retrieve and store the current processor index - 0xFF, 0xD6, // call rsi - 0x89, 0x47, 0x1C, // mov dword ptr [rdi + 28], eax - - // Mark as ready for scheduling another callback - // Intel x64 store release - 0xC7, 0x47, 0x18, 0x00, 0x00, 0x00, 0x00, // mov dword ptr [rdi + 24], 0 - - // Restore preserved register state - 0x41, 0x5B, // pop r11 - 0x41, 0x5A, // pop r10 - 0x41, 0x59, // pop r9 - 0x41, 0x58, // pop r8 - 0x5A, // pop rdx - 0x59, // pop rcx - 0x58, // pop rax - - // Restore registers used to provide parameters to the callback - 0x48, 0x8B, 0x1F, // mov rbx, qword ptr [rdi + 0] - 0x48, 0x8B, 0x77, 0x08, // mov rsi, qword ptr [rdi + 8] - 0x48, 0x8B, 0x7F, 0x10, // mov rdi, qword ptr [rdi + 16] - - // Restore RFLAGS - 0x9D, // popfq - - // Pops the original EIP off the stack and jmps to origin suspend point in the thread - 0xC3 // ret -}; -#ifdef RMT_PLATFORM_WINDOWS -static void* CreateSampleCallback(rmtU32* out_size) -{ - // Allocate page for the generated code - DWORD size = 4096; - DWORD old_protect; - void* function = VirtualAlloc(NULL, size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE); - if (function == NULL) - { - return NULL; - } - - // Clear whole allocation to int 3h - memset(function, 0xCC, size); - - // Copy over the generated code - memcpy(function, SampleCallbackBytes, sizeof(SampleCallbackBytes)); - *out_size = sizeof(SampleCallbackBytes); - - // Enable execution - VirtualProtect(function, size, PAGE_EXECUTE_READ, &old_protect); - return function; -} -#endif -#endif - -#ifdef __cplusplus -static_assert(offsetof(ThreadProfiler, nbSamplesWithoutCallback) == 24, ""); -static_assert(offsetof(ThreadProfiler, processorIndex) == 28, ""); -#endif - -static void CloseOpenSamples(Sample* sample, rmtU64 sample_time_us, rmtU32 parents_are_last) -{ - Sample* child_sample; - - // Depth-first search into children as we want to close child samples before their parents - for (child_sample = sample->first_child; child_sample != NULL; child_sample = child_sample->next_sibling) - { - rmtU32 is_last = parents_are_last & (child_sample == sample->last_child ? 1 : 0); - CloseOpenSamples(child_sample, sample_time_us, is_last); - } - - // A chain of open samples will be linked from the root to the deepest, currently open sample - if (parents_are_last > 0) - { - Sample_Close(sample, sample_time_us); - } -} - -static rmtError CheckForStallingSamples(SampleTree* stalling_sample_tree, ThreadProfiler* thread_profiler, rmtU64 sample_time_us) -{ - SampleTree* sample_tree; - rmtU32 sample_time_s = (rmtU32)(sample_time_us / 1000); - - // Initialise to empty - stalling_sample_tree->root = NULL; - stalling_sample_tree->allocator = NULL; - - // Skip the stall check if the tree is being modified - sample_tree = thread_profiler->sampleTrees[SampleType_CPU]; - if (LoadAcquire(&sample_tree->treeBeingModified) != 0) - { - return RMT_ERROR_NONE; - } - - if (sample_tree != NULL) - { - // The root is a dummy root inserted on tree creation so check that for children - rmtBool send = RMT_FALSE; - Sample* root_sample = sample_tree->root; - if (root_sample != NULL && root_sample->nb_children > 0) - { - if (sample_time_s - LoadAcquire(&sample_tree->msLastTreeSendTime) > 1000) - { - send = RMT_TRUE; - StoreRelease(&sample_tree->msLastTreeSendTime, sample_time_s); - } - } - - if (send == RMT_TRUE) - { - // Make a local copy of the tree as we want to keep the current tree for active profiling - rmtError error = SampleTree_Copy(stalling_sample_tree, sample_tree); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Close all samples from the deepest open sample, right back to the root - CloseOpenSamples(stalling_sample_tree->root, sample_time_us, 1); - } - } - - return RMT_ERROR_NONE; -} - -static rmtError InitThreadSampling(ThreadProfilers* thread_profilers) -{ - rmtError error; - - rmt_SetCurrentThreadName("RemoterySampleThreads"); - - // Make an initial gather so that we have something to work with - GatherThreads(thread_profilers); - - // Kick-off the background thread that watches for new threads - New_2(rmtThread, thread_profilers->threadGatherThread, GatherThreadsLoop, thread_profilers); - if (error != RMT_ERROR_NONE) - { - return error; - } - -#ifdef RMT_PLATFORM_WINDOWS - // Ensure we can wake up every millisecond - if (timeBeginPeriod(1) != TIMERR_NOERROR) - { - return RMT_ERROR_UNKNOWN; - } -#endif - - // We're going to be shuffling thread visits to avoid the scheduler trying to predict a work-load based on sampling - // Use the global RNG with a random seed to start the shuffle - Well512_Init((rmtU32)time(NULL)); - - return RMT_ERROR_NONE; -} - -static rmtError SampleThreadsLoop(rmtThread* rmt_thread) -{ - rmtCpuContext context; - rmtU32 processor_message_index = 0; - rmtU32 nb_processors; - Processor* processors; - rmtU32 processor_index; - - ThreadProfilers* thread_profilers = (ThreadProfilers*)rmt_thread->param; - - rmtError error = InitThreadSampling(thread_profilers); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // If we can't figure out how many processors there are then we are running on an unsupported platform - nb_processors = rmtGetNbProcessors(); - if (nb_processors == 0) - { - return RMT_ERROR_UNKNOWN; - } - - // An array entry for each processor - processors = (Processor*)rmtMalloc(nb_processors * sizeof(Processor)); - for (processor_index = 0; processor_index < nb_processors; processor_index++) - { - processors[processor_index].threadProfiler = NULL; - processors[processor_index].sampleTime = 0; - } - - while (rmt_thread->request_exit == RMT_FALSE) - { - rmtU32 lfsr_seed; - rmtU32 lfsr_value; - - // Query how many threads the gather knows about this time round - rmtU32 nb_thread_profilers = LoadAcquire(&thread_profilers->nbThreadProfilers); - - // Calculate table size log2 required to fit count entries. Normally we would adjust the log2 input by -1 so that - // power-of-2 counts map to their exact bit offset and don't require a twice larger table. You can iterate indices - // 0 to (1<= nb_thread_profilers) - { - continue; - } - - // Ignore our own thread - thread_id = rmtGetCurrentThreadId(); - thread_profiler = thread_profilers->threadProfilers + thread_index; - if (thread_profiler->threadId == thread_id) - { - continue; - } - - // Suspend the thread so we can insert a callback - thread_handle = thread_profiler->threadHandle; - if (rmtSuspendThread(thread_handle) == RMT_FALSE) - { - continue; - } - - // Mark the processor this thread was last recorded as running on. - // Note that a thread might be pre-empted multiple times in-between sampling. Given a sampling rate equal to the - // scheduling quantum, this doesn't happen too often. However in such cases, whoever marks the processor last is - // the one that gets recorded. - sample_time_us = usTimer_Get(thread_profilers->timer); - sample_count = AtomicAdd(&thread_profiler->nbSamplesWithoutCallback, 1); - processor_index = thread_profiler->processorIndex; - if (processor_index != -1) - { - assert(processor_index < nb_processors); - processors[processor_index].threadProfiler = thread_profiler; - processors[processor_index].sampleCount = sample_count; - processors[processor_index].sampleTime = sample_time_us; - } - - // Swap in a new context with our callback if one is not already scheduled on this thread - if (sample_count == 0) - { - if (rmtGetUserModeThreadContext(thread_handle, &context) == RMT_TRUE && - // There is a slight window of opportunity, after which the callback sets nbSamplesWithoutCallback=0, - // for this loop to suspend a thread while it's executing the last instructions of the callback. - ThreadProfilers_ThreadInCallback(thread_profilers, &context) == RMT_FALSE) - { - #ifdef RMT_PLATFORM_WINDOWS - #ifdef RMT_ARCH_64BIT - thread_profiler->registerBackup0 = context.Rbx; - thread_profiler->registerBackup1 = context.Rsi; - thread_profiler->registerBackup2 = context.Rdi; - context.Rbx = context.Rip; - context.Rsi = (rmtU64)GetCurrentProcessorNumber; - context.Rdi = (rmtU64)thread_profiler; - context.Rip = (DWORD64)thread_profilers->compiledSampleFn; - #endif - #ifdef RMT_ARCH_32BIT - thread_profiler->registerBackup0 = context.Ebx; - thread_profiler->registerBackup1 = context.Esi; - thread_profiler->registerBackup2 = context.Edi; - context.Ebx = context.Eip; - context.Esi = (rmtU32)GetCurrentProcessorNumber; - context.Edi = (rmtU32)thread_profiler; - context.Eip = (DWORD)&SampleCallback; - #endif - #endif - - rmtSetThreadContext(thread_handle, &context); - } - else - { - AtomicAdd(&thread_profiler->nbSamplesWithoutCallback, -1); - } - } - - // While the thread is suspended take the chance to check for samples trees that may never complete - // Because SuspendThread on Windows is an async request, this needs to be placed at a point where the request completes - // Calling GetThreadContext will ensure the request is completed so this stall check is placed after that - CheckForStallingSamples(&stalling_sample_tree, thread_profiler, sample_time_us); - - rmtResumeThread(thread_handle); - - if (stalling_sample_tree.root != NULL) - { - // If there is stalling sample tree on this thread then send it to listeners. - // Do the send *outside* of all Suspend/Resume calls as we have no way of knowing who is reading/writing the queue - // Mark this as partial so that the listeners know it will be overwritten. - Sample* sample = stalling_sample_tree.root->first_child; - assert(sample != NULL); - QueueSampleTree(thread_profilers->mqToRmtThread, sample, stalling_sample_tree.allocator, thread_profiler->threadName, thread_profiler, RMT_TRUE); - } - - - } while (lfsr_value != lfsr_seed); - - // Filter all processor samples made in this pass - for (processor_index = 0; processor_index < nb_processors; processor_index++) - { - Processor* processor = processors + processor_index; - ThreadProfiler* thread_profiler = processor->threadProfiler; - - if (thread_profiler != NULL) - { - // If this thread was on another processor on a previous pass and that processor is still tracking that thread, - // remove the thread from it. - rmtU32 last_processor_index = thread_profiler->lastProcessorIndex; - if (last_processor_index != -1 && last_processor_index != processor_index) - { - assert(last_processor_index < nb_processors); - if (processors[last_processor_index].threadProfiler == thread_profiler) - { - processors[last_processor_index].threadProfiler = NULL; - } - } - - // When the thread is still on the same processor, check to see if it hasn't triggered the callback within another - // pass. This suggests the thread has gone to sleep and is no longer assigned to any thread. - else if (processor->sampleCount > 1) - { - processor->threadProfiler = NULL; - } - - thread_profiler->lastProcessorIndex = thread_profiler->processorIndex; - } - } - - // Send current processor state off to remotery - QueueProcessorThreads(thread_profilers->mqToRmtThread, processor_message_index++, nb_processors, processors); - } - -#ifdef RMT_PLATFORM_WINDOWS - timeEndPeriod(1); -#endif - - return RMT_ERROR_NONE; -} - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @REMOTERY: Remotery ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#if RMT_USE_OPENGL -typedef struct OpenGL_t OpenGL; -static rmtError OpenGL_Create(OpenGL** opengl); -static void OpenGL_Destructor(OpenGL* opengl); -#endif - -#if RMT_USE_METAL -typedef struct Metal_t Metal; -static rmtError Metal_Create(Metal** metal); -static void Metal_Destructor(Metal* metal); -#endif - -struct Remotery -{ - Server* server; - - // Microsecond accuracy timer for CPU timestamps - usTimer timer; - - // Queue between clients and main remotery thread - rmtMessageQueue* mq_to_rmt_thread; - - // The main server thread - rmtThread* thread; - - // String table shared by all threads - StringTable* string_table; - - // Open logfile handle to append events to - FILE* logfile; - - // Set to trigger a map of each message on the remotery thread message queue - void (*map_message_queue_fn)(Remotery* rmt, Message*); - void* map_message_queue_data; - -#if RMT_USE_CUDA - rmtCUDABind cuda; -#endif - -#if RMT_USE_OPENGL - OpenGL* opengl; -#endif - -#if RMT_USE_METAL - Metal* metal; -#endif - - ThreadProfilers* threadProfilers; -}; - -// -// Global remotery context -// -static Remotery* g_Remotery = NULL; - -// -// This flag marks the EXE/DLL that created the global remotery instance. We want to allow -// only the creating EXE/DLL to destroy the remotery instance. -// -static rmtBool g_RemoteryCreated = RMT_FALSE; - -static const rmtU8 g_DecimalToHex[17] = "0123456789abcdef"; - -static void GetSampleDigest(Sample* sample, rmtU32* digest_hash, rmtU32* nb_samples) -{ - Sample* child; - - assert(sample != NULL); - assert(digest_hash != NULL); - assert(nb_samples != NULL); - - // Concatenate this sample - (*nb_samples)++; - *digest_hash = HashCombine(*digest_hash, sample->unique_id); - - { - rmtU8 shift = 4; - - // Get 6 nibbles for lower 3 bytes of the name hash - rmtU8* sample_id = (rmtU8*)&sample->name_hash; - rmtU8 hex_sample_id[6]; - hex_sample_id[0] = sample_id[0] & 15; - hex_sample_id[1] = sample_id[0] >> 4; - hex_sample_id[2] = sample_id[1] & 15; - hex_sample_id[3] = sample_id[1] >> 4; - hex_sample_id[4] = sample_id[2] & 15; - hex_sample_id[5] = sample_id[2] >> 4; - - // As the nibbles will be used as hex colour digits, shift them up to make pastel colours - hex_sample_id[0] = minU8(hex_sample_id[0] + shift, 15); - hex_sample_id[1] = minU8(hex_sample_id[1] + shift, 15); - hex_sample_id[2] = minU8(hex_sample_id[2] + shift, 15); - hex_sample_id[3] = minU8(hex_sample_id[3] + shift, 15); - hex_sample_id[4] = minU8(hex_sample_id[4] + shift, 15); - hex_sample_id[5] = minU8(hex_sample_id[5] + shift, 15); - - // Convert the nibbles to hex for the final colour - sample->unique_id_html_colour[1] = g_DecimalToHex[hex_sample_id[0]]; - sample->unique_id_html_colour[2] = g_DecimalToHex[hex_sample_id[1]]; - sample->unique_id_html_colour[3] = g_DecimalToHex[hex_sample_id[2]]; - sample->unique_id_html_colour[4] = g_DecimalToHex[hex_sample_id[3]]; - sample->unique_id_html_colour[5] = g_DecimalToHex[hex_sample_id[4]]; - sample->unique_id_html_colour[6] = g_DecimalToHex[hex_sample_id[5]]; - } - - // Concatenate children - for (child = sample->first_child; child != NULL; child = child->next_sibling) - GetSampleDigest(child, digest_hash, nb_samples); -} - -static rmtError Remotery_SendLogTextMessage(Remotery* rmt, Message* message) -{ - rmtError error = RMT_ERROR_NONE; - Buffer* bin_buf; - - // Build the buffer as if it's being sent to the server - assert(rmt != NULL); - assert(message != NULL); - bin_buf = rmt->server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - Buffer_Write(bin_buf, message->payload, message->payload_size); - - // Pass to either the server or the log file - if (Server_IsClientConnected(rmt->server) == RMT_TRUE) - { - error = Server_Send(rmt->server, bin_buf->data, bin_buf->bytes_used, 20); - } - if (rmt->logfile != NULL) - { - rmtWriteFile(rmt->logfile, bin_buf->data + WEBSOCKET_MAX_FRAME_HEADER_SIZE, bin_buf->bytes_used - WEBSOCKET_MAX_FRAME_HEADER_SIZE); - } - - return error; -} - -static rmtError bin_SampleName(Buffer* buffer, const char* name, rmtU32 name_hash, rmtU32 name_length) -{ - rmtError error; - - BIN_ERROR_CHECK(Buffer_Write(buffer, "SSMP", 4)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, name_hash)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, name_length)); - BIN_ERROR_CHECK(Buffer_Write(buffer, (void*)name, name_length)); - - return RMT_ERROR_NONE; -} - -static rmtError Remotery_AddToStringTable(Remotery* rmt, Message* message) -{ - // Add to the string table - Msg_AddToStringTable* payload = (Msg_AddToStringTable*)message->payload; - const char* name = (const char*)(payload + 1); - StringTable_Insert(rmt->string_table, payload->hash, name); - - // Emit to log file if one is open - if (rmt->logfile != NULL) - { - rmtError error; - - Buffer* bin_buf = rmt->server->bin_buf; - bin_buf->bytes_used = 0; - BIN_ERROR_CHECK(bin_SampleName(bin_buf, name, payload->hash, payload->length)); - - rmtWriteFile(rmt->logfile, bin_buf->data, bin_buf->bytes_used); - } - - return RMT_ERROR_NONE; -} - -static rmtError bin_SampleTree(Buffer* buffer, Msg_SampleTree* msg) -{ - Sample* root_sample; - char thread_name[256]; - rmtU32 digest_hash = 0; - rmtU32 nb_samples = 0; - rmtError error; - - assert(buffer != NULL); - assert(msg != NULL); - - // Get the message root sample - root_sample = msg->rootSample; - assert(root_sample != NULL); - - // Add any sample types as a thread name post-fix to ensure they get their own viewer - thread_name[0] = 0; - strncat_s(thread_name, sizeof(thread_name), msg->threadName, strnlen_s(msg->threadName, 255)); - if (root_sample->type == SampleType_CUDA) - { - strncat_s(thread_name, sizeof(thread_name), " (CUDA)", 7); - } - if (root_sample->type == SampleType_D3D11) - { - strncat_s(thread_name, sizeof(thread_name), " (D3D11)", 8); - } - if (root_sample->type == SampleType_OpenGL) - { - strncat_s(thread_name, sizeof(thread_name), " (OpenGL)", 9); - } - if (root_sample->type == SampleType_Metal) - { - strncat_s(thread_name, sizeof(thread_name), " (Metal)", 8); - } - - // Get digest hash of samples so that viewer can efficiently rebuild its tables - GetSampleDigest(root_sample, &digest_hash, &nb_samples); - - // Write global message header - BIN_ERROR_CHECK(Buffer_Write(buffer, (void*)"SMPL ", 8)); - - // Write sample message header - BIN_ERROR_CHECK(Buffer_WriteStringWithLength(buffer, thread_name)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, nb_samples)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, digest_hash)); - BIN_ERROR_CHECK(Buffer_WriteU32(buffer, msg->partialTree ? 1 : 0)); - - // Write entire sample tree - BIN_ERROR_CHECK(bin_Sample(buffer, root_sample)); - - // Patch message size - U32ToByteArray(buffer->data + 4, buffer->bytes_used); - - return RMT_ERROR_NONE; -} - -#if RMT_USE_CUDA -static rmtBool AreCUDASamplesReady(Sample* sample); -static rmtBool GetCUDASampleTimes(Sample* root_sample, Sample* sample); -#endif - -static rmtError Remotery_SendSampleTreeMessage(Remotery* rmt, Message* message) -{ - rmtError error = RMT_ERROR_NONE; - - Msg_SampleTree* sample_tree; - Sample* sample; - Buffer* bin_buf; - - assert(rmt != NULL); - assert(message != NULL); - - // Get the message root sample - sample_tree = (Msg_SampleTree*)message->payload; - sample = sample_tree->rootSample; - assert(sample != NULL); - -#if RMT_USE_CUDA - if (sample->type == SampleType_CUDA) - { - // If these CUDA samples aren't ready yet, stick them to the back of the queue and continue - rmtBool are_samples_ready; - rmt_BeginCPUSample(AreCUDASamplesReady, 0); - are_samples_ready = AreCUDASamplesReady(sample); - rmt_EndCPUSample(); - if (!are_samples_ready) - { - QueueSampleTree(rmt->mq_to_rmt_thread, sample, sample_tree->allocator, sample_tree->threadName, - message->threadProfiler, RMT_FALSE); - return RMT_ERROR_NONE; - } - - // Retrieve timing of all CUDA samples - rmt_BeginCPUSample(GetCUDASampleTimes, 0); - GetCUDASampleTimes(sample->parent, sample); - rmt_EndCPUSample(); - } -#endif - - // Reset the buffer for sending a websocket message - bin_buf = rmt->server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - - // Serialise the sample tree - rmt_BeginCPUSample(bin_SampleTree, RMTSF_Aggregate); - error = bin_SampleTree(bin_buf, sample_tree); - rmt_EndCPUSample(); - - // Release sample tree samples back to their allocator - FreeSamples(sample, sample_tree->allocator); - - if (error != RMT_ERROR_NONE) - { - return error; - } - - if (Server_IsClientConnected(rmt->server) == RMT_TRUE) - { - // Send to the viewer with a reasonably long timeout as the size of the sample data may be large - rmt_BeginCPUSample(Server_Send, RMTSF_Aggregate); - error = Server_Send(rmt->server, bin_buf->data, bin_buf->bytes_used, 50000); - rmt_EndCPUSample(); - } - - if (rmt->logfile != NULL) - { - // Write the data after the websocket header - rmtWriteFile(rmt->logfile, bin_buf->data + WEBSOCKET_MAX_FRAME_HEADER_SIZE, bin_buf->bytes_used - WEBSOCKET_MAX_FRAME_HEADER_SIZE); - } - - return error; -} - -static rmtError Remotery_SendProcessorThreads(Remotery* rmt, Message* message) -{ - rmtU32 processor_index; - rmtError error = RMT_ERROR_NONE; - - Msg_ProcessorThreads* processor_threads = (Msg_ProcessorThreads*)message->payload; - - Buffer* bin_buf; - - // Reset the buffer for sending a websocket message - bin_buf = rmt->server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - - // Serialise the message - BIN_ERROR_CHECK(Buffer_Write(bin_buf, (void*)"PRTH", 4)); - BIN_ERROR_CHECK(Buffer_WriteU32(bin_buf, processor_threads->nbProcessors)); - BIN_ERROR_CHECK(Buffer_WriteU64(bin_buf, processor_threads->messageIndex)); - for (processor_index = 0; processor_index < processor_threads->nbProcessors; processor_index++) - { - Processor* processor = processor_threads->processors + processor_index; - if (processor->threadProfiler != NULL) - { - BIN_ERROR_CHECK(Buffer_WriteU32(bin_buf, processor->threadProfiler->threadId)); - BIN_ERROR_CHECK(Buffer_WriteU32(bin_buf, processor->threadProfiler->threadNameHash)); - BIN_ERROR_CHECK(Buffer_WriteU64(bin_buf, processor->sampleTime)); - } - else - { - BIN_ERROR_CHECK(Buffer_WriteU32(bin_buf, (rmtU32)-1)); - BIN_ERROR_CHECK(Buffer_WriteU32(bin_buf, 0)); - BIN_ERROR_CHECK(Buffer_WriteU64(bin_buf, 0)); - } - } - - if (Server_IsClientConnected(rmt->server) == RMT_TRUE) - { - // Send to the viewer - error = Server_Send(rmt->server, bin_buf->data, bin_buf->bytes_used, 50); - } - - if (rmt->logfile != NULL) - { - // Write the data after the websocket header - rmtWriteFile(rmt->logfile, bin_buf->data + WEBSOCKET_MAX_FRAME_HEADER_SIZE, bin_buf->bytes_used - WEBSOCKET_MAX_FRAME_HEADER_SIZE); - } - - return error; -} - -static rmtError Remotery_SendThreadName(Remotery* rmt, Message* message) -{ - rmtU32 name_length; - rmtError error; - - Buffer* bin_buf; - - // Reset the buffer for sending a websocket message - bin_buf = rmt->server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - - // Serialise the message - BIN_ERROR_CHECK(Buffer_Write(bin_buf, (void*)"THRN", 4)); - BIN_ERROR_CHECK(Buffer_Write(bin_buf, message->payload, 8)); - name_length = *(rmtU32*)(message->payload + 4); - BIN_ERROR_CHECK(Buffer_Write(bin_buf, message->payload + 8, name_length)); - - if (Server_IsClientConnected(rmt->server) == RMT_TRUE) - { - // Send to the viewer - error = Server_Send(rmt->server, bin_buf->data, bin_buf->bytes_used, 50); - } - - if (rmt->logfile != NULL) - { - // Write the data after the websocket header - rmtWriteFile(rmt->logfile, bin_buf->data + WEBSOCKET_MAX_FRAME_HEADER_SIZE, bin_buf->bytes_used - WEBSOCKET_MAX_FRAME_HEADER_SIZE); - } - - return RMT_ERROR_NONE; -} - -static rmtError Remotery_ConsumeMessageQueue(Remotery* rmt) -{ - rmtU32 nb_messages_sent = 0; - const rmtU32 maxNbMessagesPerUpdate = g_Settings.maxNbMessagesPerUpdate; - - assert(rmt != NULL); - - // Loop reading the max number of messages for this update - // Note some messages don't consume the sent message count as they are small enough to not cause performance issues - while (nb_messages_sent < maxNbMessagesPerUpdate) - { - rmtError error = RMT_ERROR_NONE; - Message* message = rmtMessageQueue_PeekNextMessage(rmt->mq_to_rmt_thread); - if (message == NULL) - break; - - switch (message->id) - { - // This shouldn't be possible - case MsgID_NotReady: - assert(RMT_FALSE); - break; - - // Dispatch to message handler - case MsgID_AddToStringTable: - error = Remotery_AddToStringTable(rmt, message); - break; - case MsgID_LogText: - error = Remotery_SendLogTextMessage(rmt, message); - nb_messages_sent++; - break; - case MsgID_SampleTree: - rmt_BeginCPUSample(SendSampleTreeMessage, RMTSF_Aggregate); - error = Remotery_SendSampleTreeMessage(rmt, message); - nb_messages_sent++; - rmt_EndCPUSample(); - break; - case MsgID_ProcessorThreads: - Remotery_SendProcessorThreads(rmt, message); - nb_messages_sent++; - break; - case MsgID_ThreadName: - Remotery_SendThreadName(rmt, message); - break; - - default: - break; - } - - // Consume the message before reacting to any errors - rmtMessageQueue_ConsumeNextMessage(rmt->mq_to_rmt_thread, message); - if (error != RMT_ERROR_NONE) - return error; - } - - return RMT_ERROR_NONE; -} - -static void Remotery_FlushMessageQueue(Remotery* rmt) -{ - assert(rmt != NULL); - - // Loop reading all remaining messages - for (;;) - { - Message* message = rmtMessageQueue_PeekNextMessage(rmt->mq_to_rmt_thread); - if (message == NULL) - break; - - switch (message->id) - { - // These can be safely ignored - case MsgID_NotReady: - case MsgID_AddToStringTable: - case MsgID_LogText: - break; - - // Release all samples back to their allocators - case MsgID_SampleTree: { - Msg_SampleTree* sample_tree = (Msg_SampleTree*)message->payload; - FreeSamples(sample_tree->rootSample, sample_tree->allocator); - break; - } - - default: - break; - } - - rmtMessageQueue_ConsumeNextMessage(rmt->mq_to_rmt_thread, message); - } -} - -static void Remotery_MapMessageQueue(Remotery* rmt) -{ - rmtU32 read_pos, write_pos; - rmtMessageQueue* queue; - - assert(rmt != NULL); - - // Wait until the caller sets the custom data - while (LoadAcquirePointer((long* volatile*)&rmt->map_message_queue_data) == NULL) - msSleep(1); - - // Snapshot the current write position so that we're not constantly chasing other threads - // that can have no effect on the thread requesting the map. - queue = rmt->mq_to_rmt_thread; - write_pos = LoadAcquire(&queue->write_pos); - - // Walk every message in the queue and call the map function - read_pos = queue->read_pos; - while (read_pos < write_pos) - { - rmtU32 r = read_pos & (queue->size - 1); - Message* message = (Message*)(queue->data->ptr + r); - rmtU32 message_size = rmtMessageQueue_SizeForPayload(message->payload_size); - rmt->map_message_queue_fn(rmt, message); - read_pos += message_size; - } - - StoreReleasePointer((long* volatile*)&rmt->map_message_queue_data, NULL); -} - -static rmtError Remotery_ThreadMain(rmtThread* thread) -{ - Remotery* rmt = (Remotery*)thread->param; - assert(rmt != NULL); - - rmt_SetCurrentThreadName("Remotery"); - - while (thread->request_exit == RMT_FALSE) - { - rmt_BeginCPUSample(Wakeup, 0); - - rmt_BeginCPUSample(ServerUpdate, 0); - Server_Update(rmt->server); - rmt_EndCPUSample(); - - rmt_BeginCPUSample(ConsumeMessageQueue, 0); - Remotery_ConsumeMessageQueue(rmt); - rmt_EndCPUSample(); - - rmt_EndCPUSample(); - - // Process any queue map requests - if (LoadAcquirePointer((long* volatile*)&rmt->map_message_queue_fn) != NULL) - { - Remotery_MapMessageQueue(rmt); - StoreReleasePointer((long* volatile*)&rmt->map_message_queue_fn, NULL); - } - - // - // [NOTE-A] - // - // Possible sequence of user events at this point: - // - // 1. Add samples to the queue. - // 2. Shutdown remotery. - // - // This loop will exit with unrelease samples. - // - - msSleep(g_Settings.msSleepBetweenServerUpdates); - } - - // Release all samples to their allocators as a consequence of [NOTE-A] - Remotery_FlushMessageQueue(rmt); - - return RMT_ERROR_NONE; -} - -static rmtError Remotery_ReceiveMessage(void* context, char* message_data, rmtU32 message_length) -{ - Remotery* rmt = (Remotery*)context; - -// Manual dispatch on 4-byte message headers (message ID is little-endian encoded) -#define FOURCC(a, b, c, d) (rmtU32)(((d) << 24) | ((c) << 16) | ((b) << 8) | (a)) - rmtU32 message_id = *(rmtU32*)message_data; - - switch (message_id) - { - case FOURCC('C', 'O', 'N', 'I'): { - rmt_LogText("Console message received..."); - rmt_LogText(message_data + 4); - - // Pass on to any registered handler - if (g_Settings.input_handler != NULL) - g_Settings.input_handler(message_data + 4, g_Settings.input_handler_context); - - break; - } - - case FOURCC('G', 'S', 'M', 'P'): { - rmtPStr name; - - // Convert name hash to integer - rmtU32 name_hash = 0; - const char* cur = message_data + 4; - const char* end = cur + message_length - 4; - while (cur < end) - name_hash = name_hash * 10 + *cur++ - '0'; - - // Search for a matching string hash - name = StringTable_Find(rmt->string_table, name_hash); - if (name != NULL) - { - rmtU32 name_length = (rmtU32)strnlen_s_safe_c(name, 256 - 12); - - // Construct a response message containing the matching name - Buffer* bin_buf = rmt->server->bin_buf; - WebSocket_PrepareBuffer(bin_buf); - bin_SampleName(bin_buf, name, name_hash, name_length); - - // Send back immediately as we're on the server thread - return Server_Send(rmt->server, bin_buf->data, bin_buf->bytes_used, 10); - } - - break; - } - } - -#undef FOURCC - - return RMT_ERROR_NONE; -} - -static rmtError Remotery_Constructor(Remotery* rmt) -{ - rmtError error; - - assert(rmt != NULL); - - // Set default state - rmt->server = NULL; - rmt->mq_to_rmt_thread = NULL; - rmt->thread = NULL; - rmt->string_table = NULL; - rmt->logfile = NULL; - rmt->map_message_queue_fn = NULL; - rmt->map_message_queue_data = NULL; - rmt->threadProfilers = NULL; - -#if RMT_USE_CUDA - rmt->cuda.CtxSetCurrent = NULL; - rmt->cuda.EventCreate = NULL; - rmt->cuda.EventDestroy = NULL; - rmt->cuda.EventElapsedTime = NULL; - rmt->cuda.EventQuery = NULL; - rmt->cuda.EventRecord = NULL; -#endif - -#if RMT_USE_OPENGL - rmt->opengl = NULL; -#endif - -#if RMT_USE_METAL - rmt->metal = NULL; -#endif - - // Kick-off the timer - usTimer_Init(&rmt->timer); - - // Create the server - New_3(Server, rmt->server, g_Settings.port, g_Settings.reuse_open_port, g_Settings.limit_connections_to_localhost); - if (error != RMT_ERROR_NONE) - return error; - - // Setup incoming message handler - rmt->server->receive_handler = Remotery_ReceiveMessage; - rmt->server->receive_handler_context = rmt; - - // Create the main message thread with only one page - New_1(rmtMessageQueue, rmt->mq_to_rmt_thread, g_Settings.messageQueueSizeInBytes); - if (error != RMT_ERROR_NONE) - return error; - - // Create sample name string table - New_0(StringTable, rmt->string_table); - if (error != RMT_ERROR_NONE) - return error; - - if (g_Settings.logPath != NULL) - { - // Get current date/time - struct tm* now_tm = TimeDateNow(); - - // Start the log path off - char filename[512] = { 0 }; - strncat_s(filename, sizeof(filename), g_Settings.logPath, 512); - strncat_s(filename, sizeof(filename), "/remotery-log-", 14); - - // Append current date and time - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_year + 1900), 11); - strncat_s(filename, sizeof(filename), "-", 1); - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_mon + 1), 11); - strncat_s(filename, sizeof(filename), "-", 1); - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_mday), 11); - strncat_s(filename, sizeof(filename), "-", 1); - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_hour), 11); - strncat_s(filename, sizeof(filename), "-", 1); - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_min), 11); - strncat_s(filename, sizeof(filename), "-", 1); - strncat_s(filename, sizeof(filename), itoa_s(now_tm->tm_sec), 11); - - // Just append a custom extension - strncat_s(filename, sizeof(filename), ".rbin", 5); - - // Open and assume any failure simply sets NULL and the file isn't written - rmt->logfile = rmtOpenFile(filename, "w"); - - // Write the header - if (rmt->logfile != NULL) - { - rmtWriteFile(rmt->logfile, "RMTBLOGF", 8); - } - } - -#if RMT_USE_OPENGL - error = OpenGL_Create(&rmt->opengl); - if (error != RMT_ERROR_NONE) - return error; -#endif - -#if RMT_USE_METAL - error = Metal_Create(&rmt->metal); - if (error != RMT_ERROR_NONE) - return error; -#endif - - // Create the thread profilers container - New_2(ThreadProfilers, rmt->threadProfilers, &rmt->timer, rmt->mq_to_rmt_thread); - if (error != RMT_ERROR_NONE) - { - return error; - } - - // Set as the global instance before creating any threads that uses it for sampling itself - assert(g_Remotery == NULL); - g_Remotery = rmt; - g_RemoteryCreated = RMT_TRUE; - - // Ensure global instance writes complete before other threads get a chance to use it - CompilerWriteFence(); - - // Create the main update thread once everything has been defined for the global remotery object - New_2(rmtThread, rmt->thread, Remotery_ThreadMain, rmt); - return error; -} - -static void Remotery_Destructor(Remotery* rmt) -{ - assert(rmt != NULL); - - // Join the remotery thread before clearing the global object as the thread is profiling itself - Delete(rmtThread, rmt->thread); - - if (g_RemoteryCreated) - { - g_Remotery = NULL; - g_RemoteryCreated = RMT_FALSE; - } - - Delete(ThreadProfilers, rmt->threadProfilers); - -#if RMT_USE_OPENGL - Delete(OpenGL, rmt->opengl); -#endif - -#if RMT_USE_METAL - Delete(Metal, rmt->metal); -#endif - - rmtCloseFile(rmt->logfile); - - Delete(StringTable, rmt->string_table); - Delete(rmtMessageQueue, rmt->mq_to_rmt_thread); - - Delete(Server, rmt->server); -} - -static void* CRTMalloc(void* mm_context, rmtU32 size) -{ - RMT_UNREFERENCED_PARAMETER(mm_context); - return malloc((size_t)size); -} - -static void CRTFree(void* mm_context, void* ptr) -{ - RMT_UNREFERENCED_PARAMETER(mm_context); - free(ptr); -} - -static void* CRTRealloc(void* mm_context, void* ptr, rmtU32 size) -{ - RMT_UNREFERENCED_PARAMETER(mm_context); - return realloc(ptr, size); -} - -RMT_API rmtSettings* _rmt_Settings(void) -{ - // Default-initialize on first call - if (g_SettingsInitialized == RMT_FALSE) - { - g_Settings.port = 0x4597; - g_Settings.reuse_open_port = RMT_FALSE; - g_Settings.limit_connections_to_localhost = RMT_FALSE; - g_Settings.enableThreadSampler = RMT_TRUE; - g_Settings.msSleepBetweenServerUpdates = 4; - g_Settings.messageQueueSizeInBytes = 1024 * 1024; - g_Settings.maxNbMessagesPerUpdate = 50; - g_Settings.malloc = CRTMalloc; - g_Settings.free = CRTFree; - g_Settings.realloc = CRTRealloc; - g_Settings.input_handler = NULL; - g_Settings.input_handler_context = NULL; - g_Settings.logPath = NULL; - - g_SettingsInitialized = RMT_TRUE; - } - - return &g_Settings; -} - -RMT_API rmtError _rmt_CreateGlobalInstance(Remotery** remotery) -{ - rmtError error; - - // Ensure load/acquire store/release operations match this enum size - assert(sizeof(MessageID) == sizeof(rmtU32)); - - // Default-initialise if user has not set values - rmt_Settings(); - - // Creating the Remotery instance also records it as the global instance - assert(remotery != NULL); - New_0(Remotery, *remotery); - return error; -} - -RMT_API void _rmt_DestroyGlobalInstance(Remotery* remotery) -{ - // Ensure this is the module that created it - assert(g_RemoteryCreated == RMT_TRUE); - assert(g_Remotery == remotery); - Delete(Remotery, remotery); -} - -RMT_API void _rmt_SetGlobalInstance(Remotery* remotery) -{ - // Default-initialise if user has not set values - rmt_Settings(); - - g_Remotery = remotery; -} - -RMT_API Remotery* _rmt_GetGlobalInstance(void) -{ - return g_Remotery; -} - -#ifdef RMT_PLATFORM_WINDOWS -#pragma pack(push, 8) -typedef struct tagTHREADNAME_INFO -{ - DWORD dwType; // Must be 0x1000. - LPCSTR szName; // Pointer to name (in user addr space). - DWORD dwThreadID; // Thread ID (-1=caller thread). - DWORD dwFlags; // Reserved for future use, must be zero. -} THREADNAME_INFO; -#pragma pack(pop) -#endif - -wchar_t* MakeWideString(const char* string) -{ - size_t wlen; - wchar_t* wstr; - - // First get the converted length -#if defined(RMT_PLATFORM_WINDOWS) && !RMT_USE_TINYCRT - if (mbstowcs_s(&wlen, NULL, 0, string, INT_MAX) != 0) - { - return NULL; - } -#else - wlen = mbstowcs(NULL, string, 256); -#endif - - // Allocate enough words for the converted result - wstr = (wchar_t*)(rmtMalloc((wlen + 1) * sizeof(wchar_t))); - if (wstr == NULL) - { - return NULL; - } - - // Convert -#if defined(RMT_PLATFORM_WINDOWS) && !RMT_USE_TINYCRT - if (mbstowcs_s(&wlen, wstr, wlen + 1, string, wlen) != 0) -#else - if (mbstowcs(wstr, string, wlen + 1) != wlen) -#endif - { - rmtFree(wstr); - return NULL; - } - - return wstr; -} - -static void SetDebuggerThreadName(const char* name) -{ -#ifdef RMT_PLATFORM_WINDOWS - THREADNAME_INFO info; - - // See if SetThreadDescription is available in this version of Windows - // Introduced in Windows 10 build 1607 - HMODULE kernel32 = GetModuleHandleA("Kernel32.dll"); - if (kernel32 != NULL) - { - typedef HRESULT(WINAPI* SETTHREADDESCRIPTION)(HANDLE hThread, PCWSTR lpThreadDescription); - SETTHREADDESCRIPTION SetThreadDescription = (SETTHREADDESCRIPTION)GetProcAddress(kernel32, "SetThreadDescription"); - if (SetThreadDescription != NULL) - { - // Create a wide-string version of the thread name - wchar_t* wstr = MakeWideString(name); - if (wstr != NULL) - { - // Set and return, leaving a fall-through for any failure cases to use the old exception method - SetThreadDescription(GetCurrentThread(), wstr); - rmtFree(wstr); - return; - } - } - } - - info.dwType = 0x1000; - info.szName = name; - info.dwThreadID = (DWORD)-1; - info.dwFlags = 0; - -#ifndef __MINGW32__ - __try - { - RaiseException(0x406D1388, 0, sizeof(info) / sizeof(ULONG_PTR), (ULONG_PTR*)&info); - } - __except (1 /* EXCEPTION_EXECUTE_HANDLER */) - { - } -#endif -#else - RMT_UNREFERENCED_PARAMETER(name); -#endif - -#ifdef RMT_PLATFORM_LINUX - // pthread_setname_np is a non-standard GNU extension. - char name_clamp[16]; - name_clamp[0] = 0; - strncat_s(name_clamp, sizeof(name_clamp), name, 15); -#if defined(__FreeBSD__) || defined(__OpenBSD__) - pthread_set_name_np(pthread_self(), name_clamp); -#else - prctl(PR_SET_NAME, name_clamp, 0, 0, 0); -#endif -#endif -} - -RMT_API void _rmt_SetCurrentThreadName(rmtPStr thread_name) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - { - return; - } - - // Get data for this thread - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) != RMT_ERROR_NONE) - { - return; - } - - // Copy name and apply to the debugger - strcpy_s(thread_profiler->threadName, sizeof(thread_profiler->threadName), thread_name); - thread_profiler->threadNameHash = MurmurHash3_x86_32(thread_name, strnlen_s(thread_name, 64), 0); - SetDebuggerThreadName(thread_name); - - // Send the thread name for lookup -#ifdef RMT_PLATFORM_WINDOWS - QueueThreadName(g_Remotery->mq_to_rmt_thread, thread_name, thread_profiler); -#endif -} - -static rmtBool QueueLine(rmtMessageQueue* queue, unsigned char* text, rmtU32 size, struct ThreadProfiler* thread_profiler) -{ - Message* message; - rmtU32 text_size; - - assert(queue != NULL); - - // Prefix with text size - text_size = size - 8; - U32ToByteArray(text + 4, text_size); - - // Allocate some space for the line - message = rmtMessageQueue_AllocMessage(queue, size, thread_profiler); - if (message == NULL) - return RMT_FALSE; - - // Copy the text and commit the message - memcpy(message->payload, text, size); - rmtMessageQueue_CommitMessage(message, MsgID_LogText); - - return RMT_TRUE; -} - -RMT_API void _rmt_LogText(rmtPStr text) -{ - int start_offset, offset, i; - unsigned char line_buffer[1024] = {0}; - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) != RMT_ERROR_NONE) - { - return; - } - - // Start the line with the message header - line_buffer[0] = 'L'; - line_buffer[1] = 'O'; - line_buffer[2] = 'G'; - line_buffer[3] = 'M'; - // Fill with spaces to enable viewing line_buffer without offset in a debugger - // (will be overwritten later by QueueLine/rmtMessageQueue_AllocMessage) - line_buffer[4] = ' '; - line_buffer[5] = ' '; - line_buffer[6] = ' '; - line_buffer[7] = ' '; - start_offset = 8; - - // There might be newlines in the buffer, so split them into multiple network calls - offset = start_offset; - for (i = 0; text[i] != 0; i++) - { - char c = text[i]; - - // Line wrap when too long or newline encountered - if (offset == sizeof(line_buffer) - 1 || c == '\n') - { - // Send the line up to now - if (QueueLine(g_Remotery->mq_to_rmt_thread, line_buffer, offset, thread_profiler) == RMT_FALSE) - return; - - // Restart line - offset = start_offset; - - // Don't add the newline character (if this was the reason for the flush) - // to the restarted line_buffer, let's skip it - if (c == '\n') - continue; - } - - line_buffer[offset++] = c; - } - - // Send the last line - if (offset > start_offset) - { - assert(offset < (int)sizeof(line_buffer)); - QueueLine(g_Remotery->mq_to_rmt_thread, line_buffer, offset, thread_profiler); - } -} - -RMT_API void _rmt_BeginCPUSample(rmtPStr name, rmtU32 flags, rmtU32* hash_cache) -{ - // 'hash_cache' stores a pointer to a sample name's hash value. Internally this is used to identify unique - // callstacks and it would be ideal that it's not recalculated each time the sample is used. This can be statically - // cached at the point of call or stored elsewhere when dynamic names are required. - // - // If 'hash_cache' is NULL then this call becomes more expensive, as it has to recalculate the hash of the name. - - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - // TODO: Time how long the bits outside here cost and subtract them from the parent - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - Sample* sample; - rmtU32 name_hash = ThreadProfiler_GetNameHash(thread_profiler, g_Remotery->mq_to_rmt_thread, name, hash_cache); - if (ThreadProfiler_Push(thread_profiler->sampleTrees[SampleType_CPU], name_hash, flags, &sample) == RMT_ERROR_NONE) - { - // If this is an aggregate sample, store the time in 'end' as we want to preserve 'start' - if (sample->call_count > 1) - sample->us_end = usTimer_Get(&g_Remotery->timer); - else - sample->us_start = usTimer_Get(&g_Remotery->timer); - } - } -} - -RMT_API void _rmt_EndCPUSample(void) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - Sample* sample = thread_profiler->sampleTrees[SampleType_CPU]->currentParent; - - if (sample->recurse_depth > 0) - { - sample->recurse_depth--; - } - else - { - rmtU64 us_end = usTimer_Get(&g_Remotery->timer); - Sample_Close(sample, us_end); - ThreadProfiler_Pop(thread_profiler, g_Remotery->mq_to_rmt_thread, sample); - } - } -} - -#if RMT_USE_OPENGL || RMT_USE_D3D11 -static void Remotery_DeleteSampleTree(Remotery* rmt, enum SampleType sample_type) -{ - ThreadProfiler* thread_profiler; - - // Get the attached thread sampler and delete the sample tree - assert(rmt != NULL); - if (ThreadProfilers_GetCurrentThreadProfiler(rmt->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - SampleTree* sample_tree = thread_profiler->sampleTrees[sample_type]; - if (sample_tree != NULL) - { - Delete(SampleTree, sample_tree); - thread_profiler->sampleTrees[sample_type] = NULL; - } - } -} - -static rmtBool rmtMessageQueue_IsEmpty(rmtMessageQueue* queue) -{ - assert(queue != NULL); - return queue->write_pos - queue->read_pos == 0; -} - -typedef struct GatherQueuedSampleData -{ - SampleType sample_type; - Buffer* flush_samples; -} GatherQueuedSampleData; - -static void MapMessageQueueAndWait(Remotery* rmt, void (*map_message_queue_fn)(Remotery* rmt, Message*), void* data) -{ - // Basic spin lock on the map function itself - while (AtomicCompareAndSwapPointer((long* volatile*)&rmt->map_message_queue_fn, NULL, - (long*)map_message_queue_fn) == RMT_FALSE) - msSleep(1); - - StoreReleasePointer((long* volatile*)&rmt->map_message_queue_data, (long*)data); - - // Wait until map completes - while (LoadAcquirePointer((long* volatile*)&rmt->map_message_queue_fn) != NULL) - msSleep(1); -} - -static void GatherQueuedSamples(Remotery* rmt, Message* message) -{ - GatherQueuedSampleData* gather_data = (GatherQueuedSampleData*)rmt->map_message_queue_data; - - // Filter sample trees - if (message->id == MsgID_SampleTree) - { - Msg_SampleTree* sample_tree = (Msg_SampleTree*)message->payload; - Sample* sample = sample_tree->rootSample; - if (sample->type == gather_data->sample_type) - { - // Make a copy of the entire sample tree as the remotery thread may overwrite it while - // the calling thread tries to delete - rmtU32 message_size = rmtMessageQueue_SizeForPayload(message->payload_size); - Buffer_Write(gather_data->flush_samples, message, message_size); - - // Mark the message empty - message->id = MsgID_None; - } - } -} - -static void FreePendingSampleTrees(Remotery* rmt, SampleType sample_type, Buffer* flush_samples) -{ - rmtU8* data; - rmtU8* data_end; - - // Gather all sample trees currently queued for the Remotery thread - GatherQueuedSampleData gather_data; - gather_data.sample_type = sample_type; - gather_data.flush_samples = flush_samples; - MapMessageQueueAndWait(rmt, GatherQueuedSamples, &gather_data); - - // Release all sample trees to their allocators - data = flush_samples->data; - data_end = data + flush_samples->bytes_used; - while (data < data_end) - { - Message* message = (Message*)data; - rmtU32 message_size = rmtMessageQueue_SizeForPayload(message->payload_size); - Msg_SampleTree* sample_tree = (Msg_SampleTree*)message->payload; - FreeSamples(sample_tree->rootSample, sample_tree->allocator); - data += message_size; - } -} - -#endif - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @CUDA: CUDA event sampling ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#if RMT_USE_CUDA - -typedef struct CUDASample -{ - // IS-A inheritance relationship - Sample base; - - // Pair of events that wrap the sample - CUevent event_start; - CUevent event_end; - -} CUDASample; - -static rmtError MapCUDAResult(CUresult result) -{ - switch (result) - { - case CUDA_SUCCESS: - return RMT_ERROR_NONE; - case CUDA_ERROR_DEINITIALIZED: - return RMT_ERROR_CUDA_DEINITIALIZED; - case CUDA_ERROR_NOT_INITIALIZED: - return RMT_ERROR_CUDA_NOT_INITIALIZED; - case CUDA_ERROR_INVALID_CONTEXT: - return RMT_ERROR_CUDA_INVALID_CONTEXT; - case CUDA_ERROR_INVALID_VALUE: - return RMT_ERROR_CUDA_INVALID_VALUE; - case CUDA_ERROR_INVALID_HANDLE: - return RMT_ERROR_CUDA_INVALID_HANDLE; - case CUDA_ERROR_OUT_OF_MEMORY: - return RMT_ERROR_CUDA_OUT_OF_MEMORY; - case CUDA_ERROR_NOT_READY: - return RMT_ERROR_ERROR_NOT_READY; - default: - return RMT_ERROR_CUDA_UNKNOWN; - } -} - -#define CUDA_MAKE_FUNCTION(name, params) \ - typedef CUresult(CUDAAPI* name##Ptr) params; \ - name##Ptr name = (name##Ptr)g_Remotery->cuda.name; - -#define CUDA_GUARD(call) \ - { \ - rmtError error = call; \ - if (error != RMT_ERROR_NONE) \ - return error; \ - } - -// Wrappers around CUDA driver functions that manage the active context. -static rmtError CUDASetContext(void* context) -{ - CUDA_MAKE_FUNCTION(CtxSetCurrent, (CUcontext ctx)); - assert(CtxSetCurrent != NULL); - return MapCUDAResult(CtxSetCurrent((CUcontext)context)); -} -static rmtError CUDAGetContext(void** context) -{ - CUDA_MAKE_FUNCTION(CtxGetCurrent, (CUcontext * ctx)); - assert(CtxGetCurrent != NULL); - return MapCUDAResult(CtxGetCurrent((CUcontext*)context)); -} -static rmtError CUDAEnsureContext() -{ - void* current_context; - CUDA_GUARD(CUDAGetContext(¤t_context)); - - assert(g_Remotery != NULL); - if (current_context != g_Remotery->cuda.context) - CUDA_GUARD(CUDASetContext(g_Remotery->cuda.context)); - - return RMT_ERROR_NONE; -} - -// Wrappers around CUDA driver functions that manage events -static rmtError CUDAEventCreate(CUevent* phEvent, unsigned int Flags) -{ - CUDA_MAKE_FUNCTION(EventCreate, (CUevent * phEvent, unsigned int Flags)); - CUDA_GUARD(CUDAEnsureContext()); - return MapCUDAResult(EventCreate(phEvent, Flags)); -} -static rmtError CUDAEventDestroy(CUevent hEvent) -{ - CUDA_MAKE_FUNCTION(EventDestroy, (CUevent hEvent)); - CUDA_GUARD(CUDAEnsureContext()); - return MapCUDAResult(EventDestroy(hEvent)); -} -static rmtError CUDAEventRecord(CUevent hEvent, void* hStream) -{ - CUDA_MAKE_FUNCTION(EventRecord, (CUevent hEvent, CUstream hStream)); - CUDA_GUARD(CUDAEnsureContext()); - return MapCUDAResult(EventRecord(hEvent, (CUstream)hStream)); -} -static rmtError CUDAEventQuery(CUevent hEvent) -{ - CUDA_MAKE_FUNCTION(EventQuery, (CUevent hEvent)); - CUDA_GUARD(CUDAEnsureContext()); - return MapCUDAResult(EventQuery(hEvent)); -} -static rmtError CUDAEventElapsedTime(float* pMilliseconds, CUevent hStart, CUevent hEnd) -{ - CUDA_MAKE_FUNCTION(EventElapsedTime, (float* pMilliseconds, CUevent hStart, CUevent hEnd)); - CUDA_GUARD(CUDAEnsureContext()); - return MapCUDAResult(EventElapsedTime(pMilliseconds, hStart, hEnd)); -} - -static rmtError CUDASample_Constructor(CUDASample* sample) -{ - rmtError error; - - assert(sample != NULL); - - // Chain to sample constructor - Sample_Constructor((Sample*)sample); - sample->base.type = SampleType_CUDA; - sample->event_start = NULL; - sample->event_end = NULL; - - // Create non-blocking events with timing - assert(g_Remotery != NULL); - error = CUDAEventCreate(&sample->event_start, CU_EVENT_DEFAULT); - if (error == RMT_ERROR_NONE) - error = CUDAEventCreate(&sample->event_end, CU_EVENT_DEFAULT); - return error; -} - -static void CUDASample_Destructor(CUDASample* sample) -{ - assert(sample != NULL); - - // Destroy events - if (sample->event_start != NULL) - CUDAEventDestroy(sample->event_start); - if (sample->event_end != NULL) - CUDAEventDestroy(sample->event_end); - - Sample_Destructor((Sample*)sample); -} - -static rmtBool AreCUDASamplesReady(Sample* sample) -{ - rmtError error; - Sample* child; - - CUDASample* cuda_sample = (CUDASample*)sample; - assert(sample->type == SampleType_CUDA); - - // Check to see if both of the CUDA events have been processed - error = CUDAEventQuery(cuda_sample->event_start); - if (error != RMT_ERROR_NONE) - return RMT_FALSE; - error = CUDAEventQuery(cuda_sample->event_end); - if (error != RMT_ERROR_NONE) - return RMT_FALSE; - - // Check child sample events - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - if (!AreCUDASamplesReady(child)) - return RMT_FALSE; - } - - return RMT_TRUE; -} - -static rmtBool GetCUDASampleTimes(Sample* root_sample, Sample* sample) -{ - Sample* child; - - CUDASample* cuda_root_sample = (CUDASample*)root_sample; - CUDASample* cuda_sample = (CUDASample*)sample; - - float ms_start, ms_end; - - assert(root_sample != NULL); - assert(sample != NULL); - - // Get millisecond timing of each sample event, relative to initial root sample - if (CUDAEventElapsedTime(&ms_start, cuda_root_sample->event_start, cuda_sample->event_start) != RMT_ERROR_NONE) - return RMT_FALSE; - if (CUDAEventElapsedTime(&ms_end, cuda_root_sample->event_start, cuda_sample->event_end) != RMT_ERROR_NONE) - return RMT_FALSE; - - // Convert to microseconds and add to the sample - sample->us_start = (rmtU64)(ms_start * 1000); - sample->us_end = (rmtU64)(ms_end * 1000); - sample->us_length = sample->us_end - sample->us_start; - - // Get child sample times - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - if (!GetCUDASampleTimes(root_sample, child)) - return RMT_FALSE; - } - - return RMT_TRUE; -} - -RMT_API void _rmt_BindCUDA(const rmtCUDABind* bind) -{ - assert(bind != NULL); - if (g_Remotery != NULL) - g_Remotery->cuda = *bind; -} - -RMT_API void _rmt_BeginCUDASample(rmtPStr name, rmtU32* hash_cache, void* stream) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - rmtError error; - Sample* sample; - rmtU32 name_hash = ThreadProfiler_GetNameHash(thread_profiler, g_Remotery->mq_to_rmt_thread, name, hash_cache); - - // Create the CUDA tree on-demand as the tree needs an up-front-created root. - // This is not possible to create on initialisation as a CUDA binding is not yet available. - SampleTree** cuda_tree = &thread_profiler->sampleTrees[SampleType_CUDA]; - if (*cuda_tree == NULL) - { - CUDASample* root_sample; - - New_3(SampleTree, *cuda_tree, sizeof(CUDASample), (ObjConstructor)CUDASample_Constructor, - (ObjDestructor)CUDASample_Destructor); - if (error != RMT_ERROR_NONE) - return; - - // Record an event once on the root sample, used to measure absolute sample - // times since this point - root_sample = (CUDASample*)(*cuda_tree)->root; - error = CUDAEventRecord(root_sample->event_start, stream); - if (error != RMT_ERROR_NONE) - return; - } - - // Push the same and record its event - if (ThreadProfiler_Push(*cuda_tree, name_hash, 0, &sample) == RMT_ERROR_NONE) - { - CUDASample* cuda_sample = (CUDASample*)sample; - CUDAEventRecord(cuda_sample->event_start, stream); - } - } -} - -RMT_API void _rmt_EndCUDASample(void* stream) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - CUDASample* sample = (CUDASample*)thread_profiler->sampleTrees[SampleType_CUDA]->currentParent; - if (sample->base.recurse_depth > 0) - { - sample->base.recurse_depth--; - } - else - { - CUDAEventRecord(sample->event_end, stream); - ThreadProfiler_Pop(thread_profiler, g_Remotery->mq_to_rmt_thread, (Sample*)sample); - } - } -} - -#endif // RMT_USE_CUDA - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - @D3D11: Direct3D 11 event sampling ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#if RMT_USE_D3D11 - -// As clReflect has no way of disabling C++ compile mode, this forces C interfaces everywhere... -#define CINTERFACE - -// ...unfortunately these C++ helpers aren't wrapped by the same macro but they can be disabled individually -#define D3D11_NO_HELPERS - -// Allow use of the D3D11 helper macros for accessing the C-style vtable -#define COBJMACROS - -#ifdef _MSC_VER -// Disable for d3d11.h -// warning C4201: nonstandard extension used : nameless struct/union -#pragma warning(push) -#pragma warning(disable : 4201) -#endif - -#include - -#ifdef _MSC_VER -#pragma warning(pop) -#endif - -typedef struct D3D11 -{ - // Context set by user - ID3D11Device* device; - ID3D11DeviceContext* context; - - HRESULT last_error; - - // Queue to the D3D 11 main update thread - // Given that BeginSample/EndSample need to be called from the same thread that does the update, there - // is really no need for this to be a thread-safe queue. I'm using it for its convenience. - rmtMessageQueue* mq_to_d3d11_main; - - // Mark the first time so that remaining timestamps are offset from this - rmtU64 first_timestamp; - // Last time in us (CPU time, via usTimer_Get) since we last resync'ed CPU & GPU - rmtU64 last_resync; - - // Sample trees in transit in the message queue for release on shutdown - Buffer* flush_samples; -} D3D11; - -static rmtError D3D11_Create(D3D11** d3d11) -{ - rmtError error; - - assert(d3d11 != NULL); - - // Allocate space for the D3D11 data - *d3d11 = (D3D11*)rmtMalloc(sizeof(D3D11)); - if (*d3d11 == NULL) - return RMT_ERROR_MALLOC_FAIL; - - // Set defaults - (*d3d11)->device = NULL; - (*d3d11)->context = NULL; - (*d3d11)->last_error = S_OK; - (*d3d11)->mq_to_d3d11_main = NULL; - (*d3d11)->first_timestamp = 0; - (*d3d11)->last_resync = 0; - (*d3d11)->flush_samples = NULL; - - New_1(rmtMessageQueue, (*d3d11)->mq_to_d3d11_main, g_Settings.messageQueueSizeInBytes); - if (error != RMT_ERROR_NONE) - { - Delete(D3D11, *d3d11); - return error; - } - - New_1(Buffer, (*d3d11)->flush_samples, 8 * 1024); - if (error != RMT_ERROR_NONE) - { - Delete(D3D11, *d3d11); - return error; - } - - return RMT_ERROR_NONE; -} - -static void D3D11_Destructor(D3D11* d3d11) -{ - assert(d3d11 != NULL); - Delete(Buffer, d3d11->flush_samples); - Delete(rmtMessageQueue, d3d11->mq_to_d3d11_main); -} - -static HRESULT rmtD3D11Finish(ID3D11Device* device, ID3D11DeviceContext* context, rmtU64* out_timestamp, - double* out_frequency) -{ - HRESULT result; - ID3D11Query* full_stall_fence; - ID3D11Query* query_disjoint; - D3D11_QUERY_DESC query_desc; - D3D11_QUERY_DESC disjoint_desc; - UINT64 timestamp; - D3D11_QUERY_DATA_TIMESTAMP_DISJOINT disjoint; - - query_desc.Query = D3D11_QUERY_TIMESTAMP; - query_desc.MiscFlags = 0; - result = ID3D11Device_CreateQuery(device, &query_desc, &full_stall_fence); - if (result != S_OK) - return result; - - disjoint_desc.Query = D3D11_QUERY_TIMESTAMP_DISJOINT; - disjoint_desc.MiscFlags = 0; - result = ID3D11Device_CreateQuery(device, &disjoint_desc, &query_disjoint); - if (result != S_OK) - { - ID3D11Query_Release(full_stall_fence); - return result; - } - - ID3D11DeviceContext_Begin(context, (ID3D11Asynchronous*)query_disjoint); - ID3D11DeviceContext_End(context, (ID3D11Asynchronous*)full_stall_fence); - ID3D11DeviceContext_End(context, (ID3D11Asynchronous*)query_disjoint); - - result = S_FALSE; - - while (result == S_FALSE) - { - result = - ID3D11DeviceContext_GetData(context, (ID3D11Asynchronous*)query_disjoint, &disjoint, sizeof(disjoint), 0); - if (result != S_OK && result != S_FALSE) - { - ID3D11Query_Release(full_stall_fence); - ID3D11Query_Release(query_disjoint); - return result; - } - if (result == S_OK) - { - result = ID3D11DeviceContext_GetData(context, (ID3D11Asynchronous*)full_stall_fence, ×tamp, - sizeof(timestamp), 0); - if (result != S_OK && result != S_FALSE) - { - ID3D11Query_Release(full_stall_fence); - ID3D11Query_Release(query_disjoint); - return result; - } - } - // Give HyperThreading threads a breath on this spinlock. - YieldProcessor(); - } - - if (disjoint.Disjoint == FALSE) - { - double frequency = disjoint.Frequency / 1000000.0; - *out_timestamp = timestamp; - *out_frequency = frequency; - } - else - { - result = S_FALSE; - } - - ID3D11Query_Release(full_stall_fence); - ID3D11Query_Release(query_disjoint); - return result; -} - -static HRESULT SyncD3D11CpuGpuTimes(ID3D11Device* device, ID3D11DeviceContext* context, rmtU64* out_first_timestamp, - rmtU64* out_last_resync) -{ - rmtU64 cpu_time_start = 0; - rmtU64 cpu_time_stop = 0; - rmtU64 average_half_RTT = 0; // RTT = Rountrip Time. - UINT64 gpu_base = 0; - double frequency = 1; - int i; - - HRESULT result; - result = rmtD3D11Finish(device, context, &gpu_base, &frequency); - if (result != S_OK && result != S_FALSE) - return result; - - for (i = 0; i < RMT_GPU_CPU_SYNC_NUM_ITERATIONS; ++i) - { - rmtU64 half_RTT; - cpu_time_start = usTimer_Get(&g_Remotery->timer); - result = rmtD3D11Finish(device, context, &gpu_base, &frequency); - cpu_time_stop = usTimer_Get(&g_Remotery->timer); - - if (result != S_OK && result != S_FALSE) - return result; - - // Ignore attempts where there was a disjoint, since there would - // be a lot of noise in those readings for measuring the RTT - if (result == S_OK) - { - // Average the time it takes a roundtrip from CPU to GPU - // while doing nothing other than getting timestamps - half_RTT = (cpu_time_stop - cpu_time_start) >> 1ULL; - if (i == 0) - average_half_RTT = half_RTT; - else - average_half_RTT = (average_half_RTT + half_RTT) >> 1ULL; - } - } - - // All GPU times are offset from gpu_base, and then taken to - // the same relative origin CPU timestamps are based on. - // CPU is in us, we must translate it to ns. - *out_first_timestamp = gpu_base - (rmtU64)((cpu_time_start + average_half_RTT) * frequency); - *out_last_resync = cpu_time_stop; - - return result; -} - -typedef struct D3D11Timestamp -{ - // Inherit so that timestamps can be quickly allocated - ObjectLink Link; - - // Pair of timestamp queries that wrap the sample - ID3D11Query* query_start; - ID3D11Query* query_end; - - // A disjoint to measure frequency/stability - // TODO: Does *each* sample need one of these? - ID3D11Query* query_disjoint; - - rmtU64 cpu_timestamp; -} D3D11Timestamp; - -static rmtError D3D11Timestamp_Constructor(D3D11Timestamp* stamp) -{ - ThreadProfiler* thread_profiler; - D3D11_QUERY_DESC timestamp_desc; - D3D11_QUERY_DESC disjoint_desc; - ID3D11Device* device; - HRESULT* last_error; - rmtError rmt_error; - - assert(stamp != NULL); - - ObjectLink_Constructor((ObjectLink*)stamp); - - // Set defaults - stamp->query_start = NULL; - stamp->query_end = NULL; - stamp->query_disjoint = NULL; - stamp->cpu_timestamp = 0; - - assert(g_Remotery != NULL); - rmt_error = ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler); - if (rmt_error != RMT_ERROR_NONE) - { - return rmt_error; - } - assert(thread_profiler->d3d11 != NULL); - device = thread_profiler->d3d11->device; - last_error = &thread_profiler->d3d11->last_error; - - // Create start/end timestamp queries - timestamp_desc.Query = D3D11_QUERY_TIMESTAMP; - timestamp_desc.MiscFlags = 0; - *last_error = ID3D11Device_CreateQuery(device, ×tamp_desc, &stamp->query_start); - if (*last_error != S_OK) - return RMT_ERROR_D3D11_FAILED_TO_CREATE_QUERY; - *last_error = ID3D11Device_CreateQuery(device, ×tamp_desc, &stamp->query_end); - if (*last_error != S_OK) - return RMT_ERROR_D3D11_FAILED_TO_CREATE_QUERY; - - // Create disjoint query - disjoint_desc.Query = D3D11_QUERY_TIMESTAMP_DISJOINT; - disjoint_desc.MiscFlags = 0; - *last_error = ID3D11Device_CreateQuery(device, &disjoint_desc, &stamp->query_disjoint); - if (*last_error != S_OK) - return RMT_ERROR_D3D11_FAILED_TO_CREATE_QUERY; - - return RMT_ERROR_NONE; -} - -static void D3D11Timestamp_Destructor(D3D11Timestamp* stamp) -{ - assert(stamp != NULL); - - // Destroy queries - if (stamp->query_disjoint != NULL) - ID3D11Query_Release(stamp->query_disjoint); - if (stamp->query_end != NULL) - ID3D11Query_Release(stamp->query_end); - if (stamp->query_start != NULL) - ID3D11Query_Release(stamp->query_start); -} - -static void D3D11Timestamp_Begin(D3D11Timestamp* stamp, ID3D11DeviceContext* context) -{ - assert(stamp != NULL); - - // Start of disjoint and first query - stamp->cpu_timestamp = usTimer_Get(&g_Remotery->timer); - ID3D11DeviceContext_Begin(context, (ID3D11Asynchronous*)stamp->query_disjoint); - ID3D11DeviceContext_End(context, (ID3D11Asynchronous*)stamp->query_start); -} - -static void D3D11Timestamp_End(D3D11Timestamp* stamp, ID3D11DeviceContext* context) -{ - assert(stamp != NULL); - - // End of disjoint and second query - ID3D11DeviceContext_End(context, (ID3D11Asynchronous*)stamp->query_end); - ID3D11DeviceContext_End(context, (ID3D11Asynchronous*)stamp->query_disjoint); -} - -static HRESULT D3D11Timestamp_GetData(D3D11Timestamp* stamp, ID3D11Device* device, ID3D11DeviceContext* context, - rmtU64* out_start, rmtU64* out_end, rmtU64* out_first_timestamp, - rmtU64* out_last_resync) -{ - ID3D11Asynchronous* query_start; - ID3D11Asynchronous* query_end; - ID3D11Asynchronous* query_disjoint; - HRESULT result; - - UINT64 start; - UINT64 end; - D3D11_QUERY_DATA_TIMESTAMP_DISJOINT disjoint; - - assert(stamp != NULL); - query_start = (ID3D11Asynchronous*)stamp->query_start; - query_end = (ID3D11Asynchronous*)stamp->query_end; - query_disjoint = (ID3D11Asynchronous*)stamp->query_disjoint; - - // Check to see if all queries are ready - // If any fail to arrive, wait until later - result = ID3D11DeviceContext_GetData(context, query_start, &start, sizeof(start), D3D11_ASYNC_GETDATA_DONOTFLUSH); - if (result != S_OK) - return result; - result = ID3D11DeviceContext_GetData(context, query_end, &end, sizeof(end), D3D11_ASYNC_GETDATA_DONOTFLUSH); - if (result != S_OK) - return result; - result = ID3D11DeviceContext_GetData(context, query_disjoint, &disjoint, sizeof(disjoint), - D3D11_ASYNC_GETDATA_DONOTFLUSH); - if (result != S_OK) - return result; - - if (disjoint.Disjoint == FALSE) - { - double frequency = disjoint.Frequency / 1000000.0; - - // Mark the first timestamp. We may resync if we detect the GPU timestamp is in the - // past (i.e. happened before the CPU command) since it should be impossible. - assert(out_first_timestamp != NULL); - if (*out_first_timestamp == 0 || ((start - *out_first_timestamp) / frequency) < stamp->cpu_timestamp) - { - result = SyncD3D11CpuGpuTimes(device, context, out_first_timestamp, out_last_resync); - if (result != S_OK) - return result; - } - - // Calculate start and end timestamps from the disjoint info - *out_start = (rmtU64)((start - *out_first_timestamp) / frequency); - *out_end = (rmtU64)((end - *out_first_timestamp) / frequency); - } - else - { -#if RMT_D3D11_RESYNC_ON_DISJOINT - result = SyncD3D11CpuGpuTimes(device, context, out_first_timestamp, out_last_resync); - if (result != S_OK) - return result; -#endif - } - - return S_OK; -} - -typedef struct D3D11Sample -{ - // IS-A inheritance relationship - Sample base; - - D3D11Timestamp* timestamp; - -} D3D11Sample; - -static rmtError D3D11Sample_Constructor(D3D11Sample* sample) -{ - rmtError error; - - assert(sample != NULL); - - // Chain to sample constructor - Sample_Constructor((Sample*)sample); - sample->base.type = SampleType_D3D11; - New_0(D3D11Timestamp, sample->timestamp); - - return RMT_ERROR_NONE; -} - -static void D3D11Sample_Destructor(D3D11Sample* sample) -{ - Delete(D3D11Timestamp, sample->timestamp); - Sample_Destructor((Sample*)sample); -} - -RMT_API void _rmt_BindD3D11(void* device, void* context) -{ - if (g_Remotery != NULL) - { - ThreadProfiler* thread_profiler; - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - assert(thread_profiler->d3d11 != NULL); - - assert(device != NULL); - thread_profiler->d3d11->device = (ID3D11Device*)device; - assert(context != NULL); - thread_profiler->d3d11->context = (ID3D11DeviceContext*)context; - } - } -} - -static void UpdateD3D11Frame(ThreadProfiler* thread_profiler); - -RMT_API void _rmt_UnbindD3D11(void) -{ - if (g_Remotery != NULL) - { - ThreadProfiler* thread_profiler; - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - D3D11* d3d11 = thread_profiler->d3d11; - assert(d3d11 != NULL); - - // Stall waiting for the D3D queue to empty into the Remotery queue - while (!rmtMessageQueue_IsEmpty(d3d11->mq_to_d3d11_main)) - UpdateD3D11Frame(thread_profiler); - - // There will be a whole bunch of D3D11 sample trees queued up the remotery queue that need releasing - FreePendingSampleTrees(g_Remotery, SampleType_D3D11, d3d11->flush_samples); - - // Inform sampler to not add any more samples - d3d11->device = NULL; - d3d11->context = NULL; - - // Forcefully delete sample tree on this thread to release time stamps from - // the same thread that created them - Remotery_DeleteSampleTree(g_Remotery, SampleType_D3D11); - } - } -} - -RMT_API void _rmt_BeginD3D11Sample(rmtPStr name, rmtU32* hash_cache) -{ - ThreadProfiler* thread_profiler; - D3D11* d3d11; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - Sample* sample; - rmtU32 name_hash; - SampleTree** d3d_tree; - - // Has D3D11 been unbound? - d3d11 = thread_profiler->d3d11; - assert(d3d11 != NULL); - if (d3d11->device == NULL || d3d11->context == NULL) - return; - - name_hash = ThreadProfiler_GetNameHash(thread_profiler, g_Remotery->mq_to_rmt_thread, name, hash_cache); - - // Create the D3D11 tree on-demand as the tree needs an up-front-created root. - // This is not possible to create on initialisation as a D3D11 binding is not yet available. - d3d_tree = &thread_profiler->sampleTrees[SampleType_D3D11]; - if (*d3d_tree == NULL) - { - rmtError error; - New_3(SampleTree, *d3d_tree, sizeof(D3D11Sample), (ObjConstructor)D3D11Sample_Constructor, - (ObjDestructor)D3D11Sample_Destructor); - if (error != RMT_ERROR_NONE) - return; - } - - // Push the sample and activate the timestamp - if (ThreadProfiler_Push(*d3d_tree, name_hash, 0, &sample) == RMT_ERROR_NONE) - { - D3D11Sample* d3d_sample = (D3D11Sample*)sample; - D3D11Timestamp_Begin(d3d_sample->timestamp, d3d11->context); - } - } -} - -static rmtBool GetD3D11SampleTimes(Sample* sample, ThreadProfiler* thread_profiler, rmtU64* out_first_timestamp, - rmtU64* out_last_resync) -{ - Sample* child; - - D3D11Sample* d3d_sample = (D3D11Sample*)sample; - - assert(sample != NULL); - if (d3d_sample->timestamp != NULL) - { - HRESULT result; - - D3D11* d3d11 = thread_profiler->d3d11; - assert(d3d11 != NULL); - - assert(out_last_resync != NULL); - -#if (RMT_GPU_CPU_SYNC_SECONDS > 0) - if (*out_last_resync < d3d_sample->timestamp->cpu_timestamp) - { - // Convert from us to seconds. - rmtU64 time_diff = (d3d_sample->timestamp->cpu_timestamp - *out_last_resync) / 1000000ULL; - if (time_diff > RMT_GPU_CPU_SYNC_SECONDS) - { - result = SyncD3D11CpuGpuTimes(d3d11->device, d3d11->context, out_first_timestamp, out_last_resync); - if (result != S_OK) - { - d3d11->last_error = result; - return RMT_FALSE; - } - } - } -#endif - - result = D3D11Timestamp_GetData(d3d_sample->timestamp, d3d11->device, d3d11->context, &sample->us_start, - &sample->us_end, out_first_timestamp, out_last_resync); - - if (result != S_OK) - { - d3d11->last_error = result; - return RMT_FALSE; - } - - sample->us_length = sample->us_end - sample->us_start; - } - - // Sum length on the parent to track un-sampled time in the parent - if (sample->parent != NULL) - { - sample->parent->us_sampled_length += sample->us_length; - } - - // Get child sample times - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - if (!GetD3D11SampleTimes(child, thread_profiler, out_first_timestamp, out_last_resync)) - return RMT_FALSE; - } - - return RMT_TRUE; -} - -static void UpdateD3D11Frame(ThreadProfiler* thread_profiler) -{ - D3D11* d3d11; - - if (g_Remotery == NULL) - return; - - d3d11 = thread_profiler->d3d11; - assert(d3d11 != NULL); - - rmt_BeginCPUSample(rmt_UpdateD3D11Frame, 0); - - // Process all messages in the D3D queue - for (;;) - { - Msg_SampleTree* sample_tree; - Sample* sample; - - Message* message = rmtMessageQueue_PeekNextMessage(d3d11->mq_to_d3d11_main); - if (message == NULL) - break; - - // There's only one valid message type in this queue - assert(message->id == MsgID_SampleTree); - sample_tree = (Msg_SampleTree*)message->payload; - sample = sample_tree->rootSample; - assert(sample->type == SampleType_D3D11); - - // Retrieve timing of all D3D11 samples - // If they aren't ready leave the message unconsumed, holding up later frames and maintaining order - if (!GetD3D11SampleTimes(sample, thread_profiler, &d3d11->first_timestamp, &d3d11->last_resync)) - break; - - // Pass samples onto the remotery thread for sending to the viewer - QueueSampleTree(g_Remotery->mq_to_rmt_thread, sample, sample_tree->allocator, sample_tree->threadName, - message->threadProfiler, RMT_FALSE); - rmtMessageQueue_ConsumeNextMessage(d3d11->mq_to_d3d11_main, message); - } - - rmt_EndCPUSample(); -} - -RMT_API void _rmt_EndD3D11Sample(void) -{ - ThreadProfiler* thread_profiler; - D3D11* d3d11; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - D3D11Sample* d3d_sample; - - // Has D3D11 been unbound? - d3d11 = thread_profiler->d3d11; - assert(d3d11 != NULL); - if (d3d11->device == NULL || d3d11->context == NULL) - return; - - // Close the timestamp - d3d_sample = (D3D11Sample*)thread_profiler->sampleTrees[SampleType_D3D11]->currentParent; - if (d3d_sample->base.recurse_depth > 0) - { - d3d_sample->base.recurse_depth--; - } - else - { - if (d3d_sample->timestamp != NULL) - D3D11Timestamp_End(d3d_sample->timestamp, d3d11->context); - - // Send to the update loop for ready-polling - if (ThreadProfiler_Pop(thread_profiler, d3d11->mq_to_d3d11_main, (Sample*)d3d_sample)) - // Perform ready-polling on popping of the root sample - UpdateD3D11Frame(thread_profiler); - } - } -} - -#endif // RMT_USE_D3D11 - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -@OpenGL: OpenGL event sampling ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - -#if RMT_USE_OPENGL - -#ifndef APIENTRY -#if defined(__MINGW32__) || defined(__CYGWIN__) -#define APIENTRY __stdcall -#elif (defined(_MSC_VER) && (_MSC_VER >= 800)) || defined(_STDCALL_SUPPORTED) || defined(__BORLANDC__) -#define APIENTRY __stdcall -#else -#define APIENTRY -#endif -#endif - -#ifndef GLAPI -#if defined(__MINGW32__) || defined(__CYGWIN__) -#define GLAPI extern -#elif defined(_WIN32) -#define GLAPI WINGDIAPI -#else -#define GLAPI extern -#endif -#endif - -#ifndef GLAPIENTRY -#define GLAPIENTRY APIENTRY -#endif - -typedef rmtU32 GLenum; -typedef rmtU32 GLuint; -typedef rmtS32 GLint; -typedef rmtS32 GLsizei; -typedef rmtU64 GLuint64; -typedef rmtS64 GLint64; -typedef unsigned char GLubyte; - -typedef GLenum(GLAPIENTRY* PFNGLGETERRORPROC)(void); -typedef void(GLAPIENTRY* PFNGLGENQUERIESPROC)(GLsizei n, GLuint* ids); -typedef void(GLAPIENTRY* PFNGLDELETEQUERIESPROC)(GLsizei n, const GLuint* ids); -typedef void(GLAPIENTRY* PFNGLBEGINQUERYPROC)(GLenum target, GLuint id); -typedef void(GLAPIENTRY* PFNGLENDQUERYPROC)(GLenum target); -typedef void(GLAPIENTRY* PFNGLGETQUERYOBJECTIVPROC)(GLuint id, GLenum pname, GLint* params); -typedef void(GLAPIENTRY* PFNGLGETQUERYOBJECTUIVPROC)(GLuint id, GLenum pname, GLuint* params); -typedef void(GLAPIENTRY* PFNGLGETQUERYOBJECTI64VPROC)(GLuint id, GLenum pname, GLint64* params); -typedef void(GLAPIENTRY* PFNGLGETQUERYOBJECTUI64VPROC)(GLuint id, GLenum pname, GLuint64* params); -typedef void(GLAPIENTRY* PFNGLQUERYCOUNTERPROC)(GLuint id, GLenum target); -typedef void(GLAPIENTRY* PFNGLGETINTEGER64VPROC)(GLenum pname, GLint64* data); -typedef void(GLAPIENTRY* PFNGLFINISHPROC)(void); - -#define GL_NO_ERROR 0 -#define GL_QUERY_RESULT 0x8866 -#define GL_QUERY_RESULT_AVAILABLE 0x8867 -#define GL_TIME_ELAPSED 0x88BF -#define GL_TIMESTAMP 0x8E28 - -#define RMT_GL_GET_FUN(x) \ - assert(g_Remotery->opengl->x != NULL); \ - g_Remotery->opengl->x - -#define rmtglGenQueries RMT_GL_GET_FUN(__glGenQueries) -#define rmtglDeleteQueries RMT_GL_GET_FUN(__glDeleteQueries) -#define rmtglBeginQuery RMT_GL_GET_FUN(__glBeginQuery) -#define rmtglEndQuery RMT_GL_GET_FUN(__glEndQuery) -#define rmtglGetQueryObjectiv RMT_GL_GET_FUN(__glGetQueryObjectiv) -#define rmtglGetQueryObjectuiv RMT_GL_GET_FUN(__glGetQueryObjectuiv) -#define rmtglGetQueryObjecti64v RMT_GL_GET_FUN(__glGetQueryObjecti64v) -#define rmtglGetQueryObjectui64v RMT_GL_GET_FUN(__glGetQueryObjectui64v) -#define rmtglQueryCounter RMT_GL_GET_FUN(__glQueryCounter) -#define rmtglGetInteger64v RMT_GL_GET_FUN(__glGetInteger64v) -#define rmtglFinish RMT_GL_GET_FUN(__glFinish) - -struct OpenGL_t -{ - // Handle to the OS OpenGL DLL - void* dll_handle; - - PFNGLGETERRORPROC __glGetError; - PFNGLGENQUERIESPROC __glGenQueries; - PFNGLDELETEQUERIESPROC __glDeleteQueries; - PFNGLBEGINQUERYPROC __glBeginQuery; - PFNGLENDQUERYPROC __glEndQuery; - PFNGLGETQUERYOBJECTIVPROC __glGetQueryObjectiv; - PFNGLGETQUERYOBJECTUIVPROC __glGetQueryObjectuiv; - PFNGLGETQUERYOBJECTI64VPROC __glGetQueryObjecti64v; - PFNGLGETQUERYOBJECTUI64VPROC __glGetQueryObjectui64v; - PFNGLQUERYCOUNTERPROC __glQueryCounter; - PFNGLGETINTEGER64VPROC __glGetInteger64v; - PFNGLFINISHPROC __glFinish; - - // Queue to the OpenGL main update thread - // Given that BeginSample/EndSample need to be called from the same thread that does the update, there - // is really no need for this to be a thread-safe queue. I'm using it for its convenience. - rmtMessageQueue* mq_to_opengl_main; - - // Mark the first time so that remaining timestamps are offset from this - rmtU64 first_timestamp; - // Last time in us (CPU time, via usTimer_Get) since we last resync'ed CPU & GPU - rmtU64 last_resync; - - // Sample trees in transit in the message queue for release on shutdown - Buffer* flush_samples; -}; - -static GLenum rmtglGetError(void) -{ - if (g_Remotery != NULL) - { - assert(g_Remotery->opengl != NULL); - if (g_Remotery->opengl->__glGetError != NULL) - return g_Remotery->opengl->__glGetError(); - } - - return (GLenum)0; -} - -#ifdef RMT_PLATFORM_LINUX -#ifdef __cplusplus -extern "C" void* glXGetProcAddressARB(const GLubyte*); -#else -extern void* glXGetProcAddressARB(const GLubyte*); -#endif -#endif - -static ProcReturnType rmtglGetProcAddress(OpenGL* opengl, const char* symbol) -{ -#if defined(RMT_PLATFORM_WINDOWS) - { - // Get OpenGL extension-loading function for each call - typedef ProcReturnType(WINAPI * wglGetProcAddressFn)(LPCSTR); - assert(opengl != NULL); - { - wglGetProcAddressFn wglGetProcAddress = - (wglGetProcAddressFn)rmtGetProcAddress(opengl->dll_handle, "wglGetProcAddress"); - if (wglGetProcAddress != NULL) - return wglGetProcAddress(symbol); - } - } - -#elif defined(RMT_PLATFORM_MACOS) && !defined(GLEW_APPLE_GLX) - - return rmtGetProcAddress(opengl->dll_handle, symbol); - -#elif defined(RMT_PLATFORM_LINUX) - - return glXGetProcAddressARB((const GLubyte*)symbol); - -#endif - - return NULL; -} - -static rmtError OpenGL_Create(OpenGL** opengl) -{ - rmtError error; - - assert(opengl != NULL); - - *opengl = (OpenGL*)rmtMalloc(sizeof(OpenGL)); - if (*opengl == NULL) - return RMT_ERROR_MALLOC_FAIL; - - (*opengl)->dll_handle = NULL; - - (*opengl)->__glGetError = NULL; - (*opengl)->__glGenQueries = NULL; - (*opengl)->__glDeleteQueries = NULL; - (*opengl)->__glBeginQuery = NULL; - (*opengl)->__glEndQuery = NULL; - (*opengl)->__glGetQueryObjectiv = NULL; - (*opengl)->__glGetQueryObjectuiv = NULL; - (*opengl)->__glGetQueryObjecti64v = NULL; - (*opengl)->__glGetQueryObjectui64v = NULL; - (*opengl)->__glQueryCounter = NULL; - (*opengl)->__glGetInteger64v = NULL; - (*opengl)->__glFinish = NULL; - - (*opengl)->mq_to_opengl_main = NULL; - (*opengl)->first_timestamp = 0; - (*opengl)->last_resync = 0; - (*opengl)->flush_samples = NULL; - - New_1(Buffer, (*opengl)->flush_samples, 8 * 1024); - if (error != RMT_ERROR_NONE) - { - Delete(OpenGL, *opengl); - return error; - } - - New_1(rmtMessageQueue, (*opengl)->mq_to_opengl_main, g_Settings.messageQueueSizeInBytes); - - return error; -} - -static void OpenGL_Destructor(OpenGL* opengl) -{ - assert(opengl != NULL); - Delete(rmtMessageQueue, opengl->mq_to_opengl_main); - Delete(Buffer, opengl->flush_samples); -} - -static void SyncOpenGLCpuGpuTimes(rmtU64* out_first_timestamp, rmtU64* out_last_resync) -{ - rmtU64 cpu_time_start = 0; - rmtU64 cpu_time_stop = 0; - rmtU64 average_half_RTT = 0; // RTT = Rountrip Time. - GLint64 gpu_base = 0; - int i; - - rmtglFinish(); - - for (i = 0; i < RMT_GPU_CPU_SYNC_NUM_ITERATIONS; ++i) - { - rmtU64 half_RTT; - - rmtglFinish(); - cpu_time_start = usTimer_Get(&g_Remotery->timer); - rmtglGetInteger64v(GL_TIMESTAMP, &gpu_base); - cpu_time_stop = usTimer_Get(&g_Remotery->timer); - // Average the time it takes a roundtrip from CPU to GPU - // while doing nothing other than getting timestamps - half_RTT = (cpu_time_stop - cpu_time_start) >> 1ULL; - if (i == 0) - average_half_RTT = half_RTT; - else - average_half_RTT = (average_half_RTT + half_RTT) >> 1ULL; - } - - // All GPU times are offset from gpu_base, and then taken to - // the same relative origin CPU timestamps are based on. - // CPU is in us, we must translate it to ns. - *out_first_timestamp = (rmtU64)(gpu_base) - (cpu_time_start + average_half_RTT) * 1000ULL; - *out_last_resync = cpu_time_stop; -} - -typedef struct OpenGLTimestamp -{ - // Inherit so that timestamps can be quickly allocated - ObjectLink Link; - - // Pair of timestamp queries that wrap the sample - GLuint queries[2]; - rmtU64 cpu_timestamp; -} OpenGLTimestamp; - -static rmtError OpenGLTimestamp_Constructor(OpenGLTimestamp* stamp) -{ - GLenum error; - - assert(stamp != NULL); - - ObjectLink_Constructor((ObjectLink*)stamp); - - // Set defaults - stamp->queries[0] = stamp->queries[1] = 0; - stamp->cpu_timestamp = 0; - - // Empty the error queue before using it for glGenQueries - while ((error = rmtglGetError()) != GL_NO_ERROR) - ; - - // Create start/end timestamp queries - assert(g_Remotery != NULL); - rmtglGenQueries(2, stamp->queries); - error = rmtglGetError(); - if (error != GL_NO_ERROR) - return RMT_ERROR_OPENGL_ERROR; - - return RMT_ERROR_NONE; -} - -static void OpenGLTimestamp_Destructor(OpenGLTimestamp* stamp) -{ - assert(stamp != NULL); - - // Destroy queries - if (stamp->queries[0] != 0) - rmtglDeleteQueries(2, stamp->queries); -} - -static void OpenGLTimestamp_Begin(OpenGLTimestamp* stamp) -{ - assert(stamp != NULL); - - // First query - assert(g_Remotery != NULL); - stamp->cpu_timestamp = usTimer_Get(&g_Remotery->timer); - rmtglQueryCounter(stamp->queries[0], GL_TIMESTAMP); -} - -static void OpenGLTimestamp_End(OpenGLTimestamp* stamp) -{ - assert(stamp != NULL); - - // Second query - assert(g_Remotery != NULL); - rmtglQueryCounter(stamp->queries[1], GL_TIMESTAMP); -} - -static rmtBool OpenGLTimestamp_GetData(OpenGLTimestamp* stamp, rmtU64* out_start, rmtU64* out_end, - rmtU64* out_first_timestamp, rmtU64* out_last_resync) -{ - GLuint64 start = 0, end = 0; - GLint startAvailable = 0, endAvailable = 0; - - assert(g_Remotery != NULL); - - assert(stamp != NULL); - assert(stamp->queries[0] != 0 && stamp->queries[1] != 0); - - // Check to see if all queries are ready - // If any fail to arrive, wait until later - rmtglGetQueryObjectiv(stamp->queries[0], GL_QUERY_RESULT_AVAILABLE, &startAvailable); - if (!startAvailable) - return RMT_FALSE; - rmtglGetQueryObjectiv(stamp->queries[1], GL_QUERY_RESULT_AVAILABLE, &endAvailable); - if (!endAvailable) - return RMT_FALSE; - - rmtglGetQueryObjectui64v(stamp->queries[0], GL_QUERY_RESULT, &start); - rmtglGetQueryObjectui64v(stamp->queries[1], GL_QUERY_RESULT, &end); - - // Mark the first timestamp. We may resync if we detect the GPU timestamp is in the - // past (i.e. happened before the CPU command) since it should be impossible. - assert(out_first_timestamp != NULL); - if (*out_first_timestamp == 0 || ((start - *out_first_timestamp) / 1000ULL) < stamp->cpu_timestamp) - SyncOpenGLCpuGpuTimes(out_first_timestamp, out_last_resync); - - // Calculate start and end timestamps (we want us, the queries give us ns) - *out_start = (rmtU64)(start - *out_first_timestamp) / 1000ULL; - *out_end = (rmtU64)(end - *out_first_timestamp) / 1000ULL; - - return RMT_TRUE; -} - -typedef struct OpenGLSample -{ - // IS-A inheritance relationship - Sample base; - - OpenGLTimestamp* timestamp; - -} OpenGLSample; - -static rmtError OpenGLSample_Constructor(OpenGLSample* sample) -{ - rmtError error; - - assert(sample != NULL); - - // Chain to sample constructor - Sample_Constructor((Sample*)sample); - sample->base.type = SampleType_OpenGL; - New_0(OpenGLTimestamp, sample->timestamp); - - return RMT_ERROR_NONE; -} - -static void OpenGLSample_Destructor(OpenGLSample* sample) -{ - Delete(OpenGLTimestamp, sample->timestamp); - Sample_Destructor((Sample*)sample); -} - -RMT_API void _rmt_BindOpenGL() -{ - if (g_Remotery != NULL) - { - OpenGL* opengl = g_Remotery->opengl; - assert(opengl != NULL); - -#if defined(RMT_PLATFORM_WINDOWS) - opengl->dll_handle = rmtLoadLibrary("opengl32.dll"); -#elif defined(RMT_PLATFORM_MACOS) - opengl->dll_handle = rmtLoadLibrary("/System/Library/Frameworks/OpenGL.framework/Versions/Current/OpenGL"); -#elif defined(RMT_PLATFORM_LINUX) - opengl->dll_handle = rmtLoadLibrary("libGL.so"); -#endif - - opengl->__glGetError = (PFNGLGETERRORPROC)rmtGetProcAddress(opengl->dll_handle, "glGetError"); - opengl->__glGenQueries = (PFNGLGENQUERIESPROC)rmtglGetProcAddress(opengl, "glGenQueries"); - opengl->__glDeleteQueries = (PFNGLDELETEQUERIESPROC)rmtglGetProcAddress(opengl, "glDeleteQueries"); - opengl->__glBeginQuery = (PFNGLBEGINQUERYPROC)rmtglGetProcAddress(opengl, "glBeginQuery"); - opengl->__glEndQuery = (PFNGLENDQUERYPROC)rmtglGetProcAddress(opengl, "glEndQuery"); - opengl->__glGetQueryObjectiv = (PFNGLGETQUERYOBJECTIVPROC)rmtglGetProcAddress(opengl, "glGetQueryObjectiv"); - opengl->__glGetQueryObjectuiv = (PFNGLGETQUERYOBJECTUIVPROC)rmtglGetProcAddress(opengl, "glGetQueryObjectuiv"); - opengl->__glGetQueryObjecti64v = - (PFNGLGETQUERYOBJECTI64VPROC)rmtglGetProcAddress(opengl, "glGetQueryObjecti64v"); - opengl->__glGetQueryObjectui64v = - (PFNGLGETQUERYOBJECTUI64VPROC)rmtglGetProcAddress(opengl, "glGetQueryObjectui64v"); - opengl->__glQueryCounter = (PFNGLQUERYCOUNTERPROC)rmtglGetProcAddress(opengl, "glQueryCounter"); - opengl->__glGetInteger64v = (PFNGLGETINTEGER64VPROC)rmtglGetProcAddress(opengl, "glGetInteger64v"); - opengl->__glFinish = (PFNGLFINISHPROC)rmtGetProcAddress(opengl->dll_handle, "glFinish"); - } -} - -static void UpdateOpenGLFrame(void); - -RMT_API void _rmt_UnbindOpenGL(void) -{ - if (g_Remotery != NULL) - { - OpenGL* opengl = g_Remotery->opengl; - assert(opengl != NULL); - - // Stall waiting for the OpenGL queue to empty into the Remotery queue - while (!rmtMessageQueue_IsEmpty(opengl->mq_to_opengl_main)) - UpdateOpenGLFrame(); - - // There will be a whole bunch of OpenGL sample trees queued up the remotery queue that need releasing - FreePendingSampleTrees(g_Remotery, SampleType_OpenGL, opengl->flush_samples); - - // Forcefully delete sample tree on this thread to release time stamps from - // the same thread that created them - Remotery_DeleteSampleTree(g_Remotery, SampleType_OpenGL); - - // Release reference to the OpenGL DLL - if (opengl->dll_handle != NULL) - { - rmtFreeLibrary(opengl->dll_handle); - opengl->dll_handle = NULL; - } - } -} - -RMT_API void _rmt_BeginOpenGLSample(rmtPStr name, rmtU32* hash_cache) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - Sample* sample; - rmtU32 name_hash = ThreadProfiler_GetNameHash(thread_profiler, g_Remotery->mq_to_rmt_thread, name, hash_cache); - - // Create the OpenGL tree on-demand as the tree needs an up-front-created root. - // This is not possible to create on initialisation as a OpenGL binding is not yet available. - SampleTree** ogl_tree = &thread_profiler->sampleTrees[SampleType_OpenGL]; - if (*ogl_tree == NULL) - { - rmtError error; - New_3(SampleTree, *ogl_tree, sizeof(OpenGLSample), (ObjConstructor)OpenGLSample_Constructor, - (ObjDestructor)OpenGLSample_Destructor); - if (error != RMT_ERROR_NONE) - return; - } - - // Push the sample and activate the timestamp - if (ThreadProfiler_Push(*ogl_tree, name_hash, 0, &sample) == RMT_ERROR_NONE) - { - OpenGLSample* ogl_sample = (OpenGLSample*)sample; - OpenGLTimestamp_Begin(ogl_sample->timestamp); - } - } -} - -static rmtBool GetOpenGLSampleTimes(Sample* sample, rmtU64* out_first_timestamp, rmtU64* out_last_resync) -{ - Sample* child; - - OpenGLSample* ogl_sample = (OpenGLSample*)sample; - - assert(sample != NULL); - if (ogl_sample->timestamp != NULL) - { - assert(out_last_resync != NULL); -#if (RMT_GPU_CPU_SYNC_SECONDS > 0) - if (*out_last_resync < ogl_sample->timestamp->cpu_timestamp) - { - // Convert from us to seconds. - rmtU64 time_diff = (ogl_sample->timestamp->cpu_timestamp - *out_last_resync) / 1000000ULL; - if (time_diff > RMT_GPU_CPU_SYNC_SECONDS) - SyncOpenGLCpuGpuTimes(out_first_timestamp, out_last_resync); - } -#endif - - if (!OpenGLTimestamp_GetData(ogl_sample->timestamp, &sample->us_start, &sample->us_end, out_first_timestamp, - out_last_resync)) - return RMT_FALSE; - - sample->us_length = sample->us_end - sample->us_start; - } - - // Get child sample times - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - if (!GetOpenGLSampleTimes(child, out_first_timestamp, out_last_resync)) - return RMT_FALSE; - } - - return RMT_TRUE; -} - -static void UpdateOpenGLFrame(void) -{ - OpenGL* opengl; - - if (g_Remotery == NULL) - return; - - opengl = g_Remotery->opengl; - assert(opengl != NULL); - - rmt_BeginCPUSample(rmt_UpdateOpenGLFrame, 0); - - // Process all messages in the OpenGL queue - while (1) - { - Msg_SampleTree* sample_tree; - Sample* sample; - - Message* message = rmtMessageQueue_PeekNextMessage(opengl->mq_to_opengl_main); - if (message == NULL) - break; - - // There's only one valid message type in this queue - assert(message->id == MsgID_SampleTree); - sample_tree = (Msg_SampleTree*)message->payload; - sample = sample_tree->rootSample; - assert(sample->type == SampleType_OpenGL); - - // Retrieve timing of all OpenGL samples - // If they aren't ready leave the message unconsumed, holding up later frames and maintaining order - if (!GetOpenGLSampleTimes(sample, &opengl->first_timestamp, &opengl->last_resync)) - break; - - // Pass samples onto the remotery thread for sending to the viewer - QueueSampleTree(g_Remotery->mq_to_rmt_thread, sample, sample_tree->allocator, sample_tree->threadName, - message->threadProfiler, RMT_FALSE); - rmtMessageQueue_ConsumeNextMessage(opengl->mq_to_opengl_main, message); - } - - rmt_EndCPUSample(); -} - -RMT_API void _rmt_EndOpenGLSample(void) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - // Close the timestamp - OpenGLSample* ogl_sample = (OpenGLSample*)thread_profiler->sampleTrees[SampleType_OpenGL]->currentParent; - if (ogl_sample->base.recurse_depth > 0) - { - ogl_sample->base.recurse_depth--; - } - else - { - if (ogl_sample->timestamp != NULL) - OpenGLTimestamp_End(ogl_sample->timestamp); - - // Send to the update loop for ready-polling - if (ThreadProfiler_Pop(thread_profiler, g_Remotery->opengl->mq_to_opengl_main, (Sample*)ogl_sample)) - // Perform ready-polling on popping of the root sample - UpdateOpenGLFrame(); - } - } -} - -#endif // RMT_USE_OPENGL - -/* - ------------------------------------------------------------------------------------------------------------------------ - ------------------------------------------------------------------------------------------------------------------------ - @Metal: Metal event sampling - ------------------------------------------------------------------------------------------------------------------------ - ------------------------------------------------------------------------------------------------------------------------ - */ - -#if RMT_USE_METAL - -struct Metal_t -{ - // Queue to the Metal main update thread - // Given that BeginSample/EndSample need to be called from the same thread that does the update, there - // is really no need for this to be a thread-safe queue. I'm using it for its convenience. - rmtMessageQueue* mq_to_metal_main; -}; - -static rmtError Metal_Create(Metal** metal) -{ - rmtError error; - - assert(metal != NULL); - - *metal = (Metal*)rmtMalloc(sizeof(Metal)); - if (*metal == NULL) - return RMT_ERROR_MALLOC_FAIL; - - (*metal)->mq_to_metal_main = NULL; - - New_1(rmtMessageQueue, (*metal)->mq_to_metal_main, g_Settings.messageQueueSizeInBytes); - return error; -} - -static void Metal_Destructor(Metal* metal) -{ - assert(metal != NULL); - Delete(rmtMessageQueue, metal->mq_to_metal_main); -} - -typedef struct MetalTimestamp -{ - // Inherit so that timestamps can be quickly allocated - ObjectLink Link; - - // Output from GPU callbacks - rmtU64 start; - rmtU64 end; - rmtBool ready; -} MetalTimestamp; - -static rmtError MetalTimestamp_Constructor(MetalTimestamp* stamp) -{ - assert(stamp != NULL); - - ObjectLink_Constructor((ObjectLink*)stamp); - - // Set defaults - stamp->start = 0; - stamp->end = 0; - stamp->ready = RMT_FALSE; - - return RMT_ERROR_NONE; -} - -static void MetalTimestamp_Destructor(MetalTimestamp* stamp) -{ - assert(stamp != NULL); -} - -rmtU64 rmtMetal_usGetTime() -{ - // Share the CPU timer for auto-sync - assert(g_Remotery != NULL); - return usTimer_Get(&g_Remotery->timer); -} - -void rmtMetal_MeasureCommandBuffer(unsigned long long* out_start, unsigned long long* out_end, unsigned int* out_ready); - -static void MetalTimestamp_Begin(MetalTimestamp* stamp) -{ - assert(stamp != NULL); - stamp->ready = RMT_FALSE; - - // Metal can currently only issue callbacks at the command buffer level - // So for now measure execution of the entire command buffer - rmtMetal_MeasureCommandBuffer(&stamp->start, &stamp->end, &stamp->ready); -} - -static void MetalTimestamp_End(MetalTimestamp* stamp) -{ - assert(stamp != NULL); - - // As Metal can currently only measure entire command buffers, this function is a no-op - // as the completed handler was already issued in Begin -} - -static rmtBool MetalTimestamp_GetData(MetalTimestamp* stamp, rmtU64* out_start, rmtU64* out_end) -{ - assert(g_Remotery != NULL); - assert(stamp != NULL); - - // GPU writes ready flag when complete handler is called - if (stamp->ready == RMT_FALSE) - return RMT_FALSE; - - *out_start = stamp->start; - *out_end = stamp->end; - - return RMT_TRUE; -} - -typedef struct MetalSample -{ - // IS-A inheritance relationship - Sample base; - - MetalTimestamp* timestamp; - -} MetalSample; - -static rmtError MetalSample_Constructor(MetalSample* sample) -{ - rmtError error; - - assert(sample != NULL); - - // Chain to sample constructor - Sample_Constructor((Sample*)sample); - sample->base.type = SampleType_Metal; - New_0(MetalTimestamp, sample->timestamp); - - return RMT_ERROR_NONE; -} - -static void MetalSample_Destructor(MetalSample* sample) -{ - Delete(MetalTimestamp, sample->timestamp); - Sample_Destructor((Sample*)sample); -} - -static void UpdateOpenGLFrame(void); - -/*RMT_API void _rmt_UnbindMetal(void) -{ - if (g_Remotery != NULL) - { - Metal* metal = g_Remotery->metal; - assert(metal != NULL); - - // Stall waiting for the Metal queue to empty into the Remotery queue - while (!rmtMessageQueue_IsEmpty(metal->mq_to_metal_main)) - UpdateMetalFrame(); - - // Forcefully delete sample tree on this thread to release time stamps from - // the same thread that created them - Remotery_BlockingDeleteSampleTree(g_Remotery, SampleType_Metal); - } -}*/ - -RMT_API void _rmt_BeginMetalSample(rmtPStr name, rmtU32* hash_cache) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - Sample* sample; - rmtU32 name_hash = ThreadProfiler_GetNameHash(thread_profiler, g_Remotery->mq_to_rmt_thread, name, hash_cache); - - // Create the Metal tree on-demand as the tree needs an up-front-created root. - // This is not possible to create on initialisation as a Metal binding is not yet available. - SampleTree** metal_tree = &thread_profiler->sampleTrees[SampleType_Metal]; - if (*metal_tree == NULL) - { - rmtError error; - New_3(SampleTree, *metal_tree, sizeof(MetalSample), (ObjConstructor)MetalSample_Constructor, - (ObjDestructor)MetalSample_Destructor); - if (error != RMT_ERROR_NONE) - return; - } - - // Push the sample and activate the timestamp - if (ThreadProfiler_Push(*metal_tree, name_hash, 0, &sample) == RMT_ERROR_NONE) - { - MetalSample* metal_sample = (MetalSample*)sample; - MetalTimestamp_Begin(metal_sample->timestamp); - } - } -} - -static rmtBool GetMetalSampleTimes(Sample* sample) -{ - Sample* child; - - MetalSample* metal_sample = (MetalSample*)sample; - - assert(sample != NULL); - if (metal_sample->timestamp != NULL) - { - if (!MetalTimestamp_GetData(metal_sample->timestamp, &sample->us_start, &sample->us_end)) - return RMT_FALSE; - - sample->us_length = sample->us_end - sample->us_start; - } - - // Get child sample times - for (child = sample->first_child; child != NULL; child = child->next_sibling) - { - if (!GetMetalSampleTimes(child)) - return RMT_FALSE; - } - - return RMT_TRUE; -} - -static void UpdateMetalFrame(void) -{ - Metal* metal; - - if (g_Remotery == NULL) - return; - - metal = g_Remotery->metal; - assert(metal != NULL); - - rmt_BeginCPUSample(rmt_UpdateMetalFrame, 0); - - // Process all messages in the Metal queue - while (1) - { - Msg_SampleTree* sample_tree; - Sample* sample; - - Message* message = rmtMessageQueue_PeekNextMessage(metal->mq_to_metal_main); - if (message == NULL) - break; - - // There's only one valid message type in this queue - assert(message->id == MsgID_SampleTree); - sample_tree = (Msg_SampleTree*)message->payload; - sample = sample_tree->rootSample; - assert(sample->type == SampleType_Metal); - - // Retrieve timing of all Metal samples - // If they aren't ready leave the message unconsumed, holding up later frames and maintaining order - if (!GetMetalSampleTimes(sample)) - break; - - // Pass samples onto the remotery thread for sending to the viewer - QueueSampleTree(g_Remotery->mq_to_rmt_thread, sample, sample_tree->allocator, sample_tree->threadName, - message->threadProfiler, RMT_FALSE); - rmtMessageQueue_ConsumeNextMessage(metal->mq_to_metal_main, message); - } - - rmt_EndCPUSample(); -} - -RMT_API void _rmt_EndMetalSample(void) -{ - ThreadProfiler* thread_profiler; - - if (g_Remotery == NULL) - return; - - if (ThreadProfilers_GetCurrentThreadProfiler(g_Remotery->threadProfilers, &thread_profiler) == RMT_ERROR_NONE) - { - // Close the timestamp - MetalSample* metal_sample = (MetalSample*)thread_profiler->sampleTrees[SampleType_Metal]->currentParent; - if (metal_sample->base.recurse_depth > 0) - { - metal_sample->base.recurse_depth--; - } - else - { - if (metal_sample->timestamp != NULL) - MetalTimestamp_End(metal_sample->timestamp); - - // Send to the update loop for ready-polling - if (ThreadProfiler_Pop(thread_profiler, g_Remotery->metal->mq_to_metal_main, (Sample*)metal_sample)) - // Perform ready-polling on popping of the root sample - UpdateMetalFrame(); - } - } -} - -#endif // RMT_USE_METAL - -#endif // RMT_ENABLED diff --git a/include/Remotery.h b/include/Remotery.h deleted file mode 100644 index 9fc52f9..0000000 --- a/include/Remotery.h +++ /dev/null @@ -1,679 +0,0 @@ - - -/* -Copyright 2014-2018 Celtoys Ltd - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - - -/* - -Compiling ---------- - -* Windows (MSVC) - add lib/Remotery.c and lib/Remotery.h to your program. Set include - directories to add Remotery/lib path. The required library ws2_32.lib should be picked - up through the use of the #pragma comment(lib, "ws2_32.lib") directive in Remotery.c. - -* Mac OS X (XCode) - simply add lib/Remotery.c and lib/Remotery.h to your program. - -* Linux (GCC) - add the source in lib folder. Compilation of the code requires -pthreads for - library linkage. For example to compile the same run: cc lib/Remotery.c sample/sample.c - -I lib -pthread -lm - -You can define some extra macros to modify what features are compiled into Remotery. These are -documented just below this comment. - -*/ - - -#ifndef RMT_INCLUDED_H -#define RMT_INCLUDED_H - - -// Set to 0 to not include any bits of Remotery in your build -#ifndef RMT_ENABLED -#define RMT_ENABLED 1 -#endif - -// Help performance of the server sending data to the client by marking this machine as little-endian -#ifndef RMT_ASSUME_LITTLE_ENDIAN -#define RMT_ASSUME_LITTLE_ENDIAN 0 -#endif - -// Used by the Celtoys TinyCRT library (not released yet) -#ifndef RMT_USE_TINYCRT -#define RMT_USE_TINYCRT 0 -#endif - -// Assuming CUDA headers/libs are setup, allow CUDA profiling -#ifndef RMT_USE_CUDA -#define RMT_USE_CUDA 0 -#endif - -// Assuming Direct3D 11 headers/libs are setup, allow D3D11 profiling -#ifndef RMT_USE_D3D11 -#define RMT_USE_D3D11 0 -#endif - -// Allow OpenGL profiling -#ifndef RMT_USE_OPENGL -#define RMT_USE_OPENGL 0 -#endif - -// Allow Metal profiling -#ifndef RMT_USE_METAL -#define RMT_USE_METAL 0 -#endif - -// Initially use POSIX thread names to name threads instead of Thread0, 1, ... -#ifndef RMT_USE_POSIX_THREADNAMES -#define RMT_USE_POSIX_THREADNAMES 0 -#endif - -// How many times we spin data back and forth between CPU & GPU -// to calculate average RTT (Roundtrip Time). Cannot be 0. -// Affects OpenGL & D3D11 -#ifndef RMT_GPU_CPU_SYNC_NUM_ITERATIONS -#define RMT_GPU_CPU_SYNC_NUM_ITERATIONS 16 -#endif - -// Time in seconds between each resync to compensate for drifting between GPU & CPU timers, -// effects of power saving, etc. Resyncs can cause stutter, lag spikes, stalls. -// Set to 0 for never. -// Affects OpenGL & D3D11 -#ifndef RMT_GPU_CPU_SYNC_SECONDS -#define RMT_GPU_CPU_SYNC_SECONDS 30 -#endif - -// Whether we should automatically resync if we detect a timer disjoint (e.g. -// changed from AC power to battery, GPU is overheating, or throttling up/down -// due to laptop savings events). Set it to 0 to avoid resync in such events. -// Useful if for some odd reason a driver reports a lot of disjoints. -// Affects D3D11 -#ifndef RMT_D3D11_RESYNC_ON_DISJOINT -#define RMT_D3D11_RESYNC_ON_DISJOINT 1 -#endif - - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - Compiler/Platform Detection and Preprocessor Utilities ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - - -// Platform identification -#if defined(_WINDOWS) || defined(_WIN32) - #define RMT_PLATFORM_WINDOWS -#elif defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__) - #define RMT_PLATFORM_LINUX - #define RMT_PLATFORM_POSIX -#elif defined(__APPLE__) - #define RMT_PLATFORM_MACOS - #define RMT_PLATFORM_POSIX -#endif - -// Architecture identification -#ifdef RMT_PLATFORM_WINDOWS -#ifdef _M_AMD64 -#define RMT_ARCH_64BIT -#else -#define RMT_ARCH_32BIT -#endif -#endif - -#ifdef RMT_DLL - #if defined (RMT_PLATFORM_WINDOWS) - #if defined (RMT_IMPL) - #define RMT_API __declspec(dllexport) - #else - #define RMT_API __declspec(dllimport) - #endif - #elif defined (RMT_PLATFORM_POSIX) - #if defined (RMT_IMPL) - #define RMT_API __attribute__((visibility("default"))) - #else - #define RMT_API - #endif - #endif -#else - #define RMT_API -#endif - -// Allows macros to be written that can work around the inability to do: #define(x) #ifdef x -// with the C preprocessor. -#if RMT_ENABLED - #define IFDEF_RMT_ENABLED(t, f) t -#else - #define IFDEF_RMT_ENABLED(t, f) f -#endif -#if RMT_ENABLED && RMT_USE_CUDA - #define IFDEF_RMT_USE_CUDA(t, f) t -#else - #define IFDEF_RMT_USE_CUDA(t, f) f -#endif -#if RMT_ENABLED && RMT_USE_D3D11 - #define IFDEF_RMT_USE_D3D11(t, f) t -#else - #define IFDEF_RMT_USE_D3D11(t, f) f -#endif -#if RMT_ENABLED && RMT_USE_OPENGL - #define IFDEF_RMT_USE_OPENGL(t, f) t -#else - #define IFDEF_RMT_USE_OPENGL(t, f) f -#endif -#if RMT_ENABLED && RMT_USE_METAL - #define IFDEF_RMT_USE_METAL(t, f) t -#else - #define IFDEF_RMT_USE_METAL(t, f) f -#endif - - -// Public interface is written in terms of these macros to easily enable/disable itself -#define RMT_OPTIONAL(macro, x) IFDEF_ ## macro(x, ) -#define RMT_OPTIONAL_RET(macro, x, y) IFDEF_ ## macro(x, (y)) - - - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - Types ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - - - -// Boolean -typedef unsigned int rmtBool; -#define RMT_TRUE ((rmtBool)1) -#define RMT_FALSE ((rmtBool)0) - - -// Unsigned integer types -typedef unsigned char rmtU8; -typedef unsigned short rmtU16; -typedef unsigned int rmtU32; -typedef unsigned long long rmtU64; - - -// Signed integer types -typedef char rmtS8; -typedef short rmtS16; -typedef int rmtS32; -typedef long long rmtS64; - - -// Const, null-terminated string pointer -typedef const char* rmtPStr; - - -// Handle to the main remotery instance -typedef struct Remotery Remotery; - -// All possible error codes -// clang-format off -typedef enum rmtError -{ - RMT_ERROR_NONE, - RMT_ERROR_RECURSIVE_SAMPLE, // Not an error but an internal message to calling code - RMT_ERROR_UNKNOWN, // An error with a message yet to be defined, only for internal error handling - - // System errors - RMT_ERROR_MALLOC_FAIL, // Malloc call within remotery failed - RMT_ERROR_TLS_ALLOC_FAIL, // Attempt to allocate thread local storage failed - RMT_ERROR_VIRTUAL_MEMORY_BUFFER_FAIL, // Failed to create a virtual memory mirror buffer - RMT_ERROR_CREATE_THREAD_FAIL, // Failed to create a thread for the server - RMT_ERROR_OPEN_THREAD_HANDLE_FAIL, // Failed to open a thread handle, given a thread id - - // Network TCP/IP socket errors - RMT_ERROR_SOCKET_INIT_NETWORK_FAIL, // Network initialisation failure (e.g. on Win32, WSAStartup fails) - RMT_ERROR_SOCKET_CREATE_FAIL, // Can't create a socket for connection to the remote viewer - RMT_ERROR_SOCKET_BIND_FAIL, // Can't bind a socket for the server - RMT_ERROR_SOCKET_LISTEN_FAIL, // Created server socket failed to enter a listen state - RMT_ERROR_SOCKET_SET_NON_BLOCKING_FAIL, // Created server socket failed to switch to a non-blocking state - RMT_ERROR_SOCKET_INVALID_POLL, // Poll attempt on an invalid socket - RMT_ERROR_SOCKET_SELECT_FAIL, // Server failed to call select on socket - RMT_ERROR_SOCKET_POLL_ERRORS, // Poll notified that the socket has errors - RMT_ERROR_SOCKET_ACCEPT_FAIL, // Server failed to accept connection from client - RMT_ERROR_SOCKET_SEND_TIMEOUT, // Timed out trying to send data - RMT_ERROR_SOCKET_SEND_FAIL, // Unrecoverable error occured while client/server tried to send data - RMT_ERROR_SOCKET_RECV_NO_DATA, // No data available when attempting a receive - RMT_ERROR_SOCKET_RECV_TIMEOUT, // Timed out trying to receive data - RMT_ERROR_SOCKET_RECV_FAILED, // Unrecoverable error occured while client/server tried to receive data - - // WebSocket errors - RMT_ERROR_WEBSOCKET_HANDSHAKE_NOT_GET, // WebSocket server handshake failed, not HTTP GET - RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_VERSION, // WebSocket server handshake failed, can't locate WebSocket version - RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_VERSION, // WebSocket server handshake failed, unsupported WebSocket version - RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_HOST, // WebSocket server handshake failed, can't locate host - RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_HOST, // WebSocket server handshake failed, host is not allowed to connect - RMT_ERROR_WEBSOCKET_HANDSHAKE_NO_KEY, // WebSocket server handshake failed, can't locate WebSocket key - RMT_ERROR_WEBSOCKET_HANDSHAKE_BAD_KEY, // WebSocket server handshake failed, WebSocket key is ill-formed - RMT_ERROR_WEBSOCKET_HANDSHAKE_STRING_FAIL, // WebSocket server handshake failed, internal error, bad string code - RMT_ERROR_WEBSOCKET_DISCONNECTED, // WebSocket server received a disconnect request and closed the socket - RMT_ERROR_WEBSOCKET_BAD_FRAME_HEADER, // Couldn't parse WebSocket frame header - RMT_ERROR_WEBSOCKET_BAD_FRAME_HEADER_SIZE, // Partially received wide frame header size - RMT_ERROR_WEBSOCKET_BAD_FRAME_HEADER_MASK, // Partially received frame header data mask - RMT_ERROR_WEBSOCKET_RECEIVE_TIMEOUT, // Timeout receiving frame header - - RMT_ERROR_REMOTERY_NOT_CREATED, // Remotery object has not been created - RMT_ERROR_SEND_ON_INCOMPLETE_PROFILE, // An attempt was made to send an incomplete profile tree to the client - - // CUDA error messages - RMT_ERROR_CUDA_DEINITIALIZED, // This indicates that the CUDA driver is in the process of shutting down - RMT_ERROR_CUDA_NOT_INITIALIZED, // This indicates that the CUDA driver has not been initialized with cuInit() or that initialization has failed - RMT_ERROR_CUDA_INVALID_CONTEXT, // This most frequently indicates that there is no context bound to the current thread - RMT_ERROR_CUDA_INVALID_VALUE, // This indicates that one or more of the parameters passed to the API call is not within an acceptable range of values - RMT_ERROR_CUDA_INVALID_HANDLE, // This indicates that a resource handle passed to the API call was not valid - RMT_ERROR_CUDA_OUT_OF_MEMORY, // The API call failed because it was unable to allocate enough memory to perform the requested operation - RMT_ERROR_ERROR_NOT_READY, // This indicates that a resource handle passed to the API call was not valid - - // Direct3D 11 error messages - RMT_ERROR_D3D11_FAILED_TO_CREATE_QUERY, // Failed to create query for sample - - // OpenGL error messages - RMT_ERROR_OPENGL_ERROR, // Generic OpenGL error, no need to expose detail since app will need an OpenGL error callback registered - - RMT_ERROR_CUDA_UNKNOWN, -} rmtError; -// clang-format on - -typedef enum rmtSampleFlags -{ - // Default behaviour - RMTSF_None = 0, - - // Search parent for same-named samples and merge timing instead of adding a new sample - RMTSF_Aggregate = 1, - - // Merge sample with parent if it's the same sample - RMTSF_Recursive = 2, - - // Set this flag on any of your root samples so that Remotery will assert if it ends up *not* being the root sample. - // This will quickly allow you to detect Begin/End mismatches causing a sample tree imbalance. - RMTSF_Root = 4, -} rmtSampleFlags; - - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - Public Interface ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - - - -// Can call remotery functions on a null pointer -// TODO: Can embed extern "C" in these macros? - -#define rmt_Settings() \ - RMT_OPTIONAL_RET(RMT_ENABLED, _rmt_Settings(), NULL ) - -#define rmt_CreateGlobalInstance(rmt) \ - RMT_OPTIONAL_RET(RMT_ENABLED, _rmt_CreateGlobalInstance(rmt), RMT_ERROR_NONE) - -#define rmt_DestroyGlobalInstance(rmt) \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_DestroyGlobalInstance(rmt)) - -#define rmt_SetGlobalInstance(rmt) \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_SetGlobalInstance(rmt)) - -#define rmt_GetGlobalInstance() \ - RMT_OPTIONAL_RET(RMT_ENABLED, _rmt_GetGlobalInstance(), NULL) - -#define rmt_SetCurrentThreadName(rmt) \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_SetCurrentThreadName(rmt)) - -#define rmt_LogText(text) \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_LogText(text)) - -#define rmt_BeginCPUSample(name, flags) \ - RMT_OPTIONAL(RMT_ENABLED, { \ - static rmtU32 rmt_sample_hash_##name = 0; \ - _rmt_BeginCPUSample(#name, flags, &rmt_sample_hash_##name); \ - }) - -#define rmt_BeginCPUSampleDynamic(namestr, flags) \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_BeginCPUSample(namestr, flags, NULL)) - -#define rmt_EndCPUSample() \ - RMT_OPTIONAL(RMT_ENABLED, _rmt_EndCPUSample()) - - -// Callback function pointer types -typedef void* (*rmtMallocPtr)(void* mm_context, rmtU32 size); -typedef void* (*rmtReallocPtr)(void* mm_context, void* ptr, rmtU32 size); -typedef void (*rmtFreePtr)(void* mm_context, void* ptr); -typedef void (*rmtInputHandlerPtr)(const char* text, void* context); - - -// Struture to fill in to modify Remotery default settings -typedef struct rmtSettings -{ - // Which port to listen for incoming connections on - rmtU16 port; - - // When this server exits it can leave the port open in TIME_WAIT state for a while. This forces - // subsequent server bind attempts to fail when restarting. If you find restarts fail repeatedly - // with bind attempts, set this to true to forcibly reuse the open port. - rmtBool reuse_open_port; - - // Only allow connections on localhost? - // For dev builds you may want to access your game from other devices but if - // you distribute a game to your players with Remotery active, probably best - // to limit connections to localhost. - rmtBool limit_connections_to_localhost; - - // Whether to enable runtime thread sampling that discovers which processors a thread is running - // on. This will suspend and resume threads from outside repeatdly and inject code into each - // thread that automatically instruments the processor. - // Default: Enabled - rmtBool enableThreadSampler; - - // How long to sleep between server updates, hopefully trying to give - // a little CPU back to other threads. - rmtU32 msSleepBetweenServerUpdates; - - // Size of the internal message queues Remotery uses - // Will be rounded to page granularity of 64k - rmtU32 messageQueueSizeInBytes; - - // If the user continuously pushes to the message queue, the server network - // code won't get a chance to update unless there's an upper-limit on how - // many messages can be consumed per loop. - rmtU32 maxNbMessagesPerUpdate; - - // Callback pointers for memory allocation - rmtMallocPtr malloc; - rmtReallocPtr realloc; - rmtFreePtr free; - void* mm_context; - - // Callback pointer for receiving input from the Remotery console - rmtInputHandlerPtr input_handler; - - // Context pointer that gets sent to Remotery console callback function - void* input_handler_context; - - rmtPStr logPath; -} rmtSettings; - - -// Structure to fill in when binding CUDA to Remotery -typedef struct rmtCUDABind -{ - // The main context that all driver functions apply before each call - void* context; - - // Driver API function pointers that need to be pointed to - // Untyped so that the CUDA headers are not required in this file - // NOTE: These are named differently to the CUDA functions because the CUDA API has a habit of using - // macros to point function calls to different versions, e.g. cuEventDestroy is a macro for - // cuEventDestroy_v2. - void* CtxSetCurrent; - void* CtxGetCurrent; - void* EventCreate; - void* EventDestroy; - void* EventRecord; - void* EventQuery; - void* EventElapsedTime; - -} rmtCUDABind; - - -// Call once after you've initialised CUDA to bind it to Remotery -#define rmt_BindCUDA(bind) \ - RMT_OPTIONAL(RMT_USE_CUDA, _rmt_BindCUDA(bind)) - -// Mark the beginning of a CUDA sample on the specified asynchronous stream -#define rmt_BeginCUDASample(name, stream) \ - RMT_OPTIONAL(RMT_USE_CUDA, { \ - static rmtU32 rmt_sample_hash_##name = 0; \ - _rmt_BeginCUDASample(#name, &rmt_sample_hash_##name, stream); \ - }) - -// Mark the end of a CUDA sample on the specified asynchronous stream -#define rmt_EndCUDASample(stream) \ - RMT_OPTIONAL(RMT_USE_CUDA, _rmt_EndCUDASample(stream)) - - -#define rmt_BindD3D11(device, context) \ - RMT_OPTIONAL(RMT_USE_D3D11, _rmt_BindD3D11(device, context)) - -#define rmt_UnbindD3D11() \ - RMT_OPTIONAL(RMT_USE_D3D11, _rmt_UnbindD3D11()) - -#define rmt_BeginD3D11Sample(name) \ - RMT_OPTIONAL(RMT_USE_D3D11, { \ - static rmtU32 rmt_sample_hash_##name = 0; \ - _rmt_BeginD3D11Sample(#name, &rmt_sample_hash_##name); \ - }) - -#define rmt_BeginD3D11SampleDynamic(namestr) \ - RMT_OPTIONAL(RMT_USE_D3D11, _rmt_BeginD3D11Sample(namestr, NULL)) - -#define rmt_EndD3D11Sample() \ - RMT_OPTIONAL(RMT_USE_D3D11, _rmt_EndD3D11Sample()) - - -#define rmt_BindOpenGL() \ - RMT_OPTIONAL(RMT_USE_OPENGL, _rmt_BindOpenGL()) - -#define rmt_UnbindOpenGL() \ - RMT_OPTIONAL(RMT_USE_OPENGL, _rmt_UnbindOpenGL()) - -#define rmt_BeginOpenGLSample(name) \ - RMT_OPTIONAL(RMT_USE_OPENGL, { \ - static rmtU32 rmt_sample_hash_##name = 0; \ - _rmt_BeginOpenGLSample(#name, &rmt_sample_hash_##name); \ - }) - -#define rmt_BeginOpenGLSampleDynamic(namestr) \ - RMT_OPTIONAL(RMT_USE_OPENGL, _rmt_BeginOpenGLSample(namestr, NULL)) - -#define rmt_EndOpenGLSample() \ - RMT_OPTIONAL(RMT_USE_OPENGL, _rmt_EndOpenGLSample()) - - -#define rmt_BindMetal(command_buffer) \ - RMT_OPTIONAL(RMT_USE_METAL, _rmt_BindMetal(command_buffer)); - -#define rmt_UnbindMetal() \ - RMT_OPTIONAL(RMT_USE_METAL, _rmt_UnbindMetal()); - -#define rmt_BeginMetalSample(name) \ - RMT_OPTIONAL(RMT_USE_METAL, { \ - static rmtU32 rmt_sample_hash_##name = 0; \ - _rmt_BeginMetalSample(#name, &rmt_sample_hash_##name); \ - }) - -#define rmt_BeginMetalSampleDynamic(namestr) \ - RMT_OPTIONAL(RMT_USE_METAL, _rmt_BeginMetalSample(namestr, NULL)) - -#define rmt_EndMetalSample() \ - RMT_OPTIONAL(RMT_USE_METAL, _rmt_EndMetalSample()) - - - - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - C++ Public Interface Extensions ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - - - -#ifdef __cplusplus - - -#if RMT_ENABLED - -// Types that end samples in their destructors -extern "C" RMT_API void _rmt_EndCPUSample(void); -struct rmt_EndCPUSampleOnScopeExit -{ - ~rmt_EndCPUSampleOnScopeExit() - { - _rmt_EndCPUSample(); - } -}; -#if RMT_USE_CUDA -extern "C" RMT_API void _rmt_EndCUDASample(void* stream); -struct rmt_EndCUDASampleOnScopeExit -{ - rmt_EndCUDASampleOnScopeExit(void* stream) : stream(stream) - { - } - ~rmt_EndCUDASampleOnScopeExit() - { - _rmt_EndCUDASample(stream); - } - void* stream; -}; -#endif -#if RMT_USE_D3D11 -extern "C" RMT_API void _rmt_EndD3D11Sample(void); -struct rmt_EndD3D11SampleOnScopeExit -{ - ~rmt_EndD3D11SampleOnScopeExit() - { - _rmt_EndD3D11Sample(); - } -}; -#endif - -#if RMT_USE_OPENGL -extern "C" RMT_API void _rmt_EndOpenGLSample(void); -struct rmt_EndOpenGLSampleOnScopeExit -{ - ~rmt_EndOpenGLSampleOnScopeExit() - { - _rmt_EndOpenGLSample(); - } -}; -#endif - -#if RMT_USE_METAL -extern "C" RMT_API void _rmt_EndMetalSample(void); -struct rmt_EndMetalSampleOnScopeExit -{ - ~rmt_EndMetalSampleOnScopeExit() - { - _rmt_EndMetalSample(); - } -}; -#endif - -#endif - - - -// Pairs a call to rmt_BeginSample with its call to rmt_EndSample when leaving scope -#define rmt_ScopedCPUSample(name, flags) \ - RMT_OPTIONAL(RMT_ENABLED, rmt_BeginCPUSample(name, flags)); \ - RMT_OPTIONAL(RMT_ENABLED, rmt_EndCPUSampleOnScopeExit rmt_ScopedCPUSample##name); -#define rmt_ScopedCUDASample(name, stream) \ - RMT_OPTIONAL(RMT_USE_CUDA, rmt_BeginCUDASample(name, stream)); \ - RMT_OPTIONAL(RMT_USE_CUDA, rmt_EndCUDASampleOnScopeExit rmt_ScopedCUDASample##name(stream)); -#define rmt_ScopedD3D11Sample(name) \ - RMT_OPTIONAL(RMT_USE_D3D11, rmt_BeginD3D11Sample(name)); \ - RMT_OPTIONAL(RMT_USE_D3D11, rmt_EndD3D11SampleOnScopeExit rmt_ScopedD3D11Sample##name); -#define rmt_ScopedOpenGLSample(name) \ - RMT_OPTIONAL(RMT_USE_OPENGL, rmt_BeginOpenGLSample(name)); \ - RMT_OPTIONAL(RMT_USE_OPENGL, rmt_EndOpenGLSampleOnScopeExit rmt_ScopedOpenGLSample##name); -#define rmt_ScopedMetalSample(name) \ - RMT_OPTIONAL(RMT_USE_METAL, rmt_BeginMetalSample(name)); \ - RMT_OPTIONAL(RMT_USE_METAL, rmt_EndMetalSampleOnScopeExit rmt_ScopedMetalSample##name); - -#endif - - - -/* ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- - Private Interface - don't directly call these ------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------- -*/ - - - -#if RMT_ENABLED - -#ifdef __cplusplus -extern "C" { -#endif - -RMT_API rmtSettings* _rmt_Settings( void ); -RMT_API enum rmtError _rmt_CreateGlobalInstance(Remotery** remotery); -RMT_API void _rmt_DestroyGlobalInstance(Remotery* remotery); -RMT_API void _rmt_SetGlobalInstance(Remotery* remotery); -RMT_API Remotery* _rmt_GetGlobalInstance(void); -RMT_API void _rmt_SetCurrentThreadName(rmtPStr thread_name); -RMT_API void _rmt_LogText(rmtPStr text); -RMT_API void _rmt_BeginCPUSample(rmtPStr name, rmtU32 flags, rmtU32* hash_cache); -RMT_API void _rmt_EndCPUSample(void); - -#if RMT_USE_CUDA -RMT_API void _rmt_BindCUDA(const rmtCUDABind* bind); -RMT_API void _rmt_BeginCUDASample(rmtPStr name, rmtU32* hash_cache, void* stream); -RMT_API void _rmt_EndCUDASample(void* stream); -#endif - -#if RMT_USE_D3D11 -RMT_API void _rmt_BindD3D11(void* device, void* context); -RMT_API void _rmt_UnbindD3D11(void); -RMT_API void _rmt_BeginD3D11Sample(rmtPStr name, rmtU32* hash_cache); -RMT_API void _rmt_EndD3D11Sample(void); -#endif - -#if RMT_USE_OPENGL -RMT_API void _rmt_BindOpenGL(); -RMT_API void _rmt_UnbindOpenGL(void); -RMT_API void _rmt_BeginOpenGLSample(rmtPStr name, rmtU32* hash_cache); -RMT_API void _rmt_EndOpenGLSample(void); -#endif - -#if RMT_USE_METAL -RMT_API void _rmt_BeginMetalSample(rmtPStr name, rmtU32* hash_cache); -RMT_API void _rmt_EndMetalSample(void); -#endif - -#ifdef __cplusplus - -} -#endif - -#if RMT_USE_METAL -#ifdef __OBJC__ -RMT_API void _rmt_BindMetal(id command_buffer); -RMT_API void _rmt_UnbindMetal(); -#endif -#endif - -#endif // RMT_ENABLED - - -#endif diff --git a/include/RemoteryMetal.mm b/include/RemoteryMetal.mm deleted file mode 100644 index bb69da9..0000000 --- a/include/RemoteryMetal.mm +++ /dev/null @@ -1,59 +0,0 @@ -// -// Copyright 2014-2018 Celtoys Ltd -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// - -#include -#include -#include - -#import - -// Store command buffer in thread-local so that each thread can point to its own -static void SetCommandBuffer(id command_buffer) -{ - NSMutableDictionary* thread_data = [[NSThread currentThread] threadDictionary]; - thread_data[@"rmtMTLCommandBuffer"] = command_buffer; -} - -static id GetCommandBuffer() -{ - NSMutableDictionary* thread_data = [[NSThread currentThread] threadDictionary]; - return thread_data[@"rmtMTLCommandBuffer"]; -} - -extern "C" void _rmt_BindMetal(id command_buffer) -{ - SetCommandBuffer(command_buffer); -} - -extern "C" void _rmt_UnbindMetal() -{ - SetCommandBuffer(0); -} - -// Needs to be in the same lib for this to work -extern "C" unsigned long long rmtMetal_usGetTime(); - -static void SetTimestamp(void* data) -{ - *((unsigned long long*)data) = rmtMetal_usGetTime(); -} - -extern "C" void rmtMetal_MeasureCommandBuffer(unsigned long long* out_start, unsigned long long* out_end, unsigned int* out_ready) -{ - id command_buffer = GetCommandBuffer(); - [command_buffer addScheduledHandler:^(id ){ SetTimestamp(out_start); }]; - [command_buffer addCompletedHandler:^(id ){ SetTimestamp(out_end); *out_ready = 1; }]; -} diff --git a/include/indicators.hpp b/include/indicators.hpp deleted file mode 100644 index 46a0f05..0000000 --- a/include/indicators.hpp +++ /dev/null @@ -1,4649 +0,0 @@ - -#ifndef INDICATORS_COLOR -#define INDICATORS_COLOR - -namespace indicators { -enum class Color { grey, red, green, yellow, blue, magenta, cyan, white, unspecified }; -} - -#endif - - - -#ifndef INDICATORS_FONT_STYLE -#define INDICATORS_FONT_STYLE - -namespace indicators { -enum class FontStyle { bold, dark, italic, underline, blink, reverse, concealed, crossed }; -} - -#endif - - - -#ifndef INDICATORS_PROGRESS_TYPE -#define INDICATORS_PROGRESS_TYPE - -namespace indicators { -enum class ProgressType { incremental, decremental }; -} - -#endif - -//! -//! termcolor -//! ~~~~~~~~~ -//! -//! termcolor is a header-only c++ library for printing colored messages -//! to the terminal. Written just for fun with a help of the Force. -//! -//! :copyright: (c) 2013 by Ihor Kalnytskyi -//! :license: BSD, see LICENSE for details -//! - -#ifndef TERMCOLOR_HPP_ -#define TERMCOLOR_HPP_ - -#include -#include - -// Detect target's platform and set some macros in order to wrap platform -// specific code this library depends on. -#if defined(_WIN32) || defined(_WIN64) -# define TERMCOLOR_TARGET_WINDOWS -#elif defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)) -# define TERMCOLOR_TARGET_POSIX -#endif - -// If implementation has not been explicitly set, try to choose one based on -// target platform. -#if !defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) && !defined(TERMCOLOR_USE_WINDOWS_API) && !defined(TERMCOLOR_USE_NOOP) -# if defined(TERMCOLOR_TARGET_POSIX) -# define TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES -# define TERMCOLOR_AUTODETECTED_IMPLEMENTATION -# elif defined(TERMCOLOR_TARGET_WINDOWS) -# define TERMCOLOR_USE_WINDOWS_API -# define TERMCOLOR_AUTODETECTED_IMPLEMENTATION -# endif -#endif - -// These headers provide isatty()/fileno() functions, which are used for -// testing whether a standard stream refers to the terminal. -#if defined(TERMCOLOR_TARGET_POSIX) -# include -#elif defined(TERMCOLOR_TARGET_WINDOWS) -#if defined(_MSC_VER) -#if !defined(NOMINMAX) -#define NOMINMAX -#endif -#endif -# include -# include -#endif - - -namespace termcolor -{ - // Forward declaration of the `_internal` namespace. - // All comments are below. - namespace _internal - { - inline int colorize_index(); - inline FILE* get_standard_stream(const std::ostream& stream); - inline bool is_colorized(std::ostream& stream); - inline bool is_atty(const std::ostream& stream); - - #if defined(TERMCOLOR_TARGET_WINDOWS) - inline void win_change_attributes(std::ostream& stream, int foreground, int background=-1); - #endif - } - - inline - std::ostream& colorize(std::ostream& stream) - { - stream.iword(_internal::colorize_index()) = 1L; - return stream; - } - - inline - std::ostream& nocolorize(std::ostream& stream) - { - stream.iword(_internal::colorize_index()) = 0L; - return stream; - } - - inline - std::ostream& reset(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[00m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, -1); - #endif - } - return stream; - } - - inline - std::ostream& bold(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[1m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& dark(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[2m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& italic(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[3m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& underline(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[4m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, COMMON_LVB_UNDERSCORE); - #endif - } - return stream; - } - - inline - std::ostream& blink(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[5m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& reverse(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[7m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& concealed(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[8m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& crossed(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[9m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[12]; - std::snprintf(command, sizeof(command), "\033[38;5;%dm", code); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& on_color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[12]; - std::snprintf(command, sizeof(command), "\033[48;5;%dm", code); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[20]; - std::snprintf(command, sizeof(command), "\033[38;2;%d;%d;%dm", r, g, b); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& on_color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[20]; - std::snprintf(command, sizeof(command), "\033[48;2;%d;%d;%dm", r, g, b); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[30m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - 0 // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[31m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[32m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[33m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[34m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[35m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[36m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[37m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED - ); - #endif - } - return stream; - } - - - inline - std::ostream& bright_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[90m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - 0 | FOREGROUND_INTENSITY // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[91m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[92m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[93m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[94m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[95m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[96m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[97m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - - inline - std::ostream& on_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[40m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - 0 // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& on_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[41m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[42m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& on_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[43m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[44m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& on_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[45m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[46m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& on_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[47m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_RED - ); - #endif - } - - return stream; - } - - - inline - std::ostream& on_bright_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[100m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - 0 | BACKGROUND_INTENSITY // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[101m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[102m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[103m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[104m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[105m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[106m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[107m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - - return stream; - } - - - - //! Since C++ hasn't a way to hide something in the header from - //! the outer access, I have to introduce this namespace which - //! is used for internal purpose and should't be access from - //! the user code. - namespace _internal - { - // An index to be used to access a private storage of I/O streams. See - // colorize / nocolorize I/O manipulators for details. Due to the fact - // that static variables ain't shared between translation units, inline - // function with local static variable is used to do the trick and share - // the variable value between translation units. - inline int colorize_index() - { - static int colorize_index = std::ios_base::xalloc(); - return colorize_index; - } - - //! Since C++ hasn't a true way to extract stream handler - //! from the a given `std::ostream` object, I have to write - //! this kind of hack. - inline - FILE* get_standard_stream(const std::ostream& stream) - { - if (&stream == &std::cout) - return stdout; - else if ((&stream == &std::cerr) || (&stream == &std::clog)) - return stderr; - - return nullptr; - } - - // Say whether a given stream should be colorized or not. It's always - // true for ATTY streams and may be true for streams marked with - // colorize flag. - inline - bool is_colorized(std::ostream& stream) - { - return is_atty(stream) || static_cast(stream.iword(colorize_index())); - } - - //! Test whether a given `std::ostream` object refers to - //! a terminal. - inline - bool is_atty(const std::ostream& stream) - { - FILE* std_stream = get_standard_stream(stream); - - // Unfortunately, fileno() ends with segmentation fault - // if invalid file descriptor is passed. So we need to - // handle this case gracefully and assume it's not a tty - // if standard stream is not detected, and 0 is returned. - if (!std_stream) - return false; - - #if defined(TERMCOLOR_TARGET_POSIX) - return ::isatty(fileno(std_stream)); - #elif defined(TERMCOLOR_TARGET_WINDOWS) - return ::_isatty(_fileno(std_stream)); - #else - return false; - #endif - } - - #if defined(TERMCOLOR_TARGET_WINDOWS) - //! Change Windows Terminal colors attribute. If some - //! parameter is `-1` then attribute won't changed. - inline void win_change_attributes(std::ostream& stream, int foreground, int background) - { - // yeah, i know.. it's ugly, it's windows. - static WORD defaultAttributes = 0; - - // Windows doesn't have ANSI escape sequences and so we use special - // API to change Terminal output color. That means we can't - // manipulate colors by means of "std::stringstream" and hence - // should do nothing in this case. - if (!_internal::is_atty(stream)) - return; - - // get terminal handle - HANDLE hTerminal = INVALID_HANDLE_VALUE; - if (&stream == &std::cout) - hTerminal = GetStdHandle(STD_OUTPUT_HANDLE); - else if (&stream == &std::cerr) - hTerminal = GetStdHandle(STD_ERROR_HANDLE); - - // save default terminal attributes if it unsaved - if (!defaultAttributes) - { - CONSOLE_SCREEN_BUFFER_INFO info; - if (!GetConsoleScreenBufferInfo(hTerminal, &info)) - return; - defaultAttributes = info.wAttributes; - } - - // restore all default settings - if (foreground == -1 && background == -1) - { - SetConsoleTextAttribute(hTerminal, defaultAttributes); - return; - } - - // get current settings - CONSOLE_SCREEN_BUFFER_INFO info; - if (!GetConsoleScreenBufferInfo(hTerminal, &info)) - return; - - if (foreground != -1) - { - info.wAttributes &= ~(info.wAttributes & 0x0F); - info.wAttributes |= static_cast(foreground); - } - - if (background != -1) - { - info.wAttributes &= ~(info.wAttributes & 0xF0); - info.wAttributes |= static_cast(background); - } - - SetConsoleTextAttribute(hTerminal, info.wAttributes); - } - #endif // TERMCOLOR_TARGET_WINDOWS - - } // namespace _internal - -} // namespace termcolor - - -#undef TERMCOLOR_TARGET_POSIX -#undef TERMCOLOR_TARGET_WINDOWS - -#if defined(TERMCOLOR_AUTODETECTED_IMPLEMENTATION) -# undef TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES -# undef TERMCOLOR_USE_WINDOWS_API -#endif - -#endif // TERMCOLOR_HPP_ - - - -#ifndef INDICATORS_TERMINAL_SIZE -#define INDICATORS_TERMINAL_SIZE -#include - - -#if defined(_WIN32) -#include - -namespace indicators { - -static inline std::pair terminal_size() { - CONSOLE_SCREEN_BUFFER_INFO csbi; - int cols, rows; - GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi); - cols = csbi.srWindow.Right - csbi.srWindow.Left + 1; - rows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1; - return {static_cast(rows), static_cast(cols)}; -} - -static inline size_t terminal_width() { return terminal_size().second; } - -} // namespace indicators - -#else - -#include //ioctl() and TIOCGWINSZ -#include // for STDOUT_FILENO - -namespace indicators { - -static inline std::pair terminal_size() { - struct winsize size{}; - ioctl(STDOUT_FILENO, TIOCGWINSZ, &size); - return {static_cast(size.ws_row), static_cast(size.ws_col)}; -} - -static inline size_t terminal_width() { return terminal_size().second; } - -} // namespace indicators - -#endif - -#endif - - -/* -Activity Indicators for Modern C++ -https://github.com/p-ranav/indicators - -Licensed under the MIT License . -SPDX-License-Identifier: MIT -Copyright (c) 2019 Dawid Pilarski . - -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. -*/ -#ifndef INDICATORS_SETTING -#define INDICATORS_SETTING - -#include -// #include -#ifndef INDICATORS_COLOR -#define INDICATORS_COLOR - -namespace indicators { -enum class Color { grey, red, green, yellow, blue, magenta, cyan, white, unspecified }; -} - -#endif - -// #include -#ifndef INDICATORS_FONT_STYLE -#define INDICATORS_FONT_STYLE - -namespace indicators { -enum class FontStyle { bold, dark, italic, underline, blink, reverse, concealed, crossed }; -} - -#endif - -// #include -#ifndef INDICATORS_PROGRESS_TYPE -#define INDICATORS_PROGRESS_TYPE - -namespace indicators { -enum class ProgressType { incremental, decremental }; -} - -#endif -#include -#include -#include -#include -#include - -namespace indicators { - -namespace details { - -template struct if_else; - -template <> struct if_else { using type = std::true_type; }; - -template <> struct if_else { using type = std::false_type; }; - -template struct if_else_type; - -template struct if_else_type { - using type = True; -}; - -template struct if_else_type { - using type = False; -}; - -template struct conjuction; - -template <> struct conjuction<> : std::true_type {}; - -template -struct conjuction - : if_else_type>::type {}; - -template struct disjunction; - -template <> struct disjunction<> : std::false_type {}; - -template -struct disjunction - : if_else_type>::type {}; - -enum class ProgressBarOption { - bar_width = 0, - prefix_text, - postfix_text, - start, - end, - fill, - lead, - remainder, - max_postfix_text_len, - completed, - show_percentage, - show_elapsed_time, - show_remaining_time, - saved_start_time, - foreground_color, - spinner_show, - spinner_states, - font_styles, - hide_bar_when_complete, - min_progress, - max_progress, - progress_type, - stream -}; - -template struct Setting { - template ::value>::type> - explicit Setting(Args &&... args) : value(std::forward(args)...) {} - Setting(const Setting &) = default; - Setting(Setting &&) = default; - - static constexpr auto id = Id; - using type = T; - - T value{}; -}; - -template struct is_setting : std::false_type {}; - -template struct is_setting> : std::true_type {}; - -template -struct are_settings : if_else...>::value>::type {}; - -template <> struct are_settings<> : std::true_type {}; - -template struct is_setting_from_tuple; - -template struct is_setting_from_tuple> : std::true_type {}; - -template -struct is_setting_from_tuple> - : if_else...>::value>::type {}; - -template -struct are_settings_from_tuple - : if_else...>::value>::type {}; - -template struct always_true { static constexpr auto value = true; }; - -template Default &&get_impl(Default &&def) { - return std::forward(def); -} - -template -auto get_impl(Default && /*def*/, T &&first, Args &&... /*tail*/) -> - typename std::enable_if<(std::decay::type::id == Id), - decltype(std::forward(first))>::type { - return std::forward(first); -} - -template -auto get_impl(Default &&def, T && /*first*/, Args &&... tail) -> - typename std::enable_if<(std::decay::type::id != Id), - decltype(get_impl(std::forward(def), - std::forward(tail)...))>::type { - return get_impl(std::forward(def), std::forward(tail)...); -} - -template ::value, void>::type> -auto get(Default &&def, Args &&... args) - -> decltype(details::get_impl(std::forward(def), std::forward(args)...)) { - return details::get_impl(std::forward(def), std::forward(args)...); -} - -template using StringSetting = Setting; - -template using IntegerSetting = Setting; - -template using BooleanSetting = Setting; - -template struct option_idx; - -template -struct option_idx, counter> - : if_else_type<(Id == T::id), std::integral_constant, - option_idx, counter + 1>>::type {}; - -template struct option_idx, counter> { - static_assert(always_true<(ProgressBarOption)Id>::value, "No such option was found"); -}; - -template -auto get_value(Settings &&settings) - -> decltype((std::get::type>::value>( - std::declval()))) { - return std::get::type>::value>( - std::forward(settings)); -} - -} // namespace details - -namespace option { -using BarWidth = details::IntegerSetting; -using PrefixText = details::StringSetting; -using PostfixText = details::StringSetting; -using Start = details::StringSetting; -using End = details::StringSetting; -using Fill = details::StringSetting; -using Lead = details::StringSetting; -using Remainder = details::StringSetting; -using MaxPostfixTextLen = details::IntegerSetting; -using Completed = details::BooleanSetting; -using ShowPercentage = details::BooleanSetting; -using ShowElapsedTime = details::BooleanSetting; -using ShowRemainingTime = details::BooleanSetting; -using SavedStartTime = details::BooleanSetting; -using ForegroundColor = details::Setting; -using ShowSpinner = details::BooleanSetting; -using SpinnerStates = - details::Setting, details::ProgressBarOption::spinner_states>; -using HideBarWhenComplete = - details::BooleanSetting; -using FontStyles = - details::Setting, details::ProgressBarOption::font_styles>; -using MinProgress = details::IntegerSetting; -using MaxProgress = details::IntegerSetting; -using ProgressType = details::Setting; -using Stream = details::Setting; -} // namespace option -} // namespace indicators - -#endif - - -#ifndef INDICATORS_CURSOR_CONTROL -#define INDICATORS_CURSOR_CONTROL - -#if defined(_MSC_VER) -#if !defined(NOMINMAX) -#define NOMINMAX -#endif -#include -#include -#else -#include -#endif - -namespace indicators { - -#if defined(_MSC_VER) - -static inline void show_console_cursor(bool const show) { - HANDLE out = GetStdHandle(STD_OUTPUT_HANDLE); - - CONSOLE_CURSOR_INFO cursorInfo; - - GetConsoleCursorInfo(out, &cursorInfo); - cursorInfo.bVisible = show; // set the cursor visibility - SetConsoleCursorInfo(out, &cursorInfo); -} - -#else - -static inline void show_console_cursor(bool const show) { - std::fputs(show ? "\033[?25h" : "\033[?25l", stdout); -} - -#endif - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_CURSOR_MOVEMENT -#define INDICATORS_CURSOR_MOVEMENT - -#if defined(_MSC_VER) -#if !defined(NOMINMAX) -#define NOMINMAX -#endif -#include -#include -#else -#include -#endif - -namespace indicators { - -#ifdef _MSC_VER - -static inline void move(int x, int y) { - auto hStdout = GetStdHandle(STD_OUTPUT_HANDLE); - if (!hStdout) - return; - - CONSOLE_SCREEN_BUFFER_INFO csbiInfo; - GetConsoleScreenBufferInfo(hStdout, &csbiInfo); - - COORD cursor; - - cursor.X = csbiInfo.dwCursorPosition.X + x; - cursor.Y = csbiInfo.dwCursorPosition.Y + y; - SetConsoleCursorPosition(hStdout, cursor); -} - -static inline void move_up(int lines) { move(0, -lines); } -static inline void move_down(int lines) { move(0, -lines); } -static inline void move_right(int cols) { move(cols, 0); } -static inline void move_left(int cols) { move(-cols, 0); } - -#else - -static inline void move_up(int lines) { std::cout << "\033[" << lines << "A"; } -static inline void move_down(int lines) { std::cout << "\033[" << lines << "B"; } -static inline void move_right(int cols) { std::cout << "\033[" << cols << "C"; } -static inline void move_left(int cols) { std::cout << "\033[" << cols << "D"; } - -#endif - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_STREAM_HELPER -#define INDICATORS_STREAM_HELPER - -// #include -#ifndef INDICATORS_DISPLAY_WIDTH -#define INDICATORS_DISPLAY_WIDTH - -#include -#if __has_include() -#include -#define INDICATORS_HAVE_CODECVT 1 -#define _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING -#endif -#include -#include -#include -#include - -namespace unicode { - -#if INDICATORS_HAVE_CODECVT -namespace details { - -/* - * This is an implementation of wcwidth() and wcswidth() (defined in - * IEEE Std 1002.1-2001) for Unicode. - * - * http://www.opengroup.org/onlinepubs/007904975/functions/wcwidth.html - * http://www.opengroup.org/onlinepubs/007904975/functions/wcswidth.html - * - * In fixed-width output devices, Latin characters all occupy a single - * "cell" position of equal width, whereas ideographic CJK characters - * occupy two such cells. Interoperability between terminal-line - * applications and (teletype-style) character terminals using the - * UTF-8 encoding requires agreement on which character should advance - * the cursor by how many cell positions. No established formal - * standards exist at present on which Unicode character shall occupy - * how many cell positions on character terminals. These routines are - * a first attempt of defining such behavior based on simple rules - * applied to data provided by the Unicode Consortium. - * - * For some graphical characters, the Unicode standard explicitly - * defines a character-cell width via the definition of the East Asian - * FullWidth (F), Wide (W), Half-width (H), and Narrow (Na) classes. - * In all these cases, there is no ambiguity about which width a - * terminal shall use. For characters in the East Asian Ambiguous (A) - * class, the width choice depends purely on a preference of backward - * compatibility with either historic CJK or Western practice. - * Choosing single-width for these characters is easy to justify as - * the appropriate long-term solution, as the CJK practice of - * displaying these characters as double-width comes from historic - * implementation simplicity (8-bit encoded characters were displayed - * single-width and 16-bit ones double-width, even for Greek, - * Cyrillic, etc.) and not any typographic considerations. - * - * Much less clear is the choice of width for the Not East Asian - * (Neutral) class. Existing practice does not dictate a width for any - * of these characters. It would nevertheless make sense - * typographically to allocate two character cells to characters such - * as for instance EM SPACE or VOLUME INTEGRAL, which cannot be - * represented adequately with a single-width glyph. The following - * routines at present merely assign a single-cell width to all - * neutral characters, in the interest of simplicity. This is not - * entirely satisfactory and should be reconsidered before - * establishing a formal standard in this area. At the moment, the - * decision which Not East Asian (Neutral) characters should be - * represented by double-width glyphs cannot yet be answered by - * applying a simple rule from the Unicode database content. Setting - * up a proper standard for the behavior of UTF-8 character terminals - * will require a careful analysis not only of each Unicode character, - * but also of each presentation form, something the author of these - * routines has avoided to do so far. - * - * http://www.unicode.org/unicode/reports/tr11/ - * - * Markus Kuhn -- 2007-05-26 (Unicode 5.0) - * - * Permission to use, copy, modify, and distribute this software - * for any purpose and without fee is hereby granted. The author - * disclaims all warranties with regard to this software. - * - * Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c - */ - -struct interval { - int first; - int last; -}; - -/* auxiliary function for binary search in interval table */ -static inline int bisearch(wchar_t ucs, const struct interval *table, int max) { - int min = 0; - int mid; - - if (ucs < table[0].first || ucs > table[max].last) - return 0; - while (max >= min) { - mid = (min + max) / 2; - if (ucs > table[mid].last) - min = mid + 1; - else if (ucs < table[mid].first) - max = mid - 1; - else - return 1; - } - - return 0; -} - -/* The following two functions define the column width of an ISO 10646 - * character as follows: - * - * - The null character (U+0000) has a column width of 0. - * - * - Other C0/C1 control characters and DEL will lead to a return - * value of -1. - * - * - Non-spacing and enclosing combining characters (general - * category code Mn or Me in the Unicode database) have a - * column width of 0. - * - * - SOFT HYPHEN (U+00AD) has a column width of 1. - * - * - Other format characters (general category code Cf in the Unicode - * database) and ZERO WIDTH SPACE (U+200B) have a column width of 0. - * - * - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF) - * have a column width of 0. - * - * - Spacing characters in the East Asian Wide (W) or East Asian - * Full-width (F) category as defined in Unicode Technical - * Report #11 have a column width of 2. - * - * - All remaining characters (including all printable - * ISO 8859-1 and WGL4 characters, Unicode control characters, - * etc.) have a column width of 1. - * - * This implementation assumes that wchar_t characters are encoded - * in ISO 10646. - */ - -static inline int mk_wcwidth(wchar_t ucs) { - /* sorted list of non-overlapping intervals of non-spacing characters */ - /* generated by "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c" */ - static const struct interval combining[] = { - {0x0300, 0x036F}, {0x0483, 0x0486}, {0x0488, 0x0489}, {0x0591, 0x05BD}, - {0x05BF, 0x05BF}, {0x05C1, 0x05C2}, {0x05C4, 0x05C5}, {0x05C7, 0x05C7}, - {0x0600, 0x0603}, {0x0610, 0x0615}, {0x064B, 0x065E}, {0x0670, 0x0670}, - {0x06D6, 0x06E4}, {0x06E7, 0x06E8}, {0x06EA, 0x06ED}, {0x070F, 0x070F}, - {0x0711, 0x0711}, {0x0730, 0x074A}, {0x07A6, 0x07B0}, {0x07EB, 0x07F3}, - {0x0901, 0x0902}, {0x093C, 0x093C}, {0x0941, 0x0948}, {0x094D, 0x094D}, - {0x0951, 0x0954}, {0x0962, 0x0963}, {0x0981, 0x0981}, {0x09BC, 0x09BC}, - {0x09C1, 0x09C4}, {0x09CD, 0x09CD}, {0x09E2, 0x09E3}, {0x0A01, 0x0A02}, - {0x0A3C, 0x0A3C}, {0x0A41, 0x0A42}, {0x0A47, 0x0A48}, {0x0A4B, 0x0A4D}, - {0x0A70, 0x0A71}, {0x0A81, 0x0A82}, {0x0ABC, 0x0ABC}, {0x0AC1, 0x0AC5}, - {0x0AC7, 0x0AC8}, {0x0ACD, 0x0ACD}, {0x0AE2, 0x0AE3}, {0x0B01, 0x0B01}, - {0x0B3C, 0x0B3C}, {0x0B3F, 0x0B3F}, {0x0B41, 0x0B43}, {0x0B4D, 0x0B4D}, - {0x0B56, 0x0B56}, {0x0B82, 0x0B82}, {0x0BC0, 0x0BC0}, {0x0BCD, 0x0BCD}, - {0x0C3E, 0x0C40}, {0x0C46, 0x0C48}, {0x0C4A, 0x0C4D}, {0x0C55, 0x0C56}, - {0x0CBC, 0x0CBC}, {0x0CBF, 0x0CBF}, {0x0CC6, 0x0CC6}, {0x0CCC, 0x0CCD}, - {0x0CE2, 0x0CE3}, {0x0D41, 0x0D43}, {0x0D4D, 0x0D4D}, {0x0DCA, 0x0DCA}, - {0x0DD2, 0x0DD4}, {0x0DD6, 0x0DD6}, {0x0E31, 0x0E31}, {0x0E34, 0x0E3A}, - {0x0E47, 0x0E4E}, {0x0EB1, 0x0EB1}, {0x0EB4, 0x0EB9}, {0x0EBB, 0x0EBC}, - {0x0EC8, 0x0ECD}, {0x0F18, 0x0F19}, {0x0F35, 0x0F35}, {0x0F37, 0x0F37}, - {0x0F39, 0x0F39}, {0x0F71, 0x0F7E}, {0x0F80, 0x0F84}, {0x0F86, 0x0F87}, - {0x0F90, 0x0F97}, {0x0F99, 0x0FBC}, {0x0FC6, 0x0FC6}, {0x102D, 0x1030}, - {0x1032, 0x1032}, {0x1036, 0x1037}, {0x1039, 0x1039}, {0x1058, 0x1059}, - {0x1160, 0x11FF}, {0x135F, 0x135F}, {0x1712, 0x1714}, {0x1732, 0x1734}, - {0x1752, 0x1753}, {0x1772, 0x1773}, {0x17B4, 0x17B5}, {0x17B7, 0x17BD}, - {0x17C6, 0x17C6}, {0x17C9, 0x17D3}, {0x17DD, 0x17DD}, {0x180B, 0x180D}, - {0x18A9, 0x18A9}, {0x1920, 0x1922}, {0x1927, 0x1928}, {0x1932, 0x1932}, - {0x1939, 0x193B}, {0x1A17, 0x1A18}, {0x1B00, 0x1B03}, {0x1B34, 0x1B34}, - {0x1B36, 0x1B3A}, {0x1B3C, 0x1B3C}, {0x1B42, 0x1B42}, {0x1B6B, 0x1B73}, - {0x1DC0, 0x1DCA}, {0x1DFE, 0x1DFF}, {0x200B, 0x200F}, {0x202A, 0x202E}, - {0x2060, 0x2063}, {0x206A, 0x206F}, {0x20D0, 0x20EF}, {0x302A, 0x302F}, - {0x3099, 0x309A}, {0xA806, 0xA806}, {0xA80B, 0xA80B}, {0xA825, 0xA826}, - {0xFB1E, 0xFB1E}, {0xFE00, 0xFE0F}, {0xFE20, 0xFE23}, {0xFEFF, 0xFEFF}, - {0xFFF9, 0xFFFB}, {0x10A01, 0x10A03}, {0x10A05, 0x10A06}, {0x10A0C, 0x10A0F}, - {0x10A38, 0x10A3A}, {0x10A3F, 0x10A3F}, {0x1D167, 0x1D169}, {0x1D173, 0x1D182}, - {0x1D185, 0x1D18B}, {0x1D1AA, 0x1D1AD}, {0x1D242, 0x1D244}, {0xE0001, 0xE0001}, - {0xE0020, 0xE007F}, {0xE0100, 0xE01EF}}; - - /* test for 8-bit control characters */ - if (ucs == 0) - return 0; - if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0)) - return -1; - - /* binary search in table of non-spacing characters */ - if (bisearch(ucs, combining, sizeof(combining) / sizeof(struct interval) - 1)) - return 0; - - /* if we arrive here, ucs is not a combining or C0/C1 control character */ - - return 1 + (ucs >= 0x1100 && - (ucs <= 0x115f || /* Hangul Jamo init. consonants */ - ucs == 0x2329 || ucs == 0x232a || - (ucs >= 0x2e80 && ucs <= 0xa4cf && ucs != 0x303f) || /* CJK ... Yi */ - (ucs >= 0xac00 && ucs <= 0xd7a3) || /* Hangul Syllables */ - (ucs >= 0xf900 && ucs <= 0xfaff) || /* CJK Compatibility Ideographs */ - (ucs >= 0xfe10 && ucs <= 0xfe19) || /* Vertical forms */ - (ucs >= 0xfe30 && ucs <= 0xfe6f) || /* CJK Compatibility Forms */ - (ucs >= 0xff00 && ucs <= 0xff60) || /* Fullwidth Forms */ - (ucs >= 0xffe0 && ucs <= 0xffe6) || (ucs >= 0x20000 && ucs <= 0x2fffd) || - (ucs >= 0x30000 && ucs <= 0x3fffd))); -} - -static inline int mk_wcswidth(const wchar_t *pwcs, size_t n) { - int w, width = 0; - - for (; *pwcs && n-- > 0; pwcs++) - if ((w = mk_wcwidth(*pwcs)) < 0) - return -1; - else - width += w; - - return width; -} - -/* - * The following functions are the same as mk_wcwidth() and - * mk_wcswidth(), except that spacing characters in the East Asian - * Ambiguous (A) category as defined in Unicode Technical Report #11 - * have a column width of 2. This variant might be useful for users of - * CJK legacy encodings who want to migrate to UCS without changing - * the traditional terminal character-width behaviour. It is not - * otherwise recommended for general use. - */ -static inline int mk_wcwidth_cjk(wchar_t ucs) { - /* sorted list of non-overlapping intervals of East Asian Ambiguous - * characters, generated by "uniset +WIDTH-A -cat=Me -cat=Mn -cat=Cf c" */ - static const struct interval ambiguous[] = { - {0x00A1, 0x00A1}, {0x00A4, 0x00A4}, {0x00A7, 0x00A8}, {0x00AA, 0x00AA}, {0x00AE, 0x00AE}, - {0x00B0, 0x00B4}, {0x00B6, 0x00BA}, {0x00BC, 0x00BF}, {0x00C6, 0x00C6}, {0x00D0, 0x00D0}, - {0x00D7, 0x00D8}, {0x00DE, 0x00E1}, {0x00E6, 0x00E6}, {0x00E8, 0x00EA}, {0x00EC, 0x00ED}, - {0x00F0, 0x00F0}, {0x00F2, 0x00F3}, {0x00F7, 0x00FA}, {0x00FC, 0x00FC}, {0x00FE, 0x00FE}, - {0x0101, 0x0101}, {0x0111, 0x0111}, {0x0113, 0x0113}, {0x011B, 0x011B}, {0x0126, 0x0127}, - {0x012B, 0x012B}, {0x0131, 0x0133}, {0x0138, 0x0138}, {0x013F, 0x0142}, {0x0144, 0x0144}, - {0x0148, 0x014B}, {0x014D, 0x014D}, {0x0152, 0x0153}, {0x0166, 0x0167}, {0x016B, 0x016B}, - {0x01CE, 0x01CE}, {0x01D0, 0x01D0}, {0x01D2, 0x01D2}, {0x01D4, 0x01D4}, {0x01D6, 0x01D6}, - {0x01D8, 0x01D8}, {0x01DA, 0x01DA}, {0x01DC, 0x01DC}, {0x0251, 0x0251}, {0x0261, 0x0261}, - {0x02C4, 0x02C4}, {0x02C7, 0x02C7}, {0x02C9, 0x02CB}, {0x02CD, 0x02CD}, {0x02D0, 0x02D0}, - {0x02D8, 0x02DB}, {0x02DD, 0x02DD}, {0x02DF, 0x02DF}, {0x0391, 0x03A1}, {0x03A3, 0x03A9}, - {0x03B1, 0x03C1}, {0x03C3, 0x03C9}, {0x0401, 0x0401}, {0x0410, 0x044F}, {0x0451, 0x0451}, - {0x2010, 0x2010}, {0x2013, 0x2016}, {0x2018, 0x2019}, {0x201C, 0x201D}, {0x2020, 0x2022}, - {0x2024, 0x2027}, {0x2030, 0x2030}, {0x2032, 0x2033}, {0x2035, 0x2035}, {0x203B, 0x203B}, - {0x203E, 0x203E}, {0x2074, 0x2074}, {0x207F, 0x207F}, {0x2081, 0x2084}, {0x20AC, 0x20AC}, - {0x2103, 0x2103}, {0x2105, 0x2105}, {0x2109, 0x2109}, {0x2113, 0x2113}, {0x2116, 0x2116}, - {0x2121, 0x2122}, {0x2126, 0x2126}, {0x212B, 0x212B}, {0x2153, 0x2154}, {0x215B, 0x215E}, - {0x2160, 0x216B}, {0x2170, 0x2179}, {0x2190, 0x2199}, {0x21B8, 0x21B9}, {0x21D2, 0x21D2}, - {0x21D4, 0x21D4}, {0x21E7, 0x21E7}, {0x2200, 0x2200}, {0x2202, 0x2203}, {0x2207, 0x2208}, - {0x220B, 0x220B}, {0x220F, 0x220F}, {0x2211, 0x2211}, {0x2215, 0x2215}, {0x221A, 0x221A}, - {0x221D, 0x2220}, {0x2223, 0x2223}, {0x2225, 0x2225}, {0x2227, 0x222C}, {0x222E, 0x222E}, - {0x2234, 0x2237}, {0x223C, 0x223D}, {0x2248, 0x2248}, {0x224C, 0x224C}, {0x2252, 0x2252}, - {0x2260, 0x2261}, {0x2264, 0x2267}, {0x226A, 0x226B}, {0x226E, 0x226F}, {0x2282, 0x2283}, - {0x2286, 0x2287}, {0x2295, 0x2295}, {0x2299, 0x2299}, {0x22A5, 0x22A5}, {0x22BF, 0x22BF}, - {0x2312, 0x2312}, {0x2460, 0x24E9}, {0x24EB, 0x254B}, {0x2550, 0x2573}, {0x2580, 0x258F}, - {0x2592, 0x2595}, {0x25A0, 0x25A1}, {0x25A3, 0x25A9}, {0x25B2, 0x25B3}, {0x25B6, 0x25B7}, - {0x25BC, 0x25BD}, {0x25C0, 0x25C1}, {0x25C6, 0x25C8}, {0x25CB, 0x25CB}, {0x25CE, 0x25D1}, - {0x25E2, 0x25E5}, {0x25EF, 0x25EF}, {0x2605, 0x2606}, {0x2609, 0x2609}, {0x260E, 0x260F}, - {0x2614, 0x2615}, {0x261C, 0x261C}, {0x261E, 0x261E}, {0x2640, 0x2640}, {0x2642, 0x2642}, - {0x2660, 0x2661}, {0x2663, 0x2665}, {0x2667, 0x266A}, {0x266C, 0x266D}, {0x266F, 0x266F}, - {0x273D, 0x273D}, {0x2776, 0x277F}, {0xE000, 0xF8FF}, {0xFFFD, 0xFFFD}, {0xF0000, 0xFFFFD}, - {0x100000, 0x10FFFD}}; - - /* binary search in table of non-spacing characters */ - if (bisearch(ucs, ambiguous, sizeof(ambiguous) / sizeof(struct interval) - 1)) - return 2; - - return mk_wcwidth(ucs); -} - -static inline int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n) { - int w, width = 0; - - for (; *pwcs && n-- > 0; pwcs++) - if ((w = mk_wcwidth_cjk(*pwcs)) < 0) - return -1; - else - width += w; - - return width; -} - -// convert UTF-8 string to wstring -static inline std::wstring utf8_decode(const std::string &str) { - std::wstring_convert> myconv; - return myconv.from_bytes(str); -} - -// convert wstring to UTF-8 string -static inline std::string utf8_encode(const std::wstring &str) { - std::wstring_convert> myconv; - return myconv.to_bytes(str); -} - -} // namespace details - -static inline int display_width(const std::string &input) { - using namespace unicode::details; - return mk_wcswidth(utf8_decode(input).c_str(), input.size()); -} - -static inline int display_width(const std::wstring &input) { - return details::mk_wcswidth(input.c_str(), input.size()); -} - -#else - -static inline int display_width(const std::string &input) { - return input.length(); -} - -static inline int display_width(const std::wstring &input) { - return input.length(); -} - -#endif - -} // namespace unicode - -#endif -// #include -/* -Activity Indicators for Modern C++ -https://github.com/p-ranav/indicators - -Licensed under the MIT License . -SPDX-License-Identifier: MIT -Copyright (c) 2019 Dawid Pilarski . - -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. -*/ -#ifndef INDICATORS_SETTING -#define INDICATORS_SETTING - -#include -// #include -// #include -// #include -#include -#include -#include -#include -#include - -namespace indicators { - -namespace details { - -template struct if_else; - -template <> struct if_else { using type = std::true_type; }; - -template <> struct if_else { using type = std::false_type; }; - -template struct if_else_type; - -template struct if_else_type { - using type = True; -}; - -template struct if_else_type { - using type = False; -}; - -template struct conjuction; - -template <> struct conjuction<> : std::true_type {}; - -template -struct conjuction - : if_else_type>::type {}; - -template struct disjunction; - -template <> struct disjunction<> : std::false_type {}; - -template -struct disjunction - : if_else_type>::type {}; - -enum class ProgressBarOption { - bar_width = 0, - prefix_text, - postfix_text, - start, - end, - fill, - lead, - remainder, - max_postfix_text_len, - completed, - show_percentage, - show_elapsed_time, - show_remaining_time, - saved_start_time, - foreground_color, - spinner_show, - spinner_states, - font_styles, - hide_bar_when_complete, - min_progress, - max_progress, - progress_type, - stream -}; - -template struct Setting { - template ::value>::type> - explicit Setting(Args &&... args) : value(std::forward(args)...) {} - Setting(const Setting &) = default; - Setting(Setting &&) = default; - - static constexpr auto id = Id; - using type = T; - - T value{}; -}; - -template struct is_setting : std::false_type {}; - -template struct is_setting> : std::true_type {}; - -template -struct are_settings : if_else...>::value>::type {}; - -template <> struct are_settings<> : std::true_type {}; - -template struct is_setting_from_tuple; - -template struct is_setting_from_tuple> : std::true_type {}; - -template -struct is_setting_from_tuple> - : if_else...>::value>::type {}; - -template -struct are_settings_from_tuple - : if_else...>::value>::type {}; - -template struct always_true { static constexpr auto value = true; }; - -template Default &&get_impl(Default &&def) { - return std::forward(def); -} - -template -auto get_impl(Default && /*def*/, T &&first, Args &&... /*tail*/) -> - typename std::enable_if<(std::decay::type::id == Id), - decltype(std::forward(first))>::type { - return std::forward(first); -} - -template -auto get_impl(Default &&def, T && /*first*/, Args &&... tail) -> - typename std::enable_if<(std::decay::type::id != Id), - decltype(get_impl(std::forward(def), - std::forward(tail)...))>::type { - return get_impl(std::forward(def), std::forward(tail)...); -} - -template ::value, void>::type> -auto get(Default &&def, Args &&... args) - -> decltype(details::get_impl(std::forward(def), std::forward(args)...)) { - return details::get_impl(std::forward(def), std::forward(args)...); -} - -template using StringSetting = Setting; - -template using IntegerSetting = Setting; - -template using BooleanSetting = Setting; - -template struct option_idx; - -template -struct option_idx, counter> - : if_else_type<(Id == T::id), std::integral_constant, - option_idx, counter + 1>>::type {}; - -template struct option_idx, counter> { - static_assert(always_true<(ProgressBarOption)Id>::value, "No such option was found"); -}; - -template -auto get_value(Settings &&settings) - -> decltype((std::get::type>::value>( - std::declval()))) { - return std::get::type>::value>( - std::forward(settings)); -} - -} // namespace details - -namespace option { -using BarWidth = details::IntegerSetting; -using PrefixText = details::StringSetting; -using PostfixText = details::StringSetting; -using Start = details::StringSetting; -using End = details::StringSetting; -using Fill = details::StringSetting; -using Lead = details::StringSetting; -using Remainder = details::StringSetting; -using MaxPostfixTextLen = details::IntegerSetting; -using Completed = details::BooleanSetting; -using ShowPercentage = details::BooleanSetting; -using ShowElapsedTime = details::BooleanSetting; -using ShowRemainingTime = details::BooleanSetting; -using SavedStartTime = details::BooleanSetting; -using ForegroundColor = details::Setting; -using ShowSpinner = details::BooleanSetting; -using SpinnerStates = - details::Setting, details::ProgressBarOption::spinner_states>; -using HideBarWhenComplete = - details::BooleanSetting; -using FontStyles = - details::Setting, details::ProgressBarOption::font_styles>; -using MinProgress = details::IntegerSetting; -using MaxProgress = details::IntegerSetting; -using ProgressType = details::Setting; -using Stream = details::Setting; -} // namespace option -} // namespace indicators - -#endif -// #include //! -//! termcolor -//! ~~~~~~~~~ -//! -//! termcolor is a header-only c++ library for printing colored messages -//! to the terminal. Written just for fun with a help of the Force. -//! -//! :copyright: (c) 2013 by Ihor Kalnytskyi -//! :license: BSD, see LICENSE for details -//! - -#ifndef TERMCOLOR_HPP_ -#define TERMCOLOR_HPP_ - -#include -#include - -// Detect target's platform and set some macros in order to wrap platform -// specific code this library depends on. -#if defined(_WIN32) || defined(_WIN64) -# define TERMCOLOR_TARGET_WINDOWS -#elif defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)) -# define TERMCOLOR_TARGET_POSIX -#endif - -// If implementation has not been explicitly set, try to choose one based on -// target platform. -#if !defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) && !defined(TERMCOLOR_USE_WINDOWS_API) && !defined(TERMCOLOR_USE_NOOP) -# if defined(TERMCOLOR_TARGET_POSIX) -# define TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES -# define TERMCOLOR_AUTODETECTED_IMPLEMENTATION -# elif defined(TERMCOLOR_TARGET_WINDOWS) -# define TERMCOLOR_USE_WINDOWS_API -# define TERMCOLOR_AUTODETECTED_IMPLEMENTATION -# endif -#endif - -// These headers provide isatty()/fileno() functions, which are used for -// testing whether a standard stream refers to the terminal. -#if defined(TERMCOLOR_TARGET_POSIX) -# include -#elif defined(TERMCOLOR_TARGET_WINDOWS) -#if defined(_MSC_VER) -#if !defined(NOMINMAX) -#define NOMINMAX -#endif -#endif -# include -# include -#endif - - -namespace termcolor -{ - // Forward declaration of the `_internal` namespace. - // All comments are below. - namespace _internal - { - inline int colorize_index(); - inline FILE* get_standard_stream(const std::ostream& stream); - inline bool is_colorized(std::ostream& stream); - inline bool is_atty(const std::ostream& stream); - - #if defined(TERMCOLOR_TARGET_WINDOWS) - inline void win_change_attributes(std::ostream& stream, int foreground, int background=-1); - #endif - } - - inline - std::ostream& colorize(std::ostream& stream) - { - stream.iword(_internal::colorize_index()) = 1L; - return stream; - } - - inline - std::ostream& nocolorize(std::ostream& stream) - { - stream.iword(_internal::colorize_index()) = 0L; - return stream; - } - - inline - std::ostream& reset(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[00m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, -1); - #endif - } - return stream; - } - - inline - std::ostream& bold(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[1m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& dark(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[2m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& italic(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[3m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& underline(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[4m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, COMMON_LVB_UNDERSCORE); - #endif - } - return stream; - } - - inline - std::ostream& blink(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[5m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& reverse(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[7m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& concealed(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[8m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& crossed(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[9m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[12]; - std::snprintf(command, sizeof(command), "\033[38;5;%dm", code); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& on_color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[12]; - std::snprintf(command, sizeof(command), "\033[48;5;%dm", code); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[20]; - std::snprintf(command, sizeof(command), "\033[38;2;%d;%d;%dm", r, g, b); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - template inline - std::ostream& on_color(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - char command[20]; - std::snprintf(command, sizeof(command), "\033[48;2;%d;%d;%dm", r, g, b); - stream << command; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - #endif - } - return stream; - } - - inline - std::ostream& grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[30m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - 0 // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[31m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[32m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[33m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[34m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[35m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[36m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[37m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED - ); - #endif - } - return stream; - } - - - inline - std::ostream& bright_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[90m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - 0 | FOREGROUND_INTENSITY // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[91m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[92m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[93m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[94m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[95m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[96m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& bright_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[97m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, - FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY - ); - #endif - } - return stream; - } - - - inline - std::ostream& on_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[40m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - 0 // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& on_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[41m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[42m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN - ); - #endif - } - return stream; - } - - inline - std::ostream& on_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[43m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[44m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& on_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[45m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_RED - ); - #endif - } - return stream; - } - - inline - std::ostream& on_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[46m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE - ); - #endif - } - return stream; - } - - inline - std::ostream& on_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[47m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_RED - ); - #endif - } - - return stream; - } - - - inline - std::ostream& on_bright_grey(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[100m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - 0 | BACKGROUND_INTENSITY // grey (black) - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_red(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[101m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_green(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[102m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_yellow(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[103m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_blue(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[104m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_magenta(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[105m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_BLUE | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_cyan(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[106m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_INTENSITY - ); - #endif - } - return stream; - } - - inline - std::ostream& on_bright_white(std::ostream& stream) - { - if (_internal::is_colorized(stream)) - { - #if defined(TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES) - stream << "\033[107m"; - #elif defined(TERMCOLOR_USE_WINDOWS_API) - _internal::win_change_attributes(stream, -1, - BACKGROUND_GREEN | BACKGROUND_BLUE | BACKGROUND_RED | BACKGROUND_INTENSITY - ); - #endif - } - - return stream; - } - - - - //! Since C++ hasn't a way to hide something in the header from - //! the outer access, I have to introduce this namespace which - //! is used for internal purpose and should't be access from - //! the user code. - namespace _internal - { - // An index to be used to access a private storage of I/O streams. See - // colorize / nocolorize I/O manipulators for details. Due to the fact - // that static variables ain't shared between translation units, inline - // function with local static variable is used to do the trick and share - // the variable value between translation units. - inline int colorize_index() - { - static int colorize_index = std::ios_base::xalloc(); - return colorize_index; - } - - //! Since C++ hasn't a true way to extract stream handler - //! from the a given `std::ostream` object, I have to write - //! this kind of hack. - inline - FILE* get_standard_stream(const std::ostream& stream) - { - if (&stream == &std::cout) - return stdout; - else if ((&stream == &std::cerr) || (&stream == &std::clog)) - return stderr; - - return nullptr; - } - - // Say whether a given stream should be colorized or not. It's always - // true for ATTY streams and may be true for streams marked with - // colorize flag. - inline - bool is_colorized(std::ostream& stream) - { - return is_atty(stream) || static_cast(stream.iword(colorize_index())); - } - - //! Test whether a given `std::ostream` object refers to - //! a terminal. - inline - bool is_atty(const std::ostream& stream) - { - FILE* std_stream = get_standard_stream(stream); - - // Unfortunately, fileno() ends with segmentation fault - // if invalid file descriptor is passed. So we need to - // handle this case gracefully and assume it's not a tty - // if standard stream is not detected, and 0 is returned. - if (!std_stream) - return false; - - #if defined(TERMCOLOR_TARGET_POSIX) - return ::isatty(fileno(std_stream)); - #elif defined(TERMCOLOR_TARGET_WINDOWS) - return ::_isatty(_fileno(std_stream)); - #else - return false; - #endif - } - - #if defined(TERMCOLOR_TARGET_WINDOWS) - //! Change Windows Terminal colors attribute. If some - //! parameter is `-1` then attribute won't changed. - inline void win_change_attributes(std::ostream& stream, int foreground, int background) - { - // yeah, i know.. it's ugly, it's windows. - static WORD defaultAttributes = 0; - - // Windows doesn't have ANSI escape sequences and so we use special - // API to change Terminal output color. That means we can't - // manipulate colors by means of "std::stringstream" and hence - // should do nothing in this case. - if (!_internal::is_atty(stream)) - return; - - // get terminal handle - HANDLE hTerminal = INVALID_HANDLE_VALUE; - if (&stream == &std::cout) - hTerminal = GetStdHandle(STD_OUTPUT_HANDLE); - else if (&stream == &std::cerr) - hTerminal = GetStdHandle(STD_ERROR_HANDLE); - - // save default terminal attributes if it unsaved - if (!defaultAttributes) - { - CONSOLE_SCREEN_BUFFER_INFO info; - if (!GetConsoleScreenBufferInfo(hTerminal, &info)) - return; - defaultAttributes = info.wAttributes; - } - - // restore all default settings - if (foreground == -1 && background == -1) - { - SetConsoleTextAttribute(hTerminal, defaultAttributes); - return; - } - - // get current settings - CONSOLE_SCREEN_BUFFER_INFO info; - if (!GetConsoleScreenBufferInfo(hTerminal, &info)) - return; - - if (foreground != -1) - { - info.wAttributes &= ~(info.wAttributes & 0x0F); - info.wAttributes |= static_cast(foreground); - } - - if (background != -1) - { - info.wAttributes &= ~(info.wAttributes & 0xF0); - info.wAttributes |= static_cast(background); - } - - SetConsoleTextAttribute(hTerminal, info.wAttributes); - } - #endif // TERMCOLOR_TARGET_WINDOWS - - } // namespace _internal - -} // namespace termcolor - - -#undef TERMCOLOR_TARGET_POSIX -#undef TERMCOLOR_TARGET_WINDOWS - -#if defined(TERMCOLOR_AUTODETECTED_IMPLEMENTATION) -# undef TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES -# undef TERMCOLOR_USE_WINDOWS_API -#endif - -#endif // TERMCOLOR_HPP_ - - -#include -#include -#include -#include -#include -#include - -#include -#include - -namespace indicators { -namespace details { - -inline void set_stream_color(std::ostream &os, Color color) { - switch (color) { - case Color::grey: - os << termcolor::grey; - break; - case Color::red: - os << termcolor::red; - break; - case Color::green: - os << termcolor::green; - break; - case Color::yellow: - os << termcolor::yellow; - break; - case Color::blue: - os << termcolor::blue; - break; - case Color::magenta: - os << termcolor::magenta; - break; - case Color::cyan: - os << termcolor::cyan; - break; - case Color::white: - os << termcolor::white; - break; - default: - assert(false); - } -} - -inline void set_font_style(std::ostream &os, FontStyle style) { - switch (style) { - case FontStyle::bold: - os << termcolor::bold; - break; - case FontStyle::dark: - os << termcolor::dark; - break; - case FontStyle::italic: - os << termcolor::italic; - break; - case FontStyle::underline: - os << termcolor::underline; - break; - case FontStyle::blink: - os << termcolor::blink; - break; - case FontStyle::reverse: - os << termcolor::reverse; - break; - case FontStyle::concealed: - os << termcolor::concealed; - break; - case FontStyle::crossed: - os << termcolor::crossed; - break; - default: - break; - } -} - -inline std::ostream &write_duration(std::ostream &os, std::chrono::nanoseconds ns) { - using namespace std; - using namespace std::chrono; - using days = duration>; - char fill = os.fill(); - os.fill('0'); - auto d = duration_cast(ns); - ns -= d; - auto h = duration_cast(ns); - ns -= h; - auto m = duration_cast(ns); - ns -= m; - auto s = duration_cast(ns); - if (d.count() > 0) - os << setw(2) << d.count() << "d:"; - if (h.count() > 0) - os << setw(2) << h.count() << "h:"; - os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's'; - os.fill(fill); - return os; -} - -class BlockProgressScaleWriter { -public: - BlockProgressScaleWriter(std::ostream &os, size_t bar_width) : os(os), bar_width(bar_width) {} - - std::ostream &write(float progress) { - std::string fill_text{"█"}; - std::vector lead_characters{" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"}; - auto value = (std::min)(1.0f, (std::max)(0.0f, progress / 100.0f)); - auto whole_width = std::floor(value * bar_width); - auto remainder_width = fmod((value * bar_width), 1.0f); - auto part_width = std::floor(remainder_width * lead_characters.size()); - std::string lead_text = lead_characters[size_t(part_width)]; - if ((bar_width - whole_width - 1) < 0) - lead_text = ""; - for (size_t i = 0; i < whole_width; ++i) - os << fill_text; - os << lead_text; - for (size_t i = 0; i < (bar_width - whole_width - 1); ++i) - os << " "; - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; -}; - -class ProgressScaleWriter { -public: - ProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill, - const std::string &lead, const std::string &remainder) - : os(os), bar_width(bar_width), fill(fill), lead(lead), remainder(remainder) {} - - std::ostream &write(float progress) { - auto pos = static_cast(progress * bar_width / 100.0); - for (size_t i = 0, current_display_width = 0; i < bar_width;) { - std::string next; - - if (i < pos) { - next = fill; - current_display_width = unicode::display_width(fill); - } else if (i == pos) { - next = lead; - current_display_width = unicode::display_width(lead); - } else { - next = remainder; - current_display_width = unicode::display_width(remainder); - } - - i += current_display_width; - - if (i > bar_width) { - // `next` is larger than the allowed bar width - // fill with empty space instead - os << std::string((bar_width - (i - current_display_width)), ' '); - break; - } - - os << next; - } - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; - std::string fill; - std::string lead; - std::string remainder; -}; - -class IndeterminateProgressScaleWriter { -public: - IndeterminateProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill, - const std::string &lead) - : os(os), bar_width(bar_width), fill(fill), lead(lead) {} - - std::ostream &write(size_t progress) { - for (size_t i = 0; i < bar_width;) { - std::string next; - size_t current_display_width = 0; - - if (i < progress) { - next = fill; - current_display_width = unicode::display_width(fill); - } else if (i == progress) { - next = lead; - current_display_width = unicode::display_width(lead); - } else { - next = fill; - current_display_width = unicode::display_width(fill); - } - - i += current_display_width; - - if (i > bar_width) { - // `next` is larger than the allowed bar width - // fill with empty space instead - os << std::string((bar_width - (i - current_display_width)), ' '); - break; - } - - os << next; - } - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; - std::string fill; - std::string lead; -}; - -} // namespace details -} // namespace indicators - -#endif - - -#ifndef INDICATORS_PROGRESS_BAR -#define INDICATORS_PROGRESS_BAR - -// #include -#ifndef INDICATORS_STREAM_HELPER -#define INDICATORS_STREAM_HELPER - -// #include -// #include -// #include - -#include -#include -#include -#include -#include -#include - -#include -#include - -namespace indicators { -namespace details { - -inline void set_stream_color(std::ostream &os, Color color) { - switch (color) { - case Color::grey: - os << termcolor::grey; - break; - case Color::red: - os << termcolor::red; - break; - case Color::green: - os << termcolor::green; - break; - case Color::yellow: - os << termcolor::yellow; - break; - case Color::blue: - os << termcolor::blue; - break; - case Color::magenta: - os << termcolor::magenta; - break; - case Color::cyan: - os << termcolor::cyan; - break; - case Color::white: - os << termcolor::white; - break; - default: - assert(false); - } -} - -inline void set_font_style(std::ostream &os, FontStyle style) { - switch (style) { - case FontStyle::bold: - os << termcolor::bold; - break; - case FontStyle::dark: - os << termcolor::dark; - break; - case FontStyle::italic: - os << termcolor::italic; - break; - case FontStyle::underline: - os << termcolor::underline; - break; - case FontStyle::blink: - os << termcolor::blink; - break; - case FontStyle::reverse: - os << termcolor::reverse; - break; - case FontStyle::concealed: - os << termcolor::concealed; - break; - case FontStyle::crossed: - os << termcolor::crossed; - break; - default: - break; - } -} - -inline std::ostream &write_duration(std::ostream &os, std::chrono::nanoseconds ns) { - using namespace std; - using namespace std::chrono; - using days = duration>; - char fill = os.fill(); - os.fill('0'); - auto d = duration_cast(ns); - ns -= d; - auto h = duration_cast(ns); - ns -= h; - auto m = duration_cast(ns); - ns -= m; - auto s = duration_cast(ns); - if (d.count() > 0) - os << setw(2) << d.count() << "d:"; - if (h.count() > 0) - os << setw(2) << h.count() << "h:"; - os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's'; - os.fill(fill); - return os; -} - -class BlockProgressScaleWriter { -public: - BlockProgressScaleWriter(std::ostream &os, size_t bar_width) : os(os), bar_width(bar_width) {} - - std::ostream &write(float progress) { - std::string fill_text{"█"}; - std::vector lead_characters{" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"}; - auto value = (std::min)(1.0f, (std::max)(0.0f, progress / 100.0f)); - auto whole_width = std::floor(value * bar_width); - auto remainder_width = fmod((value * bar_width), 1.0f); - auto part_width = std::floor(remainder_width * lead_characters.size()); - std::string lead_text = lead_characters[size_t(part_width)]; - if ((bar_width - whole_width - 1) < 0) - lead_text = ""; - for (size_t i = 0; i < whole_width; ++i) - os << fill_text; - os << lead_text; - for (size_t i = 0; i < (bar_width - whole_width - 1); ++i) - os << " "; - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; -}; - -class ProgressScaleWriter { -public: - ProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill, - const std::string &lead, const std::string &remainder) - : os(os), bar_width(bar_width), fill(fill), lead(lead), remainder(remainder) {} - - std::ostream &write(float progress) { - auto pos = static_cast(progress * bar_width / 100.0); - for (size_t i = 0, current_display_width = 0; i < bar_width;) { - std::string next; - - if (i < pos) { - next = fill; - current_display_width = unicode::display_width(fill); - } else if (i == pos) { - next = lead; - current_display_width = unicode::display_width(lead); - } else { - next = remainder; - current_display_width = unicode::display_width(remainder); - } - - i += current_display_width; - - if (i > bar_width) { - // `next` is larger than the allowed bar width - // fill with empty space instead - os << std::string((bar_width - (i - current_display_width)), ' '); - break; - } - - os << next; - } - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; - std::string fill; - std::string lead; - std::string remainder; -}; - -class IndeterminateProgressScaleWriter { -public: - IndeterminateProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill, - const std::string &lead) - : os(os), bar_width(bar_width), fill(fill), lead(lead) {} - - std::ostream &write(size_t progress) { - for (size_t i = 0; i < bar_width;) { - std::string next; - size_t current_display_width = 0; - - if (i < progress) { - next = fill; - current_display_width = unicode::display_width(fill); - } else if (i == progress) { - next = lead; - current_display_width = unicode::display_width(lead); - } else { - next = fill; - current_display_width = unicode::display_width(fill); - } - - i += current_display_width; - - if (i > bar_width) { - // `next` is larger than the allowed bar width - // fill with empty space instead - os << std::string((bar_width - (i - current_display_width)), ' '); - break; - } - - os << next; - } - return os; - } - -private: - std::ostream &os; - size_t bar_width = 0; - std::string fill; - std::string lead; -}; - -} // namespace details -} // namespace indicators - -#endif - -#include -#include -#include -#include -// #include -// #include -// #include -#ifndef INDICATORS_TERMINAL_SIZE -#define INDICATORS_TERMINAL_SIZE -#include - - -#if defined(_WIN32) -#include - -namespace indicators { - -static inline std::pair terminal_size() { - CONSOLE_SCREEN_BUFFER_INFO csbi; - int cols, rows; - GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi); - cols = csbi.srWindow.Right - csbi.srWindow.Left + 1; - rows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1; - return {static_cast(rows), static_cast(cols)}; -} - -static inline size_t terminal_width() { return terminal_size().second; } - -} // namespace indicators - -#else - -#include //ioctl() and TIOCGWINSZ -#include // for STDOUT_FILENO - -namespace indicators { - -static inline std::pair terminal_size() { - struct winsize size{}; - ioctl(STDOUT_FILENO, TIOCGWINSZ, &size); - return {static_cast(size.ws_row), static_cast(size.ws_col)}; -} - -static inline size_t terminal_width() { return terminal_size().second; } - -} // namespace indicators - -#endif - -#endif -#include -#include -#include -#include -#include -#include -#include -#include -#include - -namespace indicators { - -class ProgressBar { - using Settings = - std::tuple; - -public: - template ::type...>::value, - void *>::type = nullptr> - explicit ProgressBar(Args &&... args) - : settings_( - details::get( - option::BarWidth{100}, std::forward(args)...), - details::get( - option::PrefixText{}, std::forward(args)...), - details::get( - option::PostfixText{}, std::forward(args)...), - details::get( - option::Start{"["}, std::forward(args)...), - details::get( - option::End{"]"}, std::forward(args)...), - details::get( - option::Fill{"="}, std::forward(args)...), - details::get( - option::Lead{">"}, std::forward(args)...), - details::get( - option::Remainder{" "}, std::forward(args)...), - details::get( - option::MaxPostfixTextLen{0}, std::forward(args)...), - details::get( - option::Completed{false}, std::forward(args)...), - details::get( - option::ShowPercentage{false}, std::forward(args)...), - details::get( - option::ShowElapsedTime{false}, std::forward(args)...), - details::get( - option::ShowRemainingTime{false}, std::forward(args)...), - details::get( - option::SavedStartTime{false}, std::forward(args)...), - details::get( - option::ForegroundColor{Color::unspecified}, - std::forward(args)...), - details::get( - option::FontStyles{std::vector{}}, - std::forward(args)...), - details::get( - option::MinProgress{0}, std::forward(args)...), - details::get( - option::MaxProgress{100}, std::forward(args)...), - details::get( - option::ProgressType{ProgressType::incremental}, - std::forward(args)...), - details::get( - option::Stream{std::cout}, std::forward(args)...)) { - - // if progress is incremental, start from min_progress - // else start from max_progress - const auto type = get_value(); - if (type == ProgressType::incremental) - progress_ = get_value(); - else - progress_ = get_value(); - } - - template - void set_option(details::Setting &&setting) { - static_assert( - !std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - } - - template - void set_option(const details::Setting &setting) { - static_assert( - !std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = setting.value; - } - - void - set_option(const details::Setting< - std::string, details::ProgressBarOption::postfix_text> &setting) { - std::lock_guard lock(mutex_); - get_value() = setting.value; - if (setting.value.length() > - get_value()) { - get_value() = - setting.value.length(); - } - } - - void set_option( - details::Setting - &&setting) { - std::lock_guard lock(mutex_); - get_value() = - std::move(setting).value; - auto &new_value = get_value(); - if (new_value.length() > - get_value()) { - get_value() = - new_value.length(); - } - } - - void set_progress(size_t new_progress) { - { - std::lock_guard lock(mutex_); - progress_ = new_progress; - } - - save_start_time(); - print_progress(); - } - - void tick() { - { - std::lock_guard lock{mutex_}; - const auto type = get_value(); - if (type == ProgressType::incremental) - progress_ += 1; - else - progress_ -= 1; - } - save_start_time(); - print_progress(); - } - - size_t current() { - std::lock_guard lock{mutex_}; - return (std::min)( - progress_, - size_t(get_value())); - } - - bool is_completed() const { - return get_value(); - } - - void mark_as_completed() { - get_value() = true; - print_progress(); - } - -private: - template - auto get_value() - -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - template - auto get_value() const -> decltype( - (details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - size_t progress_{0}; - Settings settings_; - std::chrono::nanoseconds elapsed_; - std::chrono::time_point start_time_point_; - std::mutex mutex_; - - template friend class MultiProgress; - template friend class DynamicProgress; - std::atomic multi_progress_mode_{false}; - - void save_start_time() { - auto &show_elapsed_time = - get_value(); - auto &saved_start_time = - get_value(); - auto &show_remaining_time = - get_value(); - if ((show_elapsed_time || show_remaining_time) && !saved_start_time) { - start_time_point_ = std::chrono::high_resolution_clock::now(); - saved_start_time = true; - } - } - - std::pair get_prefix_text() { - std::stringstream os; - os << get_value(); - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - - std::pair get_postfix_text() { - std::stringstream os; - const auto max_progress = - get_value(); - - if (get_value()) { - os << " " - << (std::min)(static_cast(static_cast(progress_) / - max_progress * 100), - size_t(100)) - << "%"; - } - - auto &saved_start_time = - get_value(); - - if (get_value()) { - os << " ["; - if (saved_start_time) - details::write_duration(os, elapsed_); - else - os << "00:00s"; - } - - if (get_value()) { - if (get_value()) - os << "<"; - else - os << " ["; - - if (saved_start_time) { - auto eta = std::chrono::nanoseconds( - progress_ > 0 - ? static_cast(std::ceil(float(elapsed_.count()) * - max_progress / progress_)) - : 0); - auto remaining = eta > elapsed_ ? (eta - elapsed_) : (elapsed_ - eta); - details::write_duration(os, remaining); - } else { - os << "00:00s"; - } - - os << "]"; - } else { - if (get_value()) - os << "]"; - } - - os << " " << get_value(); - - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - -public: - void print_progress(bool from_multi_progress = false) { - std::lock_guard lock{mutex_}; - - auto &os = get_value(); - - const auto type = get_value(); - const auto min_progress = - get_value(); - const auto max_progress = - get_value(); - if (multi_progress_mode_ && !from_multi_progress) { - if ((type == ProgressType::incremental && progress_ >= max_progress) || - (type == ProgressType::decremental && progress_ <= min_progress)) { - get_value() = true; - } - return; - } - auto now = std::chrono::high_resolution_clock::now(); - if (!get_value()) - elapsed_ = std::chrono::duration_cast( - now - start_time_point_); - - if (get_value() != - Color::unspecified) - details::set_stream_color( - os, get_value()); - - for (auto &style : get_value()) - details::set_font_style(os, style); - - const auto prefix_pair = get_prefix_text(); - const auto prefix_text = prefix_pair.first; - const auto prefix_length = prefix_pair.second; - os << "\r" << prefix_text; - - os << get_value(); - - details::ProgressScaleWriter writer{ - os, get_value(), - get_value(), - get_value(), - get_value()}; - writer.write(double(progress_) / double(max_progress) * 100.0f); - - os << get_value(); - - const auto postfix_pair = get_postfix_text(); - const auto postfix_text = postfix_pair.first; - const auto postfix_length = postfix_pair.second; - os << postfix_text; - - // Get length of prefix text and postfix text - const auto start_length = get_value().size(); - const auto bar_width = get_value(); - const auto end_length = get_value().size(); - const auto terminal_width = terminal_size().second; - // prefix + bar_width + postfix should be <= terminal_width - const int remaining = terminal_width - (prefix_length + start_length + bar_width + end_length + postfix_length); - if (remaining > 0) { - os << std::string(remaining, ' ') << "\r"; - } else if (remaining < 0) { - // Do nothing. Maybe in the future truncate postfix with ... - } - os.flush(); - - if ((type == ProgressType::incremental && progress_ >= max_progress) || - (type == ProgressType::decremental && progress_ <= min_progress)) { - get_value() = true; - } - if (get_value() && - !from_multi_progress) // Don't std::endl if calling from MultiProgress - os << termcolor::reset << std::endl; - } -}; - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_BLOCK_PROGRESS_BAR -#define INDICATORS_BLOCK_PROGRESS_BAR - -// #include -// #include - -#include -#include -#include -// #include -// #include -#include -#include -#include -#include -#include -#include -#include -#include - -namespace indicators { - -class BlockProgressBar { - using Settings = std::tuple; - -public: - template ::type...>::value, - void *>::type = nullptr> - explicit BlockProgressBar(Args &&... args) - : settings_(details::get( - option::ForegroundColor{Color::unspecified}, std::forward(args)...), - details::get(option::BarWidth{100}, - std::forward(args)...), - details::get(option::Start{"["}, - std::forward(args)...), - details::get(option::End{"]"}, - std::forward(args)...), - details::get( - option::PrefixText{""}, std::forward(args)...), - details::get( - option::PostfixText{""}, std::forward(args)...), - details::get( - option::ShowPercentage{true}, std::forward(args)...), - details::get( - option::ShowElapsedTime{false}, std::forward(args)...), - details::get( - option::ShowRemainingTime{false}, std::forward(args)...), - details::get(option::Completed{false}, - std::forward(args)...), - details::get( - option::SavedStartTime{false}, std::forward(args)...), - details::get( - option::MaxPostfixTextLen{0}, std::forward(args)...), - details::get( - option::FontStyles{std::vector{}}, std::forward(args)...), - details::get( - option::MaxProgress{100}, std::forward(args)...), - details::get(option::Stream{std::cout}, - std::forward(args)...)) {} - - template - void set_option(details::Setting &&setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - } - - template - void set_option(const details::Setting &setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = setting.value; - } - - void set_option( - const details::Setting &setting) { - std::lock_guard lock(mutex_); - get_value() = setting.value; - if (setting.value.length() > get_value()) { - get_value() = setting.value.length(); - } - } - - void - set_option(details::Setting &&setting) { - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - auto &new_value = get_value(); - if (new_value.length() > get_value()) { - get_value() = new_value.length(); - } - } - - void set_progress(float value) { - { - std::lock_guard lock{mutex_}; - progress_ = value; - } - save_start_time(); - print_progress(); - } - - void tick() { - { - std::lock_guard lock{mutex_}; - progress_ += 1; - } - save_start_time(); - print_progress(); - } - - size_t current() { - std::lock_guard lock{mutex_}; - return (std::min)(static_cast(progress_), - size_t(get_value())); - } - - bool is_completed() const { return get_value(); } - - void mark_as_completed() { - get_value() = true; - print_progress(); - } - -private: - template - auto get_value() -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - template - auto get_value() const - -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - Settings settings_; - float progress_{0.0}; - std::chrono::time_point start_time_point_; - std::mutex mutex_; - - template friend class MultiProgress; - template friend class DynamicProgress; - std::atomic multi_progress_mode_{false}; - - void save_start_time() { - auto &show_elapsed_time = get_value(); - auto &saved_start_time = get_value(); - auto &show_remaining_time = get_value(); - if ((show_elapsed_time || show_remaining_time) && !saved_start_time) { - start_time_point_ = std::chrono::high_resolution_clock::now(); - saved_start_time = true; - } - } - - std::pair get_prefix_text() { - std::stringstream os; - os << get_value(); - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - - std::pair get_postfix_text() { - std::stringstream os; - const auto max_progress = get_value(); - auto now = std::chrono::high_resolution_clock::now(); - auto elapsed = std::chrono::duration_cast(now - start_time_point_); - - if (get_value()) { - os << " " << (std::min)(static_cast(progress_ / max_progress * 100.0), size_t(100)) - << "%"; - } - - auto &saved_start_time = get_value(); - - if (get_value()) { - os << " ["; - if (saved_start_time) - details::write_duration(os, elapsed); - else - os << "00:00s"; - } - - if (get_value()) { - if (get_value()) - os << "<"; - else - os << " ["; - - if (saved_start_time) { - auto eta = std::chrono::nanoseconds( - progress_ > 0 - ? static_cast(std::ceil(float(elapsed.count()) * - max_progress / progress_)) - : 0); - auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta); - details::write_duration(os, remaining); - } else { - os << "00:00s"; - } - - os << "]"; - } else { - if (get_value()) - os << "]"; - } - - os << " " << get_value(); - - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - -public: - void print_progress(bool from_multi_progress = false) { - std::lock_guard lock{mutex_}; - - auto &os = get_value(); - - const auto max_progress = get_value(); - if (multi_progress_mode_ && !from_multi_progress) { - if (progress_ > max_progress) { - get_value() = true; - } - return; - } - - if (get_value() != Color::unspecified) - details::set_stream_color(os, get_value()); - - for (auto &style : get_value()) - details::set_font_style(os, style); - - const auto prefix_pair = get_prefix_text(); - const auto prefix_text = prefix_pair.first; - const auto prefix_length = prefix_pair.second; - os << "\r" << prefix_text; - - os << get_value(); - - details::BlockProgressScaleWriter writer{os, - get_value()}; - writer.write(progress_ / max_progress * 100); - - os << get_value(); - - const auto postfix_pair = get_postfix_text(); - const auto postfix_text = postfix_pair.first; - const auto postfix_length = postfix_pair.second; - os << postfix_text; - - // Get length of prefix text and postfix text - const auto start_length = get_value().size(); - const auto bar_width = get_value(); - const auto end_length = get_value().size(); - const auto terminal_width = terminal_size().second; - // prefix + bar_width + postfix should be <= terminal_width - const int remaining = terminal_width - (prefix_length + start_length + bar_width + end_length + postfix_length); - if (remaining > 0) { - os << std::string(remaining, ' ') << "\r"; - } else if (remaining < 0) { - // Do nothing. Maybe in the future truncate postfix with ... - } - os.flush(); - - if (progress_ > max_progress) { - get_value() = true; - } - if (get_value() && - !from_multi_progress) // Don't std::endl if calling from MultiProgress - os << termcolor::reset << std::endl; - } -}; - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_INDETERMINATE_PROGRESS_BAR -#define INDICATORS_INDETERMINATE_PROGRESS_BAR - -// #include - -#include -#include -#include -#include -// #include -// #include -// #include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -namespace indicators { - -class IndeterminateProgressBar { - using Settings = - std::tuple; - - enum class Direction { forward, backward }; - - Direction direction_{Direction::forward}; - -public: - template ::type...>::value, - void *>::type = nullptr> - explicit IndeterminateProgressBar(Args &&... args) - : settings_(details::get(option::BarWidth{100}, - std::forward(args)...), - details::get( - option::PrefixText{}, std::forward(args)...), - details::get( - option::PostfixText{}, std::forward(args)...), - details::get(option::Start{"["}, - std::forward(args)...), - details::get(option::End{"]"}, - std::forward(args)...), - details::get(option::Fill{"."}, - std::forward(args)...), - details::get(option::Lead{"<==>"}, - std::forward(args)...), - details::get( - option::MaxPostfixTextLen{0}, std::forward(args)...), - details::get(option::Completed{false}, - std::forward(args)...), - details::get( - option::ForegroundColor{Color::unspecified}, std::forward(args)...), - details::get( - option::FontStyles{std::vector{}}, std::forward(args)...), - details::get(option::Stream{std::cout}, - std::forward(args)...)) { - // starts with [<==>...........] - // progress_ = 0 - - // ends with [...........<==>] - // ^^^^^^^^^^^^^^^^^ bar_width - // ^^^^^^^^^^^^ (bar_width - len(lead)) - // progress_ = bar_width - len(lead) - progress_ = 0; - max_progress_ = get_value() - - get_value().size() + - get_value().size() + - get_value().size(); - } - - template - void set_option(details::Setting &&setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - } - - template - void set_option(const details::Setting &setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = setting.value; - } - - void set_option( - const details::Setting &setting) { - std::lock_guard lock(mutex_); - get_value() = setting.value; - if (setting.value.length() > get_value()) { - get_value() = setting.value.length(); - } - } - - void - set_option(details::Setting &&setting) { - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - auto &new_value = get_value(); - if (new_value.length() > get_value()) { - get_value() = new_value.length(); - } - } - - void tick() { - { - std::lock_guard lock{mutex_}; - if (get_value()) - return; - - progress_ += (direction_ == Direction::forward) ? 1 : -1; - if (direction_ == Direction::forward && progress_ == max_progress_) { - // time to go back - direction_ = Direction::backward; - } else if (direction_ == Direction::backward && progress_ == 0) { - direction_ = Direction::forward; - } - } - print_progress(); - } - - bool is_completed() { return get_value(); } - - void mark_as_completed() { - get_value() = true; - print_progress(); - } - -private: - template - auto get_value() -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - template - auto get_value() const - -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - size_t progress_{0}; - size_t max_progress_; - Settings settings_; - std::chrono::nanoseconds elapsed_; - std::mutex mutex_; - - template friend class MultiProgress; - template friend class DynamicProgress; - std::atomic multi_progress_mode_{false}; - - std::pair get_prefix_text() { - std::stringstream os; - os << get_value(); - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - - std::pair get_postfix_text() { - std::stringstream os; - os << " " << get_value(); - - const auto result = os.str(); - const auto result_size = unicode::display_width(result); - return {result, result_size}; - } - -public: - void print_progress(bool from_multi_progress = false) { - std::lock_guard lock{mutex_}; - - auto &os = get_value(); - - if (multi_progress_mode_ && !from_multi_progress) { - return; - } - if (get_value() != Color::unspecified) - details::set_stream_color(os, get_value()); - - for (auto &style : get_value()) - details::set_font_style(os, style); - - const auto prefix_pair = get_prefix_text(); - const auto prefix_text = prefix_pair.first; - const auto prefix_length = prefix_pair.second; - os << "\r" << prefix_text; - - os << get_value(); - - details::IndeterminateProgressScaleWriter writer{ - os, get_value(), - get_value(), - get_value()}; - writer.write(progress_); - - os << get_value(); - - const auto postfix_pair = get_postfix_text(); - const auto postfix_text = postfix_pair.first; - const auto postfix_length = postfix_pair.second; - os << postfix_text; - - // Get length of prefix text and postfix text - const auto start_length = get_value().size(); - const auto bar_width = get_value(); - const auto end_length = get_value().size(); - const auto terminal_width = terminal_size().second; - // prefix + bar_width + postfix should be <= terminal_width - const int remaining = terminal_width - (prefix_length + start_length + bar_width + end_length + postfix_length); - if (remaining > 0) { - os << std::string(remaining, ' ') << "\r"; - } else if (remaining < 0) { - // Do nothing. Maybe in the future truncate postfix with ... - } - os.flush(); - - if (get_value() && - !from_multi_progress) // Don't std::endl if calling from MultiProgress - os << termcolor::reset << std::endl; - } -}; - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_MULTI_PROGRESS -#define INDICATORS_MULTI_PROGRESS -#include -#include -#include -#include -#include - -// #include -// #include -#ifndef INDICATORS_CURSOR_MOVEMENT -#define INDICATORS_CURSOR_MOVEMENT - -#if defined(_MSC_VER) -#if !defined(NOMINMAX) -#define NOMINMAX -#endif -#include -#include -#else -#include -#endif - -namespace indicators { - -#ifdef _MSC_VER - -static inline void move(int x, int y) { - auto hStdout = GetStdHandle(STD_OUTPUT_HANDLE); - if (!hStdout) - return; - - CONSOLE_SCREEN_BUFFER_INFO csbiInfo; - GetConsoleScreenBufferInfo(hStdout, &csbiInfo); - - COORD cursor; - - cursor.X = csbiInfo.dwCursorPosition.X + x; - cursor.Y = csbiInfo.dwCursorPosition.Y + y; - SetConsoleCursorPosition(hStdout, cursor); -} - -static inline void move_up(int lines) { move(0, -lines); } -static inline void move_down(int lines) { move(0, -lines); } -static inline void move_right(int cols) { move(cols, 0); } -static inline void move_left(int cols) { move(-cols, 0); } - -#else - -static inline void move_up(int lines) { std::cout << "\033[" << lines << "A"; } -static inline void move_down(int lines) { std::cout << "\033[" << lines << "B"; } -static inline void move_right(int cols) { std::cout << "\033[" << cols << "C"; } -static inline void move_left(int cols) { std::cout << "\033[" << cols << "D"; } - -#endif - -} // namespace indicators - -#endif -// #include - -namespace indicators { - -template class MultiProgress { -public: - template ::type> - explicit MultiProgress(Indicators &... bars) { - bars_ = {bars...}; - for (auto &bar : bars_) { - bar.get().multi_progress_mode_ = true; - } - } - - template - typename std::enable_if<(index >= 0 && index < count), void>::type set_progress(size_t value) { - if (!bars_[index].get().is_completed()) - bars_[index].get().set_progress(value); - print_progress(); - } - - template - typename std::enable_if<(index >= 0 && index < count), void>::type set_progress(float value) { - if (!bars_[index].get().is_completed()) - bars_[index].get().set_progress(value); - print_progress(); - } - - template - typename std::enable_if<(index >= 0 && index < count), void>::type tick() { - if (!bars_[index].get().is_completed()) - bars_[index].get().tick(); - print_progress(); - } - - template - typename std::enable_if<(index >= 0 && index < count), bool>::type is_completed() const { - return bars_[index].get().is_completed(); - } - -private: - std::atomic started_{false}; - std::mutex mutex_; - std::vector> bars_; - - bool _all_completed() { - bool result{true}; - for (size_t i = 0; i < count; ++i) - result &= bars_[i].get().is_completed(); - return result; - } - -public: - void print_progress() { - std::lock_guard lock{mutex_}; - if (started_) - move_up(count); - for (auto &bar : bars_) { - bar.get().print_progress(true); - std::cout << "\n"; - } - std::cout << termcolor::reset; - if (!started_) - started_ = true; - } -}; - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_DYNAMIC_PROGRESS -#define INDICATORS_DYNAMIC_PROGRESS - -#include -#include -// #include -// #include -// #include -#include -#include -#include - -namespace indicators { - -template class DynamicProgress { - using Settings = std::tuple; - -public: - template explicit DynamicProgress(Indicators &... bars) { - bars_ = {bars...}; - for (auto &bar : bars_) { - bar.get().multi_progress_mode_ = true; - ++total_count_; - ++incomplete_count_; - } - } - - Indicator &operator[](size_t index) { - print_progress(); - std::lock_guard lock{mutex_}; - return bars_[index].get(); - } - - size_t push_back(Indicator &bar) { - std::lock_guard lock{mutex_}; - bar.multi_progress_mode_ = true; - bars_.push_back(bar); - return bars_.size() - 1; - } - - template - void set_option(details::Setting &&setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - } - - template - void set_option(const details::Setting &setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = setting.value; - } - -private: - Settings settings_; - std::atomic started_{false}; - std::mutex mutex_; - std::vector> bars_; - std::atomic total_count_{0}; - std::atomic incomplete_count_{0}; - - template - auto get_value() -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - template - auto get_value() const - -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - -public: - void print_progress() { - std::lock_guard lock{mutex_}; - auto &hide_bar_when_complete = get_value(); - if (hide_bar_when_complete) { - // Hide completed bars - if (started_) { - for (size_t i = 0; i < incomplete_count_; ++i) - std::cout << "\033[A\r\033[K" << std::flush; - } - incomplete_count_ = 0; - for (auto &bar : bars_) { - if (!bar.get().is_completed()) { - bar.get().print_progress(true); - std::cout << "\n"; - ++incomplete_count_; - } - } - if (!started_) - started_ = true; - } else { - // Don't hide any bars - if (started_) { - for (size_t i = 0; i < total_count_; ++i) - std::cout << "\x1b[A"; - } - for (auto &bar : bars_) { - bar.get().print_progress(true); - std::cout << "\n"; - } - if (!started_) - started_ = true; - } - total_count_ = bars_.size(); - std::cout << termcolor::reset; - } -}; - -} // namespace indicators - -#endif - - -#ifndef INDICATORS_PROGRESS_SPINNER -#define INDICATORS_PROGRESS_SPINNER - -// #include - -#include -#include -#include -#include -// #include -// #include -#include -#include -#include -#include -#include -#include -#include - -namespace indicators { - -class ProgressSpinner { - using Settings = - std::tuple; - -public: - template ::type...>::value, - void *>::type = nullptr> - explicit ProgressSpinner(Args &&... args) - : settings_( - details::get( - option::ForegroundColor{Color::unspecified}, std::forward(args)...), - details::get(option::PrefixText{}, - std::forward(args)...), - details::get(option::PostfixText{}, - std::forward(args)...), - details::get(option::ShowPercentage{true}, - std::forward(args)...), - details::get( - option::ShowElapsedTime{false}, std::forward(args)...), - details::get( - option::ShowRemainingTime{false}, std::forward(args)...), - details::get(option::ShowSpinner{true}, - std::forward(args)...), - details::get( - option::SavedStartTime{false}, std::forward(args)...), - details::get(option::Completed{false}, - std::forward(args)...), - details::get( - option::MaxPostfixTextLen{0}, std::forward(args)...), - details::get( - option::SpinnerStates{ - std::vector{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}}, - std::forward(args)...), - details::get( - option::FontStyles{std::vector{}}, std::forward(args)...), - details::get(option::MaxProgress{100}, - std::forward(args)...), - details::get(option::Stream{std::cout}, - std::forward(args)...)) {} - - template - void set_option(details::Setting &&setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - } - - template - void set_option(const details::Setting &setting) { - static_assert(!std::is_same( - std::declval()))>::type>::value, - "Setting has wrong type!"); - std::lock_guard lock(mutex_); - get_value() = setting.value; - } - - void set_option( - const details::Setting &setting) { - std::lock_guard lock(mutex_); - get_value() = setting.value; - if (setting.value.length() > get_value()) { - get_value() = setting.value.length(); - } - } - - void - set_option(details::Setting &&setting) { - std::lock_guard lock(mutex_); - get_value() = std::move(setting).value; - auto &new_value = get_value(); - if (new_value.length() > get_value()) { - get_value() = new_value.length(); - } - } - - void set_progress(size_t value) { - { - std::lock_guard lock{mutex_}; - progress_ = value; - } - save_start_time(); - print_progress(); - } - - void tick() { - { - std::lock_guard lock{mutex_}; - progress_ += 1; - } - save_start_time(); - print_progress(); - } - - size_t current() { - std::lock_guard lock{mutex_}; - return (std::min)(progress_, size_t(get_value())); - } - - bool is_completed() const { return get_value(); } - - void mark_as_completed() { - get_value() = true; - print_progress(); - } - -private: - Settings settings_; - size_t progress_{0}; - size_t index_{0}; - std::chrono::time_point start_time_point_; - std::mutex mutex_; - - template - auto get_value() -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - template - auto get_value() const - -> decltype((details::get_value(std::declval()).value)) { - return details::get_value(settings_).value; - } - - void save_start_time() { - auto &show_elapsed_time = get_value(); - auto &show_remaining_time = get_value(); - auto &saved_start_time = get_value(); - if ((show_elapsed_time || show_remaining_time) && !saved_start_time) { - start_time_point_ = std::chrono::high_resolution_clock::now(); - saved_start_time = true; - } - } - -public: - void print_progress() { - std::lock_guard lock{mutex_}; - - auto &os = get_value(); - - const auto max_progress = get_value(); - auto now = std::chrono::high_resolution_clock::now(); - auto elapsed = std::chrono::duration_cast(now - start_time_point_); - - if (get_value() != Color::unspecified) - details::set_stream_color(os, get_value()); - - for (auto &style : get_value()) - details::set_font_style(os, style); - - os << get_value(); - if (get_value()) - os << get_value() - [index_ % get_value().size()]; - if (get_value()) { - os << " " << std::size_t(progress_ / double(max_progress) * 100) << "%"; - } - - if (get_value()) { - os << " ["; - details::write_duration(os, elapsed); - } - - if (get_value()) { - if (get_value()) - os << "<"; - else - os << " ["; - auto eta = std::chrono::nanoseconds( - progress_ > 0 - ? static_cast(std::ceil(float(elapsed.count()) * - max_progress / progress_)) - : 0); - auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta); - details::write_duration(os, remaining); - os << "]"; - } else { - if (get_value()) - os << "]"; - } - - if (get_value() == 0) - get_value() = 10; - os << " " << get_value() - << std::string(get_value(), ' ') << "\r"; - os.flush(); - index_ += 1; - if (progress_ > max_progress) { - get_value() = true; - } - if (get_value()) - os << termcolor::reset << std::endl; - } -}; - -} // namespace indicators - -#endif - diff --git a/main.cpp b/main.cpp index 7b3291a..ea83b32 100644 --- a/main.cpp +++ b/main.cpp @@ -1,448 +1,73 @@ #include #include -#include -#include -#include -#define RMT_ENABLED 0 - -// Lib includes -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wunused-parameter" -#pragma GCC diagnostic ignored "-Wunused-variable" -#pragma GCC diagnostic ignored "-Wsign-compare" -#include -#pragma GCC diagnostic pop - -#include - -// Internal includes -#include "rtweekend.hpp" +#include "vec3.hpp" #include "color.hpp" -#include "hittable_list.hpp" -#include "sphere.hpp" -#include "camera.hpp" +#include "ray.hpp" -#ifdef DEBUG -#define print_timers() print_timers_() -#else -#define print_timers() -#endif +color ray_color(const ray& r); +double hit_sphere(const point3& center, double radius, const ray& r); -// Threading structs -struct thread_args +color ray_color(const ray& r) { - int32_t thread_id; - int32_t start; - int32_t end; -}; - -// Function signatures - -color ray_color(const ray& r, const hittable& world, int32_t depth); -float hit_sphere(const point3& center, float radius, const ray& r); -void *raytrace_lines(void *arg); -hittable_list random_scene(); - -// Global vars -indicators::DynamicProgress progress_bars; -const char *default_file = "image.ppm"; -FILE *output_file_handle; - -// Image -float aspect_ratio; -int32_t image_width; -int32_t image_height; -int32_t samples_per_pixel; -int32_t max_depth; - -color *image; -uint64_t bytes_per_line; -uint64_t bytes_per_pixel; - -// World -hittable_list world; -camera *global_camera; - -hittable_list random_scene() { - hittable_list world; - - auto ground_material = make_shared(color(0.5, 0.5, 0.5)); - world.add(sphere(point3(0,-1000,0), 1000, ground_material)); - - for (int32_t a = -11; a < 11; a++) + double t = hit_sphere(point3(0,0,-1), 0.5, r); + if (t > 0.0) { - for (int32_t b = -11; b < 11; b++) - { - float choose_mat = random_float(); - point3 center(a + 0.9*random_float(), 0.2, b + 0.9*random_float()); - - if ((center - point3(4, 0.2, 0)).length() > 0.9) - { - shared_ptr sphere_material; - if (choose_mat < 0.8) - { - // diffuse - color albedo = color::random() * color::random(); - sphere_material = make_shared(albedo); - world.add(sphere(center, 0.2, sphere_material)); - } - else if (choose_mat < 0.95) - { - // metal - color albedo = color::random(0.5, 1); - float fuzz = random_float(0, 0.5); - sphere_material = make_shared(albedo, fuzz); - world.add(sphere(center, 0.2, sphere_material)); - } - else - { - // glass - sphere_material = make_shared(1.5); - world.add(sphere(center, 0.2, sphere_material)); - } - } - } - } - - auto material1 = make_shared(1.5); - world.add(sphere(point3(0, 1, 0), 1.0, material1)); - - auto material2 = make_shared(color(0.4, 0.2, 0.1)); - world.add(sphere(point3(-4, 1, 0), 1.0, material2)); - - auto material3 = make_shared(color(0.7, 0.6, 0.5), 0.0); - world.add(sphere(point3(4, 1, 0), 1.0, material3)); - - return world; -} - -template -color ray_color(const ray& r, hittable_list& world, int32_t depth, int32_t thread_id) -{ - rmt_ScopedCPUSample(Scatter, RMTSF_Aggregate | RMTSF_Recursive); - if (depth <= 0) - { - return color(0,0,0); - } - - hit_record rec; - if (world.hit(r, 0.001, INFINITY, rec)) - { - ray scattered; - color attenuation; - rmt_BeginCPUSample(Scatter, RMTSF_Aggregate); - bool visible = rec.mat_ptr->scatter(r, rec, attenuation, scattered, thread_id); - rmt_EndCPUSample(); - if (visible) - { - return attenuation * ray_color(scattered, world, depth-1, thread_id); - } - else - { - return color(0,0,0); - } + vec3 N = normalize(r.at(t) - vec3(0,0,-1)); + return 0.5*color(N.x+1, N.y+1, N.z+1); } vec3 unit_direction = normalize(r.direction); - float t = 0.5 * (unit_direction.y + 1.0); - return (1-t) * color(1,1,1) + t*color(0.5,0.7,1.0); + t = 0.5*(unit_direction.y + 1.0); + + return (1-t) * color(1,1,1) + t*color(0.5, 0.7, 1.0); } -float hit_sphere(const point3& center, float radius, const ray& r) -{ +double hit_sphere(const point3& center, double radius, const ray& r) +{ vec3 oc = r.origin - center; - float a = r.direction.length_squared(); - float half_b = dot(oc, r.direction); - float c = oc.length_squared() - radius*radius; - float discriminant = half_b*half_b - a*c; - + double a = dot(r.direction, r.direction); + double b = 2.0 * dot(oc, r.direction); + double c = dot(oc,oc) - radius*radius; + double discriminant = b*b - 4*a*c; if (discriminant < 0) return -1; else - return (-half_b - sqrt(discriminant)) / a; + return (-b - sqrt(discriminant)) / (2.0*a); } -int32_t main(int argc, char *argv[]) + +int main() { - - - - - /* Argument parsing */ - int32_t c; - bool using_default_output = true; - - while (1) - { - static struct option long_options[] = - { - {"output", required_argument, 0, 'o'}, - {0, 0, 0, 0} - }; - /* getopt_long stores the option index here. */ - int option_index = 0; - - c = getopt_long (argc, argv, "o:", - long_options, &option_index); - - /* Detect the end of the options. */ - if (c == -1) - break; - - switch (c) - { - case 0: - /* If this option set a flag, do nothing else now. */ - if (long_options[option_index].flag != 0) - break; - printf ("option %s", long_options[option_index].name); - if (optarg) - printf (" with arg %s", optarg); - printf ("\n"); - break; - - case 'o': - using_default_output = false; - output_file_handle = fopen(optarg, "w"); - break; - - case '?': - /* getopt_long already printed an error message. */ - break; - - default: - abort(); - } - } - - if (using_default_output) - { - output_file_handle = fopen(default_file, "w"); - } - - - /* Profiling library initialization */ - Remotery *rmt; - if (RMT_ERROR_NONE != rmt_CreateGlobalInstance(&rmt)) - { - fprintf(stderr, "Error starting Remotery\n"); - } - - //indicators::show_console_cursor(false); - - - // Get the number of logical CPUs - int32_t ncores = sysconf(_SC_NPROCESSORS_ONLN); - // Initialize and seed the random number generators - pcg_table = (pcg32_random_t *) malloc(sizeof(pcg32_random_t) * ncores); - for (int32_t i = 0; i < ncores; ++i) - { - struct timespec ts; - if (timespec_get(&ts, TIME_UTC)) - { - // Use higher quality seed - uint64_t seed = (uint64_t)(ts.tv_nsec ^ ts.tv_sec); - pcg_table[i] = { seed, seed }; - } - else - { - // Error, use default seed - pcg_table[i] = default_pcg; - } - - - - } - // Image - aspect_ratio = 3.0 / 2.0; - image_width = 1200; - image_height = (int32_t) (image_width / aspect_ratio); - samples_per_pixel = 500; - max_depth = 50; - - image = (color*) malloc(image_width * image_height * sizeof(color)); - bytes_per_line = sizeof(color) * image_width; - bytes_per_pixel = sizeof(color); - - if (getenv("SPP")) - { - samples_per_pixel = strtol(getenv("SPP"), NULL, 10); - } - - // World - world = random_scene(); + double aspect_ratio = 16.0 / 9; + const int32_t image_width = 400; + const int32_t image_height = (int32_t) (image_width / aspect_ratio); // Camera - point3 lookfrom(13,2,3); - point3 lookat(0,0,0); - vec3 vup(0,1,0); - float dist_to_focus = 10.0; - float aperture = 0.1; + double viewport_height = 2.0; + double viewport_width = aspect_ratio * viewport_height; + double focal_length = 1.0; + + point3 origin = point3(0,0,0); + vec3 horizontal = vec3(viewport_width, 0, 0); + vec3 vertical = vec3(0, viewport_height, 0); + vec3 lower_left_corner = origin - horizontal/2 - vertical/2 - vec3(0, 0, focal_length); - camera cam = camera(lookfrom, lookat, vup, 20, aspect_ratio, aperture, dist_to_focus); - global_camera = &cam; - // Render - fprintf(output_file_handle, "P3\n%d %d\n255\n", image_width, image_height); + printf("P3\n%d %d\n255\n", image_width, image_height); - - std::vector threads; - std::vector args; - threads.reserve(ncores); - args.reserve(ncores); - - std::vector bar_memory; - bar_memory.reserve(ncores); - - for (int32_t i = 0; i < ncores; ++i) + for (int32_t j = image_height - 1; j >= 0; --j) { - - bar_memory[i] = new indicators::BlockProgressBar{indicators::option::BarWidth{50}, - indicators::option::ForegroundColor{indicators::Color::white}, - indicators::option::ShowElapsedTime{true}, - indicators::option::ShowRemainingTime{true}, - indicators::option::PrefixText{"Thread #" + std::to_string(i)} - }; - - progress_bars.push_back(*bar_memory[i]); - - int32_t start; - int32_t end; - - // Divide work among cores - start = image_height/ncores * i; - end = image_height/ncores * (i+1); - - // Make sure we complete the whole picture even if the work is not perfectly divisible - if (i == ncores) - end = image_height; - - args[i].start = start; - args[i].end = end; - args[i].thread_id = i; - - // TODO: Check for errors - pthread_create(&threads[i], NULL, raytrace_lines, &args[i]); - - } - - for (int32_t i = 0; i < ncores; ++i) - { - switch (pthread_join(threads[i], NULL)) - { - case EDEADLK: - fprintf(stderr, "A deadlock was detected (e.g., two threads tried to join with each other); or thread specifies the calling thread.\n"); - break; - - case EINVAL: - fprintf(stderr, "thread is not a joinable thread OR\n" - "Another thread is already waiting to join with this thread.\n"); - break; - - case ESRCH: - fprintf(stderr, "No thread with the ID thread could be found.\n"); - break; - default: - break; - } - } - - write_image(image, image_width*image_height, output_file_handle, samples_per_pixel); - - - - /* Obsolete non-threaded implementation */ - - // for (int32_t j = image_height - 1; j >= 0; --j) - // { - // rmt_ScopedCPUSample(OuterLoop, RMTSF_Aggregate); - // fprintf(stderr, "\rScanlines remaining: %d ", j); - // print_timers(); - // fflush(stderr); - - - - // for (int32_t i = 0; i < image_width; ++i) - // { - // rmt_ScopedCPUSample(InnerLoop, RMTSF_Aggregate); - // color pixel_color = color(0,0,0); - - // for (int32_t s = 0; s < samples_per_pixel; ++s) - // { - // float u = ((i + random_float()) / (image_width-1)); - // float v = ((j + random_float()) / (image_height-1)); - // ray r = cam.get_ray(u,v); - // pixel_color += ray_color(r, world, max_depth); - // } - - // write_color(output_file_handle, pixel_color, samples_per_pixel); - // } - // } - - fprintf(stderr, "\nDone\n"); - rmt_DestroyGlobalInstance(rmt); - free(image); - fclose(output_file_handle); - //indicators::show_console_cursor(true); -} - -void *raytrace_lines(void *arg) -{ - - thread_args arguments = *((thread_args*)arg); - - int32_t start = arguments.start; - int32_t end = arguments.end; - int32_t thread_id = arguments.thread_id; - - for (int32_t j = end - 1; j >= start; --j) - { - - int32_t lines_expected = end-start; - int32_t lines_completed = end-j; - progress_bars[thread_id].set_option(indicators::option::PostfixText{std::to_string(lines_completed) + "/" + std::to_string(lines_expected)}); - - progress_bars[thread_id].set_progress(((float)lines_completed/lines_expected)*100); - rmt_ScopedCPUSample(OuterLoop, RMTSF_Aggregate); + fprintf(stderr, "\rScanlines remaining: %d ", j); + fflush(stderr); for (int32_t i = 0; i < image_width; ++i) { - color pixel_color = color(0,0,0); - for (int32_t s = 0; s < samples_per_pixel; ++s) - { - float u = ((i + random_float(thread_id)) / (image_width-1)); - float v = ((j + random_float(thread_id)) / (image_height-1)); - ray r = global_camera->get_ray(u,v, thread_id); - pixel_color += ray_color(r, world, max_depth, thread_id); - } - int32_t index = j * image_width + i; - image[index] = pixel_color; - } + double u = (double)i / (image_width-1); + double v = (double)j / (image_height-1); + ray r = ray(origin, lower_left_corner + u*horizontal + v*vertical - origin); + color pixel_color = ray_color(r); + + write_color(stdout, pixel_color); + } } - return nullptr; + fprintf(stderr, "\nDone\n"); } - -#ifdef DEBUG -debug_record debug_record_array[__COUNTER__]; - -void print_timers_() -{ - for (uint32_t i = 0; - i < sizeof(debug_record_array) / sizeof(debug_record_array[0]); - ++i) - { - debug_record *record = &debug_record_array[i]; - fprintf(stderr, - "%d: %s:%s:%d; " - "Cycles = %ld; " - "Hit count %ld; " - "Cycles/hit %f; " - "Time %f", - i, record->filename, record->function_name, record->line_number, - record->cycles, - record->hit_count, - (double)record->cycles / record->hit_count, - (double)record->cycles / CLOCKS_PER_SEC); - } -} - -#endif diff --git a/material.hpp b/material.hpp deleted file mode 100644 index 5665533..0000000 --- a/material.hpp +++ /dev/null @@ -1,100 +0,0 @@ -#ifndef MATERIAL_H -#define MATERIAL_H - -#include "rtweekend.hpp" - -struct material { - virtual bool scatter(const ray& r_in, const hit_record& rec, color& attenuation, ray& scattered, int32_t thread_id = 0) const = 0; -}; - -struct lambertian : material { - /* Attributes */ - color albedo; - // Constructor - lambertian(const color& c) { albedo = c; } - - #pragma GCC diagnostic push - #pragma GCC diagnostic ignored "-Wunused-parameter" - virtual bool scatter(const ray& r_in, const hit_record& rec, color& attenuation, ray& scattered, int32_t thread_id = 0) const override - { - vec3 scatter_direction = rec.normal + random_unit_vector(thread_id); - - /* NOTE: it is possible that the random vector we generate is exactly opposite to the normal vector, - in which case it will sum to a near-zero scatter vector and generate degenerate results. - We check for near-zero vectors here. - */ - - if (scatter_direction.near_zero()) - scatter_direction = rec.normal; - - scattered = ray(rec.p, scatter_direction); - attenuation = albedo; - return true; - } - #pragma GCC diagnostic pop -}; - -struct metal : material { - /* Attributes */ - color albedo; - float fuzz; - // Constructor - metal(const color& c, float f) - { - albedo = c; - fuzz = f; - }; - - virtual bool scatter(const ray& r_in, const hit_record& rec, color& attenuation, ray& scattered, int32_t thread_id) const override - { - vec3 reflected = reflect(normalize(r_in.direction), rec.normal); - scattered = ray(rec.p, reflected + fuzz*random_in_unit_sphere(thread_id)); - attenuation = albedo; - return (dot(scattered.direction, rec.normal) > 0); - } -}; - -struct dielectric : material -{ - /* Attributes */ - float ri; // refraction index - - // Constructor - dielectric(float refraction_index) { ri = refraction_index; } - - /* Methods */ - - // Schlick's approximation of reflectance - static float reflectance(float cosine, float ref_idx) - { - float r0 = (1-ref_idx) / (1+ref_idx); - r0 = r0*r0; - return r0 + (1-r0)*pow((1 - cosine), 5); - } - - - /* Virtual methods */ - virtual bool scatter(const ray& r_in, const hit_record& rec, color& attenuation, ray& scattered, int32_t thread_id) const override - { - attenuation = color(1,1,1); - float refraction_ratio = rec.front_face ? (1.0/ri) : ri; - - vec3 unit_direction = normalize(r_in.direction); - - float cos_theta = fmin(dot(-unit_direction, rec.normal), 1); - float sin_theta = sqrt(1.0 - cos_theta*cos_theta); - - bool cannot_refract = refraction_ratio * sin_theta > 1.0; - vec3 direction; - - if (cannot_refract || reflectance(cos_theta, refraction_ratio) > random_float(thread_id)) - direction = reflect(unit_direction, rec.normal); - else - direction = refract(unit_direction, rec.normal, refraction_ratio); - - scattered = ray(rec.p, direction); - return true; - } -}; - -#endif diff --git a/random.h b/random.h deleted file mode 100644 index b5f66e7..0000000 --- a/random.h +++ /dev/null @@ -1,15 +0,0 @@ -// *Really* minimal PCG32 code / (c) 2014 M.E. O'Neill / pcg-random.org -// Licensed under Apache License 2.0 (NO WARRANTY, etc. see website) - -typedef struct { uint64_t state; uint64_t inc; } pcg32_random_t; - -uint32_t pcg32_random_r(pcg32_random_t* rng) -{ - uint64_t oldstate = rng->state; - // Advance internal state - rng->state = oldstate * 6364136223846793005ULL + (rng->inc|1); - // Calculate output function (XSH RR), uses old state for max ILP - uint32_t xorshifted = ((oldstate >> 18u) ^ oldstate) >> 27u; - uint32_t rot = oldstate >> 59u; - return (xorshifted >> rot) | (xorshifted << ((-rot) & 31)); -} diff --git a/ray.hpp b/ray.hpp index 8ad69eb..ac4231e 100644 --- a/ray.hpp +++ b/ray.hpp @@ -24,7 +24,7 @@ struct ray { } // Returns position after time t - point3 at(float t) const + point3 at(double t) const { return origin + t*direction; } diff --git a/rtweekend.hpp b/rtweekend.hpp deleted file mode 100644 index 136efe7..0000000 --- a/rtweekend.hpp +++ /dev/null @@ -1,70 +0,0 @@ -#ifndef RTWEEKEND_H -#define RTWEEKEND_H - -#include -#include -#include -#include -#include "timer.hpp" -#include "random.h" - -pcg32_random_t *pcg_table; -pcg32_random_t default_pcg = { 0x853c49e6748fea9bULL, 0xda3e39cb94b95bdbULL }; - -/* Utility functions */ -inline float degrees_to_radians(float d) -{ - return d * M_PI / 180; -} - -/* Returns a float in the range [0,1) */ -inline float random_float_() -{ - return rand() * (1.0 / RAND_MAX); -} - -/* Returns a float in the range [0,1) */ -inline float random_float(int32_t thread_id = 0) -{ - return pcg32_random_r(&pcg_table[thread_id]) * (1.0 / UINT32_MAX); -} - -/* Returns a float in the range [min,max) */ -inline float random_float(float min, float max, int32_t thread_id = 0) -{ - return min + (max-min) * random_float(thread_id); -} - -/* Clamps a value between [min,max] */ -inline float clamp(float v, float min, float max) -{ - return v < min ? min : v > max ? max : v; -} - -/* Common internal headers */ - -#include "ray.hpp" -#include "vec3.hpp" - -struct material; - -/* Common data structures */ - -struct hit_record { - point3 p; - vec3 normal; - std::shared_ptr mat_ptr; - float t; - bool front_face; - - inline void set_face_normal(const ray& r, const vec3& outward_normal) - { - front_face = dot(r.direction, outward_normal) < 0; - normal = front_face ? outward_normal : -outward_normal; - } -}; - - - - -#endif diff --git a/sphere.hpp b/sphere.hpp deleted file mode 100644 index a913a31..0000000 --- a/sphere.hpp +++ /dev/null @@ -1,61 +0,0 @@ -#ifndef SPHERE_H -#define SPHERE_H - -#include "hittable.hpp" -#include "vec3.hpp" - -struct sphere : hittable { - /* Attributes */ - point3 center; - float radius; - std::shared_ptr mat_ptr; - - /* Contructor */ - sphere(point3 c, float r, std::shared_ptr m) - { - center = c; - radius = r; - mat_ptr = m; - } - - /* Virtual methods declaration */ - bool hit(const ray& r, float t_min, float t_max, hit_record& rec) const; -}; - -/* Virtual method implementations */ -bool sphere::hit(const ray& r, float t_min, float t_max, hit_record& rec) const -{ - /* NOTE: This function is called too many times (and too fast) for it to be - profiled in a usual way using Remotery. */ - - TIMED_BLOCK(); - - vec3 oc = r.origin - center; - float a = r.direction.length_squared(); - float half_b = dot(oc, r.direction); - float c = oc.length_squared() - radius*radius; - - float discriminant = half_b*half_b - a*c; - if (discriminant < 0) - return false; - float sqrtd = sqrt(discriminant); - - // Find the nearest root that lies in the acceptable range - float root = (-half_b - sqrtd) / a; - if (root < t_min || t_max < root) - { - root = (-half_b + sqrtd) / a; - if (root < t_min || t_max < root) - return false; - } - - rec.t = root; - rec.p = r.at(rec.t); - vec3 outward_normal = (rec.p - center) / radius; - rec.set_face_normal(r, outward_normal); - rec.mat_ptr = mat_ptr; - - return true; -} - -#endif diff --git a/timer.hpp b/timer.hpp deleted file mode 100644 index 6a2c689..0000000 --- a/timer.hpp +++ /dev/null @@ -1,45 +0,0 @@ -#include -#include "rtweekend.hpp" - -#ifdef DEBUG -#define TIMED_BLOCK__(number, ...) timed_block timed_block_##Number(__COUNTER__, __FILE__, __LINE__, __FUNCTION__, ##__VA_ARGS__) -#define TIMED_BLOCK_(number, ...) TIMED_BLOCK__(number, ##__VA_ARGS__) -#define TIMED_BLOCK(...) TIMED_BLOCK_(__LINE__, ##__VA_ARGS__) -#else -#define TIMED_BLOCK(...) -#endif - -#ifdef DEBUG -struct debug_record -{ - uint64_t cycles; - uint64_t hit_count; - const char *filename; - const char *function_name; - - uint32_t line_number; - -}; - - -extern debug_record debug_record_array[]; - -struct timed_block { - // TODO: Thread safety - debug_record *record; - - timed_block(int counter, const char *filename, int line_number, const char *function_name, int hit_count = 1) - { - record = debug_record_array + counter; - record->filename = filename; - record->line_number = line_number; - record->function_name = function_name; - record->cycles -= __rdtsc(); - record->hit_count += hit_count; - } - ~timed_block() - { - record->cycles += __rdtsc(); - } -}; -#endif diff --git a/vec3.h b/vec3.h new file mode 100644 index 0000000..198b3ac --- /dev/null +++ b/vec3.h @@ -0,0 +1,73 @@ +#ifndef VEC3_H +#define VEC3_H + +#include +#include + +struct vec3 { + /* Members */ + double x; + double y; + double z; + + /* Constructors */ + + // Default + vec3() { x = 0; y = 0; z = 0; }; + + // Constructor proper. Values default to 0 + vec3(double x = 0, double y = 0, double z = 0) + { + this.x = x; + this.y = y; + this.z = z; + } + + /* Overriden operators */ + + // - operator. Not to be confused with substraction + vec3 operator-() + { + return vec3(-x, -y, -z); + } + + // straightforward vector sum + vec3& operator+=(const vec3 &v) + { + this.x += v.x; + this.y += v.y; + this.z += v.z; + } + + // scalar multiplication + vec3& operator*=(const double t) + { + x *= t; + y *= t; + z *= t; + return *this; + } + + // division by a scalar t + vec3& operator/=(const double t) + { + x /= t; + y /= t; + z /= t; + return *this; + } + + /* Methods */ + + double length() + { + std::sqrt(x*x + y*y + z*z); + } +}; + +/* Type aliases */ +typedef point3 vec3; +typedef color vec3; + + +#endif diff --git a/vec3.hpp b/vec3.hpp index 2396617..81b9450 100644 --- a/vec3.hpp +++ b/vec3.hpp @@ -1,16 +1,17 @@ #ifndef VEC3_H #define VEC3_H -#include "rtweekend.hpp" +#include +#include struct vec3 { /* Members */ - float x; - float y; - float z; + double x; + double y; + double z; // Constructor proper. Values default to 0 - vec3(float x = 0, float y = 0, float z = 0) + vec3(double x = 0, double y = 0, double z = 0) { this->x = x; this->y = y; @@ -20,7 +21,7 @@ struct vec3 { /* Overriden operators */ // - operator. Not to be confused with substraction - vec3 operator-() const + vec3 operator-() { return vec3(-x, -y, -z); } @@ -35,7 +36,7 @@ struct vec3 { } // Scalar multiplication - vec3& operator*=(const float t) + vec3& operator*=(const double t) { x *= t; y *= t; @@ -44,7 +45,7 @@ struct vec3 { } // Division by a scalar t - vec3& operator/=(const float t) + vec3& operator/=(const double t) { x /= t; y /= t; @@ -54,35 +55,10 @@ struct vec3 { /* Methods */ - float length() const + double length() const { return sqrt(x*x + y*y + z*z); - } - - // Length squared, useful for some calculations - float length_squared() const - { - return x*x + y*y + z*z; - } - - // Get a vec3 with random components in the range [0,1) - inline static vec3 random(int32_t thread_id = 0) - { - return vec3(random_float(thread_id), random_float(thread_id), random_float(thread_id)); - } - - // Get a vec3 with random components in the range [min, max) - inline static vec3 random(float min, float max, int32_t thread_id = 0) - { - return vec3(random_float(min, max, thread_id), random_float(min, max, thread_id), random_float(min, max, thread_id)); - } - - // Check if all vector components are near zero - bool near_zero() const - { - float s = 1e-8; - return (fabs(x) < s) && (fabs(y) < s) && (fabs(z) < s); - } + } }; /* Type aliases */ @@ -92,11 +68,6 @@ typedef vec3 color; /* More overloads */ -inline bool operator==(const vec3 &u, const vec3 &v) -{ - return u.x == v.x && u.y == v.y && u.z == v.z; -} - // Straightforward vector sum inline vec3 operator+(const vec3 &u, const vec3 &v) { @@ -122,33 +93,31 @@ inline vec3 operator*(const vec3 &u, const vec3 &v) } // Scalar product -inline vec3 operator*(float t,const vec3 &v) +inline vec3 operator*(double t,const vec3 &v) { return vec3(t*v.x, t*v.y, t*v.z); } -inline vec3 operator*(const vec3 &v, float t) +inline vec3 operator*(const vec3 &v, double t) { return t * v; } // Vector division by scalar. Note that we redefine it as multiplying by 1/t to avoid division by 0 -inline vec3 operator/(vec3 v, float t) +inline vec3 operator/(vec3 v, double t) { return 1/t * v; } // Straightforward dot product -inline float dot(const vec3 &u, const vec3 &v) +inline double dot(const vec3 &u, const vec3 &v) { - return u.x*v.x + u.y*v.y + u.z*v.z; } // Cross product between two vectors inline vec3 cross(const vec3 &u, const vec3 &v) { - return vec3(u.y * v.z - u.z * v.y, u.z * v.x - u.x * v.z, u.x * v.y - u.y * v.x); @@ -157,61 +126,7 @@ inline vec3 cross(const vec3 &u, const vec3 &v) // Normalize vector so its length = 1 inline vec3 normalize(const vec3 v) { - return v / v.length(); } -// Returns a vec3 of random components between [-1,1) that is inside a unit sphere -vec3 random_in_unit_sphere(int32_t thread_id) -{ - // Iterate until we find a vector with length < 1 - while (true) - { - vec3 p = vec3::random(-1,1, thread_id); - if (p.length_squared() >= 1) - continue; - return p; - } -} - -// Returns a normalized version of the above vector -vec3 random_unit_vector(int32_t thread_id) -{ - return normalize(random_in_unit_sphere(thread_id)); -} - -vec3 random_in_hemisphere(const vec3& normal, int32_t thread_id) -{ - vec3 in_unit_sphere = random_in_unit_sphere(thread_id); - - if (dot(in_unit_sphere, normal) > 0.0) - return in_unit_sphere; - else - return -in_unit_sphere; -} - -// Reflect like a metallic material -vec3 reflect(const vec3& v, const vec3 n) -{ - return v - 2*dot(v,n)*n; -} - -vec3 refract(const vec3& uv, const vec3& n, float etai_over_etat) -{ - float cos_theta = fmin(dot(-uv, n), 1.0); - vec3 r_out_perp = etai_over_etat * (uv + cos_theta*n); - vec3 r_out_parallel = -sqrt(fabs(1.0 - r_out_perp.length_squared())) * n; - return r_out_perp + r_out_parallel; -} - -vec3 random_in_unit_disk(int32_t thread_id) -{ - while (true) - { - auto p = vec3(random_float(-1,1,thread_id), random_float(-1,1,thread_id), 0); - if (p.length_squared() >= 1) continue; - return p; - } -} - #endif diff --git a/vis/Code/Console.js b/vis/Code/Console.js deleted file mode 100644 index 1f16cfe..0000000 --- a/vis/Code/Console.js +++ /dev/null @@ -1,218 +0,0 @@ - -Console = (function() -{ - var BORDER = 10; - var HEIGHT = 200; - - - function Console(wm, server) - { - // Create the window and its controls - this.Window = wm.AddWindow("Console", 10, 10, 100, 100); - this.PageContainer = this.Window.AddControlNew(new WM.Container(10, 10, 400, 160)); - DOM.Node.AddClass(this.PageContainer.Node, "ConsoleText"); - this.AppContainer = this.Window.AddControlNew(new WM.Container(10, 10, 400, 160)); - DOM.Node.AddClass(this.AppContainer.Node, "ConsoleText"); - this.UserInput = this.Window.AddControlNew(new WM.EditBox(10, 5, 400, 30, "Input", "")); - this.UserInput.SetChangeHandler(Bind(ProcessInput, this)); - this.Window.ShowNoAnim(); - - // This accumulates log text as fast as is required - this.PageTextBuffer = ""; - this.PageTextUpdatePending = false; - this.AppTextBuffer = ""; - this.AppTextUpdatePending = false; - - // Setup command history control - this.CommandHistory = LocalStore.Get("App", "Global", "CommandHistory", [ ]); - this.CommandIndex = 0; - this.MaxNbCommands = 10000; - DOM.Event.AddHandler(this.UserInput.EditNode, "keydown", Bind(OnKeyPress, this)); - DOM.Event.AddHandler(this.UserInput.EditNode, "focus", Bind(OnFocus, this)); - - // At a much lower frequency this will update the console window - window.setInterval(Bind(UpdateHTML, this), 500); - - // Setup log requests from the server - this.Server = server; - server.SetConsole(this); - server.AddMessageHandler("LOGM", Bind(OnLog, this)); - - this.Window.SetOnResize(Bind(OnUserResize, this)); - } - - - Console.prototype.Log = function(text) - { - this.PageTextBuffer = LogText(this.PageTextBuffer, text); - this.PageTextUpdatePending = true; - } - - - Console.prototype.WindowResized = function(width, height) - { - // Place window - this.Window.SetPosition(BORDER, height - BORDER - 200); - this.Window.SetSize(width - 2 * BORDER, HEIGHT); - - ResizeInternals(this); - } - - - Console.prototype.TriggerUpdate = function() - { - this.AppTextUpdatePending = true; - } - - - function OnLog(self, socket, data_view_reader) - { - var text = data_view_reader.GetString(); - self.AppTextBuffer = LogText(self.AppTextBuffer, text); - - // Don't register text as updating if disconnected as this implies a trace is being loaded, which we want to speed up - if (self.Server.Connected()) - { - self.AppTextUpdatePending = true; - } - } - - - function LogText(existing_text, new_text) - { - // Filter the text a little to make it safer - if (new_text == null) - new_text = "NULL"; - - // Find and convert any HTML entities, ensuring the browser doesn't parse any embedded HTML code - // This also allows the log to contain arbitrary C++ code (e.g. assert comparison operators) - new_text = Convert.string_to_html_entities(new_text); - - // Prefix date and end with new line - var d = new Date(); - new_text = "[" + d.toLocaleTimeString() + "] " + new_text + "
"; - - // Append to local text buffer and ensure clip the oldest text to ensure a max size - existing_text = existing_text + new_text; - var max_len = 100 * 1024; - var len = existing_text.length; - if (len > max_len) - existing_text = existing_text.substr(len - max_len, max_len); - - return existing_text; - } - - function OnUserResize(self, evt) - { - ResizeInternals(self); - } - - function ResizeInternals(self) - { - // Place controls - var parent_size = self.Window.Size; - var mid_w = parent_size[0] / 3; - self.UserInput.SetPosition(BORDER, parent_size[1] - 2 * BORDER - 30); - self.UserInput.SetSize(parent_size[0] - 100, 18); - var output_height = self.UserInput.Position[1] - 2 * BORDER; - self.PageContainer.SetPosition(BORDER, BORDER); - self.PageContainer.SetSize(mid_w - 2 * BORDER, output_height); - self.AppContainer.SetPosition(mid_w, BORDER); - self.AppContainer.SetSize(parent_size[0] - mid_w - BORDER, output_height); - } - - - function UpdateHTML(self) - { - // Reset the current text buffer as html - - if (self.PageTextUpdatePending) - { - var page_node = self.PageContainer.Node; - page_node.innerHTML = self.PageTextBuffer; - page_node.scrollTop = page_node.scrollHeight; - self.PageTextUpdatePending = false; - } - - if (self.AppTextUpdatePending) - { - var app_node = self.AppContainer.Node; - app_node.innerHTML = self.AppTextBuffer; - app_node.scrollTop = app_node.scrollHeight; - self.AppTextUpdatePending = false; - } - } - - - function ProcessInput(self, node) - { - // Send the message exactly - var msg = node.value; - self.Server.Send("CONI" + msg); - - // Emit to console and clear - self.Log("> " + msg); - self.UserInput.SetValue(""); - - // Keep track of recently issued commands, with an upper bound - self.CommandHistory.push(msg); - var extra_commands = self.CommandHistory.length - self.MaxNbCommands; - if (extra_commands > 0) - self.CommandHistory.splice(0, extra_commands); - - // Set command history index to the most recent command - self.CommandIndex = self.CommandHistory.length; - - // Backup to local store - LocalStore.Set("App", "Global", "CommandHistory", self.CommandHistory); - - // Keep focus with the edit box - return true; - } - - - function OnKeyPress(self, evt) - { - evt = DOM.Event.Get(evt); - - if (evt.keyCode == Keyboard.Codes.UP) - { - if (self.CommandHistory.length > 0) - { - // Cycle backwards through the command history - self.CommandIndex--; - if (self.CommandIndex < 0) - self.CommandIndex = self.CommandHistory.length - 1; - var command = self.CommandHistory[self.CommandIndex]; - self.UserInput.SetValue(command); - } - - // Stops default behaviour of moving cursor to the beginning - DOM.Event.StopDefaultAction(evt); - } - - else if (evt.keyCode == Keyboard.Codes.DOWN) - { - if (self.CommandHistory.length > 0) - { - // Cycle fowards through the command history - self.CommandIndex = (self.CommandIndex + 1) % self.CommandHistory.length; - var command = self.CommandHistory[self.CommandIndex]; - self.UserInput.SetValue(command); - } - - // Stops default behaviour of moving cursor to the end - DOM.Event.StopDefaultAction(evt); - } - } - - - function OnFocus(self) - { - // Reset command index on focus - self.CommandIndex = self.CommandHistory.length; - } - - - return Console; -})(); diff --git a/vis/Code/DataViewReader.js b/vis/Code/DataViewReader.js deleted file mode 100644 index e320533..0000000 --- a/vis/Code/DataViewReader.js +++ /dev/null @@ -1,52 +0,0 @@ - -// -// Simple wrapper around DataView that auto-advances the read offset and provides -// a few common data type conversions specific to this app -// -DataViewReader = (function () -{ - function DataViewReader(data_view, offset) - { - this.DataView = data_view; - this.Offset = offset; - } - - DataViewReader.prototype.AtEnd = function() - { - return this.Offset >= this.DataView.byteLength; - } - - DataViewReader.prototype.GetUInt32 = function () - { - var v = this.DataView.getUint32(this.Offset, true); - this.Offset += 4; - return v; - } - - DataViewReader.prototype.GetUInt64 = function () - { - var v = this.DataView.getFloat64(this.Offset, true); - this.Offset += 8; - return v; - } - - DataViewReader.prototype.GetStringOfLength = function (string_length) - { - var string = ""; - for (var i = 0; i < string_length; i++) - { - string += String.fromCharCode(this.DataView.getInt8(this.Offset)); - this.Offset++; - } - - return string; - } - - DataViewReader.prototype.GetString = function () - { - var string_length = this.GetUInt32(); - return this.GetStringOfLength(string_length); - } - - return DataViewReader; -})(); diff --git a/vis/Code/NameMap.js b/vis/Code/NameMap.js deleted file mode 100644 index 37a966d..0000000 --- a/vis/Code/NameMap.js +++ /dev/null @@ -1,53 +0,0 @@ -class NameMap -{ - constructor(text_buffer) - { - this.names = { }; - this.textBuffer = text_buffer; - } - - Get(name_hash) - { - // Return immediately if it's in the hash - let name = this.names[name_hash]; - if (name != undefined) - { - return [ true, name ]; - } - - // Create a temporary name that uses the hash - name = { - string: name_hash.toString(), - hash: name_hash - }; - this.names[name_hash] = name; - - // Add to the text buffer the first time this name is encountered - name.textEntry = this.textBuffer.AddText(name.string); - - return [ false, name ]; - } - - Set(name_hash, name_string) - { - // Create the name on-demand if its hash doesn't exist - let name = this.names[name_hash]; - if (name == undefined) - { - name = { - string: name_string, - hash: name_hash - }; - this.names[name_hash] = name; - } - else - { - name.string = name_string; - } - - // Apply the updated text to the buffer - name.textEntry = this.textBuffer.AddText(name_string); - - return name; - } -} \ No newline at end of file diff --git a/vis/Code/PixelTimeRange.js b/vis/Code/PixelTimeRange.js deleted file mode 100644 index a8a726c..0000000 --- a/vis/Code/PixelTimeRange.js +++ /dev/null @@ -1,61 +0,0 @@ - -class PixelTimeRange -{ - constructor(start_us, span_us, span_px) - { - this.Span_px = span_px; - this.Set(start_us, span_us); - } - - Set(start_us, span_us) - { - this.Start_us = start_us; - this.Span_us = span_us; - this.End_us = this.Start_us + span_us; - this.usPerPixel = this.Span_px / this.Span_us; - } - - SetStart(start_us) - { - this.Start_us = start_us; - this.End_us = start_us + this.Span_us; - } - - SetEnd(end_us) - { - this.End_us = end_us; - this.Start_us = end_us - this.Span_us; - } - - SetPixelSpan(span_px) - { - this.Span_px = span_px; - this.usPerPixel = this.Span_px / this.Span_us; - } - - PixelOffset(time_us) - { - return Math.floor((time_us - this.Start_us) * this.usPerPixel); - } - - PixelSize(time_us) - { - return Math.floor(time_us * this.usPerPixel); - } - - TimeAtPosition(position) - { - return this.Start_us + position / this.usPerPixel; - } - - Clone() - { - return new PixelTimeRange(this.Start_us, this.Span_us, this.Span_px); - } - - SetAsUniform(gl, program) - { - glSetUniform(gl, program, "inTimeRange.usStart", this.Start_us); - glSetUniform(gl, program, "inTimeRange.usPerPixel", this.usPerPixel); - } -} diff --git a/vis/Code/Remotery.js b/vis/Code/Remotery.js deleted file mode 100644 index 383b017..0000000 --- a/vis/Code/Remotery.js +++ /dev/null @@ -1,540 +0,0 @@ - -// -// TODO: Window resizing needs finer-grain control -// TODO: Take into account where user has moved the windows -// TODO: Controls need automatic resizing within their parent windows -// - - -Settings = (function() -{ - function Settings() - { - this.IsPaused = false; - this.SyncTimelines = true; - } - - return Settings; - -})(); - - -Remotery = (function() -{ - // crack the url and get the parameter we want - var getUrlParameter = function getUrlParameter( search_param) - { - var page_url = decodeURIComponent( window.location.search.substring(1) ), - url_vars = page_url.split('&'), - param_name, - i; - - for (i = 0; i < url_vars.length; i++) - { - param_name = url_vars[i].split('='); - - if (param_name[0] === search_param) - { - return param_name[1] === undefined ? true : param_name[1]; - } - } - }; - - function Remotery() - { - this.WindowManager = new WM.WindowManager(); - this.Settings = new Settings(); - - // "addr" param is ip:port and will override the local store version if passed in the URL - var addr = getUrlParameter( "addr" ); - if ( addr != null ) - this.ConnectionAddress = "ws://" + addr + "/rmt"; - else - this.ConnectionAddress = LocalStore.Get("App", "Global", "ConnectionAddress", "ws://127.0.0.1:17815/rmt"); - - this.Server = new WebSocketConnection(); - this.Server.AddConnectHandler(Bind(OnConnect, this)); - this.Server.AddDisconnectHandler(Bind(OnDisconnect, this)); - - // Create the console up front as everything reports to it - this.Console = new Console(this.WindowManager, this.Server); - - // Create required windows - this.TitleWindow = new TitleWindow(this.WindowManager, this.Settings, this.Server, this.ConnectionAddress); - this.TitleWindow.SetConnectionAddressChanged(Bind(OnAddressChanged, this)); - this.SampleTimelineWindow = new TimelineWindow(this.WindowManager, "Sample Timeline", this.Settings, Bind(OnTimelineCheck, this)); - this.SampleTimelineWindow.SetOnHover(Bind(OnSampleHover, this)); - this.SampleTimelineWindow.SetOnSelected(Bind(OnSampleSelected, this)); - this.ProcessorTimelineWindow = new TimelineWindow(this.WindowManager, "Processor Timeline", this.Settings, null); - - this.SampleTimelineWindow.SetOnMoved(Bind(OnTimelineMoved, this)); - this.ProcessorTimelineWindow.SetOnMoved(Bind(OnTimelineMoved, this)); - - this.TraceDrop = new TraceDrop(this); - - this.NbSampleWindows = 0; - this.SampleWindows = { }; - this.FrameHistory = { }; - this.ProcessorFrameHistory = { }; - this.SelectedFrames = { }; - this.sampleNames = new NameMap(this.SampleTimelineWindow.textBuffer); - this.threadNames = new NameMap(this.ProcessorTimelineWindow.textBuffer); - - this.Server.AddMessageHandler("SMPL", Bind(OnSamples, this)); - this.Server.AddMessageHandler("SSMP", Bind(OnSampleName, this)); - this.Server.AddMessageHandler("PRTH", Bind(OnProcessorThreads, this)); - this.Server.AddMessageHandler("THRN", Bind(OnThreadNames, this)); - - // Kick-off the auto-connect loop - AutoConnect(this); - - // Hook up resize event handler - DOM.Event.AddHandler(window, "resize", Bind(OnResizeWindow, this)); - OnResizeWindow(this); - - // Hook up browser-native canvas refresh - this.DisplayFrame = 0; - this.LastKnownPause = this.Settings.IsPaused; - var self = this; - (function display_loop() - { - window.requestAnimationFrame(display_loop); - DrawTimeline(self); - })(); - } - - - Remotery.prototype.Clear = function() - { - // Clear timelines - this.SampleTimelineWindow.Clear(); - this.ProcessorTimelineWindow.Clear(); - - // Close and clear all sample windows - for (var i in this.SampleWindows) - { - var sample_window = this.SampleWindows[i]; - sample_window.Close(); - } - this.NbSampleWindows = 0; - this.SampleWindows = { }; - - // Clear runtime data - this.FrameHistory = { }; - this.ProcessorFrameHistory = { }; - this.SelectedFrames = { }; - this.sampleNames = new NameMap(this.SampleTimelineWindow.textBuffer); - this.threadNames = new NameMap(this.ProcessorTimelineWindow.textBuffer); - - // Resize everything to fit new layout - OnResizeWindow(this); - } - - - function AutoConnect(self) - { - // Only attempt to connect if there isn't already a connection or an attempt to connect - if (!self.Server.Connected()) - self.Server.Connect(self.ConnectionAddress); - - // Always schedule another check - window.setTimeout(Bind(AutoConnect, self), 2000); - } - - - function OnConnect(self) - { - // Connection address has been validated - LocalStore.Set("App", "Global", "ConnectionAddress", self.ConnectionAddress); - - self.Clear(); - - // Ensure the viewer is ready for realtime updates - self.TitleWindow.Unpause(); - } - - function OnDisconnect(self) - { - // Pause so the user can inspect the trace - self.TitleWindow.Pause(); - } - - - function OnAddressChanged(self, node) - { - // Update and disconnect, relying on auto-connect to reconnect - self.ConnectionAddress = node.value; - self.Server.Disconnect(); - - // Give input focus away - return false; - } - - - function DrawTimeline(self) - { - // Has pause state changed? - if (self.Settings.IsPaused != self.LastKnownPaused) - { - // When switching TO paused, draw one last frame to ensure the sample text gets drawn - self.LastKnownPaused = self.Settings.IsPaused; - self.SampleTimelineWindow.DrawAllRows(); - self.ProcessorTimelineWindow.DrawAllRows(); - return; - } - - // Don't waste time drawing the timeline when paused - if (self.Settings.IsPaused) - return; - - // requestAnimationFrame can run up to 60hz which is way too much for drawing the timeline - // Assume it's running at 60hz and skip frames to achieve 10hz instead - // Doing this instead of using setTimeout because it's better for browser rendering (or; will be once WebGL is in use) - // TODO: Expose as config variable because high refresh rate is great when using a separate viewiing machine - if ((self.DisplayFrame % 10) == 0) - { - self.SampleTimelineWindow.DrawAllRows(); - self.ProcessorTimelineWindow.DrawAllRows(); - } - - self.DisplayFrame++; - } - - - function DecodeSample(self, data_view_reader) - { - var sample = {}; - - // Get name hash and lookup name it map - sample.name_hash = data_view_reader.GetUInt32(); - let [ name_exists, name ] = self.sampleNames.Get(sample.name_hash); - sample.name = name; - - // If the name doesn't exist in the map yet, request it from the server - if (!name_exists) - { - if (self.Server.Connected()) - { - self.Server.Send("GSMP" + sample.name_hash); - } - } - - // Get the rest of the sample data - sample.id = data_view_reader.GetUInt32(); - sample.colour = data_view_reader.GetStringOfLength(7); - sample.us_start = data_view_reader.GetUInt64(); - sample.us_length = data_view_reader.GetUInt64(); - sample.us_self = data_view_reader.GetUInt64(); - sample.call_count = data_view_reader.GetUInt32(); - sample.recurse_depth = data_view_reader.GetUInt32(); - - // TODO(don): Get the profiler to pass these directly instead of hex colour - const colour = parseInt(sample.colour.slice(1), 16); - const r = (colour >> 16) & 255; - const g = (colour >> 8) & 255; - const b = colour & 255; - sample.rgbColour = [ r, g, b ]; - - // Calculate dependent properties - sample.ms_length = (sample.us_length / 1000.0).toFixed(3); - sample.ms_self = (sample.us_self / 1000.0).toFixed(3); - - // Recurse into children - sample.children = []; - DecodeSampleArray(self, data_view_reader, sample.children); - - return sample; - } - - - function DecodeSampleArray(self, data_view_reader, samples) - { - var nb_samples = data_view_reader.GetUInt32(); - for (var i = 0; i < nb_samples; i++) - { - var sample = DecodeSample(self, data_view_reader); - samples.push(sample) - } - } - - - function DecodeSamples(self, data_view_reader) - { - // Message-specific header - let message = { }; - message.sample_tree_bytes = data_view_reader.GetUInt32(); - message.thread_name = data_view_reader.GetString(); - message.nb_samples = data_view_reader.GetUInt32(); - message.sample_digest = data_view_reader.GetUInt32(); - message.partial_tree = data_view_reader.GetUInt32(); - - // Read samples - message.samples = []; - message.samples.push(DecodeSample(self, data_view_reader)); - - return message; - } - - - function OnSamples(self, socket, data_view_reader) - { - // Discard any new samples while paused and connected - // Otherwise this stops a paused Remotery from loading new samples from disk - if (self.Settings.IsPaused && self.Server.Connected()) - return; - - // Binary decode incoming sample data - var message = DecodeSamples(self, data_view_reader); - var name = message.thread_name; - - // Add to frame history for this thread - var thread_frame = new ThreadFrame(message); - if (!(name in self.FrameHistory)) - { - self.FrameHistory[name] = [ ]; - } - var frame_history = self.FrameHistory[name]; - if (frame_history.length > 0 && frame_history[frame_history.length - 1].PartialTree) - { - // Always overwrite partial trees with new information - frame_history[frame_history.length - 1] = thread_frame; - } - else - { - frame_history.push(thread_frame); - } - - // Discard old frames to keep memory-use constant - var max_nb_frames = 10000; - var extra_frames = frame_history.length - max_nb_frames; - if (extra_frames > 0) - frame_history.splice(0, extra_frames); - - // Create sample windows on-demand - if (!(name in self.SampleWindows)) - { - self.SampleWindows[name] = new SampleWindow(self.WindowManager, name, self.NbSampleWindows); - self.SampleWindows[name].WindowResized(self.SampleTimelineWindow.Window, self.Console.Window); - self.NbSampleWindows++; - MoveSampleWindows(this); - } - - // Set on the window and timeline if connected as this implies a trace is being loaded, which we want to speed up - if (self.Server.Connected()) - { - self.SampleWindows[name].OnSamples(message.nb_samples, message.sample_digest, message.samples); - self.SampleTimelineWindow.OnSamples(name, frame_history); - } - } - - - function OnSampleName(self, socket, data_view_reader) - { - // Add any names sent by the server to the local map - let name_hash = data_view_reader.GetUInt32(); - let name_string = data_view_reader.GetString(); - self.sampleNames.Set(name_hash, name_string); - } - - - function OnProcessorThreads(self, socket, data_view_reader) - { - let nb_processors = data_view_reader.GetUInt32(); - let message_index = data_view_reader.GetUInt64(); - - // Decode each processor - for (let i = 0; i < nb_processors; i++) - { - let thread_id = data_view_reader.GetUInt32(); - let thread_name_hash = data_view_reader.GetUInt32(); - let sample_time = data_view_reader.GetUInt64(); - - // Add frame history for this processor - let processor_name = "Processor " + i.toString(); - if (!(processor_name in self.ProcessorFrameHistory)) - { - self.ProcessorFrameHistory[processor_name] = [ ]; - } - let frame_history = self.ProcessorFrameHistory[processor_name]; - - if (thread_id == 0xFFFFFFFF) - { - continue; - } - - // Try to merge this frame's samples with the previous frame if the are the same thread - if (frame_history.length > 0) - { - let last_thread_frame = frame_history[frame_history.length - 1]; - if (last_thread_frame.threadId == thread_id && last_thread_frame.messageIndex == message_index - 1) - { - // Update last frame message index so that the next frame can check for continuity - last_thread_frame.messageIndex = message_index; - - // Sum time elapsed on the previous frame - let us_length = sample_time - last_thread_frame.usLastStart; - last_thread_frame.usLastStart = sample_time; - last_thread_frame.EndTime_us += us_length; - last_thread_frame.Samples[0].us_length += us_length; - - continue; - } - } - - // Discard old frames to keep memory-use constant - var max_nb_frames = 10000; - var extra_frames = frame_history.length - max_nb_frames; - if (extra_frames > 0) - { - frame_history.splice(0, extra_frames); - } - - // Lookup the thread name - let [ _, thread_name ] = self.threadNames.Get(thread_name_hash); - - // Make a pastel-y colour from the thread name hash - let hash = thread_name.hash; - let r = 127 + (hash & 255) / 2; - let g = 127 + ((hash >> 4) & 255) / 2; - let b = 127 + ((hash >> 8) & 255) / 2; - - // We are co-opting the sample rendering functionality of the timeline window to display processor threads as - // thread samples. Fabricate a thread frame message, packing the processor info into one root sample. - // TODO(don): Abstract the timeline window for pure range display as this is quite inefficient. - let thread_message = { - nb_samples: 1, - sample_digest: 0, - samples : [ - { - name_hash: thread_name_hash, - name: thread_name, - id: thread_id, - colour: "#FFFFFF", - us_start: sample_time, - us_length: 250, - rgbColour: [ r, g, b ], - children: [] - } - ] - }; - - // Create a thread frame and annotate with data required to merge processor samples - let thread_frame = new ThreadFrame(thread_message); - thread_frame.threadId = thread_id; - thread_frame.messageIndex = message_index; - thread_frame.usLastStart = sample_time; - frame_history.push(thread_frame); - - if (self.Server.Connected()) - { - self.ProcessorTimelineWindow.OnSamples(processor_name, frame_history); - } - } - } - - - function OnThreadNames(self, socket, data_view_reader) - { - let name_hash = data_view_reader.GetUInt32(); - let name_length = data_view_reader.GetUInt32(); - let name_string = data_view_reader.GetStringOfLength(name_length); - self.threadNames.Set(name_hash, name_string); - } - - - function OnTimelineCheck(self, name, evt) - { - // Show/hide the equivalent sample window and move all the others to occupy any left-over space - var target = DOM.Event.GetNode(evt); - self.SampleWindows[name].SetVisible(target.checked); - MoveSampleWindows(self); - } - - - function MoveSampleWindows(self) - { - // Stack all windows next to each other - var xpos = 0; - for (var i in self.SampleWindows) - { - var sample_window = self.SampleWindows[i]; - if (sample_window.Visible) - { - sample_window.SetXPos(xpos++, self.SampleTimelineWindow.Window, self.Console.Window); - } - } - } - - - function OnSampleHover(self, thread_name, hover) - { - if (!self.Settings.IsPaused) - { - return; - } - - for (let window_thread_name in self.SampleWindows) - { - let sample_window = self.SampleWindows[window_thread_name]; - - if (window_thread_name == thread_name && hover != null) - { - // Populate with sample under hover - let frame = hover[0]; - sample_window.OnSamples(frame.NbSamples, frame.SampleDigest, frame.Samples); - } - else - { - // When there's no hover, go back to the selected frame - if (self.SelectedFrames[window_thread_name]) - { - const frame = self.SelectedFrames[window_thread_name]; - sample_window.OnSamples(frame.NbSamples, frame.SampleDigest, frame.Samples); - } - } - } - } - - - function OnSampleSelected(self, thread_name, select) - { - // Lookup sample window set the frame samples on it - if (select && thread_name in self.SampleWindows) - { - var sample_window = self.SampleWindows[thread_name]; - var frame = select[0]; - self.SelectedFrames[thread_name] = frame; - sample_window.OnSamples(frame.NbSamples, frame.SampleDigest, frame.Samples); - } - } - - - function OnResizeWindow(self) - { - // Resize windows - var w = window.innerWidth; - var h = window.innerHeight; - self.Console.WindowResized(w, h); - self.TitleWindow.WindowResized(w, h); - self.SampleTimelineWindow.WindowResized(10, w / 2 - 5, self.TitleWindow.Window); - self.ProcessorTimelineWindow.WindowResized(w / 2 + 5, w / 2 - 5, self.TitleWindow.Window); - for (var i in self.SampleWindows) - { - self.SampleWindows[i].WindowResized(self.SampleTimelineWindow.Window, self.Console.Window); - } - } - - - function OnTimelineMoved(self, timeline) - { - if (self.Settings.SyncTimelines) - { - let other_timeline = timeline == self.ProcessorTimelineWindow ? self.SampleTimelineWindow : self.ProcessorTimelineWindow; - other_timeline.SetTimeRange(timeline.TimeRange.Start_us, timeline.TimeRange.Span_us); - other_timeline.DrawAllRows(); - } - } - - - return Remotery; -})(); \ No newline at end of file diff --git a/vis/Code/SampleWindow.js b/vis/Code/SampleWindow.js deleted file mode 100644 index ea3c163..0000000 --- a/vis/Code/SampleWindow.js +++ /dev/null @@ -1,221 +0,0 @@ - -SampleWindow = (function() -{ - function SampleWindow(wm, name, offset) - { - // Sample digest for checking if grid needs to be repopulated - this.NbSamples = 0; - this.SampleDigest = null; - - // Source sample reference to reduce repopulation - this.Samples = null; - - this.XPos = 10 + offset * 410; - this.Window = wm.AddWindow(name, 100, 100, 100, 100); - this.Window.ShowNoAnim(); - this.Visible = true; - - // Create a grid that's indexed by the unique sample ID - this.Grid = this.Window.AddControlNew(new WM.Grid()); - var cell_data = - { - Name: "Samples", - Length: "Time (ms)", - Self: "Self (ms)", - Calls: "Calls", - Recurse: "Recurse", - }; - var cell_classes = - { - Name: "SampleTitleNameCell", - Length: "SampleTitleTimeCell", - Self: "SampleTitleTimeCell", - Calls: "SampleTitleCountCell", - Recurse: "SampleTitleCountCell", - }; - this.RootRow = this.Grid.Rows.Add(cell_data, "GridGroup", cell_classes); - this.RootRow.Rows.AddIndex("_ID"); - } - - - SampleWindow.prototype.Close = function() - { - this.Window.Close(); - } - - - SampleWindow.prototype.SetXPos = function(xpos, top_window, bottom_window) - { - Anim.Animate( - Bind(AnimatedMove, this, top_window, bottom_window), - this.XPos, 10 + xpos * 410, 0.25); - } - - - function AnimatedMove(self, top_window, bottom_window, val) - { - self.XPos = val; - self.WindowResized(top_window, bottom_window); - } - - - SampleWindow.prototype.SetVisible = function(visible) - { - if (visible != this.Visible) - { - if (visible == true) - this.Window.ShowNoAnim(); - else - this.Window.HideNoAnim(); - - this.Visible = visible; - } - } - - - SampleWindow.prototype.WindowResized = function(top_window, bottom_window) - { - var top = top_window.Position[1] + top_window.Size[1] + 10; - this.Window.SetPosition(this.XPos, top_window.Position[1] + top_window.Size[1] + 10); - this.Window.SetSize(400, bottom_window.Position[1] - 10 - top); - } - - - SampleWindow.prototype.OnSamples = function(nb_samples, sample_digest, samples) - { - if (!this.Visible) - return; - - // If the source hasn't changed, don't repopulate - if (this.Samples == samples) - return; - this.Samples = samples; - - // Recreate all the HTML if the number of samples gets bigger - if (nb_samples > this.NbSamples) - { - GrowGrid(this.RootRow, nb_samples); - this.NbSamples = nb_samples; - } - - // If the content of the samples changes from previous update, update them all - if (this.SampleDigest != sample_digest) - { - this.RootRow.Rows.ClearIndex("_ID"); - var index = UpdateAllSampleFields(this.RootRow, samples, 0, ""); - this.SampleDigest = sample_digest; - - // Clear out any left-over rows - for (var i = index; i < this.RootRow.Rows.Rows.length; i++) - { - var row = this.RootRow.Rows.Rows[i]; - DOM.Node.Hide(row.Node); - } - } - - else if (this.Visible) - { - // Otherwise just update the existing sample fields - UpdateChangedSampleFields(this.RootRow, samples, ""); - } - } - - - function GrowGrid(parent_row, nb_samples) - { - parent_row.Rows.Clear(); - - for (var i = 0; i < nb_samples; i++) - { - var cell_data = - { - _ID: i, - Name: "", - Length: "", - Self: "", - Calls: "", - Recurse: "", - }; - - var cell_classes = - { - Name: "SampleNameCell", - Length: "SampleTimeCell", - Self: "SampleTimeCell", - Calls: "SampleCountCell", - Recurse: "SampleCountCell", - }; - - parent_row.Rows.Add(cell_data, null, cell_classes); - } - } - - - function UpdateAllSampleFields(parent_row, samples, index, indent) - { - for (var i in samples) - { - var sample = samples[i]; - - // Match row allocation in GrowGrid - var row = parent_row.Rows.Rows[index++]; - - // Sample row may have been hidden previously - DOM.Node.Show(row.Node); - - // Assign unique ID so that the common fast path of updating sample times only - // can lookup target samples in the grid - row.CellData._ID = sample.id; - parent_row.Rows.AddRowToIndex("_ID", sample.id, row); - - // Record sample name for later comparison - row.CellData.Name = sample.name.string; - - // Set sample name and colour - var name_node = row.CellNodes["Name"]; - name_node.innerHTML = indent + sample.name.string; - DOM.Node.SetColour(name_node, sample.colour); - - row.CellNodes["Length"].innerHTML = sample.ms_length; - row.CellNodes["Self"].innerHTML = sample.ms_self; - row.CellNodes["Calls"].innerHTML = sample.call_count; - row.CellNodes["Recurse"].innerHTML = sample.recurse_depth; - - index = UpdateAllSampleFields(parent_row, sample.children, index, indent + "     "); - } - - return index; - } - - - function UpdateChangedSampleFields(parent_row, samples, indent) - { - for (var i in samples) - { - var sample = samples[i]; - - var row = parent_row.Rows.GetBy("_ID", sample.id); - if (row) - { - row.CellNodes["Length"].innerHTML = sample.ms_length; - row.CellNodes["Self"].innerHTML = sample.ms_self; - row.CellNodes["Calls"].innerHTML = sample.call_count; - row.CellNodes["Recurse"].innerHTML = sample.recurse_depth; - - // Sample name will change when it switches from hash ID to network-retrieved - // name. Quickly check that before re-applying the HTML for the name. - if (row.CellData.Name != sample.name.string) - { - var name_node = row.CellNodes["Name"]; - row.CellData.Name = sample.name.string; - name_node.innerHTML = indent + sample.name.string; - } - } - - UpdateChangedSampleFields(parent_row, sample.children, indent + "     "); - } - } - - - return SampleWindow; -})(); diff --git a/vis/Code/Shaders.js b/vis/Code/Shaders.js deleted file mode 100644 index 0e795e8..0000000 --- a/vis/Code/Shaders.js +++ /dev/null @@ -1,275 +0,0 @@ -const TimelineVShader =`#version 300 es - -#define CANVAS_BORDER 1.0 -#define SAMPLE_HEIGHT 16.0 -#define SAMPLE_BORDER 1.0 -#define SAMPLE_Y_SPACING (SAMPLE_HEIGHT + SAMPLE_BORDER * 2.0) -#define SAMPLE_Y_OFFSET (CANVAS_BORDER + 1.0) - -struct Viewport -{ - float width; - float height; -}; - -struct TimeRange -{ - float usStart; - float usPerPixel; -}; - -struct Row -{ - float yOffset; -}; - -uniform Viewport inViewport; -uniform TimeRange inTimeRange; -uniform Row inRow; - -in vec4 inSample_TextOffset; -in vec4 inColour_TextLength; - -out vec4 varColour_TimeMs; -out vec4 varPosInBoxPx_TextEntry; -out float varTimeChars; - -//#define PIXEL_ROUNDED_OFFSETS - -float PixelOffset(float time_us) -{ - float offset = (time_us - inTimeRange.usStart) * inTimeRange.usPerPixel; - #ifdef PIXEL_ROUNDED_OFFSETS - return floor(offset); - #else - return offset; - #endif -} - -float PixelSize(float time_us) -{ - float size = time_us * inTimeRange.usPerPixel; - #ifdef PIXEL_ROUNDED_OFFSETS - return floor(size); - #else - return size; - #endif -} - -void main() -{ - // Unpack input data - float us_start = inSample_TextOffset.x; - float us_length = inSample_TextOffset.y; - float depth = inSample_TextOffset.z; - float text_buffer_offset = inSample_TextOffset.w; - vec3 box_colour = inColour_TextLength.rgb; - float text_length_chars = inColour_TextLength.w; - - // Determine pixel range of the sample - float x0 = PixelOffset(us_start); - float x1 = x0 + PixelSize(us_length); - - // Calculate box to render - float offset_x = x0; - float offset_y = inRow.yOffset + SAMPLE_Y_OFFSET + (depth - 1.0) * SAMPLE_Y_SPACING; - float size_x = max(x1 - x0, 1.0); - float size_y = SAMPLE_HEIGHT; - - // Box range - float min_x = offset_x; - float min_y = offset_y; - float max_x = offset_x + size_x; - float max_y = offset_y + size_y; - - // Quad indices are: - // - // 2 3 - // +----+ - // | | - // +----+ - // 0 1 - // - vec2 position; - position.x = (gl_VertexID & 1) == 0 ? min_x : max_x; - position.y = (gl_VertexID & 2) == 0 ? min_y : max_y; - - // - // NDC is: - // -1 to 1, left to right - // -1 to 1, bottom to top - // - vec4 ndc_pos; - ndc_pos.x = (position.x / inViewport.width) * 2.0 - 1.0; - ndc_pos.y = 1.0 - (position.y / inViewport.height) * 2.0; - ndc_pos.z = 0.0; - ndc_pos.w = 1.0; - - // Calculate number of characters required to display the millisecond time - float time_ms = us_length / 1000.0; - float time_ms_int = floor(time_ms); - float time_chars = time_ms_int == 0.0 ? 1.0 : floor(log(time_ms_int) / 2.302585092994046) + 1.0; - - gl_Position = ndc_pos; - - varColour_TimeMs = vec4(box_colour / 255.0, time_ms); - varPosInBoxPx_TextEntry = vec4(position.x - offset_x, position.y - offset_y, text_buffer_offset, text_length_chars); - varTimeChars = time_chars; -} -`; - -const TimelineFShader = `#version 300 es - -precision mediump float; - -#define SAMPLE_HEIGHT 16.0 - -struct TextBufferDesc -{ - float fontWidth; - float fontHeight; - float textBufferLength; -}; - -uniform sampler2D inFontAtlasTextre; -uniform sampler2D inTextBuffer; -uniform TextBufferDesc inTextBufferDesc; - -in vec4 varColour_TimeMs; -in vec4 varPosInBoxPx_TextEntry; -in float varTimeChars; - -out vec4 outColour; - -vec4 LookupCharacter(float char_ascii, float pos_x, float pos_y, float font_width_px, float font_height_px) -{ - // 2D index of the ASCII character in the font atlas - float char_index_y = floor(char_ascii / 16.0); - float char_index_x = char_ascii - char_index_y * 16.0; - - // Start UV of the character in the font atlas - float char_base_uv_x = char_index_x / 16.0; - float char_base_uv_y = char_index_y / 16.0; - - // UV within the character itself, scaled to the font atlas - float char_uv_x = pos_x / (font_width_px * 16.0); - float char_uv_y = pos_y / (font_height_px * 16.0); - - vec2 uv; - uv.x = char_base_uv_x + char_uv_x; - uv.y = char_base_uv_y + char_uv_y; - - // Apply colour to the text in premultiplied alpha space - vec4 t = texture(inFontAtlasTextre, uv); - vec3 colour = vec3(1.0, 1.0, 1.0) * 0.25; - return vec4(colour * t.a, t.a); -} - -void main() -{ - // Font description - float font_width_px = inTextBufferDesc.fontWidth; - float font_height_px = inTextBufferDesc.fontHeight; - float text_buffer_length = inTextBufferDesc.textBufferLength; - - // Text range in the text buffer - vec2 pos_in_box_px = varPosInBoxPx_TextEntry.xy; - float text_buffer_offset = varPosInBoxPx_TextEntry.z; - float text_length_chars = varPosInBoxPx_TextEntry.w; - float text_length_px = text_length_chars * font_width_px; - - // Text placement offset within the box - const vec2 text_offset_px = vec2(4.0, 3.0); - - vec4 box_colour = vec4(varColour_TimeMs.rgb, 1.0); - - // Add a subtle border to the box so that you can visually separate samples when they are next to each other - vec2 top_left = min(pos_in_box_px.xy, 2.0); - float both = min(top_left.x, top_left.y); - box_colour.rgb *= (0.8 + both * 0.1); - - vec4 text_colour = vec4(0.0); - - float text_end_px = text_length_px + text_offset_px.x + font_width_px; - float time_length_px = (varTimeChars + 4.0) * font_width_px; - if (pos_in_box_px.x > text_end_px && pos_in_box_px.x < text_end_px + time_length_px) - { - float time_ms = varColour_TimeMs.w; - - vec2 time_pixel_pos; - time_pixel_pos.x = max(min(pos_in_box_px.x - text_end_px, time_length_px), 0.0); - time_pixel_pos.y = max(min(pos_in_box_px.y - text_offset_px.y, font_height_px - 1.0), 0.0); - - float time_index = floor(time_pixel_pos.x / font_width_px); - if (time_index < varTimeChars) - { - // Use base-10 integer digit counting to calculate the divisor needed to bring this digit below 10 - float time_divisor = 1.0; - for (int i = 0; i < int(varTimeChars - time_index - 1.0); i++) - { - time_divisor *= 10.0; - } - - // Calculate digit - float time_shifted_int = floor(time_ms / time_divisor); - float time_digit = floor(mod(time_shifted_int, 10.0)); - - text_colour = LookupCharacter(48.0 + time_digit, - time_pixel_pos.x - time_index * font_width_px, - time_pixel_pos.y, - font_width_px, font_height_px); - } - else if (time_index == varTimeChars) - { - text_colour = LookupCharacter(46.0, - time_pixel_pos.x - time_index * font_width_px, - time_pixel_pos.y, - font_width_px, font_height_px); - } - else if (time_index == varTimeChars + 1.0) - { - float time_digit = floor(mod(time_ms * 10.0, 10.0)); - text_colour = LookupCharacter(48.0 + time_digit, - time_pixel_pos.x - time_index * font_width_px, - time_pixel_pos.y, - font_width_px, font_height_px); - } - else if (time_index == varTimeChars + 2.0) - { - float time_digit = floor(mod(time_ms * 10.0, 10.0)); - text_colour = LookupCharacter(109.0, - time_pixel_pos.x - time_index * font_width_px, - time_pixel_pos.y, - font_width_px, font_height_px); - } - else if (time_index == varTimeChars + 3.0) - { - float time_digit = floor(mod(time_ms * 10.0, 10.0)); - text_colour = LookupCharacter(115.0, time_pixel_pos.x - time_index * font_width_px, time_pixel_pos.y, font_width_px, font_height_px); - } - } - else - { - // Text pixel position clamped to the bounds of the full word, allowing leakage to neighbouring NULL characters to pad zeroes - vec2 text_pixel_pos; - text_pixel_pos.x = max(min(pos_in_box_px.x - text_offset_px.x, text_length_px), -1.0); - text_pixel_pos.y = max(min(pos_in_box_px.y - text_offset_px.y, font_height_px - 1.0), 0.0); - - // Index of the current character in the text buffer - float text_index = text_buffer_offset + floor(text_pixel_pos.x / font_width_px); - - // Sample the 1D text buffer to get the ASCII character index - vec2 char_uv = vec2((text_index + 0.5) / text_buffer_length, 0.5); - float char_ascii = texture(inTextBuffer, char_uv).a * 255.0; - - text_colour = LookupCharacter(char_ascii, - text_pixel_pos.x - (text_index - text_buffer_offset) * font_width_px, - text_pixel_pos.y, - font_width_px, font_height_px); - } - - // Bring out of premultiplied alpha space and lerp with the box colour - float inv_alpha = text_colour.a == 0.0 ? 1.0 : 1.0 / text_colour.a; - outColour = mix(box_colour, vec4(text_colour.rgb * inv_alpha, 1.0), text_colour.a); -} -`; diff --git a/vis/Code/ThreadFrame.js b/vis/Code/ThreadFrame.js deleted file mode 100644 index 675f469..0000000 --- a/vis/Code/ThreadFrame.js +++ /dev/null @@ -1,29 +0,0 @@ - - -ThreadFrame = (function() -{ - function ThreadFrame(message) - { - // Persist the required message data - this.NbSamples = message.nb_samples; - this.SampleDigest = message.sample_digest; - this.Samples = message.samples; - this.PartialTree = message.partial_tree > 0 ? true : false; - - // Calculate the frame start/end times - this.StartTime_us = 0; - this.EndTime_us = 0; - var nb_root_samples = this.Samples.length; - if (nb_root_samples > 0) - { - var last_sample = this.Samples[nb_root_samples - 1]; - this.StartTime_us = this.Samples[0].us_start; - this.EndTime_us = last_sample.us_start + last_sample.us_length; - } - - this.Length_us = this.EndTime_us - this.StartTime_us; - } - - - return ThreadFrame; -})(); diff --git a/vis/Code/TimelineMarkers.js b/vis/Code/TimelineMarkers.js deleted file mode 100644 index 9054916..0000000 --- a/vis/Code/TimelineMarkers.js +++ /dev/null @@ -1,186 +0,0 @@ - -function GetTimeText(seconds) -{ - if (seconds < 0) - { - return ""; - } - - var text = ""; - - // Add any contributing hours - var h = Math.floor(seconds / 3600); - seconds -= h * 3600; - if (h) - { - text += h + "h "; - } - - // Add any contributing minutes - var m = Math.floor(seconds / 60); - seconds -= m * 60; - if (m) - { - text += m + "m "; - } - - // Add any contributing seconds or always add seconds when hours or minutes have no contribution - // This ensures the 0s marker displays - var s = Math.floor(seconds); - seconds -= s; - if (s || text == "") - { - text += s + "s "; - } - - // Add remaining milliseconds - var ms = Math.floor(seconds * 1000); - if (ms) - { - text += ms + "ms"; - } - - return text; -} - - -class TimelineMarkers -{ - constructor(timeline) - { - this.timeline = timeline; - - // Need a 2D drawing context - this.markerContainer = timeline.Window.AddControlNew(new WM.Container(10, 10, 10, 10)); - this.markerCanvas = document.createElement("canvas"); - this.markerContainer.Node.appendChild(this.markerCanvas); - this.markerContext = this.markerCanvas.getContext("2d"); - } - - Draw(time_range) - { - let ctx = this.markerContext; - - ctx.clearRect(0, 0, this.markerCanvas.width, this.markerCanvas.height); - - // Setup render state for the time line markers - ctx.strokeStyle = "#BBB"; - ctx.fillStyle = "#BBB"; - ctx.lineWidth = 1; - ctx.font = "9px LocalFiraCode"; - - // A list of all supported units of time (measured in seconds) that require markers - let units = [ 0.001, 0.01, 0.1, 1, 10, 60, 60 * 5, 60 * 60, 60 * 60 * 24 ]; - - // Given the current pixel size of a second, calculate the spacing for each unit marker - let second_pixel_size = time_range.PixelSize(1000 * 1000); - let sizeof_units = [ ]; - for (let unit of units) - { - sizeof_units.push(unit * second_pixel_size); - } - - // Calculate whether each unit marker is visible at the current zoom level - var show_unit = [ ]; - for (let sizeof_unit of sizeof_units) - { - show_unit.push(Math.max(Math.min((sizeof_unit - 4) * 0.25, 1), 0)); - } - - // Find the first visible unit - for (let i = 0; i < units.length; i++) - { - if (show_unit[i] > 0) - { - // Cut out unit information for the first set of units not visible - units = units.slice(i); - sizeof_units = sizeof_units.slice(i); - show_unit = show_unit.slice(i); - break; - } - } - - let timeline_end = this.markerCanvas.width; - for (let i = 0; i < 3; i++) - { - // Round the start time up to the next visible unit - let time_start = time_range.Start_us / (1000 * 1000); - let unit_time_start = Math.ceil(time_start / units[i]) * units[i]; - - // Calculate the canvas offset required to step to the first visible unit - let pre_step_x = time_range.PixelOffset(unit_time_start * (1000 * 1000)); - - // Draw lines for every unit at this level, keeping tracking of the seconds - var seconds = unit_time_start; - for (let x = pre_step_x; x <= timeline_end; x += sizeof_units[i]) - { - // For the first two units, don't draw the units above it to prevent - // overdraw and the visual errors that causes - // The last unit always draws - if (i > 1 || (seconds % units[i + 1])) - { - // Only the first two units scale with unit visibility - // The last unit maintains its size - let height = Math.min(i * 4 + 4 * show_unit[i], 16); - - // Draw the line on an integer boundary, shifted by 0.5 to get an un-anti-aliased 1px line - let ix = Math.floor(x); - ctx.beginPath(); - ctx.moveTo(ix + 0.5, 1); - ctx.lineTo(ix + 0.5, 1 + height); - ctx.stroke(); - } - - seconds += units[i]; - } - - if (i == 1) - { - // Draw text labels for the second unit, fading them out as they slowly - // become the first unit - ctx.globalAlpha = show_unit[0]; - var seconds = unit_time_start; - for (let x = pre_step_x; x <= timeline_end; x += sizeof_units[i]) - { - if (seconds % units[2]) - { - this.DrawTimeText(seconds, x, 16); - } - seconds += units[i]; - } - - // Restore alpha - ctx.globalAlpha = 1; - } - - else if (i == 2) - { - // Draw text labels for the third unit with no fade - var seconds = unit_time_start; - for (let x = pre_step_x; x <= timeline_end; x += sizeof_units[i]) - { - this.DrawTimeText(seconds, x, 16); - seconds += units[i]; - } - } - } - } - - DrawTimeText(seconds, x, y) - { - // Use text measuring to centre the text horizontally on the input x - var text = GetTimeText(seconds); - var width = this.markerContext.measureText(text).width; - this.markerContext.fillText(text, Math.floor(x) - width / 2, y); - } - - Resize(x, y, w, h) - { - this.markerContainer.SetPosition(x, y); - this.markerContainer.SetSize(w, h); - - // Match canvas size to container - this.markerCanvas.width = this.markerContainer.Node.clientWidth; - this.markerCanvas.height = this.markerContainer.Node.clientHeight; - } -} \ No newline at end of file diff --git a/vis/Code/TimelineRow.js b/vis/Code/TimelineRow.js deleted file mode 100644 index 562298b..0000000 --- a/vis/Code/TimelineRow.js +++ /dev/null @@ -1,389 +0,0 @@ - - -TimelineRow = (function() -{ - const RowLabelTemplate = ` -
-
- -
-
-
+
-
-
-
-
-
-
-
-
` - - - var CANVAS_BORDER = 1; - var SAMPLE_HEIGHT = 16; - var SAMPLE_BORDER = 1; - var SAMPLE_Y_SPACING = SAMPLE_HEIGHT + SAMPLE_BORDER * 2; - - - function TimelineRow(gl, name, timeline, frame_history, check_handler) - { - this.Name = name; - this.timeline = timeline; - - // Create the row HTML and add to the parent - this.LabelContainerNode = DOM.Node.CreateHTML(RowLabelTemplate); - const label_node = DOM.Node.FindWithClass(this.LabelContainerNode, "TimelineRowLabel"); - label_node.innerHTML = name; - timeline.TimelineLabels.Node.appendChild(this.LabelContainerNode); - - // All sample view windows visible by default - const checkbox_node = DOM.Node.FindWithClass(this.LabelContainerNode, "TimelineRowCheckbox"); - checkbox_node.checked = true; - checkbox_node.addEventListener("change", (e) => check_handler(name, e)); - - // Manually hook-up events to simulate div:active - // I can't get the equivalent CSS to work in Firefox, so... - const expand_node_0 = DOM.Node.FindWithClass(this.LabelContainerNode, "TimelineRowExpand", 0); - const expand_node_1 = DOM.Node.FindWithClass(this.LabelContainerNode, "TimelineRowExpand", 1); - const inc_node = DOM.Node.FindWithClass(expand_node_0, "TimelineRowExpandButton"); - const dec_node = DOM.Node.FindWithClass(expand_node_1, "TimelineRowExpandButton"); - inc_node.addEventListener("mousedown", ExpandButtonDown); - inc_node.addEventListener("mouseup", ExpandButtonUp); - inc_node.addEventListener("mouseleave", ExpandButtonUp); - dec_node.addEventListener("mousedown", ExpandButtonDown); - dec_node.addEventListener("mouseup", ExpandButtonUp); - dec_node.addEventListener("mouseleave", ExpandButtonUp); - - // Pressing +/i increases/decreases depth - inc_node.addEventListener("click", () => this.IncDepth()); - dec_node.addEventListener("click", () => this.DecDepth()); - - // Frame index to start at when looking for first visible sample - this.StartFrameIndex = 0; - - this.FrameHistory = frame_history; - this.VisibleFrames = [ ]; - this.VisibleTimeRange = null; - this.Depth = 1; - - // Currently selected sample - this.SelectSampleInfo = null; - - // Create WebGL sample buffers - this.sampleBuffer = new glDynamicBuffer(gl, gl.FLOAT, 4, 8); - this.colourBuffer = new glDynamicBuffer(gl, gl.FLOAT, 4, 8); - - // Create a vertex array for these buffers - this.vertexArrayObject = gl.createVertexArray(); - gl.bindVertexArray(this.vertexArrayObject); - this.sampleBuffer.BindAsInstanceAttribute(timeline.Program, "inSample_TextOffset"); - this.colourBuffer.BindAsInstanceAttribute(timeline.Program, "inColour_TextLength"); - - // An initial SetSize call to restore containers to their original size after traces were loaded prior to this - this.SetSize(); - } - - - TimelineRow.prototype.SetSize = function() - { - this.LabelContainerNode.style.height = CANVAS_BORDER + SAMPLE_BORDER + SAMPLE_Y_SPACING * this.Depth; - } - - - TimelineRow.prototype.SetVisibleFrames = function(time_range) - { - // Clear previous visible list - this.VisibleFrames = [ ]; - if (this.FrameHistory.length == 0) - return; - - // Store a copy of the visible time range rather than referencing it - // This prevents external modifications to the time range from affecting rendering/selection - time_range = time_range.Clone(); - this.VisibleTimeRange = time_range; - - // The frame history can be reset outside this class - // This also catches the overflow to the end of the frame list below when a thread stops sending samples - var max_frame = Math.max(this.FrameHistory.length - 1, 0); - var start_frame_index = Math.min(this.StartFrameIndex, max_frame); - - // First do a back-track in case the time range moves negatively - while (start_frame_index > 0) - { - var frame = this.FrameHistory[start_frame_index]; - if (time_range.Start_us > frame.StartTime_us) - break; - start_frame_index--; - } - - // Then search from this point for the first visible frame - while (start_frame_index < this.FrameHistory.length) - { - var frame = this.FrameHistory[start_frame_index]; - if (frame.EndTime_us > time_range.Start_us) - break; - start_frame_index++; - } - - // Gather all frames up to the end point - this.StartFrameIndex = start_frame_index; - for (var i = start_frame_index; i < this.FrameHistory.length; i++) - { - var frame = this.FrameHistory[i]; - if (frame.StartTime_us > time_range.End_us) - break; - this.VisibleFrames.push(frame); - } - } - - - TimelineRow.prototype.DrawSampleHighlight = function(sample, depth, colour, y_scroll_offset) - { - if (depth <= this.Depth) - { - // Determine pixel range of the sample - var x0 = this.VisibleTimeRange.PixelOffset(sample.us_start); - var x1 = x0 + this.VisibleTimeRange.PixelSize(sample.us_length); - - var offset_x = x0; - var offset_y = this.LabelContainerNode.offsetTop + 2 + (depth - 1) * SAMPLE_Y_SPACING + y_scroll_offset; - var size_x = x1 - x0; - var size_y = SAMPLE_HEIGHT; - - // Normal rendering - var ctx = this.timeline.drawContext; - ctx.lineWidth = 2; - ctx.strokeStyle = colour; - ctx.strokeRect(offset_x + 2.5, offset_y - 0.5, size_x - 3, size_y + 1); - } - } - - - TimelineRow.prototype.DisplayHeight = function() - { - return this.LabelContainerNode.clientHeight; - } - - - TimelineRow.prototype.YOffset = function() - { - return this.LabelContainerNode.offsetTop; - } - - - TimelineRow.prototype.DrawBackground = function(hover_sample_info, y_scroll_offset) - { - // Fill box that shows the boundary between thread rows - this.timeline.drawContext.fillStyle = "#444" - var b = CANVAS_BORDER; - this.timeline.drawContext.fillRect(b, this.YOffset() + y_scroll_offset + b, this.timeline.drawCanvas.width - b * 2, this.DisplayHeight() - b * 2); - - // Draw the selected sample for this row - if (this.SelectSampleInfo != null) - { - const sample = this.SelectSampleInfo[1]; - const depth = this.SelectSampleInfo[2]; - this.DrawSampleHighlight(sample, depth, "#FF0000", y_scroll_offset); - } - - // Draw the current hover sample if it's over this row - if (hover_sample_info != null && hover_sample_info[3] == this) - { - const sample = hover_sample_info[1]; - const depth = hover_sample_info[2]; - const thread_row = hover_sample_info[3]; - this.DrawSampleHighlight(sample, depth, "#FFFFFF", y_scroll_offset); - } - } - - - TimelineRow.prototype.Draw = function(gl, draw_text, y_scroll_offset) - { - let samples_per_depth = []; - - // Gather all root samples in the visible frame set - for (var i in this.VisibleFrames) - { - var frame = this.VisibleFrames[i]; - GatherSamples(this, frame.Samples, 1, draw_text, samples_per_depth); - } - - // Count number of samples required - let nb_samples = 0; - for (const samples_this_depth of samples_per_depth) - { - nb_samples += samples_this_depth.length; - } - - // Resize buffers to match any new count of samples - if (nb_samples > this.sampleBuffer.nbEntries) - { - this.sampleBuffer.ResizeToFitNextPow2(nb_samples); - this.colourBuffer.ResizeToFitNextPow2(nb_samples); - - // Have to create a new VAO for these buffers - this.vertexArrayObject = gl.createVertexArray(); - gl.bindVertexArray(this.vertexArrayObject); - this.sampleBuffer.BindAsInstanceAttribute(this.timeline.Program, "inSample_TextOffset"); - this.colourBuffer.BindAsInstanceAttribute(this.timeline.Program, "inColour_TextLength"); - } - - // CPU write destination for samples - let cpu_samples = this.sampleBuffer.cpuArray; - let cpu_colours = this.colourBuffer.cpuArray; - let sample_pos = 0; - - const empty_text_entry = { - offset: 0, - length: 1, - }; - - // Copy samples to the CPU buffer - // TODO(don): Use a ring buffer instead and take advantage of timeline scrolling adding new samples at the beginning/end - for (let depth = 0; depth < samples_per_depth.length; depth++) - { - let samples_this_depth = samples_per_depth[depth]; - for (const sample of samples_this_depth) - { - const text_entry = sample.name.textEntry != null ? sample.name.textEntry : empty_text_entry; - - cpu_samples[sample_pos + 0] = sample.us_start; - cpu_samples[sample_pos + 1] = sample.us_length; - cpu_samples[sample_pos + 2] = depth; - cpu_samples[sample_pos + 3] = text_entry.offset; - - cpu_colours[sample_pos + 0] = sample.rgbColour[0]; - cpu_colours[sample_pos + 1] = sample.rgbColour[1]; - cpu_colours[sample_pos + 2] = sample.rgbColour[2]; - cpu_colours[sample_pos + 3] = text_entry.length; - - sample_pos += 4; - } - } - - // Upload to GPU - this.sampleBuffer.UploadData(); - this.colourBuffer.UploadData(); - this.timeline.textBuffer.UploadData(); - - // Set row parameters - glSetUniform(gl, this.timeline.Program, "inRow.yOffset", this.YOffset() + y_scroll_offset); - - gl.bindVertexArray(this.vertexArrayObject); - gl.drawArraysInstanced(gl.TRIANGLE_STRIP, 0, 4, nb_samples); - } - - - function GatherSamples(self, samples, depth, draw_text, samples_per_depth) - { - // Ensure there's enough entries for each depth - while (depth >= samples_per_depth.length) - { - samples_per_depth.push([]); - } - let samples_this_depth = samples_per_depth[depth]; - - for (var i in samples) - { - var sample = samples[i]; - samples_this_depth.push(sample); - - if (depth < self.Depth && sample.children != null) - GatherSamples(self, sample.children, depth + 1, draw_text, samples_per_depth); - } - } - - - TimelineRow.prototype.SetSelectSample = function(sample_info) - { - this.SelectSampleInfo = sample_info; - } - - - function ExpandButtonDown(evt) - { - var node = DOM.Event.GetNode(evt); - DOM.Node.AddClass(node, "TimelineRowExpandButtonActive"); - } - - - function ExpandButtonUp(evt) - { - var node = DOM.Event.GetNode(evt); - DOM.Node.RemoveClass(node, "TimelineRowExpandButtonActive"); - } - - - TimelineRow.prototype.IncDepth = function() - { - this.Depth++; - this.SetSize(); - this.timeline.DrawAllRows(); - } - - - TimelineRow.prototype.DecDepth = function() - { - if (this.Depth > 1) - { - this.Depth--; - this.SetSize(); - - // Trigger scroll handling to ensure reducing the depth reduces the display height - this.timeline.ScrollVertically(0); - - this.timeline.DrawAllRows(); - } - } - - - TimelineRow.prototype.GetSampleAtPosition = function(time_us, mouse_y) - { - // Calculate depth of the mouse cursor - var depth = Math.min(Math.floor(mouse_y / SAMPLE_Y_SPACING) + 1, this.Depth); - - // Search for the first frame to intersect this time - for (var i in this.VisibleFrames) - { - // Use the sample's closed interval to detect hits. - // Rendering of samples ensures a sample is never smaller than one pixel so that all samples always draw, irrespective - // of zoom level. If a half-open interval is used then some visible samples will be unselectable due to them being - // smaller than a pixel. This feels pretty odd and the closed interval fixes this feeling well. - // TODO(don): There are still inconsistencies, need to shift to pixel range checking to match exactly. - var frame = this.VisibleFrames[i]; - if (time_us >= frame.StartTime_us && time_us <= frame.EndTime_us) - { - var found_sample = FindSample(this, frame.Samples, time_us, depth, 1); - if (found_sample != null) - return [ frame, found_sample[0], found_sample[1], this ]; - } - } - - return null; - } - - - function FindSample(self, samples, time_us, target_depth, depth) - { - for (var i in samples) - { - var sample = samples[i]; - if (depth == target_depth) - { - if (time_us >= sample.us_start && time_us < sample.us_start + sample.us_length) - return [ sample, depth ]; - } - - else if (depth < target_depth && sample.children != null) - { - var found_sample = FindSample(self, sample.children, time_us, target_depth, depth + 1); - if (found_sample != null) - return found_sample; - } - } - - return null; - } - - - return TimelineRow; -})(); diff --git a/vis/Code/TimelineWindow.js b/vis/Code/TimelineWindow.js deleted file mode 100644 index 87a723e..0000000 --- a/vis/Code/TimelineWindow.js +++ /dev/null @@ -1,494 +0,0 @@ - -// TODO(don): Separate all knowledge of threads from this timeline - -TimelineWindow = (function() -{ - var BORDER = 10; - - function TimelineWindow(wm, name, settings, check_handler) - { - this.Settings = settings; - - // Create timeline window - this.Window = wm.AddWindow("Timeline", 10, 20, 100, 100); - this.Window.SetTitle(name); - this.Window.ShowNoAnim(); - - this.timelineMarkers = new TimelineMarkers(this); - - // DO THESE need to be containers... can they just be divs? - // divs need a retrieval function - this.TimelineLabelScrollClipper = this.Window.AddControlNew(new WM.Container(10, 10, 10, 10)); - DOM.Node.AddClass(this.TimelineLabelScrollClipper.Node, "TimelineLabelScrollClipper"); - this.TimelineLabels = this.TimelineLabelScrollClipper.AddControlNew(new WM.Container(0, 0, 10, 10)); - DOM.Node.AddClass(this.TimelineLabels.Node, "TimelineLabels"); - - // Ordered list of thread rows on the timeline - this.ThreadRows = [ ]; - - // Create timeline container - this.TimelineContainer = this.Window.AddControlNew(new WM.Container(10, 10, 800, 160)); - DOM.Node.AddClass(this.TimelineContainer.Node, "TimelineContainer"); - - var mouse_wheel_event = (/Firefox/i.test(navigator.userAgent)) ? "DOMMouseScroll" : "mousewheel"; - DOM.Event.AddHandler(this.TimelineContainer.Node, mouse_wheel_event, Bind(OnMouseScroll, this)); - - // Setup timeline manipulation - this.MouseDown = false; - this.LastMouseState = null; - this.TimelineMoved = false; - DOM.Event.AddHandler(this.TimelineContainer.Node, "mousedown", Bind(OnMouseDown, this)); - DOM.Event.AddHandler(this.TimelineContainer.Node, "mouseup", Bind(OnMouseUp, this)); - DOM.Event.AddHandler(this.TimelineContainer.Node, "mousemove", Bind(OnMouseMove, this)); - DOM.Event.AddHandler(this.TimelineContainer.Node, "mouseleave", Bind(OnMouseLeave, this)); - - // Create a canvas for timeline 2D rendering - // TODO(don): Port this to shaders - this.drawCanvas = document.createElement("canvas"); - this.drawCanvas.width = this.TimelineContainer.Node.clientWidth; - this.drawCanvas.height = this.TimelineContainer.Node.clientHeight; - this.TimelineContainer.Node.appendChild(this.drawCanvas); - this.drawContext = this.drawCanvas.getContext("2d"); - - // Create a canvas for timeline 3D accelerated rendering - this.glCanvas = document.createElement("canvas"); - this.glCanvas.width = this.TimelineContainer.Node.clientWidth; - this.glCanvas.height = this.TimelineContainer.Node.clientHeight; - this.TimelineContainer.Node.appendChild(this.glCanvas); - - // OVERLAY - add to CSS - this.glCanvas.style.position = "absolute"; - this.glCanvas.style.top = 0; - this.glCanvas.style.left = 0; - - // For now a gl context per timeline - let gl = this.glCanvas.getContext("webgl2"); - this.gl = gl; - - const vshader = glCompileShader(gl, gl.VERTEX_SHADER, "TimelineVShader", TimelineVShader); - const fshader = glCompileShader(gl, gl.FRAGMENT_SHADER, "TimelineFShader", TimelineFShader); - this.Program = glCreateProgram(gl, vshader, fshader); - - this.font = new glFont(gl); - this.textBuffer = new glTextBuffer(gl, this.font); - - this.Window.SetOnResize(Bind(OnUserResize, this)); - - this.Clear(); - - this.OnHoverHandler = null; - this.OnSelectedHandler = null; - this.OnMovedHandler = null; - this.CheckHandler = check_handler; - - this.yScrollOffset = 0; - - this.HoverSampleInfo = null; - } - - - TimelineWindow.prototype.Clear = function() - { - // Clear out labels - this.TimelineLabels.ClearControls(); - - this.ThreadRows = [ ]; - this.TimeRange = new PixelTimeRange(0, 200 * 1000, this.TimelineContainer.Node.clientWidth); - } - - - TimelineWindow.prototype.SetOnHover = function(handler) - { - this.OnHoverHandler = handler; - } - - - TimelineWindow.prototype.SetOnSelected = function(handler) - { - this.OnSelectedHandler = handler; - } - - - TimelineWindow.prototype.SetOnMoved = function(handler) - { - this.OnMovedHandler = handler; - } - - - TimelineWindow.prototype.WindowResized = function(x, width, top_window) - { - // Resize window - var top = top_window.Position[1] + top_window.Size[1] + 10; - this.Window.SetPosition(x, top); - this.Window.SetSize(width - 2 * 10, 260); - - ResizeInternals(this); - } - - - TimelineWindow.prototype.OnSamples = function(thread_name, frame_history) - { - // Shift the timeline to the last entry on this thread - // As multiple threads come through here with different end frames, only do this for the latest - var last_frame = frame_history[frame_history.length - 1]; - if (last_frame.EndTime_us > this.TimeRange.End_us) - this.TimeRange.SetEnd(last_frame.EndTime_us); - - // Search for the index of this thread - var thread_index = -1; - for (var i in this.ThreadRows) - { - if (this.ThreadRows[i].Name == thread_name) - { - thread_index = i; - break; - } - } - - // If this thread has not been seen before, add a new row to the list and re-sort - if (thread_index == -1) - { - var row = new TimelineRow(this.gl, thread_name, this, frame_history, this.CheckHandler); - this.ThreadRows.push(row); - } - } - - - TimelineWindow.prototype.DrawBackground = function() - { - // TODO(don): Port all this lot to shader, maybe... it's not performance sensitive - - this.drawContext.clearRect(0, 0, this.drawCanvas.width, this.drawCanvas.height); - - // Draw thread row backgrounds - for (let thread_row of this.ThreadRows) - { - thread_row.DrawBackground(this.HoverSampleInfo, this.yScrollOffset); - } - - this.timelineMarkers.Draw(this.TimeRange); - } - - - TimelineWindow.prototype.DrawAllRows = function() - { - let gl = this.gl; - - gl.viewport(0, 0, gl.canvas.width, gl.canvas.height); - - gl.useProgram(this.Program); - - // Set viewport parameters - glSetUniform(gl, this.Program, "inViewport.width", gl.canvas.width); - glSetUniform(gl, this.Program, "inViewport.height", gl.canvas.height); - - // Set time range parameters - const time_range = this.TimeRange; - time_range.SetAsUniform(gl, this.Program); - - // Set text rendering resources - // Note it might not be loaded yet so we need the null check - if (this.font.atlasTexture != null) - { - glSetUniform(gl, this.Program, "inFontAtlasTextre", this.font.atlasTexture, 0); - this.textBuffer.SetAsUniform(gl, this.Program, "inTextBuffer", 1); - } - - const draw_text = this.Settings.IsPaused; - for (let i in this.ThreadRows) - { - var thread_row = this.ThreadRows[i]; - thread_row.SetVisibleFrames(time_range); - thread_row.Draw(gl, draw_text, this.yScrollOffset); - } - - // Render last so that each thread row uses any new time ranges - this.DrawBackground(); - } - - - function OnUserResize(self, evt) - { - ResizeInternals(self); - } - - function ResizeInternals(self) - { - // .TimelineRowLabel - // .TimelineRowExpand - // .TimelineRowExpand - // .TimelineRowCheck - // Window padding - let offset_x = 145+19+19+19+10; - - let MarkersHeight = 18; - - var parent_size = self.Window.Size; - - self.timelineMarkers.Resize(BORDER + offset_x, 10, parent_size[0] - 2* BORDER - offset_x, MarkersHeight); - - // Resize controls - self.TimelineContainer.SetPosition(BORDER + offset_x, 10 + MarkersHeight); - self.TimelineContainer.SetSize(parent_size[0] - 2 * BORDER - offset_x, parent_size[1] - MarkersHeight - 40); - - self.TimelineLabelScrollClipper.SetPosition(10, 10 + MarkersHeight); - self.TimelineLabelScrollClipper.SetSize(offset_x, parent_size[1] - MarkersHeight - 40); - self.TimelineLabels.SetSize(offset_x, parent_size[1] - MarkersHeight - 40); - - // Match canvas size to container - const width = self.TimelineContainer.Node.clientWidth; - const height = self.TimelineContainer.Node.clientHeight; - self.drawCanvas.width = width; - self.drawCanvas.height = height; - self.glCanvas.width = width; - self.glCanvas.height = height; - - // Adjust time range to new width - self.TimeRange.SetPixelSpan(width); - self.DrawAllRows(); - } - - - function OnMouseScroll(self, evt) - { - let mouse_state = new Mouse.State(evt); - let scale = 1.11; - if (mouse_state.WheelDelta > 0) - scale = 1 / scale; - - // What time is the mouse hovering over? - let mouse_pos = self.TimelineMousePosition(mouse_state); - let time_us = self.TimeRange.TimeAtPosition(mouse_pos[0]); - - // Calculate start time relative to the mouse hover position - var time_start_us = self.TimeRange.Start_us - time_us; - - // Scale and offset back to the hover time - self.TimeRange.Set(time_start_us * scale + time_us, self.TimeRange.Span_us * scale); - self.DrawAllRows(); - - if (self.OnMovedHandler) - { - self.OnMovedHandler(self); - } - - // Prevent vertical scrolling on mouse-wheel - DOM.Event.StopDefaultAction(evt); - } - - - TimelineWindow.prototype.SetTimeRange = function(start_us, span_us) - { - this.TimeRange.Set(start_us, span_us); - } - - - TimelineWindow.prototype.DisplayHeight = function() - { - // Sum height of each thread row - let height = 0; - for (thread_row of this.ThreadRows) - { - height += thread_row.DisplayHeight(); - } - - return height; - } - - - TimelineWindow.prototype.ScrollVertically = function(y_scroll) - { - // Calculate the minimum negative value the position of the labels can be to account for scrolling to the bottom - // of the label/depth list - let display_height = this.DisplayHeight(); - let container_height = this.TimelineLabelScrollClipper.Node.clientHeight; - let minimum_y = Math.min(container_height - display_height, 0.0); - - // Resize the label container to match the display height - this.TimelineLabels.Node.style.height = Math.max(display_height, container_height); - - // Increment the y-scroll using just-calculated limits - let old_y_scroll_offset = this.yScrollOffset; - this.yScrollOffset = Math.min(Math.max(this.yScrollOffset + y_scroll, minimum_y), 0); - - // Calculate how much the labels should actually scroll after limiting and apply - let y_scroll_px = this.yScrollOffset - old_y_scroll_offset; - this.TimelineLabels.Node.style.top = this.TimelineLabels.Node.offsetTop + y_scroll_px; - } - - - TimelineWindow.prototype.TimelineMousePosition = function(mouse_state) - { - // Position of the mouse relative to the timeline container - let node_offset = DOM.Node.GetPosition(this.TimelineContainer.Node); - let mouse_x = mouse_state.Position[0] - node_offset[0]; - let mouse_y = mouse_state.Position[1] - node_offset[1]; - - // Offset by the amount of scroll - mouse_y -= this.yScrollOffset; - - return [ mouse_x, mouse_y ]; - } - - - TimelineWindow.prototype.GetHoverThreadRow = function(mouse_pos) - { - // Search for the thread row the mouse intersects - let height = 0; - for (let thread_row of this.ThreadRows) - { - let row_height = thread_row.DisplayHeight(); - if (mouse_pos[1] >= height && mouse_pos[1] < height + row_height) - { - // Mouse y relative to row start - mouse_pos[1] -= height; - return thread_row; - } - height += row_height; - } - - return null; - } - - - function OnMouseDown(self, evt) - { - // Only manipulate the timeline when paused - if (!self.Settings.IsPaused) - return; - - self.MouseDown = true; - self.LastMouseState = new Mouse.State(evt); - self.TimelineMoved = false; - DOM.Event.StopDefaultAction(evt); - } - - - function OnMouseUp(self, evt) - { - // Only manipulate the timeline when paused - if (!self.Settings.IsPaused) - return; - - var mouse_state = new Mouse.State(evt); - - self.MouseDown = false; - - if (!self.TimelineMoved) - { - // Are we hovering over a thread row? - let mouse_pos = self.TimelineMousePosition(mouse_state); - let hover_thread_row = self.GetHoverThreadRow(mouse_pos); - if (hover_thread_row != null) - { - // Are we hovering over a sample? - let time_us = self.TimeRange.TimeAtPosition(mouse_pos[0]); - let sample_info = hover_thread_row.GetSampleAtPosition(time_us, mouse_pos[1]); - if (sample_info != null) - { - // Redraw with new select sample - hover_thread_row.SetSelectSample(sample_info); - self.DrawBackground(); - - // Call any selection handlers - if (self.OnSelectedHandler) - { - self.OnSelectedHandler(hover_thread_row.Name, sample_info); - } - } - } - } - } - - - function OnMouseMove(self, evt) - { - // Only manipulate the timeline when paused - if (!self.Settings.IsPaused) - return; - - var mouse_state = new Mouse.State(evt); - - if (self.MouseDown) - { - let movement = false; - - // Shift the visible time range with mouse movement - let time_offset_us = (mouse_state.Position[0] - self.LastMouseState.Position[0]) / self.TimeRange.usPerPixel; - if (time_offset_us != 0) - { - self.TimeRange.SetStart(self.TimeRange.Start_us - time_offset_us); - movement = true; - } - - // Control vertical movement - let y_offset_px = mouse_state.Position[1] - self.LastMouseState.Position[1]; - if (y_offset_px != 0) - { - self.ScrollVertically(y_offset_px); - movement = true; - } - - // Redraw everything if there is movement - if (movement) - { - self.DrawAllRows(); - self.TimelineMoved = true; - - if (self.OnMovedHandler) - { - self.OnMovedHandler(self); - } - } - } - - else - { - // Are we hovering over a thread row? - let mouse_pos = self.TimelineMousePosition(mouse_state); - let hover_thread_row = self.GetHoverThreadRow(mouse_pos); - if (hover_thread_row != null) - { - // Are we hovering over a sample? - let time_us = self.TimeRange.TimeAtPosition(mouse_pos[0]); - self.HoverSampleInfo = hover_thread_row.GetSampleAtPosition(time_us, mouse_pos[1]); - - // Tell listeners which sample we're hovering over - if (self.OnHoverHandler != null) - { - self.OnHoverHandler(hover_thread_row.Name, self.HoverSampleInfo); - } - } - else - { - self.HoverSampleInfo = null; - } - - // Redraw to update highlights - self.DrawBackground(); - } - - self.LastMouseState = mouse_state; - } - - - function OnMouseLeave(self, evt) - { - // Only manipulate the timeline when paused - if (!self.Settings.IsPaused) - return; - - // Cancel scrolling - self.MouseDown = false; - - // Cancel hovering - if (self.OnHoverHandler != null) - { - self.OnHoverHandler(null, null); - } - } - - - return TimelineWindow; -})(); - diff --git a/vis/Code/TitleWindow.js b/vis/Code/TitleWindow.js deleted file mode 100644 index bae31dd..0000000 --- a/vis/Code/TitleWindow.js +++ /dev/null @@ -1,105 +0,0 @@ - -TitleWindow = (function() -{ - function TitleWindow(wm, settings, server, connection_address) - { - this.Settings = settings; - - this.Window = wm.AddWindow("     Remotery", 10, 10, 100, 100); - this.Window.ShowNoAnim(); - - this.PingContainer = this.Window.AddControlNew(new WM.Container(4, -13, 10, 10)); - DOM.Node.AddClass(this.PingContainer.Node, "PingContainer"); - - this.EditBox = this.Window.AddControlNew(new WM.EditBox(10, 5, 300, 18, "Connection Address", connection_address)); - - // Setup pause button - this.PauseButton = this.Window.AddControlNew(new WM.Button("Pause", 5, 5, { toggle: true })); - this.PauseButton.SetOnClick(Bind(OnPausePressed, this)); - - this.SyncButton = this.Window.AddControlNew(new WM.Button("Sync Timelines", 5, 5, { toggle: true})); - this.SyncButton.SetOnClick(Bind(OnSyncPressed, this)); - this.SyncButton.SetState(this.Settings.SyncTimelines); - - server.AddMessageHandler("PING", Bind(OnPing, this)); - - this.Window.SetOnResize(Bind(OnUserResize, this)); - } - - - TitleWindow.prototype.SetConnectionAddressChanged = function(handler) - { - this.EditBox.SetChangeHandler(handler); - } - - - TitleWindow.prototype.WindowResized = function(width, height) - { - this.Window.SetSize(width - 2 * 10, 50); - ResizeInternals(this); - } - - TitleWindow.prototype.Pause = function() - { - if (!this.Settings.IsPaused) - { - this.PauseButton.SetText("Paused"); - this.PauseButton.SetState(true); - this.Settings.IsPaused = true; - } - } - - TitleWindow.prototype.Unpause = function() - { - if (this.Settings.IsPaused) - { - this.PauseButton.SetText("Pause"); - this.PauseButton.SetState(false); - this.Settings.IsPaused = false; - } - } - - function OnUserResize(self, evt) - { - ResizeInternals(self); - } - - function ResizeInternals(self) - { - self.PauseButton.SetPosition(self.Window.Size[0] - 60, 5); - self.SyncButton.SetPosition(self.Window.Size[0] - 155, 5); - } - - - function OnPausePressed(self) - { - if (self.PauseButton.IsPressed()) - { - self.Pause(); - } - else - { - self.Unpause(); - } - } - - - function OnSyncPressed(self) - { - self.Settings.SyncTimelines = self.SyncButton.IsPressed(); - } - - - function OnPing(self, server) - { - // Set the ping container as active and take it off half a second later - DOM.Node.AddClass(self.PingContainer.Node, "PingContainerActive"); - window.setTimeout(Bind(function(self) - { - DOM.Node.RemoveClass(self.PingContainer.Node, "PingContainerActive"); - }, self), 500); - } - - - return TitleWindow; -})(); \ No newline at end of file diff --git a/vis/Code/TraceDrop.js b/vis/Code/TraceDrop.js deleted file mode 100644 index c6eda8a..0000000 --- a/vis/Code/TraceDrop.js +++ /dev/null @@ -1,134 +0,0 @@ - -class TraceDrop -{ - constructor(remotery) - { - this.Remotery = remotery; - - // Create a full-page overlay div for dropping files onto - this.DropNode = DOM.Node.CreateHTML("
Load Remotery Trace
"); - document.body.appendChild(this.DropNode); - - // Attach drop handlers - window.addEventListener("dragenter", () => this.ShowDropZone()); - this.DropNode.addEventListener("dragenter", (e) => this.AllowDrag(e)); - this.DropNode.addEventListener("dragover", (e) => this.AllowDrag(e)); - this.DropNode.addEventListener("dragleave", () => this.HideDropZone()); - this.DropNode.addEventListener("drop", (e) => this.OnDrop(e)); - } - - ShowDropZone() - { - this.DropNode.style.display = "flex"; - } - - HideDropZone() - { - this.DropNode.style.display = "none"; - } - - AllowDrag(evt) - { - // Prevent the default drag handler kicking in - evt.preventDefault(); - - evt.dataTransfer.dropEffect = "copy"; - } - - OnDrop(evt) - { - // Prevent the default drop handler kicking in - evt.preventDefault(); - - this.HideDropZone(evt); - - // Get the file that was dropped - let files = DOM.Event.GetDropFiles(evt); - if (files.length == 0) - { - alert("No files dropped"); - return; - } - if (files.length > 1) - { - alert("Too many files dropped"); - return; - } - - // Check file type - let file = files[0]; - if (!file.name.endsWith(".rbin")) - { - alert("Not the correct .rbin file type"); - return; - } - - // Background-load the file - var remotery = this.Remotery; - let file_reader = new FileReader(); - file_reader.onload = function() - { - // Create the data reader and verify the header - let data_view = new DataView(this.result); - let data_view_reader = new DataViewReader(data_view, 0); - let header = data_view_reader.GetStringOfLength(8); - if (header != "RMTBLOGF") - { - alert("Not a valid Remotery Log File"); - return; - } - - remotery.Clear(); - - try - { - // Forward all recorded events to message handlers - while (!data_view_reader.AtEnd()) - { - remotery.Server.CallMessageHandlers(data_view_reader); - } - } - catch (e) - { - // The last message may be partially written due to process exit - // Catch this safely as it's a valid state for the file to be in - if (e instanceof RangeError) - { - console.log("Aborted reading last message"); - } - } - - // After loading completes, populate the UI which wasn't updated during loading - - remotery.Console.TriggerUpdate(); - - // Set frame history for each timeline thread - for (let name in remotery.FrameHistory) - { - let frame_history = remotery.FrameHistory[name]; - remotery.SampleTimelineWindow.OnSamples(name, frame_history); - } - remotery.SampleTimelineWindow.DrawAllRows(); - - for (let name in remotery.ProcessorFrameHistory) - { - let frame_history = remotery.ProcessorFrameHistory[name]; - remotery.ProcessorTimelineWindow.OnSamples(name, frame_history); - } - remotery.ProcessorTimelineWindow.DrawAllRows(); - - // Set the last frame of each thread sample history on the sample windows - for (let name in remotery.SampleWindows) - { - let sample_window = remotery.SampleWindows[name]; - let frame_history = remotery.FrameHistory[name]; - let frame = frame_history[frame_history.length - 1]; - sample_window.OnSamples(frame.NbSamples, frame.SampleDigest, frame.Samples); - } - - // Pause for viewing - remotery.TitleWindow.Pause(); - }; - file_reader.readAsArrayBuffer(file); - } -} \ No newline at end of file diff --git a/vis/Code/WebGL.js b/vis/Code/WebGL.js deleted file mode 100644 index 43fc9cc..0000000 --- a/vis/Code/WebGL.js +++ /dev/null @@ -1,238 +0,0 @@ - -function assert(condition, message) -{ - if (!condition) - { - throw new Error(message || "Assertion failed"); - } -} - -function glCompileShader(gl, type, name, source) -{ - console.log("Compiling " + name); - - // Compile the shader - let shader = gl.createShader(type); - gl.shaderSource(shader, source); - gl.compileShader(shader); - - // Report any errors - if (!gl.getShaderParameter(shader, gl.COMPILE_STATUS)) - { - console.log("Error compiling " + name); - console.log(gl.getShaderInfoLog(shader)); - console.trace(); - } - - return shader; -} - -function glCreateProgram(gl, vshader, fshader) -{ - // Attach shaders and link - let program = gl.createProgram(); - gl.attachShader(program, vshader); - gl.attachShader(program, fshader); - gl.linkProgram(program); - - // Report any errors - if (!gl.getProgramParameter(program, gl.LINK_STATUS)) - { - console.log("Failed to link program"); - console.trace(); - } - - return program; -} - -function glSetUniform(gl, program, name, value, index) -{ - // Get location - const location = gl.getUniformLocation(program, name); - assert(location != null, "Can't find uniform " + name); - - // Dispatch to uniform function by type - assert(value != null, "Value is null"); - const type = Object.prototype.toString.call(value).slice(8, -1); - switch (type) - { - case "Number": - gl.uniform1f(location, value); - break; - - case "WebGLTexture": - gl.activeTexture(gl.TEXTURE0 + index); - gl.bindTexture(gl.TEXTURE_2D, value); - gl.uniform1i(location, index); - break; - - default: - assert(false, "Unhandled type " + type); - break; - } -} - -function glCreateTexture(gl, width, height, data) -{ - const texture = gl.createTexture(); - - // Set filtering/wrapping to nearest/clamp - gl.bindTexture(gl.TEXTURE_2D, texture); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.NEAREST); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.NEAREST); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE); - - gl.texImage2D(gl.TEXTURE_2D, 0, gl.RGBA, width, height, 0, gl.RGBA, gl.UNSIGNED_BYTE, data); - - return texture; -} - -const glDynamicBufferType = Object.freeze({ - Buffer: 1, - Texture: 2 -}); - -class glDynamicBuffer -{ - constructor(gl, element_type, nb_elements, nb_entries, buffer_type) - { - this.gl = gl; - this.elementType = element_type; - this.nbElements = nb_elements; - this.bufferType = buffer_type == undefined ? glDynamicBufferType.Buffer : buffer_type; - this.dirty = false; - - this.Resize(nb_entries); - } - - BindAsInstanceAttribute(program, attrib_name) - { - assert(this.bufferType == glDynamicBufferType.Buffer, "Can only call BindAsInstanceAttribute with Buffer types"); - - let gl = this.gl; - - gl.bindBuffer(gl.ARRAY_BUFFER, this.buffer); - - // The attribute referenced in the program - const attrib_location = gl.getAttribLocation(program, attrib_name); - - gl.enableVertexAttribArray(attrib_location); - gl.vertexAttribPointer(attrib_location, this.nbElements, this.elementType, false, 0, 0); - - // One per instance - gl.vertexAttribDivisor(attrib_location, 1); - } - - UploadData() - { - let gl = this.gl; - - switch (this.bufferType) - { - case glDynamicBufferType.Buffer: - gl.bindBuffer(gl.ARRAY_BUFFER, this.buffer); - gl.bufferSubData(gl.ARRAY_BUFFER, 0, this.cpuArray); - break; - - case glDynamicBufferType.Texture: - gl.bindTexture(gl.TEXTURE_2D, this.texture); - gl.texImage2D(gl.TEXTURE_2D, 0, gl.ALPHA, this.nbEntries, 1, 0, gl.ALPHA, gl.UNSIGNED_BYTE, this.cpuArray); - break; - } - } - - UploadDirtyData() - { - if (this.dirty) - { - this.UploadData(); - this.dirty = false; - } - } - - ResizeToFitNextPow2(target_count) - { - let nb_entries = this.nbEntries; - while (target_count > nb_entries) - { - nb_entries <<= 1; - } - - if (nb_entries > this.nbEntries) - { - this.Resize(nb_entries); - } - } - - Resize(nb_entries) - { - let gl = this.gl; - - this.nbEntries = nb_entries; - - // Create the CPU array - const old_array = this.cpuArray; - switch (this.elementType) - { - case gl.FLOAT: - this.nbElementBytes = 4; - this.cpuArray = new Float32Array(this.nbElements * this.nbEntries); - break; - - case gl.BYTE: - this.nbElementBytes = 1; - this.cpuArray = new Uint8Array(this.nbElements * this.nbEntries); - break; - - default: - assert(false, "Unsupported dynamic buffer element type"); - } - - // Calculate byte size of the buffer - this.nbBytes = this.nbElementBytes * this.nbElements * this.nbEntries; - - if (old_array != undefined) - { - // Copy the values of the previous array over - this.cpuArray.set(old_array); - - console.log(`glDynamicBuffer: Resizing to ${nb_entries} entries, ${this.nbElements} elements per entry, ${this.nbElementBytes} bytes per element, ${this.nbBytes} bytes total.`); - } - else - { - console.log(`glDynamicBuffer: Creating ${nb_entries} entries, ${this.nbElements} elements per entry, ${this.nbElementBytes} bytes per element, ${this.nbBytes} bytes total.`); - } - - // Create the GPU buffer - switch (this.bufferType) - { - case glDynamicBufferType.Buffer: - this.buffer = gl.createBuffer(); - gl.bindBuffer(gl.ARRAY_BUFFER, this.buffer); - gl.bufferData(gl.ARRAY_BUFFER, this.nbBytes, gl.DYNAMIC_DRAW); - break; - - case glDynamicBufferType.Texture: - this.texture = gl.createTexture(); - - // Point sampling with clamp for indexing - gl.bindTexture(gl.TEXTURE_2D, this.texture); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.NEAREST); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.NEAREST); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE); - gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE); - - // Fixed-format for now - assert(this.elementType == gl.BYTE); - assert(this.nbElements == 1); - gl.texImage2D(gl.TEXTURE_2D, 0, gl.ALPHA, this.nbEntries, 1, 0, gl.ALPHA, gl.UNSIGNED_BYTE, this.cpuArray); - - break; - - default: - assert(false, "Unsupported dynamic buffer type"); - } - } -}; - diff --git a/vis/Code/WebGLFont.js b/vis/Code/WebGLFont.js deleted file mode 100644 index 263e039..0000000 --- a/vis/Code/WebGLFont.js +++ /dev/null @@ -1,119 +0,0 @@ - -class glFont -{ - constructor(gl) - { - // Offscreen canvas for rendering individual characters - this.charCanvas = document.createElement("canvas"); - this.charContext = this.charCanvas.getContext("2d"); - - // Describe the font - const font_size = 9; - this.fontWidth = 5; - this.fontHeight = 12; - const font_face = "LocalFiraCode"; - const font_desc = font_size + "px " + font_face; - - // Ensure the CSS font is loaded before we do any work with it - const self = this; - document.fonts.load(font_desc).then(function (){ - - // Create a canvas atlas for all characters in the font - const atlas_canvas = document.createElement("canvas"); - const atlas_context = atlas_canvas.getContext("2d"); - atlas_canvas.width = 16 * self.fontWidth; - atlas_canvas.height = 16 * self.fontHeight; - - // Add each character to the atlas - const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-+=[]{};\'~#,./<>?!\"£$%%^&*()"; - for (let char of chars) - { - // Render this character to the canvas on its own - self.RenderTextToCanvas(char, font_desc, self.fontWidth, self.fontHeight); - - // Calculate a location for it in the atlas using its ASCII code - const ascii_code = char.charCodeAt(0); - assert(ascii_code < 256); - const y_index = Math.floor(ascii_code / 16); - const x_index = ascii_code - y_index * 16 - assert(x_index < 16); - assert(y_index < 16); - - // Copy into the atlas - atlas_context.drawImage(self.charCanvas, x_index * self.fontWidth, y_index * self.fontHeight); - } - - // Create the atlas texture and store it in the destination object - self.atlasTexture = glCreateTexture(gl, atlas_canvas.width, atlas_canvas.height, atlas_canvas); - }); - } - - RenderTextToCanvas(text, font, width, height) - { - // Resize canvas to match - this.charCanvas.width = width; - this.charCanvas.height = height; - - // Clear the background - this.charContext.fillStyle = "black"; - this.charContext.clearRect(0, 0, width, height); - - // Render the text - this.charContext.font = font; - this.charContext.textAlign = "left"; - this.charContext.textBaseline = "top"; - this.charContext.fillText(text, 0, 1.5); - } -} - -class glTextBuffer -{ - constructor(gl, font) - { - this.font = font; - this.textMap = {}; - this.textBuffer = new glDynamicBuffer(gl, gl.BYTE, 1, 8, glDynamicBufferType.Texture); - this.textBufferPos = 0; - this.textEncoder = new TextEncoder(); - } - - AddText(text) - { - // Return if it already exists - const existing_entry = this.textMap[text]; - if (existing_entry != undefined) - { - return existing_entry; - } - - // Add to the map - // Note we're leaving an extra NULL character before every piece of text so that the shader can sample into it on text - // boundaries and sample a zero colour for clamp. - let entry = { - offset: this.textBufferPos + 1, - length: text.length, - }; - this.textMap[text] = entry; - - // Ensure there's always enough space in the text buffer before adding - this.textBuffer.ResizeToFitNextPow2(entry.offset + entry.length + 1); - this.textBuffer.cpuArray.set(this.textEncoder.encode(text), entry.offset, entry.length); - this.textBuffer.dirty = true; - this.textBufferPos = entry.offset + entry.length; - - return entry; - } - - UploadData() - { - this.textBuffer.UploadDirtyData(); - } - - SetAsUniform(gl, program, name, index) - { - glSetUniform(gl, program, name, this.textBuffer.texture, index); - glSetUniform(gl, program, "inTextBufferDesc.fontWidth", this.font.fontWidth); - glSetUniform(gl, program, "inTextBufferDesc.fontHeight", this.font.fontHeight); - glSetUniform(gl, program, "inTextBufferDesc.textBufferLength", this.textBuffer.nbEntries); - } -} \ No newline at end of file diff --git a/vis/Code/WebSocketConnection.js b/vis/Code/WebSocketConnection.js deleted file mode 100644 index 92a6153..0000000 --- a/vis/Code/WebSocketConnection.js +++ /dev/null @@ -1,137 +0,0 @@ - -WebSocketConnection = (function() -{ - function WebSocketConnection() - { - this.MessageHandlers = { }; - this.Socket = null; - this.Console = null; - } - - - WebSocketConnection.prototype.SetConsole = function(console) - { - this.Console = console; - } - - - WebSocketConnection.prototype.Connected = function() - { - // Will return true if the socket is also in the process of connecting - return this.Socket != null; - } - - - WebSocketConnection.prototype.AddConnectHandler = function(handler) - { - this.AddMessageHandler("__OnConnect__", handler); - } - - - WebSocketConnection.prototype.AddDisconnectHandler = function(handler) - { - this.AddMessageHandler("__OnDisconnect__", handler); - } - - - WebSocketConnection.prototype.AddMessageHandler = function(message_name, handler) - { - // Create the message handler array on-demand - if (!(message_name in this.MessageHandlers)) - this.MessageHandlers[message_name] = [ ]; - this.MessageHandlers[message_name].push(handler); - } - - - WebSocketConnection.prototype.Connect = function(address) - { - // Disconnect if already connected - if (this.Connected()) - this.Disconnect(); - - Log(this, "Connecting to " + address); - - this.Socket = new WebSocket(address); - this.Socket.binaryType = "arraybuffer"; - this.Socket.onopen = Bind(OnOpen, this); - this.Socket.onmessage = Bind(OnMessage, this); - this.Socket.onclose = Bind(OnClose, this); - this.Socket.onerror = Bind(OnError, this); - } - - - WebSocketConnection.prototype.Disconnect = function() - { - Log(this, "Disconnecting"); - if (this.Connected()) - this.Socket.close(); - } - - - WebSocketConnection.prototype.Send = function(msg) - { - if (this.Connected()) - this.Socket.send(msg); - } - - - function Log(self, message) - { - self.Console.Log(message); - } - - - function CallMessageHandlers(self, message_name, data_view) - { - if (message_name in self.MessageHandlers) - { - var handlers = self.MessageHandlers[message_name]; - for (var i in handlers) - handlers[i](self, data_view); - } - } - - - function OnOpen(self, event) - { - Log(self, "Connected"); - CallMessageHandlers(self, "__OnConnect__"); - } - - - function OnClose(self, event) - { - // Clear all references - self.Socket.onopen = null; - self.Socket.onmessage = null; - self.Socket.onclose = null; - self.Socket.onerror = null; - self.Socket = null; - - Log(self, "Disconnected"); - CallMessageHandlers(self, "__OnDisconnect__"); - } - - - function OnError(self, event) - { - Log(self, "Connection Error "); - } - - - function OnMessage(self, event) - { - let data_view = new DataView(event.data); - let data_view_reader = new DataViewReader(data_view, 0); - self.CallMessageHandlers(data_view_reader); - } - - WebSocketConnection.prototype.CallMessageHandlers = function(data_view_reader) - { - let id = data_view_reader.GetStringOfLength(4); - CallMessageHandlers(this, id, data_view_reader); - } - - - return WebSocketConnection; -})(); diff --git a/vis/Styles/Fonts/FiraCode/FiraCode-Regular.ttf b/vis/Styles/Fonts/FiraCode/FiraCode-Regular.ttf deleted file mode 100644 index 0d57068..0000000 Binary files a/vis/Styles/Fonts/FiraCode/FiraCode-Regular.ttf and /dev/null differ diff --git a/vis/Styles/Fonts/FiraCode/LICENSE b/vis/Styles/Fonts/FiraCode/LICENSE deleted file mode 100644 index 805e0b3..0000000 --- a/vis/Styles/Fonts/FiraCode/LICENSE +++ /dev/null @@ -1,93 +0,0 @@ -Copyright (c) 2014, The Fira Code Project Authors (https://github.com/tonsky/FiraCode) - -This Font Software is licensed under the SIL Open Font License, Version 1.1. -This license is copied below, and is also available with a FAQ at: -http://scripts.sil.org/OFL - - ------------------------------------------------------------ -SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 ------------------------------------------------------------ - -PREAMBLE -The goals of the Open Font License (OFL) are to stimulate worldwide -development of collaborative font projects, to support the font creation -efforts of academic and linguistic communities, and to provide a free and -open framework in which fonts may be shared and improved in partnership -with others. - -The OFL allows the licensed fonts to be used, studied, modified and -redistributed freely as long as they are not sold by themselves. The -fonts, including any derivative works, can be bundled, embedded, -redistributed and/or sold with any software provided that any reserved -names are not used by derivative works. The fonts and derivatives, -however, cannot be released under any other type of license. The -requirement for fonts to remain under this license does not apply -to any document created using the fonts or their derivatives. - -DEFINITIONS -"Font Software" refers to the set of files released by the Copyright -Holder(s) under this license and clearly marked as such. This may -include source files, build scripts and documentation. - -"Reserved Font Name" refers to any names specified as such after the -copyright statement(s). - -"Original Version" refers to the collection of Font Software components as -distributed by the Copyright Holder(s). - -"Modified Version" refers to any derivative made by adding to, deleting, -or substituting -- in part or in whole -- any of the components of the -Original Version, by changing formats or by porting the Font Software to a -new environment. - -"Author" refers to any designer, engineer, programmer, technical -writer or other person who contributed to the Font Software. - -PERMISSION & CONDITIONS -Permission is hereby granted, free of charge, to any person obtaining -a copy of the Font Software, to use, study, copy, merge, embed, modify, -redistribute, and sell modified and unmodified copies of the Font -Software, subject to the following conditions: - -1) Neither the Font Software nor any of its individual components, -in Original or Modified Versions, may be sold by itself. - -2) Original or Modified Versions of the Font Software may be bundled, -redistributed and/or sold with any software, provided that each copy -contains the above copyright notice and this license. These can be -included either as stand-alone text files, human-readable headers or -in the appropriate machine-readable metadata fields within text or -binary files as long as those fields can be easily viewed by the user. - -3) No Modified Version of the Font Software may use the Reserved Font -Name(s) unless explicit written permission is granted by the corresponding -Copyright Holder. This restriction only applies to the primary font name as -presented to the users. - -4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font -Software shall not be used to promote, endorse or advertise any -Modified Version, except to acknowledge the contribution(s) of the -Copyright Holder(s) and the Author(s) or with their explicit written -permission. - -5) The Font Software, modified or unmodified, in part or in whole, -must be distributed entirely under this license, and must not be -distributed under any other license. The requirement for fonts to -remain under this license does not apply to any document created -using the Font Software. - -TERMINATION -This license becomes null and void if any of the above conditions are -not met. - -DISCLAIMER -THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT -OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE -COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL -DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM -OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/vis/Styles/Remotery.css b/vis/Styles/Remotery.css deleted file mode 100644 index 24d69ce..0000000 --- a/vis/Styles/Remotery.css +++ /dev/null @@ -1,274 +0,0 @@ - -body -{ - /* Take up the full page */ - width: 100%; - height: 100%; - margin: 0px; - - background-color: #999; - - touch-action: none; -} - - -/* Override default container style to remove 3D effect */ -.Container -{ - border: none; - box-shadow: none; -} - - -/* Override default edit box style to remove 3D effect */ -.EditBox -{ - border: none; - box-shadow: none; - width:200; -} - - -@font-face -{ - font-family: "LocalFiraCode"; - src:url("Fonts/FiraCode/FiraCode-Regular.ttf"); -} - -.ConsoleText -{ - overflow:auto; - color: #BBB; - font: 10px LocalFiraCode; - margin: 3px; - white-space: pre; - line-height:14px; -} - - -.PingContainer -{ - background-color: #F55; - border-radius: 2px; - - /* Transition from green is gradual */ - transition: background-color 0.25s ease-in; -} - - -.PingContainerActive -{ - background-color: #5F5; - - /* Transition to green is instant */ - transition: none; -} - - -.SampleNameCell -{ - width:243px; -} -.SampleTimeCell -{ - width:52px; -} -.SampleCountCell -{ - width:43px; -} -.SampleTitleNameCell -{ - width:238px; - - padding: 1px 1px 1px 2px; - border: 1px solid; - border-radius: 2px; - - border-top-color:#555; - border-left-color:#555; - border-bottom-color:#111; - border-right-color:#111; - - background: #222; -} -.SampleTitleTimeCell -{ - width:47px; - - padding: 1px 1px 1px 2px; - border: 1px solid; - border-radius: 2px; - - border-top-color:#555; - border-left-color:#555; - border-bottom-color:#111; - border-right-color:#111; - - background: #222; -} -.SampleTitleCountCell -{ - width:38px; - - padding: 1px 1px 1px 2px; - border: 1px solid; - border-radius: 2px; - - border-top-color:#555; - border-left-color:#555; - border-bottom-color:#111; - border-right-color:#111; - - background: #222; -} - - -.TimelineBox -{ - /* Following style generally copies GridRowCell.GridGroup from BrowserLib */ - - padding: 1px 1px 1px 2px; - margin: 1px; - - border: 1px solid; - border-radius: 2px; - border-top-color:#555; - border-left-color:#555; - border-bottom-color:#111; - border-right-color:#111; - - background: #222; - - font: 9px Verdana; - color: #BBB; -} -.TimelineRow -{ - width: 100%; -} -.TimelineRowCheckbox -{ - width: 12px; - height: 12px; - margin: 0px; -} -.TimelineRowCheck -{ - /* Pull .TimelineRowExpand to the right of the checkbox */ - float:left; - - width: 14px; - height: 14px; -} -.TimelineRowExpand -{ - /* Pull .TimelineRowLabel to the right of +/- buttons */ - float:left; - - width: 14px; - height: 14px; -} -.TimelineRowExpandButton -{ - width: 11px; - height: 12px; - - color: #333; - - border: 1px solid; - - border-top-color:#F4F4F4; - border-left-color:#F4F4F4; - border-bottom-color:#8E8F8F; - border-right-color:#8E8F8F; - - /* Top-right to bottom-left grey background gradient */ - background: #f6f6f6; /* Old browsers */ - background: -moz-linear-gradient(-45deg, #f6f6f6 0%, #abaeb2 100%); /* FF3.6+ */ - background: -webkit-gradient(linear, left top, right bottom, color-stop(0%,#f6f6f6), color-stop(100%,#abaeb2)); /* Chrome,Safari4+ */ - background: -webkit-linear-gradient(-45deg, #f6f6f6 0%,#abaeb2 100%); /* Chrome10+,Safari5.1+ */ - background: -o-linear-gradient(-45deg, #f6f6f6 0%,#abaeb2 100%); /* Opera 11.10+ */ - background: -ms-linear-gradient(-45deg, #f6f6f6 0%,#abaeb2 100%); /* IE10+ */ - background: linear-gradient(135deg, #f6f6f6 0%,#abaeb2 100%); /* W3C */ - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f6f6f6', endColorstr='#abaeb2',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */ - - text-align: center; - vertical-align: center; -} -.TimelineRowExpandButton:hover -{ - border-top-color:#79C6F9; - border-left-color:#79C6F9; - border-bottom-color:#385D72; - border-right-color:#385D72; - - /* Top-right to bottom-left blue background gradient, matching border */ - background: #f3f3f3; /* Old browsers */ - background: -moz-linear-gradient(-45deg, #f3f3f3 0%, #79c6f9 100%); /* FF3.6+ */ - background: -webkit-gradient(linear, left top, right bottom, color-stop(0%,#f3f3f3), color-stop(100%,#79c6f9)); /* Chrome,Safari4+ */ - background: -webkit-linear-gradient(-45deg, #f3f3f3 0%,#79c6f9 100%); /* Chrome10+,Safari5.1+ */ - background: -o-linear-gradient(-45deg, #f3f3f3 0%,#79c6f9 100%); /* Opera 11.10+ */ - background: -ms-linear-gradient(-45deg, #f3f3f3 0%,#79c6f9 100%); /* IE10+ */ - background: linear-gradient(135deg, #f3f3f3 0%,#79c6f9 100%); /* W3C */ - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f3f3f3', endColorstr='#79c6f9',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */ -} -.TimelineRowExpandButtonActive -{ - /* Simple means of shifting text within a div to the bottom-right */ - padding-left:1px; - padding-top:1px; - width:10px; - height:11px; -} -.TimelineRowLabel -{ - float:left; - - width: 140px; - height: 14px; -} - -.TimelineContainer -{ -} -.TimelineLabels -{ - padding: 0; - margin: 0; - border: 0; - overflow-y: hidden; -} -.TimelineLabelScrollClipper -{ - padding: 0; - margin: 0; - border: 0; - overflow-y: hidden; -} - -.DropZone -{ - /* Covers the whole page, initially hidden */ - box-sizing: border-box; - display: none; - position: fixed; - width: 100%; - height: 100%; - left: 0; - top: 0; - - /* On top of everything possible */ - z-index: 99999; - - /* Styling for when visible */ - background: rgba(32, 4, 136, 0.25); - border: 3px dashed white; - - /* Styling for text when visible */ - color: white; - font-family: Arial, Helvetica, sans-serif; - font-size: xx-large; - align-items: center; - justify-content: center; -} diff --git a/vis/extern/BrowserLib/Core/Code/Animation.js b/vis/extern/BrowserLib/Core/Code/Animation.js deleted file mode 100644 index 516aa9c..0000000 --- a/vis/extern/BrowserLib/Core/Code/Animation.js +++ /dev/null @@ -1,65 +0,0 @@ - -// -// Very basic linear value animation system, for now. -// - - -namespace("Anim"); - - -Anim.Animation = (function() -{ - var anim_hz = 60; - - - function Animation(anim_func, start_value, end_value, time, end_callback) - { - // Setup initial parameters - this.StartValue = start_value; - this.EndValue = end_value; - this.ValueInc = (end_value - start_value) / (time * anim_hz); - this.Value = start_value; - this.Complete = false; - this.EndCallback = end_callback; - - // Cache the update function to prevent recreating the closure - var self = this; - this.AnimFunc = anim_func; - this.AnimUpdate = function() { Update(self); } - - // Call for the start value - this.AnimUpdate(); - } - - - function Update(self) - { - // Queue up the next frame immediately - var id = window.setTimeout(self.AnimUpdate, 1000 / anim_hz); - - // Linear step the value and check for completion - self.Value += self.ValueInc; - if (Math.abs(self.Value - self.EndValue) < 0.01) - { - self.Value = self.EndValue; - self.Complete = true; - - if (self.EndCallback) - self.EndCallback(); - - window.clearTimeout(id); - } - - // Pass to the animation function - self.AnimFunc(self.Value); - } - - - return Animation; -})(); - - -Anim.Animate = function(anim_func, start_value, end_value, time, end_callback) -{ - return new Anim.Animation(anim_func, start_value, end_value, time, end_callback); -} diff --git a/vis/extern/BrowserLib/Core/Code/Bind.js b/vis/extern/BrowserLib/Core/Code/Bind.js deleted file mode 100644 index 102ee26..0000000 --- a/vis/extern/BrowserLib/Core/Code/Bind.js +++ /dev/null @@ -1,92 +0,0 @@ -// -// This will generate a closure for the given function and optionally bind an arbitrary number of -// its initial arguments to specific values. -// -// Parameters: -// -// 0: Either the function scope or the function. -// 1: If 0 is the function scope, this is the function. -// Otherwise it's the start of the optional bound argument list. -// 2: Start of the optional bound argument list if 1 is the function. -// -// Examples: -// -// function GlobalFunction(p0, p1, p2) { } -// function ThisFunction(p0, p1, p2) { } -// -// var a = Bind("GlobalFunction"); -// var b = Bind(this, "ThisFunction"); -// var c = Bind("GlobalFunction", BoundParam0, BoundParam1); -// var d = Bind(this, "ThisFunction", BoundParam0, BoundParam1); -// var e = Bind(GlobalFunction); -// var f = Bind(this, ThisFunction); -// var g = Bind(GlobalFunction, BoundParam0, BoundParam1); -// var h = Bind(this, ThisFunction, BoundParam0, BoundParam1); -// -// a(0, 1, 2); -// b(0, 1, 2); -// c(2); -// d(2); -// e(0, 1, 2); -// f(0, 1, 2); -// g(2); -// h(2); -// -function Bind() -{ - // No closure to define? - if (arguments.length == 0) - return null; - - // Figure out which of the 4 call types is being used to bind - // Locate scope, function and bound parameter start index - - if (typeof(arguments[0]) == "string") - { - var scope = window; - var func = window[arguments[0]]; - var start = 1; - } - - else if (typeof(arguments[0]) == "function") - { - var scope = window; - var func = arguments[0]; - var start = 1; - } - - else if (typeof(arguments[1]) == "string") - { - var scope = arguments[0]; - var func = scope[arguments[1]]; - var start = 2; - } - - else if (typeof(arguments[1]) == "function") - { - var scope = arguments[0]; - var func = arguments[1]; - var start = 2; - } - - else - { - // unknown - console.log("Bind() ERROR: Unknown bind parameter configuration"); - return; - } - - // Convert the arguments list to an array - var arg_array = Array.prototype.slice.call(arguments, start); - start = arg_array.length; - - return function() - { - // Concatenate incoming arguments - for (var i = 0; i < arguments.length; i++) - arg_array[start + i] = arguments[i]; - - // Call the function in the given scope with the new arguments - return func.apply(scope, arg_array); - } -} diff --git a/vis/extern/BrowserLib/Core/Code/Convert.js b/vis/extern/BrowserLib/Core/Code/Convert.js deleted file mode 100644 index b1f5461..0000000 --- a/vis/extern/BrowserLib/Core/Code/Convert.js +++ /dev/null @@ -1,218 +0,0 @@ - -namespace("Convert"); - - -// -// Convert between utf8 and b64 without raising character out of range exceptions with unicode strings -// Technique described here: http://monsur.hossa.in/2012/07/20/utf-8-in-javascript.html -// -Convert.utf8string_to_b64string = function(str) -{ - return btoa(unescape(encodeURIComponent(str))); -} -Convert.b64string_to_utf8string = function(str) -{ - return decodeURIComponent(escape(atob(str))); -} - - -// -// More general approach, converting between byte arrays and b64 -// Info here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Base64_encoding_and_decoding -// -Convert.b64string_to_Uint8Array = function(sBase64, nBlocksSize) -{ - function b64ToUint6 (nChr) - { - return nChr > 64 && nChr < 91 ? - nChr - 65 - : nChr > 96 && nChr < 123 ? - nChr - 71 - : nChr > 47 && nChr < 58 ? - nChr + 4 - : nChr === 43 ? - 62 - : nChr === 47 ? - 63 - : - 0; - } - - var - sB64Enc = sBase64.replace(/[^A-Za-z0-9\+\/]/g, ""), - nInLen = sB64Enc.length, - nOutLen = nBlocksSize ? Math.ceil((nInLen * 3 + 1 >> 2) / nBlocksSize) * nBlocksSize : nInLen * 3 + 1 >> 2, - taBytes = new Uint8Array(nOutLen); - - for (var nMod3, nMod4, nUint24 = 0, nOutIdx = 0, nInIdx = 0; nInIdx < nInLen; nInIdx++) - { - nMod4 = nInIdx & 3; - nUint24 |= b64ToUint6(sB64Enc.charCodeAt(nInIdx)) << 18 - 6 * nMod4; - if (nMod4 === 3 || nInLen - nInIdx === 1) - { - for (nMod3 = 0; nMod3 < 3 && nOutIdx < nOutLen; nMod3++, nOutIdx++) - taBytes[nOutIdx] = nUint24 >>> (16 >>> nMod3 & 24) & 255; - nUint24 = 0; - } - } - - return taBytes; -} -Convert.Uint8Array_to_b64string = function(aBytes) -{ - function uint6ToB64 (nUint6) - { - return nUint6 < 26 ? - nUint6 + 65 - : nUint6 < 52 ? - nUint6 + 71 - : nUint6 < 62 ? - nUint6 - 4 - : nUint6 === 62 ? - 43 - : nUint6 === 63 ? - 47 - : - 65; - } - - var nMod3, sB64Enc = ""; - - for (var nLen = aBytes.length, nUint24 = 0, nIdx = 0; nIdx < nLen; nIdx++) - { - nMod3 = nIdx % 3; - if (nIdx > 0 && (nIdx * 4 / 3) % 76 === 0) - sB64Enc += "\r\n"; - nUint24 |= aBytes[nIdx] << (16 >>> nMod3 & 24); - if (nMod3 === 2 || aBytes.length - nIdx === 1) - { - sB64Enc += String.fromCharCode(uint6ToB64(nUint24 >>> 18 & 63), uint6ToB64(nUint24 >>> 12 & 63), uint6ToB64(nUint24 >>> 6 & 63), uint6ToB64(nUint24 & 63)); - nUint24 = 0; - } - } - - return sB64Enc.replace(/A(?=A$|$)/g, "="); -} - - -// -// Unicode and arbitrary value safe conversion between strings and Uint8Arrays -// -Convert.Uint8Array_to_string = function(aBytes) -{ - var sView = ""; - - for (var nPart, nLen = aBytes.length, nIdx = 0; nIdx < nLen; nIdx++) - { - nPart = aBytes[nIdx]; - sView += String.fromCharCode( - nPart > 251 && nPart < 254 && nIdx + 5 < nLen ? /* six bytes */ - /* (nPart - 252 << 32) is not possible in ECMAScript! So...: */ - (nPart - 252) * 1073741824 + (aBytes[++nIdx] - 128 << 24) + (aBytes[++nIdx] - 128 << 18) + (aBytes[++nIdx] - 128 << 12) + (aBytes[++nIdx] - 128 << 6) + aBytes[++nIdx] - 128 - : nPart > 247 && nPart < 252 && nIdx + 4 < nLen ? /* five bytes */ - (nPart - 248 << 24) + (aBytes[++nIdx] - 128 << 18) + (aBytes[++nIdx] - 128 << 12) + (aBytes[++nIdx] - 128 << 6) + aBytes[++nIdx] - 128 - : nPart > 239 && nPart < 248 && nIdx + 3 < nLen ? /* four bytes */ - (nPart - 240 << 18) + (aBytes[++nIdx] - 128 << 12) + (aBytes[++nIdx] - 128 << 6) + aBytes[++nIdx] - 128 - : nPart > 223 && nPart < 240 && nIdx + 2 < nLen ? /* three bytes */ - (nPart - 224 << 12) + (aBytes[++nIdx] - 128 << 6) + aBytes[++nIdx] - 128 - : nPart > 191 && nPart < 224 && nIdx + 1 < nLen ? /* two bytes */ - (nPart - 192 << 6) + aBytes[++nIdx] - 128 - : /* nPart < 127 ? */ /* one byte */ - nPart - ); - } - - return sView; -} -Convert.string_to_Uint8Array = function(sDOMStr) -{ - var aBytes, nChr, nStrLen = sDOMStr.length, nArrLen = 0; - - /* mapping... */ - - for (var nMapIdx = 0; nMapIdx < nStrLen; nMapIdx++) - { - nChr = sDOMStr.charCodeAt(nMapIdx); - nArrLen += nChr < 0x80 ? 1 : nChr < 0x800 ? 2 : nChr < 0x10000 ? 3 : nChr < 0x200000 ? 4 : nChr < 0x4000000 ? 5 : 6; - } - - aBytes = new Uint8Array(nArrLen); - - /* transcription... */ - - for (var nIdx = 0, nChrIdx = 0; nIdx < nArrLen; nChrIdx++) - { - nChr = sDOMStr.charCodeAt(nChrIdx); - if (nChr < 128) - { - /* one byte */ - aBytes[nIdx++] = nChr; - } - else if (nChr < 0x800) - { - /* two bytes */ - aBytes[nIdx++] = 192 + (nChr >>> 6); - aBytes[nIdx++] = 128 + (nChr & 63); - } - else if (nChr < 0x10000) - { - /* three bytes */ - aBytes[nIdx++] = 224 + (nChr >>> 12); - aBytes[nIdx++] = 128 + (nChr >>> 6 & 63); - aBytes[nIdx++] = 128 + (nChr & 63); - } - else if (nChr < 0x200000) - { - /* four bytes */ - aBytes[nIdx++] = 240 + (nChr >>> 18); - aBytes[nIdx++] = 128 + (nChr >>> 12 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 6 & 63); - aBytes[nIdx++] = 128 + (nChr & 63); - } - else if (nChr < 0x4000000) - { - /* five bytes */ - aBytes[nIdx++] = 248 + (nChr >>> 24); - aBytes[nIdx++] = 128 + (nChr >>> 18 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 12 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 6 & 63); - aBytes[nIdx++] = 128 + (nChr & 63); - } - else /* if (nChr <= 0x7fffffff) */ - { - /* six bytes */ - aBytes[nIdx++] = 252 + /* (nChr >>> 32) is not possible in ECMAScript! So...: */ (nChr / 1073741824); - aBytes[nIdx++] = 128 + (nChr >>> 24 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 18 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 12 & 63); - aBytes[nIdx++] = 128 + (nChr >>> 6 & 63); - aBytes[nIdx++] = 128 + (nChr & 63); - } - } - - return aBytes; -} - - -// -// Converts all characters in a string that have equivalent entities to their ampersand/entity names. -// Based on https://gist.github.com/jonathantneal/6093551 -// -Convert.string_to_html_entities = (function() -{ - 'use strict'; - - var data = '34quot38amp39apos60lt62gt160nbsp161iexcl162cent163pound164curren165yen166brvbar167sect168uml169copy170ordf171laquo172not173shy174reg175macr176deg177plusmn178sup2179sup3180acute181micro182para183middot184cedil185sup1186ordm187raquo188frac14189frac12190frac34191iquest192Agrave193Aacute194Acirc195Atilde196Auml197Aring198AElig199Ccedil200Egrave201Eacute202Ecirc203Euml204Igrave205Iacute206Icirc207Iuml208ETH209Ntilde210Ograve211Oacute212Ocirc213Otilde214Ouml215times216Oslash217Ugrave218Uacute219Ucirc220Uuml221Yacute222THORN223szlig224agrave225aacute226acirc227atilde228auml229aring230aelig231ccedil232egrave233eacute234ecirc235euml236igrave237iacute238icirc239iuml240eth241ntilde242ograve243oacute244ocirc245otilde246ouml247divide248oslash249ugrave250uacute251ucirc252uuml253yacute254thorn255yuml402fnof913Alpha914Beta915Gamma916Delta917Epsilon918Zeta919Eta920Theta921Iota922Kappa923Lambda924Mu925Nu926Xi927Omicron928Pi929Rho931Sigma932Tau933Upsilon934Phi935Chi936Psi937Omega945alpha946beta947gamma948delta949epsilon950zeta951eta952theta953iota954kappa955lambda956mu957nu958xi959omicron960pi961rho962sigmaf963sigma964tau965upsilon966phi967chi968psi969omega977thetasym978upsih982piv8226bull8230hellip8242prime8243Prime8254oline8260frasl8472weierp8465image8476real8482trade8501alefsym8592larr8593uarr8594rarr8595darr8596harr8629crarr8656lArr8657uArr8658rArr8659dArr8660hArr8704forall8706part8707exist8709empty8711nabla8712isin8713notin8715ni8719prod8721sum8722minus8727lowast8730radic8733prop8734infin8736ang8743and8744or8745cap8746cup8747int8756there48764sim8773cong8776asymp8800ne8801equiv8804le8805ge8834sub8835sup8836nsub8838sube8839supe8853oplus8855otimes8869perp8901sdot8968lceil8969rceil8970lfloor8971rfloor9001lang9002rang9674loz9824spades9827clubs9829hearts9830diams338OElig339oelig352Scaron353scaron376Yuml710circ732tilde8194ensp8195emsp8201thinsp8204zwnj8205zwj8206lrm8207rlm8211ndash8212mdash8216lsquo8217rsquo8218sbquo8220ldquo8221rdquo8222bdquo8224dagger8225Dagger8240permil8249lsaquo8250rsaquo8364euro'; - var charCodes = data.split(/[A-z]+/); - var entities = data.split(/\d+/).slice(1); - - return function encodeHTMLEntities(text) - { - return text.replace(/[\u00A0-\u2666<>"'&]/g, function (match) - { - var charCode = String(match.charCodeAt(0)); - var index = charCodes.indexOf(charCode); - return '&' + (entities[index] ? entities[index] : '#' + charCode) + ';'; - }); - }; -})(); diff --git a/vis/extern/BrowserLib/Core/Code/Core.js b/vis/extern/BrowserLib/Core/Code/Core.js deleted file mode 100644 index 542f54f..0000000 --- a/vis/extern/BrowserLib/Core/Code/Core.js +++ /dev/null @@ -1,26 +0,0 @@ - -// TODO: requires function for checking existence of dependencies - - -function namespace(name) -{ - // Ensure all nested namespaces are created only once - - var ns_list = name.split("."); - var parent_ns = window; - - for (var i in ns_list) - { - var ns_name = ns_list[i]; - if (!(ns_name in parent_ns)) - parent_ns[ns_name] = { }; - - parent_ns = parent_ns[ns_name]; - } -} - - -function multiline(fn) -{ - return fn.toString().split(/\n/).slice(1, -1).join("\n"); -} diff --git a/vis/extern/BrowserLib/Core/Code/DOM.js b/vis/extern/BrowserLib/Core/Code/DOM.js deleted file mode 100644 index ccb1276..0000000 --- a/vis/extern/BrowserLib/Core/Code/DOM.js +++ /dev/null @@ -1,526 +0,0 @@ - -namespace("DOM.Node"); -namespace("DOM.Event"); -namespace("DOM.Applet"); - - - -// -// ===================================================================================================================== -// ----- DOCUMENT NODE/ELEMENT EXTENSIONS ------------------------------------------------------------------------------ -// ===================================================================================================================== -// - - - -DOM.Node.Get = function(id) -{ - return document.getElementById(id); -} - - -// -// Set node position -// -DOM.Node.SetPosition = function(node, position) -{ - node.style.left = position[0]; - node.style.top = position[1]; -} -DOM.Node.SetX = function(node, x) -{ - node.style.left = x; -} -DOM.Node.SetY = function(node, y) -{ - node.style.top = y; -} - - -// -// Get the absolute position of a HTML element on the page -// -DOM.Node.GetPosition = function(element, account_for_scroll) -{ - // Recurse up through parents, summing offsets from their parent - var x = 0, y = 0; - for (var node = element; node != null; node = node.offsetParent) - { - x += node.offsetLeft; - y += node.offsetTop; - } - - if (account_for_scroll) - { - // Walk up the hierarchy subtracting away any scrolling - for (var node = element; node != document.body; node = node.parentNode) - { - x -= node.scrollLeft; - y -= node.scrollTop; - } - } - - return [x, y]; -} - - -// -// Set node size -// -DOM.Node.SetSize = function(node, size) -{ - node.style.width = size[0]; - node.style.height = size[1]; -} -DOM.Node.SetWidth = function(node, width) -{ - node.style.width = width; -} -DOM.Node.SetHeight = function(node, height) -{ - node.style.height = height; -} - - -// -// Get node OFFSET size: -// clientX includes padding -// offsetX includes padding and borders -// scrollX includes padding, borders and size of contained node -// -DOM.Node.GetSize = function(node) -{ - return [ node.offsetWidth, node.offsetHeight ]; -} -DOM.Node.GetWidth = function(node) -{ - return node.offsetWidth; -} -DOM.Node.GetHeight = function(node) -{ - return node.offsetHeight; -} - - -// -// Set node opacity -// -DOM.Node.SetOpacity = function(node, value) -{ - node.style.opacity = value; -} - - -DOM.Node.SetColour = function(node, colour) -{ - node.style.color = colour; -} - - -// -// Hide a node by completely disabling its rendering (it no longer contributes to document layout) -// -DOM.Node.Hide = function(node) -{ - node.style.display = "none"; -} - - -// -// Show a node by restoring its influcen in document layout -// -DOM.Node.Show = function(node) -{ - node.style.display = "block"; -} - - -// -// Add a CSS class to a HTML element, specified last -// -DOM.Node.AddClass = function(node, class_name) -{ - // Ensure the class hasn't already been added - DOM.Node.RemoveClass(node, class_name); - node.className += " " + class_name; -} - - -// -// Remove a CSS class from a HTML element -// -DOM.Node.RemoveClass = function(node, class_name) -{ - // Remove all variations of where the class name can be in the string list - var regexp = new RegExp("\\b" + class_name + "\\b"); - node.className = node.className.replace(regexp, ""); -} - - - -// -// Check to see if a HTML element contains a class -// -DOM.Node.HasClass = function(node, class_name) -{ - var regexp = new RegExp("\\b" + class_name + "\\b"); - return regexp.test(node.className); -} - - -// -// Recursively search for a node with the given class name -// -DOM.Node.FindWithClass = function(parent_node, class_name, index) -{ - // Search the children looking for a node with the given class name - for (var i in parent_node.childNodes) - { - var node = parent_node.childNodes[i]; - if (DOM.Node.HasClass(node, class_name)) - { - if (index === undefined || index-- == 0) - return node; - } - - // Recurse into children - node = DOM.Node.FindWithClass(node, class_name); - if (node != null) - return node; - } - - return null; -} - - -// -// Check to see if one node logically contains another -// -DOM.Node.Contains = function(node, container_node) -{ - while (node != null && node != container_node) - node = node.parentNode; - return node != null; -} - - -// -// Create the HTML nodes specified in the text passed in -// Assumes there is only one root node in the text -// -DOM.Node.CreateHTML = function(html) -{ - var div = document.createElement("div"); - div.innerHTML = html; - - // First child may be a text node, followed by the created HTML - var child = div.firstChild; - if (child != null && child.nodeType == 3) - child = child.nextSibling; - return child; -} - - -// -// Make a copy of a HTML element, making it visible and clearing its ID to ensure it's not a duplicate -// -DOM.Node.Clone = function(name) -{ - // Get the template element and clone it, making sure it's renderable - var node = DOM.Node.Get(name); - node = node.cloneNode(true); - node.id = null; - node.style.display = "block"; - return node; -} - - -// -// Append an arbitrary block of HTML to an existing node -// -DOM.Node.AppendHTML = function(node, html) -{ - var child = DOM.Node.CreateHTML(html); - node.appendChild(child); - return child; -} - - -// -// Append a div that clears the float style -// -DOM.Node.AppendClearFloat = function(node) -{ - var div = document.createElement("div"); - div.style.clear = "both"; - node.appendChild(div); -} - - -// -// Check to see that the object passed in is an instance of a DOM node -// -DOM.Node.IsNode = function(object) -{ - return object instanceof Element; -} - - -// -// Create an "iframe shim" so that elements within it render over a Java Applet -// http://web.archive.org/web/20110707212850/http://www.oratransplant.nl/2007/10/26/using-iframe-shim-to-partly-cover-a-java-applet/ -// -DOM.Node.CreateShim = function(parent) -{ - var shimmer = document.createElement("iframe"); - - // Position the shimmer so that it's the same location/size as its parent - shimmer.style.position = "fixed"; - shimmer.style.left = parent.style.left; - shimmer.style.top = parent.style.top; - shimmer.style.width = parent.offsetWidth; - shimmer.style.height = parent.offsetHeight; - - // We want the shimmer to be one level below its contents - shimmer.style.zIndex = parent.style.zIndex - 1; - - // Ensure its empty - shimmer.setAttribute("frameborder", "0"); - shimmer.setAttribute("src", ""); - - // Add to the document and the parent - document.body.appendChild(shimmer); - parent.Shimmer = shimmer; - return shimmer; -} - - - -// -// ===================================================================================================================== -// ----- EVENT HANDLING EXTENSIONS ------------------------------------------------------------------------------------- -// ===================================================================================================================== -// - - - -// -// Retrieves the event from the first parameter passed into an HTML event -// -DOM.Event.Get = function(evt) -{ - // Internet explorer doesn't pass the event - return window.event || evt; -} - - -// -// Retrieves the element that triggered an event from the event object -// -DOM.Event.GetNode = function(evt) -{ - evt = DOM.Event.Get(evt); - - // Get the target element - var element; - if (evt.target) - element = evt.target; - else if (e.srcElement) - element = evt.srcElement; - - // Default Safari bug - if (element.nodeType == 3) - element = element.parentNode; - - return element; -} - - -// -// Stop default action for an event -// -DOM.Event.StopDefaultAction = function(evt) -{ - if (evt && evt.preventDefault) - evt.preventDefault(); - else if (window.event && window.event.returnValue) - window.event.returnValue = false; -} - - -// -// Stops events bubbling up to parent event handlers -// -DOM.Event.StopPropagation = function(evt) -{ - evt = DOM.Event.Get(evt); - if (evt) - { - evt.cancelBubble = true; - if (evt.stopPropagation) - evt.stopPropagation(); - } -} - - -// -// Stop both event default action and propagation -// -DOM.Event.StopAll = function(evt) -{ - DOM.Event.StopDefaultAction(evt); - DOM.Event.StopPropagation(evt); -} - - -// -// Adds an event handler to an event -// -DOM.Event.AddHandler = function(obj, evt, func) -{ - if (obj) - { - if (obj.addEventListener) - obj.addEventListener(evt, func, false); - else if (obj.attachEvent) - obj.attachEvent("on" + evt, func); - } -} - - -// -// Removes an event handler from an event -// -DOM.Event.RemoveHandler = function(obj, evt, func) -{ - if (obj) - { - if (obj.removeEventListener) - obj.removeEventListener(evt, func, false); - else if (obj.detachEvent) - obj.detachEvent("on" + evt, func); - } -} - - -// -// Get the position of the mouse cursor, page relative -// -DOM.Event.GetMousePosition = function(evt) -{ - evt = DOM.Event.Get(evt); - - var px = 0; - var py = 0; - if (evt.pageX || evt.pageY) - { - px = evt.pageX; - py = evt.pageY; - } - else if (evt.clientX || evt.clientY) - { - px = e.clientX + document.body.scrollLeft + document.documentElement.scrollLeft; - py = e.clientY + document.body.scrollTop + document.documentElement.scrollTop; - } - - return [px, py]; -} - - -// -// Get the list of files attached to a drop event -// -DOM.Event.GetDropFiles = function(evt) -{ - let files = []; - if (evt.dataTransfer.items) - { - for (let i = 0; i < evt.dataTransfer.items.length; i++) - { - if (evt.dataTransfer.items[i].kind === 'file') - { - files.push(evt.dataTransfer.items[i].getAsFile()); - } - } - } - else - { - for (let i = 0; i < evt.dataTransfer.files.length; i++) - { - files.push(evt.dataTransfer.files[i]); - } - } - return files; -} - - - -// -// ===================================================================================================================== -// ----- JAVA APPLET EXTENSIONS ---------------------------------------------------------------------------------------- -// ===================================================================================================================== -// - - - -// -// Create an applet element for loading a Java applet, attaching it to the specified node -// -DOM.Applet.Load = function(dest_id, id, code, archive) -{ - // Lookup the applet destination - var dest = DOM.Node.Get(dest_id); - if (!dest) - return; - - // Construct the applet element and add it to the destination - Debug.Log("Injecting applet DOM code"); - var applet = ""; - applet += ""; - dest.innerHTML = applet; -} - - -// -// Moves and resizes a named applet so that it fits in the destination div element. -// The applet must be contained by a div element itself. This container div is moved along -// with the applet. -// -DOM.Applet.Move = function(dest_div, applet, z_index, hide) -{ - if (!applet || !dest_div) - return; - - // Before modifying any location information, hide the applet so that it doesn't render over - // any newly visible elements that appear while the location information is being modified. - if (hide) - applet.style.visibility = "hidden"; - - // Get its view rect - var pos = DOM.Node.GetPosition(dest_div); - var w = dest_div.offsetWidth; - var h = dest_div.offsetHeight; - - // It needs to be embedded in a
for correct scale/position adjustment - var container = applet.parentNode; - if (!container || container.localName != "div") - { - Debug.Log("ERROR: Couldn't find source applet's div container"); - return; - } - - // Reposition and resize the containing div element - container.style.left = pos[0]; - container.style.top = pos[1]; - container.style.width = w; - container.style.height = h; - container.style.zIndex = z_index; - - // Resize the applet itself - applet.style.width = w; - applet.style.height = h; - - // Everything modified, safe to show - applet.style.visibility = "visible"; -} diff --git a/vis/extern/BrowserLib/Core/Code/Keyboard.js b/vis/extern/BrowserLib/Core/Code/Keyboard.js deleted file mode 100644 index f70f4ea..0000000 --- a/vis/extern/BrowserLib/Core/Code/Keyboard.js +++ /dev/null @@ -1,149 +0,0 @@ - -namespace("Keyboard") - - -// ===================================================================================================================== -// Key codes copied from closure-library -// https://code.google.com/p/closure-library/source/browse/closure/goog/events/keycodes.js -// --------------------------------------------------------------------------------------------------------------------- -// Copyright 2006 The Closure Library Authors. All Rights Reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS-IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -Keyboard.Codes = { - WIN_KEY_FF_LINUX : 0, - MAC_ENTER : 3, - BACKSPACE : 8, - TAB : 9, - NUM_CENTER : 12, // NUMLOCK on FF/Safari Mac - ENTER : 13, - SHIFT : 16, - CTRL : 17, - ALT : 18, - PAUSE : 19, - CAPS_LOCK : 20, - ESC : 27, - SPACE : 32, - PAGE_UP : 33, // also NUM_NORTH_EAST - PAGE_DOWN : 34, // also NUM_SOUTH_EAST - END : 35, // also NUM_SOUTH_WEST - HOME : 36, // also NUM_NORTH_WEST - LEFT : 37, // also NUM_WEST - UP : 38, // also NUM_NORTH - RIGHT : 39, // also NUM_EAST - DOWN : 40, // also NUM_SOUTH - PRINT_SCREEN : 44, - INSERT : 45, // also NUM_INSERT - DELETE : 46, // also NUM_DELETE - ZERO : 48, - ONE : 49, - TWO : 50, - THREE : 51, - FOUR : 52, - FIVE : 53, - SIX : 54, - SEVEN : 55, - EIGHT : 56, - NINE : 57, - FF_SEMICOLON : 59, // Firefox (Gecko) fires this for semicolon instead of 186 - FF_EQUALS : 61, // Firefox (Gecko) fires this for equals instead of 187 - FF_DASH : 173, // Firefox (Gecko) fires this for dash instead of 189 - QUESTION_MARK : 63, // needs localization - A : 65, - B : 66, - C : 67, - D : 68, - E : 69, - F : 70, - G : 71, - H : 72, - I : 73, - J : 74, - K : 75, - L : 76, - M : 77, - N : 78, - O : 79, - P : 80, - Q : 81, - R : 82, - S : 83, - T : 84, - U : 85, - V : 86, - W : 87, - X : 88, - Y : 89, - Z : 90, - META : 91, // WIN_KEY_LEFT - WIN_KEY_RIGHT : 92, - CONTEXT_MENU : 93, - NUM_ZERO : 96, - NUM_ONE : 97, - NUM_TWO : 98, - NUM_THREE : 99, - NUM_FOUR : 100, - NUM_FIVE : 101, - NUM_SIX : 102, - NUM_SEVEN : 103, - NUM_EIGHT : 104, - NUM_NINE : 105, - NUM_MULTIPLY : 106, - NUM_PLUS : 107, - NUM_MINUS : 109, - NUM_PERIOD : 110, - NUM_DIVISION : 111, - F1 : 112, - F2 : 113, - F3 : 114, - F4 : 115, - F5 : 116, - F6 : 117, - F7 : 118, - F8 : 119, - F9 : 120, - F10 : 121, - F11 : 122, - F12 : 123, - NUMLOCK : 144, - SCROLL_LOCK : 145, - - // OS-specific media keys like volume controls and browser controls. - FIRST_MEDIA_KEY : 166, - LAST_MEDIA_KEY : 183, - - SEMICOLON : 186, // needs localization - DASH : 189, // needs localization - EQUALS : 187, // needs localization - COMMA : 188, // needs localization - PERIOD : 190, // needs localization - SLASH : 191, // needs localization - APOSTROPHE : 192, // needs localization - TILDE : 192, // needs localization - SINGLE_QUOTE : 222, // needs localization - OPEN_SQUARE_BRACKET : 219, // needs localization - BACKSLASH : 220, // needs localization - CLOSE_SQUARE_BRACKET: 221, // needs localization - WIN_KEY : 224, - MAC_FF_META : 224, // Firefox (Gecko) fires this for the meta key instead of 91 - MAC_WK_CMD_LEFT : 91, // WebKit Left Command key fired, same as META - MAC_WK_CMD_RIGHT : 93, // WebKit Right Command key fired, different from META - WIN_IME : 229, - - // We've seen users whose machines fire this keycode at regular one - // second intervals. The common thread among these users is that - // they're all using Dell Inspiron laptops, so we suspect that this - // indicates a hardware/bios problem. - // http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx - PHANTOM : 255 -}; -// ===================================================================================================================== diff --git a/vis/extern/BrowserLib/Core/Code/LocalStore.js b/vis/extern/BrowserLib/Core/Code/LocalStore.js deleted file mode 100644 index 7bb8481..0000000 --- a/vis/extern/BrowserLib/Core/Code/LocalStore.js +++ /dev/null @@ -1,40 +0,0 @@ - -namespace("LocalStore"); - - -LocalStore.Set = function(class_name, class_id, variable_id, data) -{ - try - { - if (typeof(Storage) != "undefined") - { - var name = class_name + "_" + class_id + "_" + variable_id; - localStorage[name] = JSON.stringify(data); - } - } - catch (e) - { - console.log("Local Storage Set Error: " + e.message); - } -} - - -LocalStore.Get = function(class_name, class_id, variable_id, default_data) -{ - try - { - if (typeof(Storage) != "undefined") - { - var name = class_name + "_" + class_id + "_" + variable_id; - var data = localStorage[name] - if (data) - return JSON.parse(data); - } - } - catch (e) - { - console.log("Local Storage Get Error: " + e.message); - } - - return default_data; -} \ No newline at end of file diff --git a/vis/extern/BrowserLib/Core/Code/Mouse.js b/vis/extern/BrowserLib/Core/Code/Mouse.js deleted file mode 100644 index a694b80..0000000 --- a/vis/extern/BrowserLib/Core/Code/Mouse.js +++ /dev/null @@ -1,83 +0,0 @@ - -namespace("Mouse"); - - -Mouse.State =(function() -{ - function State(event) - { - // Get button press states - if (typeof event.buttons != "undefined") - { - // Firefox - this.Left = (event.buttons & 1) != 0; - this.Right = (event.buttons & 2) != 0; - this.Middle = (event.buttons & 4) != 0; - } - else - { - // Chrome - this.Left = (event.button == 0); - this.Middle = (event.button == 1); - this.Right = (event.button == 2); - } - - // Get page-relative mouse position - this.Position = DOM.Event.GetMousePosition(event); - - // Get wheel delta - var delta = 0; - if (event.wheelDelta) - delta = event.wheelDelta / 120; // IE/Opera - else if (event.detail) - delta = -event.detail / 3; // Mozilla - this.WheelDelta = delta; - - // Get the mouse position delta - // Requires Pointer Lock API support - this.PositionDelta = [ - event.movementX || event.mozMovementX || event.webkitMovementX || 0, - event.movementY || event.mozMovementY || event.webkitMovementY || 0 - ]; - } - - return State; -})(); - - -// -// Basic Pointer Lock API support -// https://developer.mozilla.org/en-US/docs/WebAPI/Pointer_Lock -// http://www.chromium.org/developers/design-documents/mouse-lock -// -// Note that API has not been standardised yet so browsers can implement functions with prefixes -// - - -Mouse.PointerLockSupported = function() -{ - return 'pointerLockElement' in document || 'mozPointerLockElement' in document || 'webkitPointerLockElement' in document; -} - - -Mouse.RequestPointerLock = function(element) -{ - element.requestPointerLock = element.requestPointerLock || element.mozRequestPointerLock || element.webkitRequestPointerLock; - if (element.requestPointerLock) - element.requestPointerLock(); -} - - -Mouse.ExitPointerLock = function() -{ - document.exitPointerLock = document.exitPointerLock || document.mozExitPointerLock || document.webkitExitPointerLock; - if (document.exitPointerLock) - document.exitPointerLock(); -} - - -// Can use this element to detect whether pointer lock is enabled (returns non-null) -Mouse.PointerLockElement = function() -{ - return document.pointerLockElement || document.mozPointerLockElement || document.webkitPointerLockElement; -} diff --git a/vis/extern/BrowserLib/Core/Code/MurmurHash3.js b/vis/extern/BrowserLib/Core/Code/MurmurHash3.js deleted file mode 100644 index c423d49..0000000 --- a/vis/extern/BrowserLib/Core/Code/MurmurHash3.js +++ /dev/null @@ -1,68 +0,0 @@ - -namespace("Hash"); - -/** - * JS Implementation of MurmurHash3 (r136) (as of May 20, 2011) - * - * @author Gary Court - * @see http://github.com/garycourt/murmurhash-js - * @author Austin Appleby - * @see http://sites.google.com/site/murmurhash/ - * - * @param {string} key ASCII only - * @param {number} seed Positive integer only - * @return {number} 32-bit positive integer hash - */ - -Hash.Murmur3 = function(key, seed) -{ - var remainder, bytes, h1, h1b, c1, c1b, c2, c2b, k1, i; - - remainder = key.length & 3; // key.length % 4 - bytes = key.length - remainder; - h1 = seed; - c1 = 0xcc9e2d51; - c2 = 0x1b873593; - i = 0; - - while (i < bytes) { - k1 = - ((key.charCodeAt(i) & 0xff)) | - ((key.charCodeAt(++i) & 0xff) << 8) | - ((key.charCodeAt(++i) & 0xff) << 16) | - ((key.charCodeAt(++i) & 0xff) << 24); - ++i; - - k1 = ((((k1 & 0xffff) * c1) + ((((k1 >>> 16) * c1) & 0xffff) << 16))) & 0xffffffff; - k1 = (k1 << 15) | (k1 >>> 17); - k1 = ((((k1 & 0xffff) * c2) + ((((k1 >>> 16) * c2) & 0xffff) << 16))) & 0xffffffff; - - h1 ^= k1; - h1 = (h1 << 13) | (h1 >>> 19); - h1b = ((((h1 & 0xffff) * 5) + ((((h1 >>> 16) * 5) & 0xffff) << 16))) & 0xffffffff; - h1 = (((h1b & 0xffff) + 0x6b64) + ((((h1b >>> 16) + 0xe654) & 0xffff) << 16)); - } - - k1 = 0; - - switch (remainder) { - case 3: k1 ^= (key.charCodeAt(i + 2) & 0xff) << 16; - case 2: k1 ^= (key.charCodeAt(i + 1) & 0xff) << 8; - case 1: k1 ^= (key.charCodeAt(i) & 0xff); - - k1 = (((k1 & 0xffff) * c1) + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff; - k1 = (k1 << 15) | (k1 >>> 17); - k1 = (((k1 & 0xffff) * c2) + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff; - h1 ^= k1; - } - - h1 ^= key.length; - - h1 ^= h1 >>> 16; - h1 = (((h1 & 0xffff) * 0x85ebca6b) + ((((h1 >>> 16) * 0x85ebca6b) & 0xffff) << 16)) & 0xffffffff; - h1 ^= h1 >>> 13; - h1 = ((((h1 & 0xffff) * 0xc2b2ae35) + ((((h1 >>> 16) * 0xc2b2ae35) & 0xffff) << 16))) & 0xffffffff; - h1 ^= h1 >>> 16; - - return h1 >>> 0; -} \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Code/Button.js b/vis/extern/BrowserLib/WindowManager/Code/Button.js deleted file mode 100644 index 12e0981..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Button.js +++ /dev/null @@ -1,131 +0,0 @@ - -namespace("WM"); - - -WM.Button = (function() -{ - var template_html = "
"; - - - function Button(text, x, y, opts) - { - this.OnClick = null; - this.Toggle = opts && opts.toggle; - - this.Node = DOM.Node.CreateHTML(template_html); - - // Set node dimensions - this.SetPosition(x, y); - if (opts && opts.w && opts.h) - this.SetSize(opts.w, opts.h); - - // Override the default class name - if (opts && opts.class) - this.Node.className = opts.class; - - this.SetText(text); - - // Create the mouse press event handlers - DOM.Event.AddHandler(this.Node, "mousedown", Bind(OnMouseDown, this)); - this.OnMouseOutDelegate = Bind(OnMouseUp, this, false); - this.OnMouseUpDelegate = Bind(OnMouseUp, this, true); - } - - - Button.prototype.SetPosition = function(x, y) - { - this.Position = [ x, y ]; - DOM.Node.SetPosition(this.Node, this.Position); - } - - - Button.prototype.SetSize = function(w, h) - { - this.Size = [ w, h ]; - DOM.Node.SetSize(this.Node, this.Size); - } - - - Button.prototype.SetText = function(text) - { - this.Node.innerHTML = text; - } - - - Button.prototype.SetOnClick = function(on_click) - { - this.OnClick = on_click; - } - - - Button.prototype.SetState = function(pressed) - { - if (pressed) - DOM.Node.AddClass(this.Node, "ButtonHeld"); - else - DOM.Node.RemoveClass(this.Node, "ButtonHeld"); - } - - - Button.prototype.ToggleState = function() - { - if (DOM.Node.HasClass(this.Node, "ButtonHeld")) - this.SetState(false); - else - this.SetState(true); - } - - - Button.prototype.IsPressed = function() - { - return DOM.Node.HasClass(this.Node, "ButtonHeld"); - } - - - function OnMouseDown(self, evt) - { - // Decide how to set the button state - if (self.Toggle) - self.ToggleState(); - else - self.SetState(true); - - // Activate release handlers - DOM.Event.AddHandler(self.Node, "mouseout", self.OnMouseOutDelegate); - DOM.Event.AddHandler(self.Node, "mouseup", self.OnMouseUpDelegate); - - DOM.Event.StopAll(evt); - } - - - function OnMouseUp(self, confirm, evt) - { - if (confirm) - { - // Only release for non-toggles - if (!self.Toggle) - self.SetState(false); - } - else - { - // Decide how to set the button state - if (self.Toggle) - self.ToggleState(); - else - self.SetState(false); - } - - // Remove release handlers - DOM.Event.RemoveHandler(self.Node, "mouseout", self.OnMouseOutDelegate); - DOM.Event.RemoveHandler(self.Node, "mouseup", self.OnMouseUpDelegate); - - // Call the click handler if this is a button press - if (confirm && self.OnClick) - self.OnClick(self); - - DOM.Event.StopAll(evt); - } - - - return Button; -})(); \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Code/ComboBox.js b/vis/extern/BrowserLib/WindowManager/Code/ComboBox.js deleted file mode 100644 index d199b3a..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/ComboBox.js +++ /dev/null @@ -1,237 +0,0 @@ - -namespace("WM"); - - -WM.ComboBoxPopup = (function() -{ - var body_template_html = "
"; - - var item_template_html = " \ -
\ -
\ -
\ -
\ -
"; - - - function ComboBoxPopup(combo_box) - { - this.ComboBox = combo_box; - this.ParentNode = combo_box.Node; - this.ValueNodes = [ ]; - - // Create the template node - this.Node = DOM.Node.CreateHTML(body_template_html); - - DOM.Event.AddHandler(this.Node, "mousedown", Bind(SelectItem, this)); - this.CancelDelegate = Bind(this, "Cancel"); - } - - - ComboBoxPopup.prototype.SetValues = function(values) - { - // Clear existing values - this.Node.innerHTML = ""; - - // Generate HTML nodes for each value - this.ValueNodes = [ ]; - for (var i in values) - { - var item_node = DOM.Node.CreateHTML(item_template_html); - var text_node = DOM.Node.FindWithClass(item_node, "ComboBoxPopupItemText"); - - item_node.Value = values[i]; - text_node.innerHTML = values[i]; - - this.Node.appendChild(item_node); - this.ValueNodes.push(item_node); - } - } - - - ComboBoxPopup.prototype.Show = function(selection_index) - { - // Initially match the position of the parent node - var pos = DOM.Node.GetPosition(this.ParentNode); - DOM.Node.SetPosition(this.Node, pos); - - // Take the width/z-index from the parent node - this.Node.style.width = this.ParentNode.offsetWidth; - this.Node.style.zIndex = this.ParentNode.style.zIndex + 1; - - // Setup event handlers - DOM.Event.AddHandler(document.body, "mousedown", this.CancelDelegate); - - // Show the popup so that the HTML layout engine kicks in before - // the layout info is used below - this.ParentNode.appendChild(this.Node); - - // Show/hide the tick image based on which node is selected - for (var i in this.ValueNodes) - { - var node = this.ValueNodes[i]; - var icon_node = DOM.Node.FindWithClass(node, "ComboBoxPopupItemIcon"); - - if (i == selection_index) - { - icon_node.style.display = "block"; - - // Also, shift the popup up so that the mouse is over the selected item and is highlighted - var item_pos = DOM.Node.GetPosition(this.ValueNodes[selection_index]); - var diff_pos = [ item_pos[0] - pos[0], item_pos[1] - pos[1] ]; - pos = [ pos[0] - diff_pos[0], pos[1] - diff_pos[1] ]; - } - else - { - icon_node.style.display = "none"; - } - } - - DOM.Node.SetPosition(this.Node, pos); - } - - - ComboBoxPopup.prototype.Hide = function() - { - DOM.Event.RemoveHandler(document.body, "mousedown", this.CancelDelegate); - this.ParentNode.removeChild(this.Node); - } - - - function SelectItem(self, evt) - { - // Search for which item node is being clicked on - var node = DOM.Event.GetNode(evt); - for (var i in self.ValueNodes) - { - var value_node = self.ValueNodes[i]; - if (DOM.Node.Contains(node, value_node)) - { - // Set the value on the combo box - self.ComboBox.SetValue(value_node.Value); - self.Hide(); - break; - } - } - } - - - function Cancel(self, evt) - { - // Don't cancel if the mouse up is anywhere on the popup or combo box - var node = DOM.Event.GetNode(evt); - if (!DOM.Node.Contains(node, self.Node) && - !DOM.Node.Contains(node, self.ParentNode)) - { - self.Hide(); - } - - - DOM.Event.StopAll(evt); - } - - - return ComboBoxPopup; -})(); - - -WM.ComboBox = (function() -{ - var template_html = " \ -
\ -
\ -
\ -
\ -
"; - - - function ComboBox() - { - this.OnChange = null; - - // Create the template node and locate key nodes - this.Node = DOM.Node.CreateHTML(template_html); - this.TextNode = DOM.Node.FindWithClass(this.Node, "ComboBoxText"); - - // Create a reusable popup - this.Popup = new WM.ComboBoxPopup(this); - - // Set an empty set of values - this.SetValues([]); - this.SetValue("<empty>"); - - // Create the mouse press event handlers - DOM.Event.AddHandler(this.Node, "mousedown", Bind(OnMouseDown, this)); - this.OnMouseOutDelegate = Bind(OnMouseUp, this, false); - this.OnMouseUpDelegate = Bind(OnMouseUp, this, true); - } - - - ComboBox.prototype.SetOnChange = function(on_change) - { - this.OnChange = on_change; - } - - - ComboBox.prototype.SetValues = function(values) - { - this.Values = values; - this.Popup.SetValues(values); - } - - - ComboBox.prototype.SetValue = function(value) - { - // Set the value and its HTML rep - var old_value = this.Value; - this.Value = value; - this.TextNode.innerHTML = value; - - // Call change handler - if (this.OnChange) - this.OnChange(value, old_value); - } - - - ComboBox.prototype.GetValue = function() - { - return this.Value; - } - - - function OnMouseDown(self, evt) - { - // If this check isn't made, the click will trigger from the popup, too - var node = DOM.Event.GetNode(evt); - if (DOM.Node.Contains(node, self.Node)) - { - // Add the depression class and activate release handlers - DOM.Node.AddClass(self.Node, "ComboBoxPressed"); - DOM.Event.AddHandler(self.Node, "mouseout", self.OnMouseOutDelegate); - DOM.Event.AddHandler(self.Node, "mouseup", self.OnMouseUpDelegate); - - DOM.Event.StopAll(evt); - } - } - - - function OnMouseUp(self, confirm, evt) - { - // Remove depression class and remove release handlers - DOM.Node.RemoveClass(self.Node, "ComboBoxPressed"); - DOM.Event.RemoveHandler(self.Node, "mouseout", self.OnMouseOutDelegate); - DOM.Event.RemoveHandler(self.Node, "mouseup", self.OnMouseUpDelegate); - - // If this is a confirmed press and there are some values in the list, show the popup - if (confirm && self.Values.length > 0) - { - var selection_index = self.Values.indexOf(self.Value); - self.Popup.Show(selection_index); - } - - DOM.Event.StopAll(evt); - } - - - return ComboBox; -})(); diff --git a/vis/extern/BrowserLib/WindowManager/Code/Container.js b/vis/extern/BrowserLib/WindowManager/Code/Container.js deleted file mode 100644 index 6a6bdf1..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Container.js +++ /dev/null @@ -1,48 +0,0 @@ - -namespace("WM"); - - -WM.Container = (function() -{ - var template_html = "
"; - - - function Container(x, y, w, h) - { - // Create a simple container node - this.Node = DOM.Node.CreateHTML(template_html); - this.SetPosition(x, y); - this.SetSize(w, h); - } - - - Container.prototype.SetPosition = function(x, y) - { - this.Position = [ x, y ]; - DOM.Node.SetPosition(this.Node, this.Position); - } - - - Container.prototype.SetSize = function(w, h) - { - this.Size = [ w, h ]; - DOM.Node.SetSize(this.Node, this.Size); - } - - - Container.prototype.AddControlNew = function(control) - { - control.ParentNode = this.Node; - this.Node.appendChild(control.Node); - return control; - } - - - Container.prototype.ClearControls = function() - { - this.Node.innerHTML = ""; - } - - - return Container; -})(); \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Code/EditBox.js b/vis/extern/BrowserLib/WindowManager/Code/EditBox.js deleted file mode 100644 index fd0a039..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/EditBox.js +++ /dev/null @@ -1,119 +0,0 @@ - -namespace("WM"); - - -WM.EditBox = (function() -{ - var template_html = " \ -
\ -
Label
\ - \ -
"; - - - function EditBox(x, y, w, h, label, text) - { - this.ChangeHandler = null; - - // Create node and locate its internal nodes - this.Node = DOM.Node.CreateHTML(template_html); - this.LabelNode = DOM.Node.FindWithClass(this.Node, "EditBoxLabel"); - this.EditNode = DOM.Node.FindWithClass(this.Node, "EditBox"); - - // Set label and value - this.LabelNode.innerHTML = label; - this.SetValue(text); - - this.SetPosition(x, y); - this.SetSize(w, h); - - this.PreviousValue = ""; - - // Hook up the event handlers - DOM.Event.AddHandler(this.EditNode, "focus", Bind(OnFocus, this)); - DOM.Event.AddHandler(this.EditNode, "keypress", Bind(OnKeyPress, this)); - DOM.Event.AddHandler(this.EditNode, "keydown", Bind(OnKeyDown, this)); - } - - - EditBox.prototype.SetPosition = function(x, y) - { - this.Position = [ x, y ]; - DOM.Node.SetPosition(this.Node, this.Position); - } - - - EditBox.prototype.SetSize = function(w, h) - { - this.Size = [ w, h ]; - DOM.Node.SetSize(this.EditNode, this.Size); - } - - - EditBox.prototype.SetChangeHandler = function(handler) - { - this.ChangeHandler = handler; - } - - - EditBox.prototype.SetValue = function(value) - { - if (this.EditNode) - this.EditNode.value = value; - } - - - EditBox.prototype.GetValue = function() - { - if (this.EditNode) - return this.EditNode.value; - - return null; - } - - - EditBox.prototype.LoseFocus = function() - { - if (this.EditNode) - this.EditNode.blur(); - } - - - function OnFocus(self, evt) - { - // Backup on focus - self.PreviousValue = self.EditNode.value; - } - - - function OnKeyPress(self, evt) - { - // Allow enter to confirm the text only when there's data - if (evt.keyCode == 13 && self.EditNode.value != "" && self.ChangeHandler) - { - var focus = self.ChangeHandler(self.EditNode); - if (!focus) - self.EditNode.blur(); - self.PreviousValue = ""; - } - } - - - function OnKeyDown(self, evt) - { - // Allow escape to cancel any text changes - if (evt.keyCode == 27) - { - // On initial edit of the input, escape should NOT replace with the empty string - if (self.PreviousValue != "") - { - self.EditNode.value = self.PreviousValue; - } - - self.EditNode.blur(); - } - } - - - return EditBox; -})(); diff --git a/vis/extern/BrowserLib/WindowManager/Code/Grid.js b/vis/extern/BrowserLib/WindowManager/Code/Grid.js deleted file mode 100644 index bb72858..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Grid.js +++ /dev/null @@ -1,248 +0,0 @@ - -namespace("WM"); - - -WM.GridRows = (function() -{ - function GridRows(parent_object) - { - this.ParentObject = parent_object; - - // Array of rows in the order they were added - this.Rows = [ ]; - - // Collection of custom row indexes for fast lookup - this.Indexes = { }; - } - - - GridRows.prototype.AddIndex = function(cell_field_name) - { - var index = { }; - - // Go through existing rows and add to the index - for (var i in this.Rows) - { - var row = this.Rows[i]; - if (cell_field_name in row.CellData) - { - var cell_field = row.CellData[cell_field_name]; - index[cell_field] = row; - } - } - - this.Indexes[cell_field_name] = index; - } - - - GridRows.prototype.ClearIndex = function(index_name) - { - this.Indexes[index_name] = { }; - } - - GridRows.prototype.AddRowToIndex = function(index_name, cell_data, row) - { - this.Indexes[index_name][cell_data] = row; - } - - - GridRows.prototype.Add = function(cell_data, row_classes, cell_classes) - { - var row = new WM.GridRow(this.ParentObject, cell_data, row_classes, cell_classes); - this.Rows.push(row); - return row; - } - - - GridRows.prototype.GetBy = function(cell_field_name, cell_data) - { - var index = this.Indexes[cell_field_name]; - return index[cell_data]; - } - - - GridRows.prototype.Clear = function() - { - // Remove all node references from the parent - for (var i in this.Rows) - { - var row = this.Rows[i]; - row.Parent.BodyNode.removeChild(row.Node); - } - - // Clear all indexes - for (var i in this.Indexes) - this.Indexes[i] = { }; - - this.Rows = [ ]; - } - - - return GridRows; -})(); - - -WM.GridRow = (function() -{ - var template_html = "
"; - - - // - // 'cell_data' is an object with a variable number of fields. - // Any fields prefixed with an underscore are hidden. - // - function GridRow(parent, cell_data, row_classes, cell_classes) - { - // Setup data - this.Parent = parent; - this.IsOpen = true; - this.AnimHandle = null; - this.Rows = new WM.GridRows(this); - this.CellData = cell_data; - this.CellNodes = { } - - // Create the main row node - this.Node = DOM.Node.CreateHTML(template_html); - if (row_classes) - DOM.Node.AddClass(this.Node, row_classes); - - // Embed a pointer to the row in the root node so that it can be clicked - this.Node.GridRow = this; - - // Create nodes for each required cell - for (var attr in this.CellData) - { - if (this.CellData.hasOwnProperty(attr)) - { - var data = this.CellData[attr]; - - // Update any grid row index references - if (attr in parent.Rows.Indexes) - parent.Rows.AddRowToIndex(attr, data, this); - - // Hide any cells with underscore prefixes - if (attr[0] == "_") - continue; - - // Create a node for the cell and add any custom classes - var node = DOM.Node.AppendHTML(this.Node, "
"); - if (cell_classes && attr in cell_classes) - DOM.Node.AddClass(node, cell_classes[attr]); - this.CellNodes[attr] = node; - - // If this is a Window Control, add its node to the cell - if (data instanceof Object && "Node" in data && DOM.Node.IsNode(data.Node)) - { - data.ParentNode = node; - node.appendChild(data.Node); - } - - else - { - // Otherwise just assign the data as text - node.innerHTML = data; - } - } - } - - // Add the body node for any children - if (!this.Parent.BodyNode) - this.Parent.BodyNode = DOM.Node.AppendHTML(this.Parent.Node, "
"); - - // Add the row to the parent - this.Parent.BodyNode.appendChild(this.Node); - } - - - GridRow.prototype.Open = function() - { - // Don't allow open while animating - if (this.AnimHandle == null || this.AnimHandle.Complete) - { - this.IsOpen = true; - - // Kick off open animation - var node = this.BodyNode; - this.AnimHandle = Anim.Animate( - function (val) { DOM.Node.SetHeight(node, val) }, - 0, this.Height, 0.2); - } - } - - - GridRow.prototype.Close = function() - { - // Don't allow close while animating - if (this.AnimHandle == null || this.AnimHandle.Complete) - { - this.IsOpen = false; - - // Record height for the next open request - this.Height = this.BodyNode.offsetHeight; - - // Kick off close animation - var node = this.BodyNode; - this.AnimHandle = Anim.Animate( - function (val) { DOM.Node.SetHeight(node, val) }, - this.Height, 0, 0.2); - } - } - - - GridRow.prototype.Toggle = function() - { - if (this.IsOpen) - this.Close(); - else - this.Open(); - } - - - return GridRow; -})(); - - -WM.Grid = (function() -{ - var template_html = " \ -
\ -
\ -
"; - - - function Grid() - { - this.Rows = new WM.GridRows(this); - - this.Node = DOM.Node.CreateHTML(template_html); - this.BodyNode = DOM.Node.FindWithClass(this.Node, "GridBody"); - - DOM.Event.AddHandler(this.Node, "dblclick", OnDblClick); - - var mouse_wheel_event = (/Firefox/i.test(navigator.userAgent)) ? "DOMMouseScroll" : "mousewheel"; - DOM.Event.AddHandler(this.Node, mouse_wheel_event, Bind(OnMouseScroll, this)); - } - - function OnDblClick(evt) - { - // Clicked on a header? - var node = DOM.Event.GetNode(evt); - if (DOM.Node.HasClass(node, "GridRowName")) - { - // Toggle rows open/close - var row = node.parentNode.GridRow; - if (row) - row.Toggle(); - } - } - - - function OnMouseScroll(self, evt) - { - var mouse_state = new Mouse.State(evt); - self.Node.scrollTop -= mouse_state.WheelDelta * 20; - } - - - return Grid; -})(); diff --git a/vis/extern/BrowserLib/WindowManager/Code/Label.js b/vis/extern/BrowserLib/WindowManager/Code/Label.js deleted file mode 100644 index 9b1d852..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Label.js +++ /dev/null @@ -1,31 +0,0 @@ - -namespace("WM"); - - -WM.Label = (function() -{ - var template_html = "
"; - - - function Label(x, y, text) - { - // Create the node - this.Node = DOM.Node.CreateHTML(template_html); - - // Allow position to be optional - if (x != null && y != null) - DOM.Node.SetPosition(this.Node, [x, y]); - - this.SetText(text); - } - - - Label.prototype.SetText = function(text) - { - if (text != null) - this.Node.innerHTML = text; - } - - - return Label; -})(); \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Code/Treeview.js b/vis/extern/BrowserLib/WindowManager/Code/Treeview.js deleted file mode 100644 index 66ef80e..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Treeview.js +++ /dev/null @@ -1,352 +0,0 @@ - -namespace("WM"); - - -WM.Treeview = (function() -{ - var Margin = 10; - - - var tree_template_html = " \ -
\ -
\ -
\ -
\ -
\ -
\ -
"; - - - var item_template_html = " \ -
\ - \ -
\ -
\ -
\ -
\ -
"; - - - // TODO: Remove parent_node (required for stuff that doesn't use the WM yet) - function Treeview(x, y, width, height, parent_node) - { - // Cache initialisation options - this.ParentNode = parent_node; - this.Position = [ x, y ]; - this.Size = [ width, height ]; - - this.Node = null; - this.ScrollbarNode = null; - this.SelectedItem = null; - this.ContentsNode = null; - - // Setup options - this.HighlightOnHover = false; - this.EnableScrollbar = true; - this.HorizontalLayoutDepth = 1; - - // Generate an empty tree - this.Clear(); - } - - - Treeview.prototype.SetHighlightOnHover = function(highlight) - { - this.HighlightOnHover = highlight; - } - - - Treeview.prototype.SetEnableScrollbar = function(enable) - { - this.EnableScrollbar = enable; - } - - - Treeview.prototype.SetHorizontalLayoutDepth = function(depth) - { - this.HorizontalLayoutDepth = depth; - } - - - Treeview.prototype.SetNodeSelectedHandler = function(handler) - { - this.NodeSelectedHandler = handler; - } - - - Treeview.prototype.Clear = function() - { - this.RootItem = new WM.TreeviewItem(this, null, null, null, null); - this.GenerateHTML(); - } - - - Treeview.prototype.Root = function() - { - return this.RootItem; - } - - - Treeview.prototype.ClearSelection = function() - { - if (this.SelectedItem != null) - { - DOM.Node.RemoveClass(this.SelectedItem.Node, "TreeviewItemSelected"); - this.SelectedItem = null; - } - } - - - Treeview.prototype.SelectItem = function(item, mouse_pos) - { - // Notify the select handler - if (this.NodeSelectedHandler) - this.NodeSelectedHandler(item.Node, this.SelectedItem, item, mouse_pos); - - // Remove highlight from the old selection - this.ClearSelection(); - - // Swap in new selection and apply highlight - this.SelectedItem = item; - DOM.Node.AddClass(this.SelectedItem.Node, "TreeviewItemSelected"); - } - - - Treeview.prototype.GenerateHTML = function() - { - // Clone the template and locate important nodes - var old_node = this.Node; - this.Node = DOM.Node.CreateHTML(tree_template_html); - this.ChildrenNode = DOM.Node.FindWithClass(this.Node, "TreeviewItemChildren"); - this.ScrollbarNode = DOM.Node.FindWithClass(this.Node, "TreeviewScrollbar"); - - DOM.Node.SetPosition(this.Node, this.Position); - DOM.Node.SetSize(this.Node, this.Size); - - // Generate the contents of the treeview - GenerateTree(this, this.ChildrenNode, this.RootItem.Children, 0); - - // Cross-browser (?) means of adding a mouse wheel handler - var mouse_wheel_event = (/Firefox/i.test(navigator.userAgent)) ? "DOMMouseScroll" : "mousewheel"; - DOM.Event.AddHandler(this.Node, mouse_wheel_event, Bind(OnMouseScroll, this)); - - DOM.Event.AddHandler(this.Node, "dblclick", Bind(OnMouseDoubleClick, this)); - DOM.Event.AddHandler(this.Node, "mousedown", Bind(OnMouseDown, this)); - DOM.Event.AddHandler(this.Node, "mouseup", OnMouseUp); - - // Swap in the newly generated control node if it's already been attached to a parent - if (old_node && old_node.parentNode) - { - old_node.parentNode.removeChild(old_node); - this.ParentNode.appendChild(this.Node); - } - - if (this.EnableScrollbar) - { - this.UpdateScrollbar(); - DOM.Event.AddHandler(this.ScrollbarNode, "mousedown", Bind(OnMouseDown_Scrollbar, this)); - DOM.Event.AddHandler(this.ScrollbarNode, "mouseup", Bind(OnMouseUp_Scrollbar, this)); - DOM.Event.AddHandler(this.ScrollbarNode, "mouseout", Bind(OnMouseUp_Scrollbar, this)); - DOM.Event.AddHandler(this.ScrollbarNode, "mousemove", Bind(OnMouseMove_Scrollbar, this)); - } - - else - { - DOM.Node.Hide(DOM.Node.FindWithClass(this.Node, "TreeviewScrollbarInset")); - } - } - - - Treeview.prototype.UpdateScrollbar = function() - { - if (!this.EnableScrollbar) - return; - - var scrollbar_scale = Math.min((this.Node.offsetHeight - Margin * 2) / this.ChildrenNode.offsetHeight, 1); - this.ScrollbarNode.style.height = parseInt(scrollbar_scale * 100) + "%"; - - // Shift the scrollbar container along with the parent window - this.ScrollbarNode.parentNode.style.top = this.Node.scrollTop; - - var scroll_fraction = this.Node.scrollTop / (this.Node.scrollHeight - this.Node.offsetHeight); - var max_height = this.Node.offsetHeight - Margin; - var max_scrollbar_offset = max_height - this.ScrollbarNode.offsetHeight; - var scrollbar_offset = scroll_fraction * max_scrollbar_offset; - this.ScrollbarNode.style.top = scrollbar_offset; - } - - - function GenerateTree(self, parent_node, items, depth) - { - if (items.length == 0) - return null; - - for (var i in items) - { - var item = items[i]; - - // Create the node for this item and locate important nodes - var node = DOM.Node.CreateHTML(item_template_html); - var img = DOM.Node.FindWithClass(node, "TreeviewItemImage"); - var text = DOM.Node.FindWithClass(node, "TreeviewItemText"); - var children = DOM.Node.FindWithClass(node, "TreeviewItemChildren"); - - // Attach the item to the node - node.TreeviewItem = item; - item.Node = node; - - // Add the class which highlights selection on hover - if (self.HighlightOnHover) - DOM.Node.AddClass(node, "TreeviewItemHover"); - - // Instruct the children to wrap around - if (depth >= self.HorizontalLayoutDepth) - node.style.cssFloat = "left"; - - if (item.OpenImage == null || item.CloseImage == null) - { - // If there no images, remove the image node - node.removeChild(img); - } - else - { - // Set the image source to open - img.src = item.OpenImage.src; - img.style.width = item.OpenImage.width; - img.style.height = item.OpenImage.height; - item.ImageNode = img; - } - - // Setup the text to display - text.innerHTML = item.Label; - - // Add the div to the parent and recurse into children - parent_node.appendChild(node); - GenerateTree(self, children, item.Children, depth + 1); - item.ChildrenNode = children; - } - - // Clear the wrap-around - if (depth >= self.HorizontalLayoutDepth) - DOM.Node.AppendClearFloat(parent_node.parentNode); - } - - - function OnMouseScroll(self, evt) - { - // Get mouse wheel movement - var delta = evt.detail ? evt.detail * -1 : evt.wheelDelta; - delta *= 8; - - // Scroll the main window with wheel movement and clamp - self.Node.scrollTop -= delta; - self.Node.scrollTop = Math.min(self.Node.scrollTop, (self.ChildrenNode.offsetHeight - self.Node.offsetHeight) + Margin * 2); - - self.UpdateScrollbar(); - } - - - function OnMouseDoubleClick(self, evt) - { - DOM.Event.StopDefaultAction(evt); - - // Get the tree view item being clicked, if any - var node = DOM.Event.GetNode(evt); - var tvitem = GetTreeviewItemFromNode(self, node); - if (tvitem == null) - return; - - if (tvitem.Children.length) - tvitem.Toggle(); - } - - - function OnMouseDown(self, evt) - { - DOM.Event.StopDefaultAction(evt); - - // Get the tree view item being clicked, if any - var node = DOM.Event.GetNode(evt); - var tvitem = GetTreeviewItemFromNode(self, node); - if (tvitem == null) - return; - - // If clicking on the image, expand any children - if (node.tagName == "IMG" && tvitem.Children.length) - { - tvitem.Toggle(); - } - - else - { - var mouse_pos = DOM.Event.GetMousePosition(evt); - self.SelectItem(tvitem, mouse_pos); - } - } - - - function OnMouseUp(evt) - { - // Event handler used merely to stop events bubbling up to containers - DOM.Event.StopPropagation(evt); - } - - - function OnMouseDown_Scrollbar(self, evt) - { - self.ScrollbarHeld = true; - - // Cache the mouse height relative to the scrollbar - self.LastY = evt.clientY; - self.ScrollY = self.Node.scrollTop; - - DOM.Node.AddClass(self.ScrollbarNode, "TreeviewScrollbarHeld"); - DOM.Event.StopDefaultAction(evt); - } - - - function OnMouseUp_Scrollbar(self, evt) - { - self.ScrollbarHeld = false; - DOM.Node.RemoveClass(self.ScrollbarNode, "TreeviewScrollbarHeld"); - } - - - function OnMouseMove_Scrollbar(self, evt) - { - if (self.ScrollbarHeld) - { - var delta_y = evt.clientY - self.LastY; - self.LastY = evt.clientY; - - var max_height = self.Node.offsetHeight - Margin; - var max_scrollbar_offset = max_height - self.ScrollbarNode.offsetHeight; - var max_contents_scroll = self.Node.scrollHeight - self.Node.offsetHeight; - var scale = max_contents_scroll / max_scrollbar_offset; - - // Increment the local float variable and assign, as scrollTop is of type int - self.ScrollY += delta_y * scale; - self.Node.scrollTop = self.ScrollY; - self.Node.scrollTop = Math.min(self.Node.scrollTop, (self.ChildrenNode.offsetHeight - self.Node.offsetHeight) + Margin * 2); - - self.UpdateScrollbar(); - } - } - - - function GetTreeviewItemFromNode(self, node) - { - // Walk up toward the tree view node looking for this first item - while (node && node != self.Node) - { - if ("TreeviewItem" in node) - return node.TreeviewItem; - - node = node.parentNode; - } - - return null; - } - - return Treeview; -})(); diff --git a/vis/extern/BrowserLib/WindowManager/Code/TreeviewItem.js b/vis/extern/BrowserLib/WindowManager/Code/TreeviewItem.js deleted file mode 100644 index ac6133e..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/TreeviewItem.js +++ /dev/null @@ -1,109 +0,0 @@ - -namespace("WM"); - - -WM.TreeviewItem = (function() -{ - function TreeviewItem(treeview, name, data, open_image, close_image) - { - // Assign members - this.Treeview = treeview; - this.Label = name; - this.Data = data; - this.OpenImage = open_image; - this.CloseImage = close_image; - - this.Children = [ ]; - - // The HTML node wrapping the item and its children - this.Node = null; - - // The HTML node storing the image for the open/close state feedback - this.ImageNode = null; - - // The HTML node storing just the children - this.ChildrenNode = null; - - // Animation handle for opening and closing the child nodes, only used - // if the tree view item as children - this.AnimHandle = null; - - // Open state of the item - this.IsOpen = true; - } - - - TreeviewItem.prototype.AddItem = function(name, data, open_image, close_image) - { - var item = new WM.TreeviewItem(this.Treeview, name, data, open_image, close_image); - this.Children.push(item); - return item; - } - - - TreeviewItem.prototype.Open = function() - { - if (this.AnimHandle == null || this.AnimHandle.Complete) - { - // Swap to the open state - this.IsOpen = true; - if (this.ImageNode != null && this.OpenImage != null) - this.ImageNode.src = this.OpenImage.src; - - // Cache for closure binding - var child_node = this.ChildrenNode; - var end_height = this.StartHeight; - var treeview = this.Treeview; - - // Reveal the children and animate their height to max - this.ChildrenNode.style.display = "block"; - this.AnimHandle = Anim.Animate( - function (val) { DOM.Node.SetHeight(child_node, val) }, - 0, end_height, 0.2, - function() { treeview.UpdateScrollbar(); }); - - // Fade the children in - Anim.Animate(function(val) { DOM.Node.SetOpacity(child_node, val) }, 0, 1, 0.2); - } - } - - - TreeviewItem.prototype.Close = function() - { - if (this.AnimHandle == null || this.AnimHandle.Complete) - { - // Swap to the close state - this.IsOpen = false; - if (this.ImageNode != null && this.CloseImage != null) - this.ImageNode.src = this.CloseImage.src; - - // Cache for closure binding - var child_node = this.ChildrenNode; - var treeview = this.Treeview; - - // Mark the height of the item for reload later - this.StartHeight = child_node.offsetHeight; - - // Shrink the height of the children and hide them upon completion - this.AnimHandle = Anim.Animate( - function (val) { DOM.Node.SetHeight(child_node, val) }, - this.ChildrenNode.offsetHeight, 0, 0.2, - function() { child_node.style.display = "none"; treeview.UpdateScrollbar(); }); - - // Fade the children out - Anim.Animate(function(val) { DOM.Node.SetOpacity(child_node, val) }, 1, 0, 0.2); - } - } - - - TreeviewItem.prototype.Toggle = function() - { - if (this.IsOpen) - this.Close(); - else - this.Open(); - } - - - return TreeviewItem; -})(); diff --git a/vis/extern/BrowserLib/WindowManager/Code/Window.js b/vis/extern/BrowserLib/WindowManager/Code/Window.js deleted file mode 100644 index b91db6b..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/Window.js +++ /dev/null @@ -1,314 +0,0 @@ - -namespace("WM"); - - -WM.Window = (function() -{ - var template_html = multiline(function(){/* \ -
-
-
Window Title Bar
-
✕
-
-
-
-
⋰
-
- */}); - - - function Window(manager, title, x, y, width, height, parent_node) - { - this.Manager = manager; - this.ParentNode = parent_node || document.body; - this.OnMove = null; - this.OnResize = null; - this.Visible = false; - this.AnimatedShow = false; - - // Clone the window template and locate key nodes within it - this.Node = DOM.Node.CreateHTML(template_html); - this.TitleBarNode = DOM.Node.FindWithClass(this.Node, "WindowTitleBar"); - this.TitleBarTextNode = DOM.Node.FindWithClass(this.Node, "WindowTitleBarText"); - this.TitleBarCloseNode = DOM.Node.FindWithClass(this.Node, "WindowTitleBarClose"); - this.ResizeHandleNode = DOM.Node.FindWithClass(this.Node, "WindowResizeHandle"); - this.BodyNode = DOM.Node.FindWithClass(this.Node, "WindowBody"); - - // Setup the position and dimensions of the window - this.SetPosition(x, y); - this.SetSize(width, height); - - // Set the title text - this.TitleBarTextNode.innerHTML = title; - - // Hook up event handlers - DOM.Event.AddHandler(this.Node, "mousedown", Bind(this, "SetTop")); - DOM.Event.AddHandler(this.TitleBarNode, "mousedown", Bind(this, "BeginMove")); - DOM.Event.AddHandler(this.ResizeHandleNode, "mousedown", Bind(this, "BeginResize")); - DOM.Event.AddHandler(this.TitleBarCloseNode, "mouseup", Bind(this, "Hide")); - - // Create delegates for removable handlers - this.MoveDelegate = Bind(this, "Move"); - this.EndMoveDelegate = Bind(this, "EndMove") - this.ResizeDelegate = Bind(this, "Resize"); - this.EndResizeDelegate = Bind(this, "EndResize"); - } - - Window.prototype.SetOnMove = function(on_move) - { - this.OnMove = on_move; - } - - Window.prototype.SetOnResize = function(on_resize) - { - this.OnResize = on_resize; - } - - - Window.prototype.Show = function() - { - if (this.Node.parentNode != this.ParentNode) - { - this.ShowNoAnim(); - Anim.Animate(Bind(this, "OpenAnimation"), 0, 1, 1); - } - } - - - Window.prototype.ShowNoAnim = function() - { - // Add to the document - this.ParentNode.appendChild(this.Node); - this.AnimatedShow = false; - this.Visible = true; - } - - - Window.prototype.Hide = function(evt) - { - if (this.Node.parentNode == this.ParentNode && evt.button == 0) - { - if (this.AnimatedShow) - { - // Trigger animation that ends with removing the window from the document - Anim.Animate( - Bind(this, "CloseAnimation"), - 0, 1, 0.25, - Bind(this, "HideNoAnim")); - } - else - { - this.HideNoAnim(); - } - } - } - - - Window.prototype.HideNoAnim = function() - { - if (this.Node.parentNode == this.ParentNode) - { - // Remove node - this.ParentNode.removeChild(this.Node); - this.Visible = false; - } - } - - - Window.prototype.Close = function() - { - this.HideNoAnim(); - this.Manager.RemoveWindow(this); - } - - - Window.prototype.SetTop = function() - { - this.Manager.SetTopWindow(this); - } - - - - Window.prototype.SetTitle = function(title) - { - this.TitleBarTextNode.innerHTML = title; - } - - - // TODO: Update this - Window.prototype.AddControl = function(control) - { - // Get all arguments to this function and replace the first with this window node - var args = [].slice.call(arguments); - args[0] = this.BodyNode; - - // Create the control and call its Init method with the modified arguments - var instance = new control(); - instance.Init.apply(instance, args); - - return instance; - } - - - Window.prototype.AddControlNew = function(control) - { - control.ParentNode = this.BodyNode; - this.BodyNode.appendChild(control.Node); - return control; - } - - - Window.prototype.RemoveControl = function(control) - { - if (control.ParentNode == this.BodyNode) - { - control.ParentNode.removeChild(control.Node); - } - } - - - Window.prototype.Scale = function(t) - { - // Calculate window bounds centre/extents - var ext_x = this.Size[0] / 2; - var ext_y = this.Size[1] / 2; - var mid_x = this.Position[0] + ext_x; - var mid_y = this.Position[1] + ext_y; - - // Scale from the mid-point - DOM.Node.SetPosition(this.Node, [ mid_x - ext_x * t, mid_y - ext_y * t ]); - DOM.Node.SetSize(this.Node, [ this.Size[0] * t, this.Size[1] * t ]); - } - - - Window.prototype.OpenAnimation = function(val) - { - // Power ease in - var t = 1 - Math.pow(1 - val, 8); - this.Scale(t); - DOM.Node.SetOpacity(this.Node, 1 - Math.pow(1 - val, 8)); - this.AnimatedShow = true; - } - - - Window.prototype.CloseAnimation = function(val) - { - // Power ease out - var t = 1 - Math.pow(val, 4); - this.Scale(t); - DOM.Node.SetOpacity(this.Node, t); - } - - - Window.prototype.NotifyChange = function() - { - if (this.OnMove) - { - var pos = DOM.Node.GetPosition(this.Node); - this.OnMove(this, pos); - } - } - - - Window.prototype.BeginMove = function(evt) - { - // Calculate offset of the window from the mouse down position - var mouse_pos = DOM.Event.GetMousePosition(evt); - this.Offset = [ mouse_pos[0] - this.Position[0], mouse_pos[1] - this.Position[1] ]; - - // Dynamically add handlers for movement and release - DOM.Event.AddHandler(document, "mousemove", this.MoveDelegate); - DOM.Event.AddHandler(document, "mouseup", this.EndMoveDelegate); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.Move = function(evt) - { - // Use the offset at the beginning of movement to drag the window around - var mouse_pos = DOM.Event.GetMousePosition(evt); - var offset = this.Offset; - var pos = [ mouse_pos[0] - offset[0], mouse_pos[1] - offset[1] ]; - this.SetPosition(pos[0], pos[1]); - - if (this.OnMove) - this.OnMove(this, pos); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.EndMove = function(evt) - { - // Remove handlers added during mouse down - DOM.Event.RemoveHandler(document, "mousemove", this.MoveDelegate); - DOM.Event.RemoveHandler(document, "mouseup", this.EndMoveDelegate); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.BeginResize = function(evt) - { - // Calculate offset of the window from the mouse down position - var mouse_pos = DOM.Event.GetMousePosition(evt); - this.MousePosBeforeResize = [ mouse_pos[0], mouse_pos[1] ]; - this.SizeBeforeResize = this.Size; - - // Dynamically add handlers for movement and release - DOM.Event.AddHandler(document, "mousemove", this.ResizeDelegate); - DOM.Event.AddHandler(document, "mouseup", this.EndResizeDelegate); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.Resize = function(evt) - { - // Use the offset at the beginning of movement to drag the window around - var mouse_pos = DOM.Event.GetMousePosition(evt); - var offset = [ mouse_pos[0] - this.MousePosBeforeResize[0], mouse_pos[1] - this.MousePosBeforeResize[1] ]; - this.SetSize(this.SizeBeforeResize[0] + offset[0], this.SizeBeforeResize[1] + offset[1]); - - if (this.OnResize) - this.OnResize(this, this.Size); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.EndResize = function(evt) - { - // Remove handlers added during mouse down - DOM.Event.RemoveHandler(document, "mousemove", this.ResizeDelegate); - DOM.Event.RemoveHandler(document, "mouseup", this.EndResizeDelegate); - - DOM.Event.StopDefaultAction(evt); - } - - - Window.prototype.SetPosition = function(x, y) - { - this.Position = [ x, y ]; - DOM.Node.SetPosition(this.Node, this.Position); - } - - - Window.prototype.SetSize = function(w, h) - { - w = Math.max(80, w); - h = Math.max(15, h); - this.Size = [ w, h ]; - DOM.Node.SetSize(this.Node, this.Size); - } - - - Window.prototype.GetZIndex = function() - { - return parseInt(this.Node.style.zIndex); - } - - - return Window; -})(); \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Code/WindowManager.js b/vis/extern/BrowserLib/WindowManager/Code/WindowManager.js deleted file mode 100644 index a4b80aa..0000000 --- a/vis/extern/BrowserLib/WindowManager/Code/WindowManager.js +++ /dev/null @@ -1,65 +0,0 @@ - -namespace("WM"); - - -WM.WindowManager = (function() -{ - function WindowManager() - { - // An empty list of windows under window manager control - this.Windows = [ ]; - } - - - WindowManager.prototype.AddWindow = function(title, x, y, width, height, parent_node) - { - // Create the window and add it to the list of windows - var wnd = new WM.Window(this, title, x, y, width, height, parent_node); - this.Windows.push(wnd); - - // Always bring to the top on creation - wnd.SetTop(); - - return wnd; - } - - - WindowManager.prototype.RemoveWindow = function(window) - { - // Remove from managed window list - var index = this.Windows.indexOf(window); - if (index != -1) - { - this.Windows.splice(index, 1); - } - } - - - WindowManager.prototype.SetTopWindow = function(top_wnd) - { - // Bring the window to the top of the window list - var top_wnd_index = this.Windows.indexOf(top_wnd); - if (top_wnd_index != -1) - this.Windows.splice(top_wnd_index, 1); - this.Windows.push(top_wnd); - - // Set a CSS z-index for each visible window from the bottom up - for (var i in this.Windows) - { - var wnd = this.Windows[i]; - if (!wnd.Visible) - continue; - - // Ensure there's space between each window for the elements inside to be sorted - var z = (parseInt(i) + 1) * 10; - wnd.Node.style.zIndex = z; - - // Notify window that its z-order has changed - wnd.NotifyChange(); - } - } - - - return WindowManager; - -})(); \ No newline at end of file diff --git a/vis/extern/BrowserLib/WindowManager/Styles/WindowManager.css b/vis/extern/BrowserLib/WindowManager/Styles/WindowManager.css deleted file mode 100644 index e367bc0..0000000 --- a/vis/extern/BrowserLib/WindowManager/Styles/WindowManager.css +++ /dev/null @@ -1,652 +0,0 @@ - - -.notextsel -{ - /* Disable text selection so that it doesn't interfere with button-clicking */ - user-select: none; - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* Internet Explorer */ - -khtml-user-select: none; /* KHTML browsers (e.g. Konqueror) */ - -webkit-user-select: none; /* Chrome, Safari, and Opera */ - -webkit-touch-callout: none; /* Disable Android and iOS callouts*/ - - /* Stops the text cursor over the label */ - cursor:default; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Window Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - -body -{ - /* Clip contents to browser window without adding scrollbars */ - overflow: hidden; -} - -.Window -{ - position:absolute; - - /* Clip all contents to the window border */ - overflow: hidden; - - background: #555; - - /*padding: 0px !important;*/ - - border-radius: 3px; - -moz-border-radius: 5px; - - -webkit-box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; - box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; -} - -/*:root -{ - --SideBarSize: 5px; -} - -.WindowBodyDebug -{ - color: #BBB; - font: 9px Verdana; - white-space: nowrap; -} - -.WindowSizeLeft -{ - position: absolute; - left: 0px; - top: 0px; - width: var(--SideBarSize); - height: 100%; -} -.WindowSizeRight -{ - position: absolute; - left: calc(100% - var(--SideBarSize)); - top:0px; - width: var(--SideBarSize); - height:100%; -} -.WindowSizeTop -{ - position: absolute; - left: 0px; - top: 0px; - width: 100%; - height: var(--SideBarSize); -} -.WindowSizeBottom -{ - position: absolute; - left: 0px; - top: calc(100% - var(--SideBarSize)); - width: 100%; - height: var(--SideBarSize); -}*/ - - -.Window_Transparent -{ - /* Set transparency changes to fade in/out */ - opacity: 0.5; - transition: opacity 0.5s ease-out; - -moz-transition: opacity 0.5s ease-out; - -webkit-transition: opacity 0.5s ease-out; -} - -.Window_Transparent:hover -{ - opacity: 1; -} - -.WindowTitleBar -{ - height: 17px; - cursor: move; - /*overflow: hidden;*/ - - border-bottom: 1px solid #303030; - border-radius: 5px; -} - -.WindowTitleBarText -{ - color: #BBB; - font: 9px Verdana; - /*white-space: nowrap;*/ - - padding: 3px; - cursor: move; -} - -.WindowTitleBarClose -{ - color: #999999; - font: 9px Verdana; - - padding: 3px; - cursor: default; -} - -.WindowTitleBarClose:hover { - color: #bbb; -} - -.WindowResizeHandle -{ - color: #999999; - font: 17px Verdana; - padding: 3px; - cursor: se-resize; - position: absolute; - bottom: -7px; - right: -3px; -} - -.WindowBody { - position: absolute; - /* overflow: hidden; */ - display: block; - padding: 10px; - border-top: 1px solid #606060; - top: 18px; - left: 0; - right: 0; - bottom: 0; - height: auto; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Container Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.Container -{ - /* Position relative to the parent window */ - position: absolute; - - /* Clip contents */ - /*overflow: hidden;*/ - - background:#2C2C2C; - - border: 1px black solid; - - /* Two inset box shadows to simulate depressing */ - -webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; -} - -/*.Panel -{*/ - /* Position relative to the parent window */ - /*position: absolute;*/ - - /* Clip contents */ - /*overflow: hidden; - - background:#2C2C2C; - - border: 1px black solid;*/ - - /* Two inset box shadows to simulate depressing */ - /*-webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset;*/ -/*}*/ - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Ruler Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -/*.Ruler -{ - position: absolute; - - border: dashed 1px; - - opacity: 0.35; -}*/ - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Treeview Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.Treeview -{ - position: absolute; - - background:#2C2C2C; - border: 1px solid black; - overflow:hidden; - - /* Two inset box shadows to simulate depressing */ - -webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; -} - -.TreeviewItem -{ - margin:1px; - padding:2px; - border:solid 1px #2C2C2C; - background-color:#2C2C2C; -} - -.TreeviewItemImage -{ - float: left; -} - -.TreeviewItemText -{ - float: left; - margin-left:4px; -} - -.TreeviewItemChildren -{ - overflow: hidden; -} - -.TreeviewItemSelected -{ - background-color:#444; - border-color:#FFF; - - -webkit-transition: background-color 0.2s ease-in-out; - -moz-transition: background-color 0.2s ease-in-out; - -webkit-transition: border-color 0.2s ease-in-out; - -moz-transition: border-color 0.2s ease-in-out; -} - -/* Used to populate treeviews that want highlight on hover behaviour */ -.TreeviewItemHover -{ -} - -.TreeviewItemHover:hover -{ - background-color:#111; - border-color:#444; - - -webkit-transition: background-color 0.2s ease-in-out; - -moz-transition: background-color 0.2s ease-in-out; - -webkit-transition: border-color 0.2s ease-in-out; - -moz-transition: border-color 0.2s ease-in-out; -} - -.TreeviewScrollbarInset -{ - float: right; - - position:relative; - - height: 100%; - - /* CRAZINESS PART A: Trying to get the inset and scrollbar to have 100% height match its container */ - margin: -8px -8px 0 0; - padding: 0 1px 14px 1px; - - width:20px; - background:#2C2C2C; - border: 1px solid black; - - /* Two inset box shadows to simulate depressing */ - -webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; -} - -.TreeviewScrollbar -{ - position:relative; - - background:#2C2C2C; - border: 1px solid black; - - /* CRAZINESS PART B: Trying to get the inset and scrollbar to have 100% height match its container */ - padding: 0 0 10px 0; - margin: 1px 0 0 0; - - width: 18px; - height: 100%; - - border-radius:6px; - border-color:#000; - border-width:1px; - border-style:solid; - - /* The gradient for the button background */ - background-color:#666; - background: -webkit-gradient(linear, left top, left bottom, from(#666), to(#383838)); - background: -moz-linear-gradient(top, #666, #383838); - filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#666666', endColorstr='#383838'); - - /* A box shadow and inset box highlight */ - -webkit-box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; - box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; -} - -.TreeviewScrollbarHeld -{ - /* Reset the gradient to a full-colour background */ - background:#383838; - - /* Two inset box shadows to simulate depressing */ - -webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Edit Box Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.EditBoxContainer -{ - position: absolute; - padding:2px 10px 2px 10px; -} - -.EditBoxLabel -{ - float:left; - padding: 3px 4px 4px 4px; - font: 9px Verdana; -} - -.EditBox -{ - float:left; - - background:#666; - border: 1px solid; - border-radius: 6px; - padding: 3px 4px 3px 4px; - height: 20px; - - box-shadow: 1px 1px 1px #222 inset; - - transition: all 0.3s ease-in-out; -} - -.EditBox:focus -{ - background:#FFF; - outline:0; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Label Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.Label -{ - /* Position relative to the parent window */ - position:absolute; - - color: #BBB; - font: 9px Verdana; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Combo Box Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.ComboBox -{ - position:absolute; - - /* TEMP! */ - width:90px; - - /* Height is fixed to match the font */ - height:14px; - - /* Align the text within the combo box */ - padding: 1px 0 0 5px; - - /* Solid, rounded border */ - border: 1px solid #111; - border-radius: 5px; - - /* http://www.colorzilla.com/gradient-editor/#e3e3e3+0,c6c6c6+22,b7b7b7+33,afafaf+50,a7a7a7+67,797979+82,414141+100;Custom */ - background: #e3e3e3; - background: -moz-linear-gradient(top, #e3e3e3 0%, #c6c6c6 22%, #b7b7b7 33%, #afafaf 50%, #a7a7a7 67%, #797979 82%, #414141 100%); - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#e3e3e3), color-stop(22%,#c6c6c6), color-stop(33%,#b7b7b7), color-stop(50%,#afafaf), color-stop(67%,#a7a7a7), color-stop(82%,#797979), color-stop(100%,#414141)); - background: -webkit-linear-gradient(top, #e3e3e3 0%,#c6c6c6 22%,#b7b7b7 33%,#afafaf 50%,#a7a7a7 67%,#797979 82%,#414141 100%); - background: -o-linear-gradient(top, #e3e3e3 0%,#c6c6c6 22%,#b7b7b7 33%,#afafaf 50%,#a7a7a7 67%,#797979 82%,#414141 100%); - background: -ms-linear-gradient(top, #e3e3e3 0%,#c6c6c6 22%,#b7b7b7 33%,#afafaf 50%,#a7a7a7 67%,#797979 82%,#414141 100%); - background: linear-gradient(top, #e3e3e3 0%,#c6c6c6 22%,#b7b7b7 33%,#afafaf 50%,#a7a7a7 67%,#797979 82%,#414141 100%); - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#e3e3e3', endColorstr='#414141',GradientType=0 ); -} - -.ComboBoxPressed -{ - /* The reverse of the default background, simulating depression */ - background: #414141; - background: -moz-linear-gradient(top, #414141 0%, #797979 18%, #a7a7a7 33%, #afafaf 50%, #b7b7b7 67%, #c6c6c6 78%, #e3e3e3 100%); - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#414141), color-stop(18%,#797979), color-stop(33%,#a7a7a7), color-stop(50%,#afafaf), color-stop(67%,#b7b7b7), color-stop(78%,#c6c6c6), color-stop(100%,#e3e3e3)); - background: -webkit-linear-gradient(top, #414141 0%,#797979 18%,#a7a7a7 33%,#afafaf 50%,#b7b7b7 67%,#c6c6c6 78%,#e3e3e3 100%); - background: -o-linear-gradient(top, #414141 0%,#797979 18%,#a7a7a7 33%,#afafaf 50%,#b7b7b7 67%,#c6c6c6 78%,#e3e3e3 100%); - background: -ms-linear-gradient(top, #414141 0%,#797979 18%,#a7a7a7 33%,#afafaf 50%,#b7b7b7 67%,#c6c6c6 78%,#e3e3e3 100%); - background: linear-gradient(top, #414141 0%,#797979 18%,#a7a7a7 33%,#afafaf 50%,#b7b7b7 67%,#c6c6c6 78%,#e3e3e3 100%); - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#414141', endColorstr='#e3e3e3',GradientType=0 ); -} - -.ComboBoxText -{ - /* Text info */ - color: #000; - font: 9px Verdana; - - float:left; -} - -.ComboBoxIcon -{ - /* Push the image to the far right */ - float:right; - - /* Align the image with the combo box */ - padding: 2px 5px 0 0; -} - -.ComboBoxPopup -{ - position: fixed; - - background: #CCC; - - border-radius: 5px; - - padding: 1px 0 1px 0; -} - -.ComboBoxPopupItem -{ - /* Text info */ - color: #000; - font: 9px Verdana; - - padding: 1px 1px 1px 5px; - - border-bottom: 1px solid #AAA; - border-top: 1px solid #FFF; -} - -.ComboBoxPopupItemText -{ - float:left; -} - -.ComboBoxPopupItemIcon -{ - /* Push the image to the far right */ - float:right; - - /* Align the image with the combo box */ - padding: 2px 5px 0 0; -} - -.ComboBoxPopupItem:first-child -{ - border-top: 0px; -} - -.ComboBoxPopupItem:last-child -{ - border-bottom: 0px; -} - -.ComboBoxPopupItem:hover -{ - color:#FFF; - background: #2036E1; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Grid Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - -.Grid { - overflow: auto; - background: #333; - height: 100%; - border-radius: 2px; -} - -.GridBody -{ - overflow-x: auto; - overflow-y: auto; - height: inherit; -} - -.GridRow -{ - display: inline-block; - white-space: nowrap; - - background:#303030; - - color: #BBB; - font: 9px Verdana; - - padding: 2px; -} - -.GridRow.GridGroup -{ - padding: 0px; -} - -.GridRow:nth-child(odd) -{ - background:#333; -} - -.GridRowCell -{ - display: inline-block; -} -.GridRowCell.GridGroup -{ - color: #BBB; - - /* Override default from name */ - width: 100%; - - padding: 1px 1px 1px 2px; - border: 1px solid; - border-radius: 2px; - - border-top-color:#555; - border-left-color:#555; - border-bottom-color:#111; - border-right-color:#111; - - background: #222; -} - -.GridRowBody -{ - /* Clip all contents for show/hide group*/ - overflow: hidden; - - /* Crazy CSS rules: controls for properties don't clip if this isn't set on this parent */ - position: relative; -} - - - -/* ------------------------------------------------------------------------------------------------------------------ */ -/* Button Styles */ -/* ------------------------------------------------------------------------------------------------------------------ */ - - - -.Button -{ - /* Position relative to the parent window */ - position:absolute; - - border-radius:4px; - - /* Padding at the top includes 2px for the text drop-shadow */ - padding: 2px 5px 3px 5px; - - color: #BBB; - font: 9px Verdana; - text-shadow: 1px 1px 1px black; - text-align: center; - - background-color:#555; - - /* A box shadow and inset box highlight */ - -webkit-box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; - box-shadow: 1px 1px 1px #222, 1px 1px 1px #777 inset; -} - -.Button:hover { - background-color: #616161; -} - -.Button.ButtonHeld -{ - /* Reset the gradient to a full-colour background */ - background:#383838; - - /* Two inset box shadows to simulate depressing */ - -webkit-box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; - box-shadow: -1px -1px 1px #222 inset, 1px 1px 1px #222 inset; -} diff --git a/vis/index.html b/vis/index.html deleted file mode 100644 index f8d5177..0000000 --- a/vis/index.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Remotery Viewer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file