X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fjava-1.2.8%2Fjavamem.m;fp=octave_packages%2Fjava-1.2.8%2Fjavamem.m;h=33d3f6ef73193ced376cb9dbea0b176a934b59d9;hp=0000000000000000000000000000000000000000;hb=f5f7a74bd8a4900f0b797da6783be80e11a68d86;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/java-1.2.8/javamem.m b/octave_packages/java-1.2.8/javamem.m new file mode 100644 index 0000000..33d3f6e --- /dev/null +++ b/octave_packages/java-1.2.8/javamem.m @@ -0,0 +1,84 @@ +## Copyright (C) 2010 Philip Nienhuis, +## +## This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## . + +## -*- texinfo -*- +## @deftypefn {Function File} javamem +## @deftypefnx {Function File} [@var{jmem}] = javamem +## Show current memory status of the Java virtual machine (JVM) +## & run garbage collector. +## +## When no return argument is given the info is echoed to the screen. +## Otherwise, output cell array @var{jmem} contains Maximum, Total, +## and Free memory (in bytes). +## +## All Java-based routines are run in the JVM's shared memory pool, +## a dedicated and separate part of memory claimed by the JVM from +## your computer's total memory (which comprises physical RAM and +## virtual memory / swap space on hard disk). +## +## The maximum available memory can be set using the file java.opts +## (in the same subdirectory where javaaddpath.m lives, see +## "which javaaddpath". Usually that is: @* +## [/usr]/share/octave/packages/java-. +## +## java.opts is a plain text file, one option per line. The +## default initial memory size and default maximum memory size (which +## are both system dependent) can be overridden like so: @* +## -Xms64m @* +## -Xmx512m @* +## (in megabytes in this example.) +## You can adapt these values to your own requirements if your system +## has limited available physical memory or when you get Java memory +## errors. +## +## "Total memory" is what the operating system has currently assigned +## to the JVM and depends on actual and active memory usage. +## "Free memory" is self-explanatory. During operation of Java-based +## octave functions the amounts of Total and Free memory will vary, +## due to Java's own cleaning up and your operating system's memory +## management. +## +## @end deftypefn + +## Author: Philip Nienhuis +## Created: 2010-03-25 +## Updates: +## 2010-03-26 Changed name to javamem & indentation to double spaces +## 2010-08-25 Corrected text on java memory assignments +## 2010-09-05 Further overhauled help text + +function [ j_mem ] = javamem () + + rt = java_invoke ('java.lang.Runtime', 'getRuntime'); + rt.gc; + jmem = cell (3, 1); + jmem{1} = rt.maxMemory ().doubleValue (); + jmem{2} = rt.totalMemory ().doubleValue (); + jmem{3} = rt.freeMemory ().doubleValue (); + + if (nargout < 1) + printf ("\nJava virtual machine (JVM) memory info:\n"); + printf ("Maximum available memory: %5d MiB;\n", jmem{1} / 1024 / 1024); + printf (" (...running garbage collector...)\n"); + printf ("OK, current status:\n"); + printf ("Total memory in virtual machine: %5d MiB;\n", jmem{2} / 1024 / 1024); + printf ("Free memory in virtual machine: %5d MiB;\n", jmem{3} / 1024 / 1024); + printf ("%d CPUs available.\n", rt.availableProcessors ()); + else + j_mem = jmem; + endif + +endfunction