Whamcloud - gitweb
merge with HEAD.
[fs/lustre-release.git] / libcfs / libcfs / user-prim.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * libcfs/libcfs/user-prim.c
37  *
38  * Implementations of portable APIs for liblustre
39  *
40  * Author: Nikita Danilov <nikita@clusterfs.com>
41  */
42
43 /*
44  * liblustre is single-threaded, so most "synchronization" APIs are trivial.
45  */
46
47 #ifndef __KERNEL__
48
49 #include <libcfs/libcfs.h>
50
51 /*
52  * Wait queue. No-op implementation.
53  */
54
55 void cfs_waitq_init(struct cfs_waitq *waitq)
56 {
57         LASSERT(waitq != NULL);
58         (void)waitq;
59 }
60
61 void cfs_waitlink_init(struct cfs_waitlink *link)
62 {
63         LASSERT(link != NULL);
64         (void)link;
65 }
66
67 void cfs_waitq_add(struct cfs_waitq *waitq, struct cfs_waitlink *link)
68 {
69         LASSERT(waitq != NULL);
70         LASSERT(link != NULL);
71         (void)waitq;
72         (void)link;
73 }
74
75 void cfs_waitq_add_exclusive(struct cfs_waitq *waitq, struct cfs_waitlink *link)
76 {
77         LASSERT(waitq != NULL);
78         LASSERT(link != NULL);
79         (void)waitq;
80         (void)link;
81 }
82
83 void cfs_waitq_del(struct cfs_waitq *waitq, struct cfs_waitlink *link)
84 {
85         LASSERT(waitq != NULL);
86         LASSERT(link != NULL);
87         (void)waitq;
88         (void)link;
89 }
90
91 int cfs_waitq_active(struct cfs_waitq *waitq)
92 {
93         LASSERT(waitq != NULL);
94         (void)waitq;
95         return 0;
96 }
97
98 void cfs_waitq_signal(struct cfs_waitq *waitq)
99 {
100         LASSERT(waitq != NULL);
101         (void)waitq;
102 }
103
104 void cfs_waitq_signal_nr(struct cfs_waitq *waitq, int nr)
105 {
106         LASSERT(waitq != NULL);
107         (void)waitq;
108 }
109
110 void cfs_waitq_broadcast(struct cfs_waitq *waitq)
111 {
112         LASSERT(waitq != NULL);
113         (void)waitq;
114 }
115
116 void cfs_waitq_wait(struct cfs_waitlink *link, cfs_task_state_t state)
117 {
118         LASSERT(link != NULL);
119         (void)link;
120 }
121
122 int64_t cfs_waitq_timedwait(struct cfs_waitlink *link, cfs_task_state_t state,
123                             int64_t timeout)
124 {
125         LASSERT(link != NULL);
126         (void)link;
127         return 0;
128 }
129
130 void cfs_schedule_timeout(cfs_task_state_t state, int64_t timeout)
131 {
132         cfs_waitlink_t    l;
133         /* sleep(timeout) here instead? */
134         cfs_waitq_timedwait(&l, state, timeout);
135 }
136
137 void
138 cfs_pause(cfs_duration_t d)
139 {
140         struct timespec s;
141
142         cfs_duration_nsec(d, &s);
143         nanosleep(&s, NULL);
144 }
145
146 int cfs_need_resched(void)
147 {
148         return 0;
149 }
150
151 void cfs_cond_resched(void)
152 {
153 }
154
155 /*
156  * Timer
157  */
158
159 void cfs_init_timer(cfs_timer_t *t)
160 {
161         CFS_INIT_LIST_HEAD(&t->tl_list);
162 }
163
164 void cfs_timer_init(cfs_timer_t *l, cfs_timer_func_t *func, void *arg)
165 {
166         CFS_INIT_LIST_HEAD(&l->tl_list);
167         l->function = func;
168         l->data = (ulong_ptr_t)arg;
169         return;
170 }
171
172 int cfs_timer_is_armed(cfs_timer_t *l)
173 {
174         if (cfs_time_before(cfs_time_current(), l->expires))
175                 return 1;
176         else
177                 return 0;
178 }
179
180 void cfs_timer_arm(cfs_timer_t *l, cfs_time_t deadline)
181 {
182         l->expires = deadline;
183 }
184
185 void cfs_timer_disarm(cfs_timer_t *l)
186 {
187 }
188 cfs_time_t cfs_timer_deadline(cfs_timer_t *l)
189 {
190         return l->expires;
191 }
192
193
194 #ifdef HAVE_LIBPTHREAD
195
196 /*
197  * Threads
198  */
199
200 struct lustre_thread_arg {
201         cfs_thread_t f;
202         void *arg;
203 };
204 static void *cfs_thread_helper(void *data)
205 {
206         struct lustre_thread_arg *targ = data;
207         cfs_thread_t f  = targ->f;
208         void *arg = targ->arg;
209
210         free(targ);
211
212         (void)f(arg);
213         return NULL;
214 }
215 int cfs_create_thread(cfs_thread_t func, void *arg)
216 {
217         pthread_t tid;
218         pthread_attr_t tattr;
219         int rc;
220         struct lustre_thread_arg *targ_p = malloc(sizeof(struct lustre_thread_arg));
221
222         if ( targ_p == NULL )
223                 return -ENOMEM;
224
225         targ_p->f = func;
226         targ_p->arg = arg;
227
228         pthread_attr_init(&tattr);
229         pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
230         rc = pthread_create(&tid, &tattr, cfs_thread_helper, targ_p);
231         pthread_attr_destroy(&tattr);
232         return -rc;
233 }
234 #endif
235
236 uid_t cfs_curproc_uid(void)
237 {
238         return getuid();
239 }
240
241 int cfs_parse_int_tunable(int *value, char *name)
242 {
243         char    *env = getenv(name);
244         char    *end;
245
246         if (env == NULL)
247                 return 0;
248
249         *value = (int)strtoull(env, &end, 0);
250         if (*end == 0)
251                 return 0;
252
253         CERROR("Can't parse tunable %s=%s\n", name, env);
254         return -EINVAL;
255 }
256
257
258 void cfs_enter_debugger(void)
259 {
260         /*
261          * nothing for now.
262          */
263 }
264
265 void cfs_daemonize(char *str)
266 {
267         return;
268 }
269
270 int cfs_daemonize_ctxt(char *str)
271 {
272         return 0;
273 }
274
275 cfs_sigset_t cfs_block_allsigs(void)
276 {
277         cfs_sigset_t   all;
278         cfs_sigset_t   old;
279         int            rc;
280
281         sigfillset(&all);
282         rc = sigprocmask(SIG_SETMASK, &all, &old);
283         LASSERT(rc == 0);
284
285         return old;
286 }
287
288 cfs_sigset_t cfs_block_sigs(cfs_sigset_t blocks)
289 {
290         cfs_sigset_t   old;
291         int   rc;
292
293         rc = sigprocmask(SIG_SETMASK, &blocks, &old);
294         LASSERT (rc == 0);
295
296         return old;
297 }
298
299 void cfs_restore_sigs(cfs_sigset_t old)
300 {
301         int   rc = sigprocmask(SIG_SETMASK, &old, NULL);
302
303         LASSERT (rc == 0);
304 }
305
306 int cfs_signal_pending(void)
307 {
308         cfs_sigset_t    empty;
309         cfs_sigset_t    set;
310         int  rc;
311
312         rc = sigpending(&set);
313         LASSERT (rc == 0);
314
315         sigemptyset(&empty);
316
317         return !memcmp(&empty, &set, sizeof(set));
318 }
319
320 void cfs_clear_sigpending(void)
321 {
322         return;
323 }
324
325 #ifdef __linux__
326
327 /*
328  * In glibc (NOT in Linux, so check above is not right), implement
329  * stack-back-tracing through backtrace() function.
330  */
331 #include <execinfo.h>
332
333 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
334 {
335         backtrace(trace->frame, ARRAY_SIZE(trace->frame));
336 }
337
338 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
339 {
340         if (0 <= frame_no && frame_no < ARRAY_SIZE(trace->frame))
341                 return trace->frame[frame_no];
342         else
343                 return NULL;
344 }
345
346 #else
347
348 void cfs_stack_trace_fill(struct cfs_stack_trace *trace)
349 {}
350 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no)
351 {
352         return NULL;
353 }
354
355 /* __linux__ */
356 #endif
357
358 void lbug_with_loc(const char *file, const char *func, const int line)
359 {
360         /* No libcfs_catastrophe in userspace! */
361         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line, "LBUG\n");
362         abort();
363 }
364
365 /* !__KERNEL__ */
366 #endif
367
368 /*
369  * Local variables:
370  * c-indentation-style: "K&R"
371  * c-basic-offset: 8
372  * tab-width: 8
373  * fill-column: 80
374  * scroll-step: 1
375  * End:
376  */