1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24 * Use is subject to license terms.
25 * Copyright 2013 Joyent, Inc.  All rights reserved.
26 * Copyright 2017 OmniOS Community Edition (OmniOSce) Association.
27 */
28
29#include "libscf_impl.h"
30
31#include <assert.h>
32#include <dlfcn.h>
33#include <libintl.h>
34#include <pthread.h>
35#include <stdarg.h>
36#include <stdio.h>
37#include <stdlib.h>
38#include <string.h>
39#include <sys/machelf.h>
40#include <thread.h>
41
42#include <ucontext.h>
43
44extern int ndebug;
45
46static struct scf_error_info {
47	scf_error_t	ei_code;
48	const char	*ei_desc;
49} scf_errors[] = {
50	{SCF_ERROR_NONE,		"no error"},
51	{SCF_ERROR_NOT_BOUND,		"handle not bound"},
52	{SCF_ERROR_NOT_SET,		"cannot use unset argument"},
53	{SCF_ERROR_NOT_FOUND,		"entity not found"},
54	{SCF_ERROR_TYPE_MISMATCH,	"type does not match value"},
55	{SCF_ERROR_IN_USE,		"cannot modify while in-use"},
56	{SCF_ERROR_CONNECTION_BROKEN,	"connection to repository broken"},
57	{SCF_ERROR_INVALID_ARGUMENT,	"invalid argument"},
58	{SCF_ERROR_NO_MEMORY,		"no memory available"},
59	{SCF_ERROR_CONSTRAINT_VIOLATED,	"required constraint not met"},
60	{SCF_ERROR_EXISTS,		"object already exists"},
61	{SCF_ERROR_NO_SERVER,		"repository server unavailable"},
62	{SCF_ERROR_NO_RESOURCES,	"server has insufficient resources"},
63	{SCF_ERROR_PERMISSION_DENIED,	"insufficient privileges for action"},
64	{SCF_ERROR_BACKEND_ACCESS,	"backend refused access"},
65	{SCF_ERROR_BACKEND_READONLY,	"backend is read-only"},
66	{SCF_ERROR_HANDLE_MISMATCH,	"mismatched SCF handles"},
67	{SCF_ERROR_HANDLE_DESTROYED,	"object bound to destroyed handle"},
68	{SCF_ERROR_VERSION_MISMATCH,	"incompatible SCF version"},
69	{SCF_ERROR_DELETED,		"object has been deleted"},
70	{SCF_ERROR_TEMPLATE_INVALID,	"template data is invalid"},
71
72	{SCF_ERROR_CALLBACK_FAILED,	"user callback function failed"},
73
74	{SCF_ERROR_INTERNAL,		"internal error"}
75};
76#define	SCF_NUM_ERRORS	(sizeof (scf_errors) / sizeof (*scf_errors))
77
78/* a SWAG just in case things get out of sync, we can notice */
79#define	LOOKS_VALID(e)	\
80	((e) >= scf_errors[0].ei_code && \
81	    (e) < scf_errors[SCF_NUM_ERRORS - 1].ei_code + 10)
82
83static scf_error_t	_scf_fallback_error = SCF_ERROR_NONE;
84
85#if defined(PTHREAD_ONCE_KEY_NP)
86
87static pthread_key_t	scf_error_key = PTHREAD_ONCE_KEY_NP;
88
89int
90scf_setup_error(void)
91{
92	return (pthread_key_create_once_np(&scf_error_key, NULL) == 0);
93}
94
95#else	/* PTHREAD_ONCE_KEY_NP */
96
97/*
98 * This old code is here to enable the building of a native version
99 * of libscf.so when the build machine has not yet been upgraded
100 * to a version of libc that provides pthread_key_create_once_np().
101 * It should be deleted when solaris_nevada ships.
102 * This code is not MT-safe in a relaxed memory model.
103 */
104
105static pthread_key_t	scf_error_key = 0;
106
107int
108scf_setup_error(void)
109{
110	static pthread_mutex_t scf_key_lock = PTHREAD_MUTEX_INITIALIZER;
111	static volatile int scf_error_key_setup = 0;
112
113	if (scf_error_key_setup == 0) {
114		(void) pthread_mutex_lock(&scf_key_lock);
115		if (scf_error_key_setup == 0) {
116			if (pthread_key_create(&scf_error_key, NULL) == 0)
117				scf_error_key_setup = 1;
118		}
119		(void) pthread_mutex_unlock(&scf_key_lock);
120	}
121
122	return (scf_error_key_setup == 1);
123}
124
125#endif	/* PTHREAD_ONCE_KEY_NP */
126
127int
128scf_set_error(scf_error_t code)
129{
130	assert(LOOKS_VALID(code));
131
132	if (scf_setup_error())
133		(void) pthread_setspecific(scf_error_key, (void *)code);
134	else
135		_scf_fallback_error = code;
136	return (-1);
137}
138
139scf_error_t
140scf_error(void)
141{
142	scf_error_t ret;
143
144	ret = (scf_error_t)pthread_getspecific(scf_error_key);
145	if (ret == 0)
146		return (_scf_fallback_error);
147	assert(LOOKS_VALID(ret));
148	return (ret);
149}
150
151const char *
152scf_strerror(scf_error_t code)
153{
154	struct scf_error_info *cur, *end;
155
156	cur = scf_errors;
157	end = cur + SCF_NUM_ERRORS;
158
159	for (; cur < end; cur++)
160		if (code == cur->ei_code)
161			return (dgettext(TEXT_DOMAIN, cur->ei_desc));
162
163	return (dgettext(TEXT_DOMAIN, "unknown error"));
164}
165
166const char *
167scf_get_msg(scf_msg_t msg)
168{
169	switch (msg) {
170	case SCF_MSG_ARGTOOLONG:
171		return (dgettext(TEXT_DOMAIN,
172		    "Argument '%s' is too long, ignoring\n"));
173
174	case SCF_MSG_PATTERN_NOINSTANCE:
175		return (dgettext(TEXT_DOMAIN,
176		    "Pattern '%s' doesn't match any instances\n"));
177
178	case SCF_MSG_PATTERN_NOINSTSVC:
179		return (dgettext(TEXT_DOMAIN,
180		    "Pattern '%s' doesn't match any instances or services\n"));
181
182	case SCF_MSG_PATTERN_NOSERVICE:
183		return (dgettext(TEXT_DOMAIN,
184		    "Pattern '%s' doesn't match any services\n"));
185
186	case SCF_MSG_PATTERN_NOENTITY:
187		return (dgettext(TEXT_DOMAIN,
188		    "Pattern '%s' doesn't match any entities\n"));
189
190	case SCF_MSG_PATTERN_MULTIMATCH:
191		return (dgettext(TEXT_DOMAIN,
192		    "Pattern '%s' matches multiple instances:\n"));
193
194	case SCF_MSG_PATTERN_POSSIBLE:
195		return (dgettext(TEXT_DOMAIN, "    %s\n"));
196
197	case SCF_MSG_PATTERN_LEGACY:
198		return (dgettext(TEXT_DOMAIN,
199		    "Operation not supported for legacy service '%s'\n"));
200
201	case SCF_MSG_PATTERN_MULTIPARTIAL:
202		return (dgettext(TEXT_DOMAIN,
203		    "Partial FMRI '%s' matches multiple instances:\n"));
204
205	default:
206		abort();
207		/* NOTREACHED */
208	}
209
210}
211