SWAMPy

✎ CARVE FLESH

EDITING: nssbase.h

/* 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 NSSBASE_H
#define NSSBASE_H

/*
 * nssbase.h
 *
 * This header file contains the prototypes of the basic public
 * NSS routines.
 */

#ifndef NSSBASET_H
#include "nssbaset.h"
#endif /* NSSBASET_H */

PR_BEGIN_EXTERN_C

/*
 * NSSArena
 *
 * The public methods relating to this type are:
 *
 *  NSSArena_Create  -- constructor
 *  NSSArena_Destroy
 *  NSS_ZAlloc
 *  NSS_ZRealloc
 *  NSS_ZFreeIf
 */

/*
 * NSSArena_Create
 *
 * This routine creates a new memory arena.  This routine may return
 * NULL upon error, in which case it will have created an error stack.
 *
 * The top-level error may be one of the following values:
 *  NSS_ERROR_NO_MEMORY
 *
 * Return value:
 *  NULL upon error
 *  A pointer to an NSSArena upon success
 */

NSS_EXTERN NSSArena *NSSArena_Create(void);

extern const NSSError NSS_ERROR_NO_MEMORY;

/*
 * NSSArena_Destroy
 *
 * This routine will destroy the specified arena, freeing all memory
 * allocated from it.  This routine returns a PRStatus value; if
 * successful, it will return PR_SUCCESS.  If unsuccessful, it will
 * create an error stack and return PR_FAILURE.
 *
 * The top-level error may be one of the following values:
 *  NSS_ERROR_INVALID_ARENA
 *
 * Return value:
 *  PR_SUCCESS upon success
 *  PR_FAILURE upon failure
 */

NSS_EXTERN PRStatus NSSArena_Destroy(NSSArena *arena);

extern const NSSError NSS_ERROR_INVALID_ARENA;

/*
 * The error stack
 *
 * The public methods relating to the error stack are:
 *
 *  NSS_GetError
 *  NSS_GetErrorStack
 */

/*
 * NSS_GetError
 *
 * This routine returns the highest-level (most general) error set
 * by the most recent NSS library routine called by the same thread
 * calling this routine.
 *
 * This routine cannot fail.  It may return NSS_ERROR_NO_ERROR, which
 * indicates that the previous NSS library call did not set an error.
 *
 * Return value:
 *  0 if no error has been set
 *  A nonzero error number
 */

NSS_EXTERN NSSError NSS_GetError(void);

extern const NSSError NSS_ERROR_NO_ERROR;

/*
 * NSS_GetErrorStack
 *
 * This routine returns a pointer to an array of NSSError values,
 * containingthe entire sequence or "stack" of errors set by the most
 * recent NSS library routine called by the same thread calling this
 * routine.  NOTE: the caller DOES NOT OWN the memory pointed to by
 * the return value.  The pointer will remain valid until the calling
 * thread calls another NSS routine.  The lowest-level (most specific)
 * error is first in the array, and the highest-level is last.  The
 * array is zero-terminated.  This routine may return NULL upon error;
 * this indicates a low-memory situation.
 *
 * Return value:
 *  NULL upon error, which is an implied NSS_ERROR_NO_MEMORY
 *  A NON-caller-owned pointer to an array of NSSError values
 */

NSS_EXTERN NSSError *NSS_GetErrorStack(void);

/*
 * NSS_ZNEW
 *
 * This preprocessor macro will allocate memory for a new object
 * of the specified type with nss_ZAlloc, and will cast the
 * return value appropriately.  If the optional arena argument is
 * non-null, the memory will be obtained from that arena; otherwise,
 * the memory will be obtained from the heap.  This routine may
 * return NULL upon error, in which case it will have set an error
 * upon the error stack.
 *
 * The error may be one of the following values:
 *  NSS_ERROR_INVALID_ARENA
 *  NSS_ERROR_NO_MEMORY
 *
 * Return value:
 *  NULL upon error
 *  A pointer to the new segment of zeroed memory
 */

#define NSS_ZNEW(arenaOpt, type) ((type *)NSS_ZAlloc((arenaOpt), sizeof(type)))

