lib/libpuffs/puffs_cc.3

   1 .\"     $NetBSD: puffs_cc.3,v 1.11 2008/01/28 18:35:50 pooka Exp $
   2 .\"
   3 .\" Copyright (c) 2007, 2008 Antti Kantee.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd January 28, 2008
  27 .Dt PUFFS_CC 3
  28 .Os
  29 .Sh NAME
  30 .Nm puffs_cc
  31 .Nd puffs continuation routines
  32 .Sh LIBRARY
  33 .Lb libpuffs
  34 .Sh SYNOPSIS
  35 .In puffs.h
  36 .Ft void
  37 .Fn puffs_cc_yield "struct puffs_cc *pcc"
  38 .Ft void
  39 .Fn puffs_cc_continue "struct puffs_cc *pcc"
  40 .Ft void
  41 .Fn puffs_cc_schedule "struct puffs_cc *pcc"
  42 .Ft struct puffs_cc *
  43 .Fn puffs_cc_getcc "struct puffs_usermount *pu"
  44 .Sh DESCRIPTION
  45 .Em IMPORTANT NOTE!
  46 This document describes interfaces which are not yet guaranteed to be
  47 stable.
  48 In case you update your system sources, please recompile everything
  49 and fix compilation errors.
  50 If your sources are out-of-sync, incorrect operation may result.
  51 The interfaces in this document will most likely be hugely simplified
  52 in later versions or made transparent to the implementation.
  53 .Pp
  54 These routines are used for the cooperative multitasking suite present
  55 in puffs.
  56 .Pp
  57 .Bl -tag -width xxxx
  58 .It Fn puffs_cc_yield "pcc"
  59 Suspend and save the current execution context and return control
  60 to the previous point.
  61 In practice, from the file system author perspective, control returns
  62 back to where either the mainloop or where
  63 .Fn puffs_dispatch_exec
  64 was called from.
  65 .It Fn puffs_cc_continue pcc
  66 Will suspend current execution and return control to where it was
  67 before before calling
  68 .Fn puffs_cc_yield .
  69 This is rarely called directly but rather through
  70 .Fn puffs_dispatch_exec .
  71 .It Fn puffs_cc_schedule "pcc"
  72 Schedule a continuation.
  73 As opposed to
  74 .Fn puffs_cc_continue
  75 this call returns immediately.
  76 .Fa pcc
  77 will be scheduled sometime in the future.
  78 .It Fn puffs_cc_getcc "pu"
  79 Returns the current pcc or
  80 .Dv NULL
  81 if this is the main thread.
  82 .Em NOTE :
  83 The argument
  84 .Ar pu
  85 will most likely disappear at some point.
  86 .El
  87 .Pp
  88 Before calling
  89 .Fn puffs_cc_yield
  90 a file system will typically want to record some cookie value into its
  91 own internal bookkeeping.
  92 This cookie should be hooked to the
  93 .Va pcc
  94 so that the correct continuation can be continued when the event it
  95 was waiting for triggers.  Alternatively, the
  96 .Xr puffs_framebuf 3
  97 framework and
  98 .Fn puffs_mainloop
  99 can be used for handling this automatically.
 100 .Sh SEE ALSO
 101 .Xr puffs 3 ,
 102 .Xr puffs_framebuf 3