xref: /src/common/lib/libprop/prop_object_impl.h

/*	$NetBSD: prop_object_impl.h,v 1.41 2025/05/14 03:25:46 thorpej Exp $	*/

/*-
 * Copyright (c) 2006, 2020, 2025 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _PROPLIB_PROP_OBJECT_IMPL_H_
#define	_PROPLIB_PROP_OBJECT_IMPL_H_

#if defined(HAVE_NBTOOL_CONFIG_H)
#include "nbtool_config.h"
#endif

#if defined(_KERNEL) || defined(_STANDALONE)
#include <lib/libkern/libkern.h>
#else
#include <inttypes.h>
#endif

#include "prop_stack.h"

struct _prop_object;

struct _prop_object_externalize_context {
	char *		poec_buf;		/* string buffer */
	size_t		poec_capacity;		/* capacity of buffer */
	size_t		poec_len;		/* current length of string */
	unsigned int	poec_depth;		/* nesting depth */
	prop_format_t	poec_format;		/* output format */
};

struct _prop_object_type_tags {
	const char	*xml_tag;
	const char	*json_open_tag;
	const char	*json_close_tag;
	const char	*json_empty_sep;
};

bool		_prop_extern_append_char(
				struct _prop_object_externalize_context *,
				unsigned char);
bool		_prop_extern_append_cstring(
				struct _prop_object_externalize_context *,
				const char *);
bool		_prop_extern_start_line(
				struct _prop_object_externalize_context *);
bool		_prop_extern_end_line(
				struct _prop_object_externalize_context *,
				const char *);

bool		_prop_extern_append_start_tag(
				struct _prop_object_externalize_context *,
				const struct _prop_object_type_tags *,
				const char *);
bool		_prop_extern_append_end_tag(
				struct _prop_object_externalize_context *,
				const struct _prop_object_type_tags *);
bool		_prop_extern_append_empty_tag(
				struct _prop_object_externalize_context *,
				const struct _prop_object_type_tags *);

bool		_prop_extern_append_encoded_cstring(
				struct _prop_object_externalize_context *,
				const char *);

bool		_prop_object_externalize_to_file(struct _prop_object *,
				const char *, prop_format_t);
char *		_prop_object_externalize(struct _prop_object *,
				prop_format_t fmt);

typedef enum {
	_PROP_TAG_TYPE_START,			/* e.g. <dict> */
	_PROP_TAG_TYPE_END,			/* e.g. </dict> */
	_PROP_TAG_TYPE_EITHER
} _prop_tag_type_t;

struct _prop_object_internalize_context {
	prop_format_t poic_format;

	const char *poic_data;
	const char *poic_cp;

	const char *poic_tag_start;

	const char *poic_tagname;
	size_t      poic_tagname_len;
	const char *poic_tagattr;
	size_t      poic_tagattr_len;
	const char *poic_tagattrval;
	size_t      poic_tagattrval_len;

	bool   poic_is_empty_element;
	_prop_tag_type_t poic_tag_type;
};

typedef enum {
	_PROP_OBJECT_FREE_DONE,
	_PROP_OBJECT_FREE_RECURSE,
	_PROP_OBJECT_FREE_FAILED
} _prop_object_free_rv_t;

typedef enum {
	_PROP_OBJECT_EQUALS_FALSE,
	_PROP_OBJECT_EQUALS_TRUE,
	_PROP_OBJECT_EQUALS_RECURSE
} _prop_object_equals_rv_t;

