1 /* 2 * Copyright (c) 2015-2019, The University of Oxford 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 3. Neither the name of the University of Oxford nor the names of its 13 * contributors may be used to endorse or promote products derived from this 14 * software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef UTILITY_OSKAR_GET_MEMORY_USAGE_H_ 30 #define UTILITY_OSKAR_GET_MEMORY_USAGE_H_ 31 32 /** 33 * @file oskar_get_memory_usage.h 34 */ 35 36 #include <oskar_global.h> 37 #include <log/oskar_log.h> 38 #include <stddef.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @brief Returns the total physical system memory, in bytes. 46 */ 47 OSKAR_EXPORT 48 size_t oskar_get_total_physical_memory(void); 49 50 /** 51 * @brief Returns the free physical system memory, in bytes. 52 */ 53 OSKAR_EXPORT 54 size_t oskar_get_free_physical_memory(void); 55 56 /** 57 * @brief Returns the total swap memory, in bytes. 58 */ 59 OSKAR_EXPORT 60 size_t oskar_get_total_swap_memory(void); 61 62 /** 63 * @brief Returns the free swap system, in bytes. 64 */ 65 OSKAR_EXPORT 66 size_t oskar_get_free_swap_memory(void); 67 68 /** 69 * @brief Returns the memory used by the current process, in bytes. 70 */ 71 OSKAR_EXPORT 72 size_t oskar_get_memory_usage(void); 73 74 /** 75 * @brief Prints a summary of the current memory usage. 76 */ 77 OSKAR_EXPORT 78 void oskar_print_memory_info(void); 79 80 /** 81 * @brief Writes current memory usage to the log. 82 */ 83 OSKAR_EXPORT 84 void oskar_log_mem(oskar_Log* log); 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif /* UTILITY_OSKAR_GET_MEMORY_USAGE_H_ */ 91