/*
 * NSS_ZNEWARRAY
 *
 * This preprocessor macro will allocate memory for an array of
 * new objects, and will cast the return value appropriately.
 * If the optional arena argument is non-null, the memory will
 * be obtained from that arena; otherwise, the memory will be
 * obtained from the heap.  This routine may return NULL upon
 * error, in which case it will have set an error upon the error
 * stack.  The array size may be specified as zero.
 *
 * The error may be one of the following values:
 *  NSS_ERROR_INVALID_ARENA
 *  NSS_ERROR_NO_MEMORY
 *
 * Return value:
 *  NULL upon error
 *  A pointer to the new segment of zeroed memory
 */

#define NSS_ZNEWARRAY(arenaOpt, type, quantity) \
    ((type *)NSS_ZAlloc((arenaOpt), sizeof(type) * (quantity)))

/*
 * NSS_ZAlloc
 *
 * This routine allocates and zeroes a section of memory of the
 * size, and returns to the caller a pointer to that memory.  If
 * the optional arena argument is non-null, the memory will be
 * obtained from that arena; otherwise, the memory will be obtained
 * from the heap.  This routine may return NULL upon error, in
 * which case it will have set an error upon the error stack.  The
 * value specified for size may be zero; in which case a valid
 * zero-length block of memory will be allocated.  This block may
 * be expanded by calling NSS_ZRealloc.
 *
 * The error may be one of the following values:
 *  NSS_ERROR_INVALID_ARENA
 *  NSS_ERROR_NO_MEMORY
 *  NSS_ERROR_ARENA_MARKED_BY_ANOTHER_THREAD
 *
 * Return value:
 *  NULL upon error
 *  A pointer to the new segment of zeroed memory
 */

NSS_EXTERN void *NSS_ZAlloc(NSSArena *arenaOpt, PRUint32 size);

/*
 * NSS_ZRealloc
 *
 * This routine reallocates a block of memory obtained by calling
 * nss_ZAlloc or nss_ZRealloc.  The portion of memory
 * between the new and old sizes -- which is either being newly
 * obtained or released -- is in either case zeroed.  This routine
 * may return NULL upon failure, in which case it will have placed
 * an error on the error stack.
 *
 * The error may be one of the following values:
 *  NSS_ERROR_INVALID_POINTER
 *  NSS_ERROR_NO_MEMORY
 *  NSS_ERROR_ARENA_MARKED_BY_ANOTHER_THREAD
 *
 * Return value:
 *  NULL upon error
 *  A pointer to the replacement segment of memory
 */

NSS_EXTERN void *NSS_ZRealloc(void *pointer, PRUint32 newSize);

/*
 * NSS_ZFreeIf
 *
 * If the specified pointer is non-null, then the region of memory
 * to which it points -- which must have been allocated with
 * nss_ZAlloc -- will be zeroed and released.  This routine
 * returns a PRStatus value; if successful, it will return PR_SUCCESS.
 * If unsuccessful, it will set an error on the error stack and return
 * PR_FAILURE.
 *
 * The error may be one of the following values:
 *  NSS_ERROR_INVALID_POINTER
 *
 * Return value:
 *  PR_SUCCESS
 *  PR_FAILURE
 */

NSS_EXTERN PRStatus NSS_ZFreeIf(void *pointer);

PR_END_EXTERN_C

