lws-region.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */


typedef struct lws_region_claim {
        const uint8_t           *s;     /* NULL: slot free */
        const uint8_t           *e;
        const char              *who;
        uint16_t                gen;    /* distinguishes reuses of the slot */
} lws_region_claim_t;

typedef struct lws_region {
        const char              *name;
        const uint8_t           *base;
        size_t                  len;
        lws_region_claim_t      *claims;
        uint8_t                 count_claims;
        uint8_t                 flags;
} lws_region_t;
 
/* lws_region_init() flags */
#define LWS_REGION_F_ABORT              (1 << 0)  /* abort() on violation */
 
/* lws_region_claim() results other than a handle */
enum {
        LWS_REGION_NOT_TRACKED          = -1, /* p is not in the buffer */
        LWS_REGION_E_OVERRUN            = -2, /* runs past the end */
        LWS_REGION_E_OVERLAP            = -3, /* overlaps a live claim */
        LWS_REGION_E_FULL               = -4, /* no free claim slot */
};

LWS_VISIBLE LWS_EXTERN int
lws_region_init(lws_region_t *r, const char *name, const void *base,
                size_t len, lws_region_claim_t *claims, size_t count_claims,
                unsigned int flags);

LWS_VISIBLE LWS_EXTERN int
lws_region_claim(lws_region_t *r, const void *p, size_t len, const char *who);

LWS_VISIBLE LWS_EXTERN void
lws_region_release(lws_region_t *r, int handle);

LWS_VISIBLE LWS_EXTERN void
lws_region_release_containing(lws_region_t *r, const void *p);

LWS_VISIBLE LWS_EXTERN void
lws_region_trim(lws_region_t *r, const void *p);

LWS_VISIBLE LWS_EXTERN int
lws_region_idle(const lws_region_t *r, const char *where);