gecko/nsprpub/pr/include/prsystem.h
Michael Wu ff73a9422b Update NSPR to NSPR_4_9_1_BETA1 tag, a=ted
Includes bug 331299, 722125, 693329, 274013, 716564, 736962, 739469, 482002, 693329
2012-05-10 12:01:43 -07:00

109 lines
2.6 KiB
C

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef prsystem_h___
#define prsystem_h___
/*
** API to NSPR functions returning system info.
*/
#include "prtypes.h"
PR_BEGIN_EXTERN_C
/*
** Get the host' directory separator.
** Pathnames are then assumed to be of the form:
** [<sep><root_component><sep>]*(<component><sep>)<leaf_name>
*/
NSPR_API(char) PR_GetDirectorySeparator(void);
/*
** OBSOLETE -- the function name is misspelled.
** Use PR_GetDirectorySeparator instead.
*/
NSPR_API(char) PR_GetDirectorySepartor(void);
/*
** Get the host' path separator.
** Paths are assumed to be of the form:
** <directory>[<sep><directory>]*
*/
NSPR_API(char) PR_GetPathSeparator(void);
/* Types of information available via PR_GetSystemInfo(...) */
typedef enum {
PR_SI_HOSTNAME, /* the hostname with the domain name (if any)
* removed */
PR_SI_SYSNAME,
PR_SI_RELEASE,
PR_SI_ARCHITECTURE,
PR_SI_HOSTNAME_UNTRUNCATED /* the hostname exactly as configured
* on the system */
} PRSysInfo;
/*
** If successful returns a null termintated string in 'buf' for
** the information indicated in 'cmd'. If unseccussful the reason for
** the failure can be retrieved from PR_GetError().
**
** The buffer is allocated by the caller and should be at least
** SYS_INFO_BUFFER_LENGTH bytes in length.
*/
#define SYS_INFO_BUFFER_LENGTH 256
NSPR_API(PRStatus) PR_GetSystemInfo(PRSysInfo cmd, char *buf, PRUint32 buflen);
/*
** Return the number of bytes in a page
*/
NSPR_API(PRInt32) PR_GetPageSize(void);
/*
** Return log2 of the size of a page
*/
NSPR_API(PRInt32) PR_GetPageShift(void);
/*
** PR_GetNumberOfProcessors() -- returns the number of CPUs
**
** Description:
** PR_GetNumberOfProcessors() extracts the number of processors
** (CPUs available in an SMP system) and returns the number.
**
** Parameters:
** none
**
** Returns:
** The number of available processors or -1 on error
**
*/
NSPR_API(PRInt32) PR_GetNumberOfProcessors( void );
/*
** PR_GetPhysicalMemorySize() -- returns the amount of system RAM
**
** Description:
** PR_GetPhysicalMemorySize() determines the amount of physical RAM
** in the system and returns the size in bytes.
**
** Parameters:
** none
**
** Returns:
** The amount of system RAM, or 0 on failure.
**
*/
NSPR_API(PRUint64) PR_GetPhysicalMemorySize(void);
PR_END_EXTERN_C
#endif /* prsystem_h___ */