Movatterモバイル変換

pmparsetimewindow(3) — Linux manual page

PMPARSETIMEWINDOW(3)     Library Functions ManualPMPARSETIMEWINDOW(3)

NAME        top

pmParseTimeWindow- parse time window command line arguments

C SYNOPSIS        top

#include <pcp/pmapi.h>int pmParseTimeWindow(const char *swStart, const char *swEnd,const char *swAlign, const char *swOffset,const struct timespec *logStart,const struct timespec *logEnd,struct timespec *rsltStart,struct timespec *rsltEnd,struct timespec *rsltOffset, char **errMsg);cc ... -lpcp

DESCRIPTION        top

pmParseTimeWindoware  designed to encapsulate the interpretation       of the-S,-T,-Aand-Ocommand line options used by  Performance       Co-Pilot  (PCP)  applications to define a time window of interest.       The time window is defined by a start time and an  end  time  that       constrains the time interval during which the PCP application will       retrieve  and  display performance metrics.  In the absence of the-Oand-Aoptions to specify an initial  sample  time  origin  and       time  alignment (see below), the PCP application will retrieve the       first sample at the start of the time window.       The syntax and meaning of the various argument formats  for  these       options is described inPCPIntro(1).

USAGE        top

pmParseTimeWindowexpect to be called with the argument of the-S       option asswStart, the argument of the-Toption asswEnd, the ar‐       gument of the-Aoption asswAlign, and the argument of the-Oop‐       tion asswOffset.  Any or all of these parameters may be  NULL  to       indicate  that  the  corresponding  command  line  option  was not       present.       If the application is using a set of PCP archives as the source of       performance metrics, you also need to supply the time of the first       archive entry aslogStart, and the time of the last archive  entry       aslogEnd.   SeepmGetArchiveLabel(3) andpmGetArchiveEnd(3) for       how to obtain values for these times.       If the application is manipulating multiple  concurrent  archives,       then  the caller must resolve how the default time window is to be       defined (the union of the time intervals  in  all  archives  is  a       likely interpretation).       If  the  application  is  using  a  live feed of performance data,logStartshould be the current time (but could be aligned  on  the       next second for example), whilelogEndshould have itstv_sec com‐       ponent set toPM_MAX_TIME_T.       ThersltStart,rsltEndandrsltOffsetstructures must be allocated       before callingpmParseTimeWindow.       You  also  need to set the current PCP reporting time zone to cor‐       rectly reflect the-zand-Zcommand line parameters before  call‐       ing  these routines.  SeepmUseZone(3) and friends for information       on how this is done.

DIAGNOSTICS        top

       If the conversion is successful,pmParseTimeWindowreturn  1  and       fill inrsltStart,rsltEndandrsltOffsetwith the start, end, and       offset  times for the time window defined by the input parameters.       TheerrMsgparameter is not changed when eitherpmParseTimeWindow       returns 1.       If the conversion is successful, but the requested alignment could       not  be  performed (e.g. the set of PCP archives is too short) the       alignment is ignored,rsltStart,rsltEndandrsltOffsetare filled       in andpmParseTimeWindowreturn 0.   In  this  case,errMsgwill       point to a warning message in a dynamically allocated buffer.  The       caller is responsible for releasing the buffer by callingfree(3).       If the argument strings could not be parsed,pmParseTimeWindowre‐       turn -1.  In this case,errMsgwill point to an error message in a       dynamically  allocated  buffer.  The caller is responsible for re‐       leasing the buffer by callingfree(3).

COMPATIBILITY        top

       Prior to PCP 7.0 andlibpcp.so.4 thelogStart,logEnd,rsltStart,rsltEnd  andrsltOffset arguments were struct timeval.  To support       PMAPI transition, the old interface and semantics can be  used  if       applications  are  linked  withlibpcp.so.3  or  recompiled  with-DPMAPI_VERSION=2.       For a time in PCP 6.x there was a routine with the same  semantics       as  the  currentpmParseTimeWindowcalledpmParseHighResTimeWindow       although this is now deprecated and compile-time support  forpm‐ParseHighResTimeWindowwill be removed in a future release.

SEE ALSO        top

free(3),PMAPI(3),pmGetArchiveEnd(3),pmGetArchiveLabel(3),pmNewContextZone(3),pmNewZone(3),pmParseInterval(3)    andpmUseZone(3).

COLOPHON        top

       This  page is part of thePCP (Performance Co-Pilot) project.  In‐       formation about the project can be found at  ⟨http://www.pcp.io/⟩.       If  you  have  a  bug  report  for  this  manual  page, send it to       pcp@groups.io.  This page was obtained from the project's upstream       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on       2025-08-11.   (At  that  time,  the date of the most recent commit       that was found in the repository was 2025-08-11.)  If you discover       any rendering problems in this HTML version of the  page,  or  you       believe  there is a better or more up-to-date source for the page,       or you have corrections or improvements to the information in this       COLOPHON (which isnot part of the original manual page),  send  a       mail to man-pages@man7.orgPerformance Co-Pilot               PCPPMPARSETIMEWINDOW(3)

Pages that refer to this page:pmseries(1), __pmconverttime(3), pmparseinterval(3), __pmparsetime(3)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.