4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/libcfs/user-prim.c
38 * Implementations of portable APIs for liblustre
40 * Author: Nikita Danilov <nikita@clusterfs.com>
44 * liblustre is single-threaded, so most "synchronization" APIs are trivial.
50 #include <libcfs/libcfs.h>
53 * Wait queue. No-op implementation.
56 void cfs_waitq_init(struct cfs_waitq *waitq)
58 LASSERT(waitq != NULL);
62 void cfs_waitlink_init(struct cfs_waitlink *link)
64 LASSERT(link != NULL);
68 void cfs_waitq_add(struct cfs_waitq *waitq, struct cfs_waitlink *link)
70 LASSERT(waitq != NULL);
71 LASSERT(link != NULL);
76 void cfs_waitq_add_exclusive(struct cfs_waitq *waitq, struct cfs_waitlink *link)
78 LASSERT(waitq != NULL);
79 LASSERT(link != NULL);
84 void cfs_waitq_add_exclusive_head(struct cfs_waitq *waitq, struct cfs_waitlink *link)
86 cfs_waitq_add_exclusive(waitq, link);
89 void cfs_waitq_del(struct cfs_waitq *waitq, struct cfs_waitlink *link)
91 LASSERT(waitq != NULL);
92 LASSERT(link != NULL);
97 int cfs_waitq_active(struct cfs_waitq *waitq)
99 LASSERT(waitq != NULL);
104 void cfs_waitq_signal(struct cfs_waitq *waitq)
106 LASSERT(waitq != NULL);
110 void cfs_waitq_signal_nr(struct cfs_waitq *waitq, int nr)
112 LASSERT(waitq != NULL);
116 void cfs_waitq_broadcast(struct cfs_waitq *waitq)
118 LASSERT(waitq != NULL);
122 void cfs_waitq_wait(struct cfs_waitlink *link, cfs_task_state_t state)
124 LASSERT(link != NULL);
127 /* well, wait for something to happen */
128 call_wait_handler(0);
131 int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, cfs_task_state_t state,
134 LASSERT(link != NULL);
136 call_wait_handler(timeout);
140 void cfs_schedule_timeout_and_set_state(cfs_task_state_t state, int64_t timeout)
143 /* sleep(timeout) here instead? */
144 cfs_waitq_timedwait(&l, state, timeout);
148 cfs_pause(cfs_duration_t d)
152 cfs_duration_nsec(d, &s);
156 int cfs_need_resched(void)
161 void cfs_cond_resched(void)
169 void cfs_init_timer(cfs_timer_t *t)
171 CFS_INIT_LIST_HEAD(&t->tl_list);
174 void cfs_timer_init(cfs_timer_t *l, cfs_timer_func_t *func, void *arg)
176 CFS_INIT_LIST_HEAD(&l->tl_list);
178 l->data = (ulong_ptr_t)arg;
182 int cfs_timer_is_armed(cfs_timer_t *l)
184 if (cfs_time_before(cfs_time_current(), l->expires))
190 void cfs_timer_arm(cfs_timer_t *l, cfs_time_t deadline)
192 l->expires = deadline;
195 void cfs_timer_disarm(cfs_timer_t *l)
198 cfs_time_t cfs_timer_deadline(cfs_timer_t *l)
204 #ifdef HAVE_LIBPTHREAD
210 struct lustre_thread_arg {
214 static void *cfs_thread_helper(void *data)
216 struct lustre_thread_arg *targ = data;
217 cfs_thread_t f = targ->f;
218 void *arg = targ->arg;
226 int cfs_create_thread(cfs_thread_t func, void *arg, unsigned long flags)
229 pthread_attr_t tattr;
231 struct lustre_thread_arg *targ_p = malloc(sizeof(struct lustre_thread_arg));
233 if ( targ_p == NULL )
239 pthread_attr_init(&tattr);
240 pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
241 rc = pthread_create(&tid, &tattr, cfs_thread_helper, targ_p);
242 pthread_attr_destroy(&tattr);
247 uid_t cfs_curproc_uid(void)
252 gid_t cfs_curproc_gid(void)
257 uid_t cfs_curproc_fsuid(void)
262 gid_t cfs_curproc_fsgid(void)
267 #ifndef HAVE_STRLCPY /* not in glibc for RHEL 5.x, remove when obsolete */
268 size_t strlcpy(char *tgt, const char *src, size_t tgt_len)
270 int src_len = strlen(src);
272 strncpy(tgt, src, tgt_len - 1);
273 tgt[tgt_len - 1] = '\0';
279 #ifndef HAVE_STRLCAT /* not in glibc for RHEL 5.x, remove when obsolete */
280 size_t strlcat(char *tgt, const char *src, size_t size)
282 size_t tgt_len = strlen(tgt);
284 if (size > tgt_len) {
285 strncat(tgt, src, size - tgt_len - 1);
286 tgt[size - 1] = '\0';
289 return tgt_len + strlen(src);
293 /* Read the environment variable of current process specified by @key. */
294 int cfs_get_environ(const char *key, char *value, int *val_len)
303 len = strlcpy(value, entry, *val_len);
310 void cfs_enter_debugger(void)
317 void cfs_daemonize(char *str)
322 int cfs_daemonize_ctxt(char *str)
327 cfs_sigset_t cfs_block_allsigs(void)
334 rc = sigprocmask(SIG_BLOCK, &all, &old);
340 cfs_sigset_t cfs_block_sigs(unsigned long sigs)
343 cfs_sigset_t blocks = { { sigs } }; /* kludge */
346 rc = sigprocmask(SIG_BLOCK, &blocks, &old);
352 /* Block all signals except for the @sigs. It's only used in
353 * Linux kernel, just a dummy here. */
354 cfs_sigset_t cfs_block_sigsinv(unsigned long sigs)
359 /* Return old blocked sigs */
360 rc = sigprocmask(SIG_SETMASK, NULL, &old);
366 void cfs_restore_sigs(cfs_sigset_t old)
368 int rc = sigprocmask(SIG_SETMASK, &old, NULL);
373 int cfs_signal_pending(void)
379 rc = sigpending(&set);
384 return !memcmp(&empty, &set, sizeof(set));
387 void cfs_clear_sigpending(void)
395 * In glibc (NOT in Linux, so check above is not right), implement
396 * stack-back-tracing through backtrace() function.
398 #include <execinfo.h>
400 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
402 backtrace(trace->frame, ARRAY_SIZE(trace->frame));
405 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
407 if (0 <= frame_no && frame_no < ARRAY_SIZE(trace->frame))
408 return trace->frame[frame_no];
415 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
417 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
425 void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
427 /* No libcfs_catastrophe in userspace! */
428 libcfs_debug_msg(msgdata, "LBUG\n");
437 * c-indentation-style: "K&R"