.TH "sasutil" 1 "Wed Sep 21 2022" "Version 1.4.0" "sasutil manual" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sasutil \- control program for libsphde project 

.SH "SYNOPSIS"
.PP
sasutil [-h] [-v] [-p path] <command> [<args>]
.SH "DESCRIPTION"
.PP
The sasutil utility is used to control de libsphde share memory segments, showing its internal details (memory state/dump, lock/semaphores details, etc\&.), memory maps and reseting its internal state\&.
.SH "OPTIONS"
.PP
.PP
.nf

\fB-v\fP
    Prints the sasutil version\&.
.fi
.PP
.PP
.PP
.nf

\fB-h\fP
    Prints the synopsis and a list of the available commands\&.
.fi
.PP
.PP
.PP
.nf

\fB-p\fP
    Path to wherever libsphde segment is located\&. This also can be
    controlled by setting SASSTOREPATH environment variable\&. If not path is
    given, will use the current path\&.
.fi
.PP
.SH "COMMANDS"
.PP
The available commands are: stat, detail, reset, dump, remove, list, path, and map\&.
.PP
.PP
.nf

\fBstat\fP
    Shows the overall memory statistics: total in use, total free, total
    uncommited, total region free, total region used, and anchor free space\&.
.fi
.PP
.PP
.PP
.nf

\fBdetail\fP
    Shows detailed information, dividing each statistic from \fBstat\fP
    command in memory block information\&.
.fi
.PP
.PP
.PP
.nf

\fBreset\fP
    Resets the anchor semaphore (used to access the control shared memory
    segment), the allocated segments and all internal locks\&. This command
    is useful to reset the SPHDE state after an process finished with
    unexpected error (like a SEGFAULT)\&.
.fi
.PP
.PP
.PP
.nf

\fBdump <address\\:size>\fP
    Dumps a list of <memory:size> where <memory> is a memory address in
    hexadecimal and <size> is decimal\&. The output is similar to
    \fBhexdump\fP utility called with '-C' option\&.
.fi
.PP
.PP
.PP
.nf

\fBremove\fP
    Removed the allocated segments, internal locks and anchor semaphores from
    control shared memory segment)\&.
.fi
.PP
.PP
.PP
.nf

\fBlist\fP
    List and dump in use shared memory blocks\&.
.fi
.PP
.PP
.PP
.nf

\fBpath\fP
    Shows the store path used (as indicated by SASSTOREPATH)\&.
.fi
.PP
.PP
.PP
.nf

\fBmap <pid> \fP
    Shows the memory map (/proc/<pid>/maps) for PIDs indicates as aguments\&.
    Default is current process\&.
.fi
.PP
.SH "ENVIRONMENT VARIABLES"
.PP
The sasutil command accepts te following environment variables:
.PP
.PP
.nf

\fISASSTOREPATH\fP
    Defines the path to search for the store segment to attach and analyze\&.
.fi
.PP
.SH "AUTHOR"
.PP
Written by Steven Munroe (initial API and implementation) and Adhemerval Zanella (bugfixes and API improvements)\&.
.SH "REPORTING BUG"
.PP
Report a bug to munroesj@us.ibm.com
.SH "COPYRIGHT"
.PP
Copyright (c) 2009, 2011 IBM Corporation\&. All rights reserved\&. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1\&.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html \&.
.SH "SEE ALSO"
.PP