nislib.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:12k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* Copyright (C) 1997, 1998, 1999 Free Software Foundation, Inc.
  2.    This file is part of the GNU C Library.
  3.    Contributed by Thorsten Kukuk <kukuk@suse.de>, 1997.
  4.    The GNU C Library is free software; you can redistribute it and/or
  5.    modify it under the terms of the GNU Lesser General Public
  6.    License as published by the Free Software Foundation; either
  7.    version 2.1 of the License, or (at your option) any later version.
  8.    The GNU C Library is distributed in the hope that it will be useful,
  9.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.    Lesser General Public License for more details.
  12.    You should have received a copy of the GNU Lesser General Public
  13.    License along with the GNU C Library; if not, write to the Free
  14.    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  15.    02111-1307 USA.  */
  16. #ifndef __RPCSVC_NISLIB_H__
  17. #define __RPCSVC_NISLIB_H__
  18. #include <features.h>
  19. __BEGIN_DECLS
  20. typedef const char *const_nis_name;
  21. /* nis_names: These functions are used to locate and manipulate all NIS+
  22.  * objects except the NIS+ entry objects.
  23.  *
  24.  * nis_lookup (name, flags) resolves a NIS+ name and returns a copy of
  25.  *                          that object  from a NIS+ server.
  26.  *    const nis_name name: name of the object to be resolved
  27.  *    unsigned int flags: logically ORing zero or more flags (FOLLOW_LINKS,
  28.  *                          HARD_LOOKUP, [NO_CACHE], MASTER_ONLY, EXPAND_NAME)
  29.  *
  30.  * nis_add (name, obj) adds objects to the NIS+ namespace.
  31.  *    const nis_name name: fully qualified NIS+ name.
  32.  *    const nis_object *obj: object members zo_name and zo_domain will be
  33.  *                           constructed from name.
  34.  *
  35.  * nis_remove (name, obj) removes objects from the NIS+ namespace.
  36.  *    const nis_name name: fully qualified NIS+ name.
  37.  *    const nis_object *obj: if not NULL, it is assumed to point to a copy
  38.  *                           of the object being removed. In this case, if
  39.  *                           the object on the server does not have the same
  40.  *                           object identifier as the  object  being  passed,
  41.  *                           the operation will fail with the NIS_NOTSAMEOBJ
  42.  *                           error.
  43.  *
  44.  * nis_modify (name, obj) can change specific attributes of an object
  45.  *                        that already exists in the namespace.
  46.  */
  47. extern nis_result *nis_lookup (const_nis_name name, unsigned int flags)
  48.      __THROW;
  49. extern nis_result *nis_add (const_nis_name name, const nis_object *obj)
  50.      __THROW;
  51. extern nis_result *nis_remove (const_nis_name name,
  52.        const nis_object *obj) __THROW;
  53. extern nis_result *nis_modify (const_nis_name name,
  54.        const nis_object *obj) __THROW;
  55. /* nis_tables: These functions are used to search and modify NIS+ tables.
  56.  *
  57.  * nis_list (table_name, flags, callback(table_name, obj, userdata), userdata)
  58.  *           search a table in the NIS+ namespace.
  59.  *    const nis_name table_name: indexed name ([xx=yy],table.dir)
  60.  *    unsigned int flags: logically ORing one or more flags (FOLLOW_LINKS,
  61.  *                      [FOLLOW_PATH], HARD_LOOKUP, [ALL_RESULTS], [NO_CACHE],
  62.  *                      MASTER_ONLY, EXPAND_NAME, RETURN_RESULT)
  63.  *    callback(): callback is an optional pointer to a function that will
  64.  *                process the ENTRY type objects that are returned from the
  65.  *                search. If this pointer is NULL, then all entries that match
  66.  *                the search criteria are returned in the nis_result structure,
  67.  *                otherwise  this  function  will  be  called once for each
  68.  *                entry returned.
  69.  *    void *userdata: passed to callback function along with the returned
  70.  *                    entry object.
  71.  *
  72.  * nis_add_entry (table_name, obj, flags) will add the NIS+ object to the
  73.  *                                        NIS+ table_name.
  74.  *    const nis_name table_name
  75.  *    const nis_object *obj
  76.  *    unsigned int flags: 0, ADD_OVERWRITE, RETURN_RESULT
  77.  *
  78.  * nis_modify_entry (name, obj, flags) modifies an object identified by name.
  79.  *    const nis_name name: object identifier
  80.  *    const nis_object *obj: should point to an entry with the EN_MODIFIED
  81.  *                           flag set in each column that contains new
  82.  *                           information.
  83.  *    unsigned int flags: 0, MOD_SAMEOBJ, RETURN_RESULT
  84.  *
  85.  * nis_remove_entry (table_name, obj, flags) removes a set of entries
  86.  *                                 identified by table_name from the table.
  87.  *    const nis_name table_name: indexed NIS+ name
  88.  *    const nis_object *obj: if obj is non-null, it is presumed to point to
  89.  *                           a cached copy of the entry. When the removal is
  90.  *                           attempted, and the object that would be removed
  91.  *                           is not the same as the cached object pointed to
  92.  *                           by object then the operation will fail with an
  93.  *                           NIS_NOTSAMEOBJ error
  94.  *    unsigned int flags: 0, REM_MULTIPLE
  95.  *
  96.  * nis_first_entry (table_name) fetches entries from a table one at a time.
  97.  *    const nis_name table_name
  98.  *
  99.  * nis_next_entry (table_name, cookie) retrieves the "next" entry from a
  100.  *                                     table specified by table_name.
  101.  *    const nis_name table_name:
  102.  *    const netobj *cookie: The value of cookie from the nis_result structure
  103.  *                          form the previous call.
  104.  */
  105. extern nis_result *nis_list (const_nis_name name, unsigned int flags,
  106.      int (*callback)(const_nis_name table_name,
  107.      const nis_object *obj,
  108.      const void *userdata),
  109.      const void *userdata) __THROW;
  110. extern nis_result *nis_add_entry (const_nis_name table_name,
  111.   const nis_object *obj,
  112.   unsigned int flags) __THROW;
  113. extern nis_result *nis_modify_entry (const_nis_name name,
  114.      const nis_object *obj,
  115.      unsigned int flags) __THROW;
  116. extern nis_result *nis_remove_entry (const_nis_name table_name,
  117.      const nis_object *obj,
  118.      unsigned int flags) __THROW;
  119. extern nis_result *nis_first_entry (const_nis_name table_name) __THROW;
  120. extern nis_result *nis_next_entry (const_nis_name table_name,
  121.    const netobj *cookie) __THROW;
  122. /*
  123. ** nis_server
  124. */
  125. extern nis_error nis_mkdir (const_nis_name dirname,
  126.     const nis_server *machine) __THROW;
  127. extern nis_error nis_rmdir (const_nis_name dirname,
  128.     const nis_server *machine) __THROW;
  129. extern nis_error nis_servstate (const nis_server *machine,
  130. const nis_tag *tags, int numtags,
  131. nis_tag **result) __THROW;
  132. extern nis_error nis_stats (const nis_server *machine,
  133.     const nis_tag *tags, int numtags,
  134.     nis_tag **result) __THROW;
  135. extern void nis_freetags (nis_tag *tags, int numtags) __THROW;
  136. extern nis_server **nis_getservlist (const_nis_name dirname) __THROW;
  137. extern void nis_freeservlist (nis_server **machines) __THROW;
  138. /*
  139. ** nis_subr
  140. */
  141. extern nis_name nis_leaf_of (const_nis_name name) __THROW;
  142. extern nis_name nis_leaf_of_r (const_nis_name name, char *buffer,
  143.        size_t buflen) __THROW;
  144. extern nis_name nis_name_of (const_nis_name name) __THROW;
  145. extern nis_name nis_name_of_r (const_nis_name name, char *buffer,
  146.        size_t buflen) __THROW;
  147. extern nis_name nis_domain_of (const_nis_name name) __THROW;
  148. extern nis_name nis_domain_of_r (const_nis_name name, char *buffer,
  149.  size_t buflen) __THROW;
  150. extern nis_name *nis_getnames (const_nis_name name) __THROW;
  151. extern void nis_freenames (nis_name *namelist) __THROW;
  152. extern name_pos nis_dir_cmp (const_nis_name n1, const_nis_name n2) __THROW;
  153. extern nis_object *nis_clone_object (const nis_object *src,
  154.      nis_object *dest) __THROW;
  155. extern void nis_destroy_object (nis_object *obj) __THROW;
  156. extern void nis_print_object (const nis_object *obj) __THROW;
  157. /*
  158. ** nis_local_names
  159. */
  160. extern nis_name nis_local_group (void) __THROW;
  161. extern nis_name nis_local_directory (void) __THROW;
  162. extern nis_name nis_local_principal (void) __THROW;
  163. extern nis_name nis_local_host (void) __THROW;
  164. /*
  165. ** nis_error
  166. */
  167. extern const char *nis_sperrno (const nis_error status) __THROW;
  168. extern void nis_perror (const nis_error status, const char *label) __THROW;
  169. extern void nis_lerror (const nis_error status, const char *label) __THROW;
  170. extern char *nis_sperror (const nis_error status, const char *label) __THROW;
  171. extern char *nis_sperror_r (const nis_error status, const char *label,
  172.     char *buffer, size_t buflen) __THROW;
  173. /*
  174. ** nis_groups
  175. */
  176. extern bool_t nis_ismember (const_nis_name principal,
  177.     const_nis_name group) __THROW;
  178. extern nis_error nis_addmember (const_nis_name member,
  179. const_nis_name group) __THROW;
  180. extern nis_error nis_removemember (const_nis_name member,
  181.    const_nis_name group) __THROW;
  182. extern nis_error nis_creategroup (const_nis_name group,
  183.   unsigned int flags) __THROW;
  184. extern nis_error nis_destroygroup (const_nis_name group) __THROW;
  185. extern void nis_print_group_entry (const_nis_name group) __THROW;
  186. extern nis_error nis_verifygroup (const_nis_name group) __THROW;
  187. /*
  188. ** nis_ping
  189. */
  190. extern void nis_ping (const_nis_name dirname, uint32_t utime,
  191.       const nis_object *dirobj) __THROW;
  192. extern nis_result *nis_checkpoint (const_nis_name dirname) __THROW;
  193. /*
  194. ** nis_print (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
  195. */
  196. extern void nis_print_result (const nis_result *result) __THROW;
  197. extern void nis_print_rights (unsigned int rights) __THROW;
  198. extern void nis_print_directory (const directory_obj *dirobj) __THROW;
  199. extern void nis_print_group (const group_obj *grpobj) __THROW;
  200. extern void nis_print_table (const table_obj *tblobj) __THROW;
  201. extern void nis_print_link (const link_obj *lnkobj) __THROW;
  202. extern void nis_print_entry (const entry_obj *enobj) __THROW;
  203. /*
  204. ** nis_file (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
  205. */
  206. extern directory_obj *readColdStartFile (void) __THROW;
  207. extern bool_t writeColdStartFile (const directory_obj *dirobj) __THROW;
  208. extern nis_object *nis_read_obj (const char *obj) __THROW;
  209. extern bool_t nis_write_obj (const char *file, const nis_object *obj) __THROW;
  210. /*
  211. ** nis_clone - (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
  212. */
  213. extern directory_obj *nis_clone_directory (const directory_obj *src,
  214.    directory_obj *dest) __THROW;
  215. extern nis_result *nis_clone_result (const nis_result *src,
  216.      nis_result *dest) __THROW;
  217. /* nis_free - nis_freeresult */
  218. extern void nis_freeresult (nis_result *result) __THROW;
  219. /* (XXX THE FOLLOWING ARE INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
  220. extern void nis_free_request (ib_request *req) __THROW;
  221. extern void nis_free_directory (directory_obj *dirobj) __THROW;
  222. extern void nis_free_object (nis_object *obj) __THROW;
  223. /* (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
  224. extern nis_name __nis_default_owner (char *) __THROW;
  225. extern nis_name __nis_default_group (char *) __THROW;
  226. extern uint32_t __nis_default_ttl (char *) __THROW;
  227. extern unsigned int __nis_default_access (char *, unsigned int) __THROW;
  228. extern fd_result *__nis_finddirectory (directory_obj *, const_nis_name) __THROW;
  229. extern void __free_fdresult (fd_result *) __THROW;
  230. extern uint32_t __nis_hash (const void *keyarg, register size_t len) __THROW;
  231. /* NIS+ cache locking */
  232. extern int __nis_lock_cache (void) __THROW;
  233. extern int __nis_unlock_cache (void) __THROW;
  234. /* (XXX INTERNAL FUNCTIONS, ONLY FOR rpc.nisd AND glibc !!) */
  235. #if defined (NIS_INTERNAL) || defined (_LIBC)
  236. struct dir_binding
  237. {
  238.   CLIENT *clnt;                  /* RPC CLIENT handle */
  239.   nis_server *server_val;        /* List of servers */
  240.   unsigned int server_len;       /* # of servers */
  241.   unsigned int server_used;      /* Which server we are bind in the moment ? */
  242.   unsigned int current_ep;       /* Which endpoint of the server are in use? */
  243.   unsigned int trys;             /* How many server have we tried ? */
  244.   unsigned int class;            /* From which class is server_val ? */
  245.   bool_t master_only;            /* Is only binded to the master */
  246.   bool_t use_auth;               /* Do we use AUTH ? */
  247.   bool_t use_udp;                /* Do we use UDP ? */
  248.   struct sockaddr_in addr;       /* Server's IP address */
  249.   int socket;                    /* Server's local socket */
  250. };
  251. typedef struct dir_binding dir_binding;
  252. extern nis_error __nisbind_create (dir_binding *, const nis_server *,
  253.    unsigned int, unsigned int) __THROW;
  254. extern nis_error __nisbind_connect (dir_binding *) __THROW;
  255. extern nis_error __nisbind_next (dir_binding *) __THROW;
  256. extern void __nisbind_destroy (dir_binding *) __THROW;
  257. extern nis_error __nisfind_server (const_nis_name, directory_obj **) __THROW;
  258. #endif
  259. __END_DECLS
  260. #endif /* __RPCSVC_NISLIB_H__ */