error.c revision 7887:b6618727fabf 
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 */
26
27#include "libscf_impl.h"
28
29#include <assert.h>
30#include <dlfcn.h>
31#include <libintl.h>
32#include <pthread.h>
33#include <stdarg.h>
34#include <stdio.h>
35#include <stdlib.h>
36#include <string.h>
37#include <sys/machelf.h>
38#include <thread.h>
39
40#include <ucontext.h>
41
42extern int ndebug;
43
44static struct scf_error_info {
45	scf_error_t	ei_code;
46	const char	*ei_desc;
47} scf_errors[] = {
48	{SCF_ERROR_NONE,		"no error"},
49	{SCF_ERROR_NOT_BOUND,		"handle not bound"},
50	{SCF_ERROR_NOT_SET,		"cannot use unset argument"},
51	{SCF_ERROR_NOT_FOUND,		"entity not found"},
52	{SCF_ERROR_TYPE_MISMATCH,	"type does not match value"},
53	{SCF_ERROR_IN_USE,		"cannot modify while in-use"},
54	{SCF_ERROR_CONNECTION_BROKEN,	"connection to repository broken"},
55	{SCF_ERROR_INVALID_ARGUMENT,	"invalid argument"},
56	{SCF_ERROR_NO_MEMORY,		"no memory available"},
57	{SCF_ERROR_CONSTRAINT_VIOLATED,	"required constraint not met"},
58	{SCF_ERROR_EXISTS,		"object already exists"},
59	{SCF_ERROR_NO_SERVER,		"repository server unavailable"},
60	{SCF_ERROR_NO_RESOURCES,	"server has insufficient resources"},
61	{SCF_ERROR_PERMISSION_DENIED,	"insufficient privileges for action"},
62	{SCF_ERROR_BACKEND_ACCESS,	"backend refused access"},
63	{SCF_ERROR_BACKEND_READONLY,	"backend is read-only"},
64	{SCF_ERROR_HANDLE_MISMATCH,	"mismatched SCF handles"},
65	{SCF_ERROR_HANDLE_DESTROYED,	"object bound to destroyed handle"},
66	{SCF_ERROR_VERSION_MISMATCH,	"incompatible SCF version"},
67	{SCF_ERROR_DELETED,		"object has been deleted"},
68	{SCF_ERROR_TEMPLATE_INVALID,	"template data is invalid"},
69
70	{SCF_ERROR_CALLBACK_FAILED,	"user callback function failed"},
71
72	{SCF_ERROR_INTERNAL,		"internal error"}
73};
74#define	SCF_NUM_ERRORS	(sizeof (scf_errors) / sizeof (*scf_errors))
75
76/* a SWAG just in case things get out of sync, we can notice */
77#define	LOOKS_VALID(e)	\
78	((e) >= scf_errors[0].ei_code && \
79	    (e) < scf_errors[SCF_NUM_ERRORS - 1].ei_code + 10)
80
81static scf_error_t	_scf_fallback_error = SCF_ERROR_NONE;
82
83#if defined(PTHREAD_ONCE_KEY_NP)
84
85static pthread_key_t	scf_error_key = PTHREAD_ONCE_KEY_NP;
86
87int
88scf_setup_error(void)
89{
90	return (pthread_key_create_once_np(&scf_error_key, NULL) == 0);
91}
92
93#else	/* PTHREAD_ONCE_KEY_NP */
94
95/*
96 * This old code is here to enable the building of a native version
97 * of libscf.so when the build machine has not yet been upgraded
98 * to a version of libc that provides pthread_key_create_once_np().
99 * It should be deleted when solaris_nevada ships.
100 * This code is not MT-safe in a relaxed memory model.
101 */
102
103static pthread_key_t	scf_error_key = 0;
104
105int
106scf_setup_error(void)
107{
108	static pthread_mutex_t scf_key_lock = PTHREAD_MUTEX_INITIALIZER;
109	static volatile int scf_error_key_setup = 0;
110
111	if (scf_error_key_setup == 0) {
112		(void) pthread_mutex_lock(&scf_key_lock);
113		if (scf_error_key_setup == 0) {
114			if (pthread_key_create(&scf_error_key, NULL) == 0)
115				scf_error_key_setup = 1;
116		}
117		(void) pthread_mutex_unlock(&scf_key_lock);
118	}
119
120	return (scf_error_key_setup == 1);
121}
122
123#endif	/* PTHREAD_ONCE_KEY_NP */
124
125int
126scf_set_error(scf_error_t code)
127{
128	assert(LOOKS_VALID(code));
129
130	if (scf_setup_error())
131		(void) pthread_setspecific(scf_error_key, (void *)code);
132	else
133		_scf_fallback_error = code;
134	return (-1);
135}
136
137scf_error_t
138scf_error(void)
139{
140	scf_error_t ret;
141
142	ret = (scf_error_t)pthread_getspecific(scf_error_key);
143	if (ret == 0)
144		return (_scf_fallback_error);
145	assert(LOOKS_VALID(ret));
146	return (ret);
147}
148
149const char *
150scf_strerror(scf_error_t code)
151{
152	struct scf_error_info *cur, *end;
153
154	cur = scf_errors;
155	end = cur + SCF_NUM_ERRORS;
156
157	for (; cur < end; cur++)
158		if (code == cur->ei_code)
159			return (dgettext(TEXT_DOMAIN, cur->ei_desc));
160
161	return (dgettext(TEXT_DOMAIN, "unknown error"));
162}
163
164const char *
165scf_get_msg(scf_msg_t msg)
166{
167	switch (msg) {
168	case SCF_MSG_ARGTOOLONG:
169		return (dgettext(TEXT_DOMAIN,
170		    "Argument '%s' is too long, ignoring\n"));
171
172	case SCF_MSG_PATTERN_NOINSTANCE:
173		return (dgettext(TEXT_DOMAIN,
174		    "Pattern '%s' doesn't match any instances\n"));
175
176	case SCF_MSG_PATTERN_NOINSTSVC:
177		return (dgettext(TEXT_DOMAIN,
178		    "Pattern '%s' doesn't match any instances or services\n"));
179
180	case SCF_MSG_PATTERN_NOSERVICE:
181		return (dgettext(TEXT_DOMAIN,
182		    "Pattern '%s' doesn't match any services\n"));
183
184	case SCF_MSG_PATTERN_NOENTITY:
185		return (dgettext(TEXT_DOMAIN,
186		    "Pattern '%s' doesn't match any entities\n"));
187
188	case SCF_MSG_PATTERN_MULTIMATCH:
189		return (dgettext(TEXT_DOMAIN,
190		    "Pattern '%s' matches multiple instances:\n"));
191
192	case SCF_MSG_PATTERN_POSSIBLE:
193		return (dgettext(TEXT_DOMAIN, "    %s\n"));
194
195	case SCF_MSG_PATTERN_LEGACY:
196		return (dgettext(TEXT_DOMAIN,
197		    "Operation not supported for legacy service '%s'\n"));
198
199	default:
200		abort();
201		/* NOTREACHED */
202	}
203
204}
205