.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "rbucket 3"
.TH rbucket 3 "2003-10-23" "Roy 1.0.7" "Roy API Docs"
.SH "NAME"
rbucket \- Roy bucket memory allocator
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
#include <roy.h>
.PP
RBucket * rbucket_new (unsigned int size);
.PP
void rbucket_empty (RBucket *bucket);
.PP
void rbucket_destroy (RBucket *bucket);
.PP
void * rbucket_alloc (RBucket *bucket);
.PP
void rbucket_free (RBucket *bucket, void *mem);
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
RBucket implements an even faster memory allocator than \fIrchunk\fR\|(3).
This one uses a structure \fIRBucket\fR to contain the pool of memory
from which it allocates and frees.  Unlike \fIrchunk\fR\|(3), rbucket does
not perform any thread locking, and only allocates chunks of sizes
as specified by \fIrbucket_new\fR\|(3).
.PP
As rbucket does not perform thread locking, it is generally expected that
rbucket will be used per\-thread, or the user will have to do the locking.
See \fIrthread\fR\|(3) for details on roy threading, and \fIrthread_mutex\fR\|(3) for
mutexes in particular.
.PP
The speed achieved by rbucket is almost that of using \fIalloca\fR\|(3), but is
safe for use on all platforms.
.PP
\&\fIrbucket_new\fR\|(3) creates a new bucket that will allow you to allocate
\&\fIsize\fR sized blocks of memory from it.
.PP
\&\fIrbucket_destroy\fR\|(3) frees the RBucket structure and \s-1ALL\s0 memory used
in \s-1ALL\s0 blocks allocated from this bucket.  Blocks allocated with
\&\fIrbucket_alloc\fR\|(3) are freed along with those still in the bucket.
Again, \s-1ALL\s0 memory used by the bucket is freed, whether allocated
or not.
.PP
\&\fIrbucket_empty\fR\|(3) frees all blocks in \fIbucket\fR, both those in use
and not in use, but does not destroy the RBucket structure itself
so that it can continue to be used.
.PP
\&\fIrbucket_alloc\fR\|(3) allocates a block from \fIbucket\fR.  This returns
a newly allocated block of memory of the size specified in
\&\fIrbucket_new\fR\|(3).
.PP
\&\fIrbucket_alloc0\fR\|(3) allocates a block from \fIbucket\fR the same
as \fIrbucket_alloc\fR\|(3), but zeros the memory before returning it.
.PP
\&\fIrbucket_free\fR\|(3) returns the block of memory \fImem\fR back to the 
\&\fIbucket\fR.  It will then be made available for future allocations
with \fIrbucket_alloc\fR\|(3).
.SH "MACROS"
.IX Header "MACROS"
rbucket_alloc, rbucket_alloc0, and rbucket_free are implemented as macros,
though there should never be a problem with their behavior if used as
functions.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIroy\fR\|(3)