<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libnl: lib/object.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnl <span id="projectnumber">1.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>lib/object.c</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * lib/object.c Generic Cacheable Object</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * of the License.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch></span>
<a name="l00010"></a>00010 <span class="comment"> */</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment">/**</span>
<a name="l00013"></a>00013 <span class="comment"> * @ingroup cache</span>
<a name="l00014"></a>00014 <span class="comment"> * @defgroup object Object</span>
<a name="l00015"></a>00015 <span class="comment"> * @{</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#include <netlink-local.h></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <netlink/netlink.h></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <netlink/cache.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <netlink/object.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <netlink/utils.h></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *obj_ops(<span class="keyword">struct</span> nl_object *obj)
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 <span class="keywordflow">if</span> (!obj->ce_ops)
<a name="l00027"></a>00027 BUG();
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keywordflow">return</span> obj->ce_ops;
<a name="l00030"></a>00030 }
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/**</span>
<a name="l00033"></a>00033 <span class="comment"> * @name Object Creation/Deletion</span>
<a name="l00034"></a>00034 <span class="comment"> * @{</span>
<a name="l00035"></a>00035 <span class="comment"> */</span>
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/**</span>
<a name="l00038"></a>00038 <span class="comment"> * Allocate a new object of kind specified by the operations handle</span>
<a name="l00039"></a>00039 <span class="comment"> * @arg ops cache operations handle</span>
<a name="l00040"></a>00040 <span class="comment"> * @return The new object or NULL</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a><a class="code" href="group__object.html#ga9c1f2fd887d8325839f452879cdf982a">00042</a> <span class="keyword">struct </span>nl_object *<a class="code" href="group__object.html#ga9c1f2fd887d8325839f452879cdf982a" title="Allocate a new object of kind specified by the operations handle.">nl_object_alloc</a>(<span class="keyword">struct</span> <a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops)
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">struct </span>nl_object *<span class="keyword">new</span>;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#a0fbd42c77db2f0488b8cd72858ece719" title="Size of object including its header.">oo_size</a> < <span class="keyword">sizeof</span>(*<span class="keyword">new</span>))
<a name="l00047"></a>00047 BUG();
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">new</span> = calloc(1, ops-><a class="code" href="structnl__object__ops.html#a0fbd42c77db2f0488b8cd72858ece719" title="Size of object including its header.">oo_size</a>);
<a name="l00050"></a>00050 <span class="keywordflow">if</span> (!<span class="keyword">new</span>) {
<a name="l00051"></a>00051 nl_errno(ENOMEM);
<a name="l00052"></a>00052 <span class="keywordflow">return</span> NULL;
<a name="l00053"></a>00053 }
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">new</span>->ce_refcnt = 1;
<a name="l00056"></a>00056 nl_init_list_head(&new->ce_list);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">new</span>->ce_ops = ops;
<a name="l00059"></a>00059 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#ac15b64a03806850db9493bd2fbfb64b7" title="Constructor function.">oo_constructor</a>)
<a name="l00060"></a>00060 ops-><a class="code" href="structnl__object__ops.html#ac15b64a03806850db9493bd2fbfb64b7" title="Constructor function.">oo_constructor</a>(<span class="keyword">new</span>);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 NL_DBG(4, <span class="stringliteral">"Allocated new object %p\n"</span>, <span class="keyword">new</span>);
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keywordflow">return</span> <span class="keyword">new</span>;
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * Allocate a new object of kind specified by the name</span>
<a name="l00069"></a>00069 <span class="comment"> * @arg kind name of object type</span>
<a name="l00070"></a>00070 <span class="comment"> * @return The new object or nULL</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a><a class="code" href="group__object.html#ga5123af5fe83a3c0bdc5984fd4561b7b6">00072</a> <span class="keyword">struct </span>nl_object *<a class="code" href="group__object.html#ga5123af5fe83a3c0bdc5984fd4561b7b6" title="Allocate a new object of kind specified by the name.">nl_object_alloc_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *kind)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 <span class="keyword">struct </span><a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *ops;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 ops = <a class="code" href="group__cache__mngt.html#ga7657cf661e569b4b43842a82e409b5fd" title="Lookup the set cache operations of a certain cache type.">nl_cache_ops_lookup</a>(kind);
<a name="l00077"></a>00077 <span class="keywordflow">if</span> (!ops) {
<a name="l00078"></a>00078 nl_error(ENOENT, <span class="stringliteral">"Unable to lookup cache kind \"%s\""</span>, kind);
<a name="l00079"></a>00079 <span class="keywordflow">return</span> NULL;
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keywordflow">return</span> <a class="code" href="group__object.html#ga9c1f2fd887d8325839f452879cdf982a" title="Allocate a new object of kind specified by the operations handle.">nl_object_alloc</a>(ops->co_obj_ops);
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00085"></a><a class="code" href="structnl__derived__object.html">00085</a> <span class="keyword">struct </span><a class="code" href="structnl__derived__object.html">nl_derived_object</a> {
<a name="l00086"></a>00086 <a class="code" href="group__object__api.html#ga0f84d461252a52ed33e307432bd0b3f8" title="Common Object Header.">NLHDR_COMMON</a>
<a name="l00087"></a>00087 <span class="keywordtype">char</span> data;
<a name="l00088"></a>00088 };
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/**</span>
<a name="l00091"></a>00091 <span class="comment"> * Allocate a new object and copy all data from an existing object</span>
<a name="l00092"></a>00092 <span class="comment"> * @arg obj object to inherite data from</span>
<a name="l00093"></a>00093 <span class="comment"> * @return The new object or NULL.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a><a class="code" href="group__object.html#ga90d86d45c53d2be6ba927bec662159d7">00095</a> <span class="keyword">struct </span>nl_object *<a class="code" href="group__object.html#ga90d86d45c53d2be6ba927bec662159d7" title="Allocate a new object and copy all data from an existing object.">nl_object_clone</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <span class="keyword">struct </span>nl_object *<span class="keyword">new</span>;
<a name="l00098"></a>00098 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(obj);
<a name="l00099"></a>00099 <span class="keywordtype">int</span> doff = offsetof(<span class="keyword">struct</span> <a class="code" href="structnl__derived__object.html">nl_derived_object</a>, data);
<a name="l00100"></a>00100 <span class="keywordtype">int</span> size;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">new</span> = <a class="code" href="group__object.html#ga9c1f2fd887d8325839f452879cdf982a" title="Allocate a new object of kind specified by the operations handle.">nl_object_alloc</a>(ops);
<a name="l00103"></a>00103 <span class="keywordflow">if</span> (!<span class="keyword">new</span>)
<a name="l00104"></a>00104 <span class="keywordflow">return</span> NULL;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 size = ops-><a class="code" href="structnl__object__ops.html#a0fbd42c77db2f0488b8cd72858ece719" title="Size of object including its header.">oo_size</a> - doff;
<a name="l00107"></a>00107 <span class="keywordflow">if</span> (size < 0)
<a name="l00108"></a>00108 BUG();
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">new</span>->ce_ops = obj->ce_ops;
<a name="l00111"></a>00111 <span class="keyword">new</span>->ce_msgtype = obj->ce_msgtype;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordflow">if</span> (size)
<a name="l00114"></a>00114 memcpy((<span class="keywordtype">void</span> *)<span class="keyword">new</span> + doff, (<span class="keywordtype">void</span> *)obj + doff, size);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#ada92030f50d49c033007952393c8d9b2" title="Cloning function.">oo_clone</a>) {
<a name="l00117"></a>00117 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#ada92030f50d49c033007952393c8d9b2" title="Cloning function.">oo_clone</a>(<span class="keyword">new</span>, obj) < 0) {
<a name="l00118"></a>00118 <a class="code" href="group__object.html#gabf3bc276bb9102f83fc96d299b6b03ce" title="Free a cacheable object.">nl_object_free</a>(<span class="keyword">new</span>);
<a name="l00119"></a>00119 <span class="keywordflow">return</span> NULL;
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (size && ops-><a class="code" href="structnl__object__ops.html#a38797e8754a31bb259120ef9101bbb0a" title="Destructor function.">oo_free_data</a>)
<a name="l00122"></a>00122 BUG();
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordflow">return</span> <span class="keyword">new</span>;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment">/**</span>
<a name="l00128"></a>00128 <span class="comment"> * Free a cacheable object</span>
<a name="l00129"></a>00129 <span class="comment"> * @arg obj object to free</span>
<a name="l00130"></a>00130 <span class="comment"> *</span>
<a name="l00131"></a>00131 <span class="comment"> * @return 0 or a negative error code.</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a><a class="code" href="group__object.html#gabf3bc276bb9102f83fc96d299b6b03ce">00133</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#gabf3bc276bb9102f83fc96d299b6b03ce" title="Free a cacheable object.">nl_object_free</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(obj);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordflow">if</span> (obj->ce_refcnt > 0)
<a name="l00138"></a>00138 NL_DBG(1, <span class="stringliteral">"Warning: Freeing object in use...\n"</span>);
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordflow">if</span> (obj->ce_cache)
<a name="l00141"></a>00141 <a class="code" href="group__cache.html#ga8d1f1d2c3b355a7f129d9cd6f7da2b52" title="Removes an object from a cache.">nl_cache_remove</a>(obj);
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#a38797e8754a31bb259120ef9101bbb0a" title="Destructor function.">oo_free_data</a>)
<a name="l00144"></a>00144 ops-><a class="code" href="structnl__object__ops.html#a38797e8754a31bb259120ef9101bbb0a" title="Destructor function.">oo_free_data</a>(obj);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 free(obj);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 NL_DBG(4, <span class="stringliteral">"Freed object %p\n"</span>, obj);
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150 <span class="comment"></span>
<a name="l00151"></a>00151 <span class="comment">/** @} */</span>
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">/**</span>
<a name="l00154"></a>00154 <span class="comment"> * @name Reference Management</span>
<a name="l00155"></a>00155 <span class="comment"> * @{</span>
<a name="l00156"></a>00156 <span class="comment"> */</span>
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">/**</span>
<a name="l00159"></a>00159 <span class="comment"> * Acquire a reference on a object</span>
<a name="l00160"></a>00160 <span class="comment"> * @arg obj object to acquire reference from</span>
<a name="l00161"></a>00161 <span class="comment"> */</span>
<a name="l00162"></a><a class="code" href="group__object.html#gabd5767ac47ec6f09d1ac643f44eb8bfd">00162</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#gabd5767ac47ec6f09d1ac643f44eb8bfd" title="Acquire a reference on a object.">nl_object_get</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 obj->ce_refcnt++;
<a name="l00165"></a>00165 NL_DBG(4, <span class="stringliteral">"New reference to object %p, total %d\n"</span>,
<a name="l00166"></a>00166 obj, obj->ce_refcnt);
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168 <span class="comment"></span>
<a name="l00169"></a>00169 <span class="comment">/**</span>
<a name="l00170"></a>00170 <span class="comment"> * Release a reference from an object</span>
<a name="l00171"></a>00171 <span class="comment"> * @arg obj object to release reference from</span>
<a name="l00172"></a>00172 <span class="comment"> */</span>
<a name="l00173"></a><a class="code" href="group__object.html#ga9905da094bf4c03cf4ac78aeaa86a12b">00173</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#ga9905da094bf4c03cf4ac78aeaa86a12b" title="Release a reference from an object.">nl_object_put</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00174"></a>00174 {
<a name="l00175"></a>00175 <span class="keywordflow">if</span> (!obj)
<a name="l00176"></a>00176 <span class="keywordflow">return</span>;
<a name="l00177"></a>00177
<a name="l00178"></a>00178 obj->ce_refcnt--;
<a name="l00179"></a>00179 NL_DBG(4, <span class="stringliteral">"Returned object reference %p, %d remaining\n"</span>,
<a name="l00180"></a>00180 obj, obj->ce_refcnt);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keywordflow">if</span> (obj->ce_refcnt < 0)
<a name="l00183"></a>00183 BUG();
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keywordflow">if</span> (obj->ce_refcnt <= 0)
<a name="l00186"></a>00186 <a class="code" href="group__object.html#gabf3bc276bb9102f83fc96d299b6b03ce" title="Free a cacheable object.">nl_object_free</a>(obj);
<a name="l00187"></a>00187 }
<a name="l00188"></a>00188 <span class="comment"></span>
<a name="l00189"></a>00189 <span class="comment">/**</span>
<a name="l00190"></a>00190 <span class="comment"> * Check whether this object is used by multiple users</span>
<a name="l00191"></a>00191 <span class="comment"> * @arg obj object to check</span>
<a name="l00192"></a>00192 <span class="comment"> * @return true or false</span>
<a name="l00193"></a>00193 <span class="comment"> */</span>
<a name="l00194"></a><a class="code" href="group__object.html#ga7dcec440f9e35a5611a6b613ed63eab8">00194</a> <span class="keywordtype">int</span> <a class="code" href="group__object.html#ga7dcec440f9e35a5611a6b613ed63eab8" title="Check whether this object is used by multiple users.">nl_object_shared</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00195"></a>00195 {
<a name="l00196"></a>00196 <span class="keywordflow">return</span> obj->ce_refcnt > 1;
<a name="l00197"></a>00197 }
<a name="l00198"></a>00198 <span class="comment"></span>
<a name="l00199"></a>00199 <span class="comment">/** @} */</span>
<a name="l00200"></a>00200 <span class="comment"></span>
<a name="l00201"></a>00201 <span class="comment">/**</span>
<a name="l00202"></a>00202 <span class="comment"> * @name Marks</span>
<a name="l00203"></a>00203 <span class="comment"> * @{</span>
<a name="l00204"></a>00204 <span class="comment"> */</span>
<a name="l00205"></a>00205 <span class="comment"></span>
<a name="l00206"></a>00206 <span class="comment">/**</span>
<a name="l00207"></a>00207 <span class="comment"> * Add mark to object</span>
<a name="l00208"></a>00208 <span class="comment"> * @arg obj Object to mark</span>
<a name="l00209"></a>00209 <span class="comment"> */</span>
<a name="l00210"></a><a class="code" href="group__object.html#gadbc633bb8ae194050473818e0484613d">00210</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#gadbc633bb8ae194050473818e0484613d" title="Add mark to object.">nl_object_mark</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00211"></a>00211 {
<a name="l00212"></a>00212 obj->ce_flags |= NL_OBJ_MARK;
<a name="l00213"></a>00213 }
<a name="l00214"></a>00214 <span class="comment"></span>
<a name="l00215"></a>00215 <span class="comment">/**</span>
<a name="l00216"></a>00216 <span class="comment"> * Remove mark from object</span>
<a name="l00217"></a>00217 <span class="comment"> * @arg obj Object to unmark</span>
<a name="l00218"></a>00218 <span class="comment"> */</span>
<a name="l00219"></a><a class="code" href="group__object.html#ga7e4df25f8e809ed9a0fd336c21b8f2b0">00219</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#ga7e4df25f8e809ed9a0fd336c21b8f2b0" title="Remove mark from object.">nl_object_unmark</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00220"></a>00220 {
<a name="l00221"></a>00221 obj->ce_flags &= ~NL_OBJ_MARK;
<a name="l00222"></a>00222 }
<a name="l00223"></a>00223 <span class="comment"></span>
<a name="l00224"></a>00224 <span class="comment">/**</span>
<a name="l00225"></a>00225 <span class="comment"> * Return true if object is marked</span>
<a name="l00226"></a>00226 <span class="comment"> * @arg obj Object to check</span>
<a name="l00227"></a>00227 <span class="comment"> * @return true if object is marked, otherwise false</span>
<a name="l00228"></a>00228 <span class="comment"> */</span>
<a name="l00229"></a><a class="code" href="group__object.html#gad4e3c7a399395cc2f8d5ea61138484e5">00229</a> <span class="keywordtype">int</span> <a class="code" href="group__object.html#gad4e3c7a399395cc2f8d5ea61138484e5" title="Return true if object is marked.">nl_object_is_marked</a>(<span class="keyword">struct</span> nl_object *obj)
<a name="l00230"></a>00230 {
<a name="l00231"></a>00231 <span class="keywordflow">return</span> (obj->ce_flags & NL_OBJ_MARK);
<a name="l00232"></a>00232 }
<a name="l00233"></a>00233 <span class="comment"></span>
<a name="l00234"></a>00234 <span class="comment">/** @} */</span>
<a name="l00235"></a>00235 <span class="comment"></span>
<a name="l00236"></a>00236 <span class="comment">/**</span>
<a name="l00237"></a>00237 <span class="comment"> * @name Utillities</span>
<a name="l00238"></a>00238 <span class="comment"> * @{</span>
<a name="l00239"></a>00239 <span class="comment"> */</span>
<a name="l00240"></a>00240 <span class="comment"></span>
<a name="l00241"></a>00241 <span class="comment">/**</span>
<a name="l00242"></a>00242 <span class="comment"> * Dump this object according to the specified parameters</span>
<a name="l00243"></a>00243 <span class="comment"> * @arg obj object to dump</span>
<a name="l00244"></a>00244 <span class="comment"> * @arg params dumping parameters</span>
<a name="l00245"></a>00245 <span class="comment"> */</span>
<a name="l00246"></a><a class="code" href="group__object.html#ga22a8e9cfa628d4346de3655523fd90b3">00246</a> <span class="keywordtype">void</span> <a class="code" href="group__object.html#ga22a8e9cfa628d4346de3655523fd90b3" title="Dump this object according to the specified parameters.">nl_object_dump</a>(<span class="keyword">struct</span> nl_object *obj, <span class="keyword">struct</span> <a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *params)
<a name="l00247"></a>00247 {
<a name="l00248"></a>00248 dump_from_ops(obj, params);
<a name="l00249"></a>00249 }
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/**</span>
<a name="l00252"></a>00252 <span class="comment"> * Check if the identifiers of two objects are identical </span>
<a name="l00253"></a>00253 <span class="comment"> * @arg a an object</span>
<a name="l00254"></a>00254 <span class="comment"> * @arg b another object of same type</span>
<a name="l00255"></a>00255 <span class="comment"> *</span>
<a name="l00256"></a>00256 <span class="comment"> * @return true if both objects have equal identifiers, otherwise false.</span>
<a name="l00257"></a>00257 <span class="comment"> */</span>
<a name="l00258"></a><a class="code" href="group__object.html#gaab17e2f7a53ad9eb9cae3d0a60e41074">00258</a> <span class="keywordtype">int</span> <a class="code" href="group__object.html#gaab17e2f7a53ad9eb9cae3d0a60e41074" title="Check if the identifiers of two objects are identical.">nl_object_identical</a>(<span class="keyword">struct</span> nl_object *a, <span class="keyword">struct</span> nl_object *b)
<a name="l00259"></a>00259 {
<a name="l00260"></a>00260 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(a);
<a name="l00261"></a>00261 <span class="keywordtype">int</span> req_attrs;
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="comment">/* Both objects must be of same type */</span>
<a name="l00264"></a>00264 <span class="keywordflow">if</span> (ops != obj_ops(b))
<a name="l00265"></a>00265 <span class="keywordflow">return</span> 0;
<a name="l00266"></a>00266
<a name="l00267"></a>00267 req_attrs = ops->oo_id_attrs;
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="comment">/* Both objects must provide all required attributes to uniquely</span>
<a name="l00270"></a>00270 <span class="comment"> * identify an object */</span>
<a name="l00271"></a>00271 <span class="keywordflow">if</span> ((a->ce_mask & req_attrs) != req_attrs ||
<a name="l00272"></a>00272 (b->ce_mask & req_attrs) != req_attrs)
<a name="l00273"></a>00273 <span class="keywordflow">return</span> 0;
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="comment">/* Can't judge unless we can compare */</span>
<a name="l00276"></a>00276 <span class="keywordflow">if</span> (ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a> == NULL)
<a name="l00277"></a>00277 <span class="keywordflow">return</span> 0;
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="keywordflow">return</span> !(ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a>(a, b, req_attrs, 0));
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281 <span class="comment"></span>
<a name="l00282"></a>00282 <span class="comment">/**</span>
<a name="l00283"></a>00283 <span class="comment"> * Compute bitmask representing difference in attribute values</span>
<a name="l00284"></a>00284 <span class="comment"> * @arg a an object</span>
<a name="l00285"></a>00285 <span class="comment"> * @arg b another object of same type</span>
<a name="l00286"></a>00286 <span class="comment"> *</span>
<a name="l00287"></a>00287 <span class="comment"> * The bitmask returned is specific to an object type, each bit set represents</span>
<a name="l00288"></a>00288 <span class="comment"> * an attribute which mismatches in either of the two objects. Unavailability</span>
<a name="l00289"></a>00289 <span class="comment"> * of an attribute in one object and presence in the other is regarded a</span>
<a name="l00290"></a>00290 <span class="comment"> * mismatch as well.</span>
<a name="l00291"></a>00291 <span class="comment"> *</span>
<a name="l00292"></a>00292 <span class="comment"> * @return Bitmask describing differences or 0 if they are completely identical.</span>
<a name="l00293"></a>00293 <span class="comment"> */</span>
<a name="l00294"></a><a class="code" href="group__object.html#ga0ee9c6a43d27a40ef64e964184576aeb">00294</a> uint32_t <a class="code" href="group__object.html#ga0ee9c6a43d27a40ef64e964184576aeb" title="Compute bitmask representing difference in attribute values.">nl_object_diff</a>(<span class="keyword">struct</span> nl_object *a, <span class="keyword">struct</span> nl_object *b)
<a name="l00295"></a>00295 {
<a name="l00296"></a>00296 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(a);
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="keywordflow">if</span> (ops != obj_ops(b) || ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a> == NULL)
<a name="l00299"></a>00299 <span class="keywordflow">return</span> UINT_MAX;
<a name="l00300"></a>00300
<a name="l00301"></a>00301 <span class="keywordflow">return</span> ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a>(a, b, ~0, 0);
<a name="l00302"></a>00302 }
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">/**</span>
<a name="l00305"></a>00305 <span class="comment"> * Match a filter against an object</span>
<a name="l00306"></a>00306 <span class="comment"> * @arg obj object to check</span>
<a name="l00307"></a>00307 <span class="comment"> * @arg filter object of same type acting as filter</span>
<a name="l00308"></a>00308 <span class="comment"> *</span>
<a name="l00309"></a>00309 <span class="comment"> * @return 1 if the object matches the filter or 0</span>
<a name="l00310"></a>00310 <span class="comment"> * if no filter procedure is available or if the</span>
<a name="l00311"></a>00311 <span class="comment"> * filter does not match.</span>
<a name="l00312"></a>00312 <span class="comment"> */</span>
<a name="l00313"></a><a class="code" href="group__object.html#gad4d9124deaff34511d03f3b73fef040c">00313</a> <span class="keywordtype">int</span> <a class="code" href="group__object.html#gad4d9124deaff34511d03f3b73fef040c" title="Match a filter against an object.">nl_object_match_filter</a>(<span class="keyword">struct</span> nl_object *obj, <span class="keyword">struct</span> nl_object *filter)
<a name="l00314"></a>00314 {
<a name="l00315"></a>00315 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(obj);
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="keywordflow">if</span> (ops != obj_ops(filter) || ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a> == NULL)
<a name="l00318"></a>00318 <span class="keywordflow">return</span> 0;
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <span class="keywordflow">return</span> !(ops-><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a>(obj, filter, filter->ce_mask,
<a name="l00321"></a>00321 LOOSE_FLAG_COMPARISON));
<a name="l00322"></a>00322 }
<a name="l00323"></a>00323 <span class="comment"></span>
<a name="l00324"></a>00324 <span class="comment">/**</span>
<a name="l00325"></a>00325 <span class="comment"> * Convert bitmask of attributes to a character string</span>
<a name="l00326"></a>00326 <span class="comment"> * @arg obj object of same type as attribute bitmask</span>
<a name="l00327"></a>00327 <span class="comment"> * @arg attrs bitmask of attribute types</span>
<a name="l00328"></a>00328 <span class="comment"> * @arg buf destination buffer</span>
<a name="l00329"></a>00329 <span class="comment"> * @arg len length of destination buffer</span>
<a name="l00330"></a>00330 <span class="comment"> *</span>
<a name="l00331"></a>00331 <span class="comment"> * Converts the bitmask of attribute types into a list of attribute</span>
<a name="l00332"></a>00332 <span class="comment"> * names separated by comas.</span>
<a name="l00333"></a>00333 <span class="comment"> *</span>
<a name="l00334"></a>00334 <span class="comment"> * @return destination buffer.</span>
<a name="l00335"></a>00335 <span class="comment"> */</span>
<a name="l00336"></a><a class="code" href="group__object.html#ga66f1f891eb1ebde2192e01a4b026c1c1">00336</a> <span class="keywordtype">char</span> *<a class="code" href="group__object.html#ga66f1f891eb1ebde2192e01a4b026c1c1" title="Convert bitmask of attributes to a character string.">nl_object_attrs2str</a>(<span class="keyword">struct</span> nl_object *obj, uint32_t attrs,
<a name="l00337"></a>00337 <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> len)
<a name="l00338"></a>00338 {
<a name="l00339"></a>00339 <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a> *ops = obj_ops(obj);
<a name="l00340"></a>00340
<a name="l00341"></a>00341 <span class="keywordflow">if</span> (ops->oo_attrs2str != NULL)
<a name="l00342"></a>00342 <span class="keywordflow">return</span> ops->oo_attrs2str(attrs, buf, len);
<a name="l00343"></a>00343 <span class="keywordflow">else</span> {
<a name="l00344"></a>00344 memset(buf, 0, len);
<a name="l00345"></a>00345 <span class="keywordflow">return</span> buf;
<a name="l00346"></a>00346 }
<a name="l00347"></a>00347 }
<a name="l00348"></a>00348 <span class="comment"></span>
<a name="l00349"></a>00349 <span class="comment">/**</span>
<a name="l00350"></a>00350 <span class="comment"> * Return list of attributes present in an object</span>
<a name="l00351"></a>00351 <span class="comment"> * @arg obj an object</span>
<a name="l00352"></a>00352 <span class="comment"> * @arg buf destination buffer</span>
<a name="l00353"></a>00353 <span class="comment"> * @arg len length of destination buffer</span>
<a name="l00354"></a>00354 <span class="comment"> *</span>
<a name="l00355"></a>00355 <span class="comment"> * @return destination buffer.</span>
<a name="l00356"></a>00356 <span class="comment"> */</span>
<a name="l00357"></a><a class="code" href="group__object.html#ga654b45a913fc7c59cd8ac7f918311655">00357</a> <span class="keywordtype">char</span> *<a class="code" href="group__object.html#ga654b45a913fc7c59cd8ac7f918311655" title="Return list of attributes present in an object.">nl_object_attr_list</a>(<span class="keyword">struct</span> nl_object *obj, <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> len)
<a name="l00358"></a>00358 {
<a name="l00359"></a>00359 <span class="keywordflow">return</span> <a class="code" href="group__object.html#ga66f1f891eb1ebde2192e01a4b026c1c1" title="Convert bitmask of attributes to a character string.">nl_object_attrs2str</a>(obj, obj->ce_mask, buf, len);
<a name="l00360"></a>00360 }
<a name="l00361"></a>00361 <span class="comment"></span>
<a name="l00362"></a>00362 <span class="comment">/** @} */</span>
<a name="l00363"></a>00363 <span class="comment"></span>
<a name="l00364"></a>00364 <span class="comment">/**</span>
<a name="l00365"></a>00365 <span class="comment"> * @name Attributes</span>
<a name="l00366"></a>00366 <span class="comment"> * @{</span>
<a name="l00367"></a>00367 <span class="comment"> */</span>
<a name="l00368"></a>00368
<a name="l00369"></a>00369 <span class="keywordtype">int</span> nl_object_get_refcnt(<span class="keyword">struct</span> nl_object *obj)
<a name="l00370"></a>00370 {
<a name="l00371"></a>00371 <span class="keywordflow">return</span> obj->ce_refcnt;
<a name="l00372"></a>00372 }
<a name="l00373"></a>00373
<a name="l00374"></a>00374 <span class="keyword">struct </span>nl_cache *nl_object_get_cache(<span class="keyword">struct</span> nl_object *obj)
<a name="l00375"></a>00375 {
<a name="l00376"></a>00376 <span class="keywordflow">return</span> obj->ce_cache;
<a name="l00377"></a>00377 }
<a name="l00378"></a>00378
<a name="l00379"></a>00379 <span class="keywordtype">void</span> *nl_object_priv(<span class="keyword">struct</span> nl_object *obj)
<a name="l00380"></a>00380 {
<a name="l00381"></a>00381 <span class="keywordflow">return</span> obj;
<a name="l00382"></a>00382 }
<a name="l00383"></a>00383 <span class="comment"></span>
<a name="l00384"></a>00384 <span class="comment">/** @} */</span>
<a name="l00385"></a>00385 <span class="comment"></span>
<a name="l00386"></a>00386 <span class="comment">/** @} */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 for libnl by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
87b89b73c41f4440bb86afd421c7548f
>
files
>
210
