1/*
2 * Copyright (c) 2015, 2015, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2015, 2015 SAP SE. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26// Encapsulates the libodm library and provides more convenient interfaces.
27
28#ifndef OS_AIX_VM_LIBODM_AIX_HPP
29#define OS_AIX_VM_LIBODM_AIX_HPP
30
31#include <odmi.h>
32
33
34// The purpose of this code is to dynamically load the libodm library
35// instead of statically linking against it. The library is AIX-specific.
36// It only exists on AIX, not on PASE. In order to share binaries
37// between AIX and PASE, we can't directly link against it.
38
39typedef int          (*fun_odm_initialize )(void);
40typedef char*        (*fun_odm_set_path   )(char*);
41typedef CLASS_SYMBOL (*fun_odm_mount_class)(char*);
42typedef void*        (*fun_odm_get_obj    )(CLASS_SYMBOL, char*, void*, int);
43typedef int          (*fun_odm_terminate  )(void);
44
45class dynamicOdm {
46  void *_libhandle;
47 protected:
48  fun_odm_initialize  _odm_initialize;
49  fun_odm_set_path    _odm_set_path;
50  fun_odm_mount_class _odm_mount_class;
51  fun_odm_get_obj     _odm_get_obj;
52  fun_odm_terminate   _odm_terminate;
53 public:
54  dynamicOdm();
55  ~dynamicOdm();
56  bool odm_loaded() {return _libhandle != NULL; }
57};
58
59
60// We provide a more convenient interface for odm access and
61// especially to determine the exact AIX kernel version.
62
63class odmWrapper : private dynamicOdm {
64  CLASS_SYMBOL _odm_class;
65  char *_data;
66  bool _initialized;
67  void clean_data();
68
69 public:
70  // Make sure everything gets initialized and cleaned up properly.
71  explicit odmWrapper(char* odm_class_name, char* odm_path = NULL) : _odm_class((CLASS_SYMBOL)-1),
72                                                                     _data(NULL), _initialized(false) {
73    if (!odm_loaded()) { return; }
74    _initialized = ((*_odm_initialize)() != -1);
75    if (_initialized) {
76      if (odm_path) { (*_odm_set_path)(odm_path); }
77      _odm_class = (*_odm_mount_class)(odm_class_name);
78    }
79  }
80  ~odmWrapper() {
81    if (_initialized) { (*_odm_terminate)(); clean_data(); }
82  }
83
84  CLASS_SYMBOL odm_class() { return _odm_class; }
85  bool has_class() { return odm_class() != (CLASS_SYMBOL)-1; }
86  int class_offset(char *field, bool is_aix_5);
87  char* data() { return _data; }
88
89  char* retrieve_obj(char* name = NULL) {
90    clean_data();
91    char *cnp = (char*)(void*)(*_odm_get_obj)(odm_class(), name, NULL, (name == NULL) ? ODM_NEXT : ODM_FIRST);
92    if (cnp != (char*)-1) { _data = cnp; }
93    return data();
94  }
95
96  int read_short(int offs) {
97    short *addr = (short*)(data() + offs);
98    return *addr;
99  }
100
101  // Determine the exact AIX kernel version as 4 byte value.
102  // The high order 2 bytes must be initialized already. They can be determined by uname.
103  static void determine_os_kernel_version(uint32_t* p_ver);
104};
105
106#endif // OS_AIX_VM_LIBODM_AIX_HPP
107