Merge lp:~gnuoy/charm-helpers/hugepages into lp:charm-helpers

[Liam Young]

[Chris Glass (tribaal)]

Looks good generally, I have a concern inline I'd like you to at least look at (maybe not implement in this branch, though).

[Chris Glass (tribaal)]

It seems I overlooked a crucial piece of information in my previous comment.

All good - +1 :)

review: Approve

[lp:~gnuoy/charm-helpers/hugepages]

431. By Liam Young on 2015-08-19

Remove unnecessary shebang

=== added file 'charmhelpers/core/hugepage.py'
--- charmhelpers/core/hugepage.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/core/hugepage.py	2015-08-19 09:41:08 +0000
@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
+import yaml
+from charmhelpers.core import fstab
+from charmhelpers.core import sysctl
+from charmhelpers.core.host import (
+    add_group,
+    add_user_to_group,
+    fstab_mount,
+    mkdir,
+)
+
+
+def hugepage_support(user, group='hugetlb', nr_hugepages=256,
+                     max_map_count=65536, mnt_point='/run/hugepages/kvm',
+                     pagesize='2MB', mount=True):
+    """Enable hugepages on system.
+
+    Args:
+    user (str)  -- Username to allow access to hugepages to
+    group (str) -- Group name to own hugepages
+    nr_hugepages (int) -- Number of pages to reserve
+    max_map_count (int) -- Number of Virtual Memory Areas a process can own
+    mnt_point (str) -- Directory to mount hugepages on
+    pagesize (str) -- Size of hugepages
+    mount (bool) -- Whether to Mount hugepages
+    """
+    group_info = add_group(group)
+    gid = group_info.gr_gid
+    add_user_to_group(user, group)
+    sysctl_settings = {
+        'vm.nr_hugepages': nr_hugepages,
+        'vm.max_map_count': max_map_count,
+        'vm.hugetlb_shm_group': gid,
+    }
+    sysctl.create(yaml.dump(sysctl_settings), '/etc/sysctl.d/10-hugepage.conf')
+    mkdir(mnt_point, owner='root', group='root', perms=0o755, force=False)
+    lfstab = fstab.Fstab()
+    fstab_entry = lfstab.get_entry_by_attr('mountpoint', mnt_point)
+    if fstab_entry:
+        lfstab.remove_entry(fstab_entry)
+    entry = lfstab.Entry('nodev', mnt_point, 'hugetlbfs',
+                         'mode=1770,gid={},pagesize={}'.format(gid, pagesize), 0, 0)
+    lfstab.add_entry(entry)
+    if mount:
+        fstab_mount(mnt_point)

=== added file 'tests/core/test_hugepage.py'
--- tests/core/test_hugepage.py	1970-01-01 00:00:00 +0000
+++ tests/core/test_hugepage.py	2015-08-19 09:41:08 +0000
@@ -0,0 +1,82 @@
+from testtools import TestCase
+from mock import patch
+from charmhelpers.core import hugepage
+
+TO_PATCH = [
+    'fstab',
+    'add_group',
+    'add_user_to_group',
+    'sysctl',
+    'fstab_mount',
+    'mkdir',
+]
+
+
+class Group(object):
+    def __init__(self):
+        self.gr_gid = '1010'
+
+
+class HugepageTests(TestCase):
+
+    def setUp(self):
+        super(HugepageTests, self).setUp()
+        for m in TO_PATCH:
+            setattr(self, m, self._patch(m))
+
+    def _patch(self, method):
+        _m = patch('charmhelpers.core.hugepage.' + method)
+        mock = _m.start()
+        self.addCleanup(_m.stop)
+        return mock
+
+    def test_hugepage_support(self):
+        self.add_group.return_value = Group()
+        self.fstab.Fstab().get_entry_by_attr.return_value = 'old fstab entry'
+        self.fstab.Fstab().Entry.return_value = 'new fstab entry'
+        hugepage.hugepage_support('nova')
+        sysctl_expect = ("{vm.hugetlb_shm_group: '1010', "
+                         "vm.max_map_count: 65536, vm.nr_hugepages: 256}\n")
+        self.sysctl.create.assert_called_with(sysctl_expect,
+                                              '/etc/sysctl.d/10-hugepage.conf')
+        self.mkdir.assert_called_with('/run/hugepages/kvm', owner='root',
+                                      group='root', perms=0o755, force=False)
+        self.fstab.Fstab().remove_entry.assert_called_with('old fstab entry')
+        self.fstab.Fstab().Entry.assert_called_with(
+            'nodev', '/run/hugepages/kvm', 'hugetlbfs',
+            'mode=1770,gid=1010,pagesize=2MB', 0, 0)
+        self.fstab.Fstab().add_entry.assert_called_with('new fstab entry')
+        self.fstab_mount.assert_called_with('/run/hugepages/kvm')
+
+    def test_hugepage_support_new_mnt(self):
+        self.add_group.return_value = Group()
+        self.fstab.Fstab().get_entry_by_attr.return_value = None
+        self.fstab.Fstab().Entry.return_value = 'new fstab entry'
+        hugepage.hugepage_support('nova')
+        self.assertEqual(self.fstab.Fstab().remove_entry.call_args_list, [])
+
+    def test_hugepage_support_no_automount(self):
+        self.add_group.return_value = Group()
+        self.fstab.Fstab().get_entry_by_attr.return_value = None
+        self.fstab.Fstab().Entry.return_value = 'new fstab entry'
+        hugepage.hugepage_support('nova', mount=False)
+        self.assertEqual(self.fstab_mount.call_args_list, [])
+
+    def test_hugepage_support_nodefaults(self):
+        self.add_group.return_value = Group()
+        self.fstab.Fstab().get_entry_by_attr.return_value = 'old fstab entry'
+        self.fstab.Fstab().Entry.return_value = 'new fstab entry'
+        hugepage.hugepage_support(
+            'nova', group='neutron', nr_hugepages=512, max_map_count=70000,
+            mnt_point='/hugepages', pagesize='1GB', mount=False)
+        sysctl_expect = ("{vm.hugetlb_shm_group: '1010', "
+                         "vm.max_map_count: 70000, vm.nr_hugepages: 512}\n")
+        self.sysctl.create.assert_called_with(sysctl_expect,
+                                              '/etc/sysctl.d/10-hugepage.conf')
+        self.mkdir.assert_called_with('/hugepages', owner='root',
+                                      group='root', perms=0o755, force=False)
+        self.fstab.Fstab().remove_entry.assert_called_with('old fstab entry')
+        self.fstab.Fstab().Entry.assert_called_with(
+            'nodev', '/hugepages', 'hugetlbfs',
+            'mode=1770,gid=1010,pagesize=1GB', 0, 0)
+        self.fstab.Fstab().add_entry.assert_called_with('new fstab entry')