#endif /* NSSBASE_H */

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 base64.h	H	1.1 KB	2026-06-18 11:25	EDIT
📄 blapit.h	H	14.6 KB	2026-06-18 11:25	EDIT
📄 cert.h	H	60 KB	2026-06-18 11:25	EDIT
📄 certdb.h	H	3.1 KB	2026-06-18 11:25	EDIT
📄 certt.h	H	47.3 KB	2026-06-18 11:25	EDIT
📄 ciferfam.h	H	2.4 KB	2026-06-18 11:25	EDIT
📄 cmmf.h	H	42.2 KB	2026-06-18 11:25	EDIT
📄 cmmft.h	H	2.2 KB	2026-06-18 11:25	EDIT
📄 cms.h	H	38.8 KB	2026-06-18 11:25	EDIT
📄 cmsreclist.h	H	908 B	2026-06-18 11:25	EDIT
📄 cmst.h	H	16.9 KB	2026-06-18 11:25	EDIT
📄 crmf.h	H	62.9 KB	2026-06-18 11:25	EDIT
📄 crmft.h	H	5.3 KB	2026-06-18 11:25	EDIT
📄 cryptohi.h	H	17.9 KB	2026-06-18 11:25	EDIT
📄 cryptoht.h	H	426 B	2026-06-18 11:25	EDIT
📄 eccutil.h	H	425 B	2026-06-18 11:25	EDIT
📄 ecl-exp.h	H	6.8 KB	2026-06-18 11:25	EDIT
📄 hasht.h	H	1.9 KB	2026-06-18 11:25	EDIT
📄 jar-ds.h	H	1.9 KB	2026-06-18 11:25	EDIT
📄 jar.h	H	9.9 KB	2026-06-18 11:25	EDIT
📄 jarfile.h	H	1.7 KB	2026-06-18 11:25	EDIT
📄 key.h	H	425 B	2026-06-18 11:25	EDIT
📄 keyhi.h	H	8.4 KB	2026-06-18 11:25	EDIT
📄 keyt.h	H	431 B	2026-06-18 11:25	EDIT
📄 keythi.h	H	7.1 KB	2026-06-18 11:25	EDIT
📄 kyber.h	H	965 B	2026-06-18 11:25	EDIT
📄 lowkeyi.h	H	2.3 KB	2026-06-18 11:25	EDIT
📄 lowkeyti.h	H	2.8 KB	2026-06-18 11:25	EDIT
📄 nss.h	H	15 KB	2026-06-18 11:25	EDIT
📄 nssb64.h	H	3.2 KB	2026-06-18 11:25	EDIT
📄 nssb64t.h	H	466 B	2026-06-18 11:25	EDIT
📄 nssbase.h	H	6.5 KB	2026-06-18 11:25	EDIT
📄 nssbaset.h	H	2.6 KB	2026-06-18 11:25	EDIT
📄 nssck.api	API	41.2 KB	2026-06-18 11:25	EDIT
📄 nssckbi.h	H	2.4 KB	2026-06-18 11:25	EDIT
📄 nssckepv.h	H	320 B	2026-06-18 11:25	EDIT
📄 nssckft.h	H	327 B	2026-06-18 11:25	EDIT
📄 nssckfw.h	H	7.1 KB	2026-06-18 11:25	EDIT
📄 nssckfwc.h	H	16.7 KB	2026-06-18 11:25	EDIT
📄 nssckfwt.h	H	2 KB	2026-06-18 11:25	EDIT
📄 nssckg.h	H	314 B	2026-06-18 11:25	EDIT
📄 nssckmdt.h	H	63.2 KB	2026-06-18 11:25	EDIT
📄 nssckt.h	H	366 B	2026-06-18 11:25	EDIT
📄 nssilckt.h	H	5.8 KB	2026-06-18 11:25	EDIT
📄 nssilock.h	H	7.6 KB	2026-06-18 11:25	EDIT
📄 nsslocks.h	H	380 B	2026-06-18 11:25	EDIT
📄 nsslowhash.h	H	1.3 KB	2026-06-18 11:25	EDIT
📄 nssrwlk.h	H	4.9 KB	2026-06-18 11:25	EDIT
📄 nssrwlkt.h	H	535 B	2026-06-18 11:25	EDIT
📄 nssutil.h	H	966 B	2026-06-18 11:25	EDIT
📄 ocsp.h	H	28.2 KB	2026-06-18 11:25	EDIT
📄 ocspt.h	H	12.2 KB	2026-06-18 11:25	EDIT
📄 p12.h	H	9.2 KB	2026-06-18 11:25	EDIT
📄 p12plcy.h	H	755 B	2026-06-18 11:25	EDIT
📄 p12t.h	H	4.5 KB	2026-06-18 11:25	EDIT
📄 pk11func.h	H	494 B	2026-06-18 11:25	EDIT
📄 pk11hpke.h	H	1.8 KB	2026-06-18 11:25	EDIT
📄 pk11pqg.h	H	6.4 KB	2026-06-18 11:25	EDIT
📄 pk11priv.h	H	10.1 KB	2026-06-18 11:25	EDIT
📄 pk11pub.h	H	59.2 KB	2026-06-18 11:25	EDIT
📄 pk11sdr.h	H	731 B	2026-06-18 11:25	EDIT
📄 pkcs11.h	H	7.8 KB	2026-06-18 11:25	EDIT
📄 pkcs11f.h	H	31.1 KB	2026-06-18 11:25	EDIT
📄 pkcs11n.h	H	27.7 KB	2026-06-18 11:25	EDIT
📄 pkcs11p.h	H	869 B	2026-06-18 11:25	EDIT
📄 pkcs11t.h	H	86.6 KB	2026-06-18 11:25	EDIT
📄 pkcs11u.h	H	709 B	2026-06-18 11:25	EDIT
📄 pkcs11uri.h	H	3 KB	2026-06-18 11:25	EDIT
📄 pkcs12.h	H	1.4 KB	2026-06-18 11:25	EDIT
📄 pkcs12t.h	H	11 KB	2026-06-18 11:25	EDIT
📄 pkcs1sig.h	H	1.2 KB	2026-06-18 11:25	EDIT
📄 pkcs7t.h	H	9 KB	2026-06-18 11:25	EDIT
📄 portreg.h	H	3 KB	2026-06-18 11:25	EDIT
📄 preenc.h	H	3.7 KB	2026-06-18 11:25	EDIT
📄 secasn1.h	H	12.9 KB	2026-06-18 11:25	EDIT
📄 secasn1t.h	H	10.7 KB	2026-06-18 11:25	EDIT
📄 seccomon.h	H	2.1 KB	2026-06-18 11:25	EDIT
📄 secder.h	H	5.9 KB	2026-06-18 11:25	EDIT
📄 secdert.h	H	3.9 KB	2026-06-18 11:25	EDIT
📄 secdig.h	H	3.3 KB	2026-06-18 11:25	EDIT
📄 secdigt.h	H	622 B	2026-06-18 11:25	EDIT
📄 secerr.h	H	11.4 KB	2026-06-18 11:25	EDIT
📄 sechash.h	H	1.7 KB	2026-06-18 11:25	EDIT
📄 secitem.h	H	4.7 KB	2026-06-18 11:25	EDIT
📄 secmime.h	H	7 KB	2026-06-18 11:25	EDIT
📄 secmod.h	H	8 KB	2026-06-18 11:25	EDIT
📄 secmodt.h	H	16.2 KB	2026-06-18 11:25	EDIT
📄 secoid.h	H	4.9 KB	2026-06-18 11:25	EDIT
📄 secoidt.h	H	19.4 KB	2026-06-18 11:25	EDIT
📄 secpkcs5.h	H	2 KB	2026-06-18 11:25	EDIT
📄 secpkcs7.h	H	24.8 KB	2026-06-18 11:25	EDIT
📄 secport.h	H	14.7 KB	2026-06-18 11:25	EDIT
📄 shsign.h	H	816 B	2026-06-18 11:25	EDIT
📄 smime.h	H	5.6 KB	2026-06-18 11:25	EDIT
📄 ssl.h	H	73.7 KB	2026-06-18 11:25	EDIT
📄 sslerr.h	H	16 KB	2026-06-18 11:25	EDIT
📄 sslexp.h	H	54.9 KB	2026-06-18 11:25	EDIT
📄 sslproto.h	H	14.1 KB	2026-06-18 11:25	EDIT
📄 sslt.h	H	20.6 KB	2026-06-18 11:25	EDIT
📄 utilmodt.h	H	1.6 KB	2026-06-18 11:25	EDIT
📄 utilpars.h	H	3.4 KB	2026-06-18 11:25	EDIT
📄 utilparst.h	H	3.3 KB	2026-06-18 11:25	EDIT
📄 utilrename.h	H	8.6 KB	2026-06-18 11:25	EDIT