xref: /minix3/lib/libc/sys/sa_register.2 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1.\"     $NetBSD: sa_register.2,v 1.2 2004/03/14 10:19:59 snj Exp $
2.\"
3.\" Copyright (c)2004 YAMAMOTO Takashi,
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" ------------------------------------------------------------
28.Dd March 14, 2004
29.Dt SA_REGISTER 2
30.Os
31.Sh NAME
32.Nm sa_register
33.Nd register a scheduler activation upcall handler
34.\" ------------------------------------------------------------
35.Sh LIBRARY
36.Lb libc
37.\" ------------------------------------------------------------
38.Sh SYNOPSIS
39.In sa.h
40.Ft int
41.Fn sa_register \
42    "sa_upcall_t new" \
43    "sa_upcall_t *old" \
44    "int flags" \
45    "ssize_t stackinfo_offset"
46.\" ------------------------------------------------------------
47.Sh DESCRIPTION
48.Nm
49is used to prepare scheduler activation.
50It registers the upcall handler specified by
51.Fa new .
52If
53.Fa old
54isn't
55.Dv NULL ,
56the previous handler will be returned to the location pointed by it.
57If
58.Dv SA_FLAG_STACKINFO
59is specified in
60.Fa flags ,
61.Fa stackinfo_offset
62is used to locate per upcall stack memory areas shared between
63userland and kernel.
64.Fa stackinfo_offset
65is a byte offset from the corresponding upcall stack.
66.\" ------------------------------------------------------------
67.Sh RETURN VALUES
68.Fn sa_register
69returns zero on success.
70Otherwise, a value of \-1 is returned and
71.Va errno
72is set to indicate the error.
73.\" ------------------------------------------------------------
74.Sh SEE ALSO
75.Xr pthread 3
76