#define	_PROP_EOF(c)		((c) == '\0')
#define	_PROP_ISSPACE(c)	\
	((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')

#define	_PROP_TAG_MATCH(ctx, t)				\
	_prop_intern_match((ctx)->poic_tagname,		\
			   (ctx)->poic_tagname_len,	\
			   (t), strlen(t))

#define	_PROP_TAGATTR_MATCH(ctx, a)			\
	_prop_intern_match((ctx)->poic_tagattr,		\
			   (ctx)->poic_tagattr_len,	\
			   (a), strlen(a))

#define	_PROP_TAGATTRVAL_MATCH(ctx, a)			\
	_prop_intern_match((ctx)->poic_tagattrval,	\
			   (ctx)->poic_tagattrval_len,	\
			   (a), strlen(a))

const char *	_prop_intern_skip_whitespace(const char *);
bool		_prop_intern_match(const char *, size_t, const char *, size_t);

bool		_prop_intern_decode_string(
				struct _prop_object_internalize_context *,
				char *, size_t, size_t *, const char **);

bool		_prop_xml_intern_find_tag(
				struct _prop_object_internalize_context *,
				const char *, _prop_tag_type_t);

prop_object_t	_prop_object_internalize(const char *,
				const struct _prop_object_type_tags *);
prop_object_t	_prop_object_internalize_from_file(const char *,
				const struct _prop_object_type_tags *);

typedef bool (*prop_object_internalizer_t)(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
typedef bool (*prop_object_internalizer_continue_t)(prop_stack_t,
				prop_object_t *,
				struct _prop_object_internalize_context *,
				void *, prop_object_t);

	/* These are here because they're required by shared code. */
bool		_prop_array_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
bool		_prop_bool_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
bool		_prop_data_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
bool		_prop_dictionary_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
bool		_prop_number_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);
bool		_prop_string_internalize(prop_stack_t, prop_object_t *,
				struct _prop_object_internalize_context *);

bool		_prop_string_externalize_internal(
				struct _prop_object_externalize_context *,
				const struct _prop_object_type_tags *,
				const char *);

struct _prop_object_type {
	/* type indicator */
	uint32_t	pot_type;
	/* func to free object */
	_prop_object_free_rv_t
			(*pot_free)(prop_stack_t, prop_object_t *);
	/*
	 * func to free the child returned by pot_free with stack == NULL.
	 *
	 * Must be implemented if pot_free can return anything other than
	 * _PROP_OBJECT_FREE_DONE.
	 */
	void	(*pot_emergency_free)(prop_object_t);
	/* func to externalize object */
	bool	(*pot_extern)(struct _prop_object_externalize_context *,
			      void *);
	/* func to test quality */
	_prop_object_equals_rv_t
		(*pot_equals)(prop_object_t, prop_object_t,
			      void **, void **,
			      prop_object_t *, prop_object_t *);
	/*
	 * func to finish equality iteration.
	 *
	 * Must be implemented if pot_equals can return
	 * _PROP_OBJECT_EQUALS_RECURSE
	 */
	void	(*pot_equals_finish)(prop_object_t, prop_object_t);
	void    (*pot_lock)(void);
	void    (*pot_unlock)(void);
};

struct _prop_object {
	const struct _prop_object_type *po_type;/* type descriptor */
	uint32_t	po_refcnt;		/* reference count */
};

void		_prop_object_init(struct _prop_object *,
				  const struct _prop_object_type *);
void		_prop_object_fini(struct _prop_object *);

struct _prop_object_iterator {
	prop_object_t	(*pi_next_object)(void *);
	void		(*pi_reset)(void *);
	prop_object_t	pi_obj;
	uint32_t	pi_version;
};

#define _PROP_NOTHREAD_ONCE_DECL(x)	static bool x = false;
#define _PROP_NOTHREAD_ONCE_RUN(x,f)					\
	do {								\
		if ((x) == false) {					\
			f();						\
			x = true;					\
		}							\
	} while (/*CONSTCOND*/0)

#if defined(_KERNEL)

/*
 * proplib in the kernel...
 */

#include <sys/param.h>
#include <sys/malloc.h>
#include <sys/pool.h>
#include <sys/systm.h>
#include <sys/rwlock.h>
#include <sys/once.h>

#define	_PROP_ASSERT(x)			KASSERT(x)

#define	_PROP_MALLOC(s, t)		malloc((s), (t), M_WAITOK)
#define	_PROP_CALLOC(s, t)		malloc((s), (t), M_WAITOK | M_ZERO)
#define	_PROP_REALLOC(v, s, t)		realloc((v), (s), (t), M_WAITOK)
#define	_PROP_FREE(v, t)		free((v), (t))

#define	_PROP_POOL_GET(p)		pool_get(&(p), PR_WAITOK)
#define	_PROP_POOL_PUT(p, v)		pool_put(&(p), (v))

struct prop_pool_init {
	struct pool *pp;
	size_t size;
	const char *wchan;
};
#define	_PROP_POOL_INIT(pp, size, wchan)				\
struct pool pp;								\
static const struct prop_pool_init _link_ ## pp[1] = {			\
	{ &pp, size, wchan }						\
};									\
__link_set_add_rodata(prop_linkpools, _link_ ## pp);

#define	_PROP_MALLOC_DEFINE(t, s, l)					\
		MALLOC_DEFINE(t, s, l);

#define	_PROP_MUTEX_DECL_STATIC(x)	static kmutex_t x;
#define	_PROP_MUTEX_INIT(x)		mutex_init(&(x),MUTEX_DEFAULT,IPL_NONE)
#define	_PROP_MUTEX_LOCK(x)		mutex_enter(&(x))
#define	_PROP_MUTEX_UNLOCK(x)		mutex_exit(&(x))

#define	_PROP_RWLOCK_DECL(x)		krwlock_t x ;
#define	_PROP_RWLOCK_INIT(x)		rw_init(&(x))
#define	_PROP_RWLOCK_RDLOCK(x)		rw_enter(&(x), RW_READER)
#define	_PROP_RWLOCK_WRLOCK(x)		rw_enter(&(x), RW_WRITER)
#define	_PROP_RWLOCK_UNLOCK(x)		rw_exit(&(x))
#define	_PROP_RWLOCK_DESTROY(x)		rw_destroy(&(x))

#define _PROP_ONCE_DECL(x)		static ONCE_DECL(x);
#define _PROP_ONCE_RUN(x,f)		RUN_ONCE(&(x), f)

#include <sys/atomic.h>

#define	_PROP_ATOMIC_LOAD(x)		atomic_load_relaxed(x)
#define _PROP_ATOMIC_INC32(x)		atomic_inc_32(x)
#define _PROP_ATOMIC_DEC32(x)		atomic_dec_32(x)
#define _PROP_ATOMIC_INC32_NV(x, v)	v = atomic_inc_32_nv(x)
#define _PROP_ATOMIC_DEC32_NV(x, v)	v = atomic_dec_32_nv(x)

#elif defined(_STANDALONE)

/*
 * proplib in a standalone environment...
 */

#include <lib/libsa/stand.h>

void *		_prop_standalone_calloc(size_t);
void *		_prop_standalone_realloc(void *, size_t);

#define	_PROP_ASSERT(x)			/* nothing */

#define	_PROP_MALLOC(s, t)		alloc((s))
#define	_PROP_CALLOC(s, t)		_prop_standalone_calloc((s))
#define	_PROP_REALLOC(v, s, t)		_prop_standalone_realloc((v), (s))
#define	_PROP_FREE(v, t)		dealloc((v), 0)		/* XXX */

#define	_PROP_POOL_GET(p)		alloc((p))
#define	_PROP_POOL_PUT(p, v)		dealloc((v), (p))

#define	_PROP_POOL_INIT(p, s, d)	static const size_t p = s;

#define	_PROP_MALLOC_DEFINE(t, s, l)	/* nothing */

#define	_PROP_MUTEX_DECL_STATIC(x)	/* nothing */
#define	_PROP_MUTEX_INIT(x)		/* nothing */
#define	_PROP_MUTEX_LOCK(x)		/* nothing */
#define	_PROP_MUTEX_UNLOCK(x)		/* nothing */

#define	_PROP_RWLOCK_DECL(x)		/* nothing */
#define	_PROP_RWLOCK_INIT(x)		/* nothing */
#define	_PROP_RWLOCK_RDLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_WRLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_UNLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_DESTROY(x)		/* nothing */

#define _PROP_ONCE_DECL(x)		_PROP_NOTHREAD_ONCE_DECL(x)
#define _PROP_ONCE_RUN(x,f)		_PROP_NOTHREAD_ONCE_RUN(x,f)

#define	_PROP_ATOMIC_LOAD(x)		*(x)
#define _PROP_ATOMIC_INC32(x)		++*(x)
#define _PROP_ATOMIC_DEC32(x)		--*(x)
#define _PROP_ATOMIC_INC32_NV(x, v)	v = ++*(x)
#define _PROP_ATOMIC_DEC32_NV(x, v)	v = --*(x)

#else

/*
 * proplib in user space...
 */

#include <assert.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>

#define	_PROP_ASSERT(x)			/*LINTED*/assert(x)

#define	_PROP_MALLOC(s, t)		malloc((s))
#define	_PROP_CALLOC(s, t)		calloc(1, (s))
#define	_PROP_REALLOC(v, s, t)		realloc((v), (s))
#define	_PROP_FREE(v, t)		free((v))

#define	_PROP_POOL_GET(p)		malloc((p))
#define	_PROP_POOL_PUT(p, v)		free((v))

#define	_PROP_POOL_INIT(p, s, d)	static const size_t p = s;

#define	_PROP_MALLOC_DEFINE(t, s, l)	/* nothing */

#if defined(__NetBSD__) && defined(_LIBPROP)
/*
 * Use the same mechanism as libc; we get pthread mutexes for threaded
 * programs and do-nothing stubs for non-threaded programs.
 */
#include <sys/atomic.h>
#include "reentrant.h"
#define	_PROP_MUTEX_DECL_STATIC(x)	static mutex_t x;
#define	_PROP_MUTEX_INIT(x)		mutex_init(&(x), NULL)
#define	_PROP_MUTEX_LOCK(x)		mutex_lock(&(x))
#define	_PROP_MUTEX_UNLOCK(x)		mutex_unlock(&(x))

#define	_PROP_RWLOCK_DECL(x)		rwlock_t x ;
#define	_PROP_RWLOCK_INIT(x)		rwlock_init(&(x), NULL)
#define	_PROP_RWLOCK_RDLOCK(x)		rwlock_rdlock(&(x))
#define	_PROP_RWLOCK_WRLOCK(x)		rwlock_wrlock(&(x))
#define	_PROP_RWLOCK_UNLOCK(x)		rwlock_unlock(&(x))
#define	_PROP_RWLOCK_DESTROY(x)		rwlock_destroy(&(x))

#define _PROP_ONCE_DECL(x)						\
	static pthread_once_t x = PTHREAD_ONCE_INIT;
#define _PROP_ONCE_RUN(x,f)		thr_once(&(x), (void(*)(void))f);

#define	_PROP_ATOMIC_LOAD(x)		*(x)
#define _PROP_ATOMIC_INC32(x)		atomic_inc_32(x)
#define _PROP_ATOMIC_DEC32(x)		atomic_dec_32(x)
#define _PROP_ATOMIC_INC32_NV(x, v)	v = atomic_inc_32_nv(x)
#define _PROP_ATOMIC_DEC32_NV(x, v)	v = atomic_dec_32_nv(x)

#define	_PROP_EXPORT			__attribute__((visibility("default")))

#elif defined(HAVE_NBTOOL_CONFIG_H)
/*
 * None of NetBSD's build tools are multi-threaded.
 */
#define	_PROP_MUTEX_DECL_STATIC(x)	/* nothing */
#define	_PROP_MUTEX_INIT(x)		/* nothing */
#define	_PROP_MUTEX_LOCK(x)		/* nothing */
#define	_PROP_MUTEX_UNLOCK(x)		/* nothing */

#define	_PROP_RWLOCK_DECL(x)		/* nothing */
#define	_PROP_RWLOCK_INIT(x)		/* nothing */
#define	_PROP_RWLOCK_RDLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_WRLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_UNLOCK(x)		/* nothing */
#define	_PROP_RWLOCK_DESTROY(x)		/* nothing */

#define _PROP_ONCE_DECL(x)		_PROP_NOTHREAD_ONCE_DECL(x)
#define _PROP_ONCE_RUN(x,f)		_PROP_NOTHREAD_ONCE_RUN(x,f)

#define	_PROP_ATOMIC_LOAD(x)		*(x)
#define _PROP_ATOMIC_INC32(x)		++*(x)
#define _PROP_ATOMIC_DEC32(x)		--*(x)
#define _PROP_ATOMIC_INC32_NV(x, v)	v = ++*(x)
#define _PROP_ATOMIC_DEC32_NV(x, v)	v = --*(x)

#else
/*
 * Use pthread mutexes everywhere else.
 */
#include <pthread.h>
#define	_PROP_MUTEX_DECL_STATIC(x)	static pthread_mutex_t x;
#define	_PROP_MUTEX_INIT(x)		pthread_mutex_init(&(x), NULL)
#define	_PROP_MUTEX_LOCK(x)		pthread_mutex_lock(&(x))
#define	_PROP_MUTEX_UNLOCK(x)		pthread_mutex_unlock(&(x))

#define	_PROP_RWLOCK_DECL(x)		pthread_rwlock_t x ;
#define	_PROP_RWLOCK_INIT(x)		pthread_rwlock_init(&(x), NULL)
#define	_PROP_RWLOCK_RDLOCK(x)		pthread_rwlock_rdlock(&(x))
#define	_PROP_RWLOCK_WRLOCK(x)		pthread_rwlock_wrlock(&(x))
#define	_PROP_RWLOCK_UNLOCK(x)		pthread_rwlock_unlock(&(x))
#define	_PROP_RWLOCK_DESTROY(x)		pthread_rwlock_destroy(&(x))

#define _PROP_ONCE_DECL(x)						\
	static pthread_once_t x = PTHREAD_ONCE_INIT;
#define _PROP_ONCE_RUN(x,f)		pthread_once(&(x),(void(*)(void))f)

#define _PROP_NEED_REFCNT_MTX

#define	_PROP_ATOMIC_LOAD(x)		*(x)

#define _PROP_ATOMIC_INC32(x)						\
do {									\
	pthread_mutex_lock(&_prop_refcnt_mtx);				\
	(*(x))++;							\
	pthread_mutex_unlock(&_prop_refcnt_mtx);			\
} while (/*CONSTCOND*/0)

#define _PROP_ATOMIC_DEC32(x)						\
do {									\
	pthread_mutex_lock(&_prop_refcnt_mtx);				\
	(*(x))--;							\
	pthread_mutex_unlock(&_prop_refcnt_mtx);			\
} while (/*CONSTCOND*/0)

#define _PROP_ATOMIC_INC32_NV(x, v)					\
do {									\
	pthread_mutex_lock(&_prop_refcnt_mtx);				\
	v = ++(*(x));							\
	pthread_mutex_unlock(&_prop_refcnt_mtx);			\
} while (/*CONSTCOND*/0)

#define _PROP_ATOMIC_DEC32_NV(x, v)					\
do {									\
	pthread_mutex_lock(&_prop_refcnt_mtx);				\
	v = --(*(x));							\
	pthread_mutex_unlock(&_prop_refcnt_mtx);			\
} while (/*CONSTCOND*/0)

#endif
#endif /* _KERNEL */

#ifndef _PROP_EXPORT
#define	_PROP_EXPORT			/* nothing */
#endif

/*
 * Language features.
 */
#if defined(__NetBSD__)
#include <sys/cdefs.h>
#define	_PROP_ARG_UNUSED		__unused
#if defined(__clang__)
#define	_PROP_DEPRECATED(s, m)		/* delete */
#else /* ! __clang__ */
#define	_PROP_DEPRECATED(s, m)		__warn_references(s, m)
#endif /* __clang__ */
#define	_PROP_UNCONST(x)		__UNCONST(x)
#else
#define	_PROP_ARG_UNUSED		/* delete */
#define	_PROP_DEPRECATED(s, m)		/* delete */
#define	_PROP_UNCONST(x)	((void *)(unsigned long)(const void *)(x))
#endif /* __NetBSD__ */

#endif /* _PROPLIB_PROP_OBJECT_IMPL_H_ */