1 /* 2 * Copyright (c) 2016-2017, Marie Helene Kvello-Aune 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * thislist of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation and/or 13 * other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 17 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 OR 21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #pragma once 30 31 #include "libifconfig.h" 32 33 34 struct errstate { 35 /** 36 * Type of error. 37 */ 38 ifconfig_errtype errtype; 39 40 /** 41 * The error occured in this ioctl() request. 42 * Populated if errtype = IOCTL 43 */ 44 unsigned long ioctl_request; 45 46 /** 47 * The value of the global errno variable when the error occured. 48 */ 49 int errcode; 50 }; 51 52 struct ifconfig_handle { 53 struct errstate error; 54 int sockets[AF_MAX + 1]; 55 /** Cached output of getifaddrs */ 56 struct ifaddrs *ifap; 57 }; 58 59 /* Fetch the list of interface addrs, if it hasn't already been fetched */ 60 int ifconfig_getifaddrs(ifconfig_handle_t *h); 61 62 /** 63 * Retrieves socket for address family <paramref name="addressfamily"> from 64 * cache, or creates it if it doesn't already exist. 65 * @param addressfamily The address family of the socket to retrieve 66 * @param s The retrieved socket. 67 * @return 0 on success, -1 on failure. 68 * {@example 69 * This example shows how to retrieve a socket from the cache. 70 * {@code 71 * static void myfunc() \{ 72 * int s; 73 * if (ifconfig_socket(AF_LOCAL, &s) != 0) \{ 74 * // Handle error state here 75 * \} 76 * // user code here 77 * \} 78 * } 79 * } 80 */ 81 int ifconfig_socket(ifconfig_handle_t *h, const int addressfamily, int *s); 82 83 /** Function to wrap ioctl() and automatically populate ifconfig_errstate when appropriate.*/ 84 int ifconfig_ioctlwrap(ifconfig_handle_t *h, const int addressfamily, 85 unsigned long request, void *data); 86